Merge pull request wojtkowiak#22 from tkhtechnology/MX002-9288

fix: do not download new version when desktopHCP is set to false
liris-tech · Aug 11, 2023 · f6f824a · f6f824a
2 parents d88a3e1 + bb250b7
commit f6f824a
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 5 deletions.
diff --git a/skeleton/modules/autoupdate.js b/skeleton/modules/autoupdate.js
@@ -236,6 +236,10 @@ export default class HCPClient {
      * @private
      */
     checkForUpdates() {
+        if (('desktopHCP' in this.appSettings) && !this.appSettings.desktopHCP) {
+            this.log.verbose(`Skipping checking for updates because desktopHCP is disabled`);
+            return;
+        }
         const rootUrl = this.settings.customHCPUrl ?
             this.settings.customHCPUrl : this.currentAssetBundle.getRootUrlString();
 

diff --git a/tests/functional/modules/autoupdate.test.js b/tests/functional/modules/autoupdate.test.js
@@ -80,14 +80,16 @@ function exists(checkPath) {
  * @param {boolean} printErrorLogs - Whether to print errors even if `printLogs` is false
  * @param {boolean} testMode       - Whether to inform autoupdate that this is a test run. Currently
  *                                   when true, autoupdate does not fire the startup timer
+ * @param {Object} [appSettings]   - object pass as appSettings to HCPClient
+ *
  * @returns {HCPClient}
  */
 async function setUpAutoupdate(printLogs = false, onNewVersionReady, expectedVersion = 'version1',
     errorCallback = Function.prototype, printErrorLogs = false,
-    testMode = true) {
+    testMode = true, appSettings = {}) {
     const autoupdate = new HCPClient({
         log: getFakeLogger(printLogs, printErrorLogs),
-        appSettings: {},
+        appSettings,
         // fake systemEvents
         eventsBus: {
             on() {
@@ -154,10 +156,11 @@ async function setUpAutoupdate(printLogs = false, onNewVersionReady, expectedVer
  * @param {boolean} printErrorLogs - Whether to print errors even if `printLogs` is false.
  * @param {boolean} testMode       - Whether to inform autoupdate that this is a test run. Currently
  *                                   when true, autoupdate does not fire the startup timer.
+ * @param {Object} [appSettings]   - object pass as appSettings to HCPClient
  */
 async function runAutoUpdateTests(done, testCallback, versionExpectedAfter,
     versionExpectedBefore = 'version1', doNotCallDone = false,
-    printErrorLogs = showErrors, testMode = true) {
+    printErrorLogs = showErrors, testMode = true, appSettings) {
     let autoupdate;
     try {
         autoupdate = await setUpAutoupdate(showLogs, async () => {
@@ -171,7 +174,7 @@ async function runAutoUpdateTests(done, testCallback, versionExpectedAfter,
             if (!doNotCallDone) {
                 done();
             }
-        }, versionExpectedBefore, undefined, printErrorLogs, testMode);
+        }, versionExpectedBefore, undefined, printErrorLogs, testMode, appSettings);
     } catch (e) {
         done(e);
     }
@@ -236,7 +239,7 @@ function shutdownMeteorServer() {
 }
 
 function waitForTestToFail(delay, done) {
-    setTimeout(() => {
+    return setTimeout(() => {
         done();
     }, delay);
 }
@@ -946,4 +949,27 @@ describe('autoupdate', () => {
             autoupdate.checkForUpdates();
         });
     });
+
+    describe('when desktopHCP', () => {
+        beforeEach(async () => {
+            meteorServer = await serveVersion('version2');
+            cleanup();
+        });
+        afterEach(() => {
+            shutdownMeteorServer();
+            shutdownLocalServer();
+        });
+
+        it('is set to false then should not emit new version', (done) => {
+            const timeout = waitForTestToFail(1000, done);
+            runAutoUpdateTests(done, () => {
+                clearTimeout(timeout);
+                done('onVersionReady invoked unexpectedly');
+            }, 'version2', 'version1', true, false, true, { desktopHCP: false });
+        });
+
+        it('is set to true then should emit new version', (done) => {
+            runAutoUpdateTests(done, Function.prototype, 'version2', 'version1', false, false, true, { desktopHCP: true });
+        });
+    });
 });
diff --git a/tests/helpers/autoupdate/meteorServer.js b/tests/helpers/autoupdate/meteorServer.js
@@ -121,6 +121,16 @@ export default class MeteorServer {
 
         server.use(setETag);
 
+        function versionDesktop(req, res, next) {
+            const parsedUrl = url.parse(req.url);
+            if (parsedUrl.pathname.endsWith('version.desktop.json')) {
+                const manifest = require(path.join(serverPath, 'manifest.json'))
+                res.end(JSON.stringify(manifest.version));
+            }
+            next();
+        }
+        server.use(versionDesktop);
+
         // Serve files as static from the main directory.
         server.use(serveStatic(serverPath),
             {});