fixing will-quit listener so that it does not disrupt the app.quit() listener invocations

Author: robertpatrick

documentation/1.0/content/release notes/_index.md

@@ -7,6 +7,6 @@ pre = "<b> </b>"
 
 ### Known Issues
 
-- On Windows, the Application Update dialog `Install on Exit` works _only_ if you installed the application for the current user only.  If the application was installed for all users, `Install on Exit` will cause the older version of the application to be uninstalled but the new version will not be installed.  This is due to issue https://github.com/electron-userland/electron-builder/issues/6329.
+- On Windows, the Application Update dialog `Install on Exit` works _only_ if you installed the application for the current user only.  If the application was installed for all users, `Install on Exit` will cause the older version of the application to be uninstalled but the new version will not be installed.  This is due to issue https://github.com/electron-userland/electron-builder/issues/2363.  This issue is fixed in the latest version of electron-updater but unfortunately, the fix breaks the `Install Now` functionality (see issue https://github.com/electron-userland/electron-builder/issues/6425).
 
 - When running the WKT UI application on Windows, the image builder tool (docker or podman) also must be directly executable in Windows.  For example, there is currently no support for running the WKT UI application in Windows and running podman under the Windows Subsystem for Linux (WSL2).  However, running Docker Desktop for Windows with a WSL2 backend _is_ fully supported because the `docker` command is executable directly in Windows (without having to call WSL2). If you need to use podman on Windows, then refer to the podman blog entries at https://podman.io/blogs/2021/09/06/podman-on-macs.html and https://podman.io/blogs/2020/09/02/running_windows_or_mac.html for more information about downloading, installing, and configuring the Windows Remote Client.

electron/app/js/appUpdater.js

@@ -46,6 +46,11 @@ function registerAutoUpdateListeners() {
       }
       autoUpdater.quitAndInstall();
     }
+    // On Windows, when _installType = 'onExit' and the app is installed for all users, [email protected]
+    // doesn't work.  This is fixed in [email protected] but that version suffers from
+    // https://github.com/electron-userland/electron-builder/issues/6425, which causes
+    // a Windows installer regression.
+    //
   });
 }
 

electron/app/js/userSettings.js

@@ -5,10 +5,8 @@
  */
 const { app } = require('electron');
 const fs = require('fs');
-const fsPromises = require('fs/promises');
 const path = require('path');
 
-const fsUtils = require('./fsUtils');
 const { getErrorMessage } = require('./errorUtils');
 
 // eslint-disable-next-line no-unused-vars
@@ -66,35 +64,26 @@ function getUserSettingsForRemote() {
   return JSON.stringify(_constructFilteredCopy(settings));
 }
 
-async function applyUserSettingsFromRemote(remoteUserSettingsJson) {
-  let remoteUserSettingsObject;
-  try {
-    remoteUserSettingsObject = JSON.parse(remoteUserSettingsJson);
-    verifyRemoteUserSettingsObject(remoteUserSettingsObject);
-  } catch (err) {
-    return Promise.reject(err);
-  }
+function applyUserSettingsFromRemote(remoteUserSettingsJson) {
+  const { getLogger } = require('./wktLogging');
+  const logger = getLogger();
 
-  return new Promise((resolve, reject) => {
-    const currentSettings = _getUserSettings();
-    const { getLogger } = require('./wktLogging');
-    const logger = getLogger();
-    for (const privateField of appPrivateFieldNames) {
-      logger.debug(`privateField = ${privateField}`);
-      if (Object.prototype.hasOwnProperty.call(currentSettings, privateField)) {
-        logger.debug(`adding private field ${privateField} to new user settings object`);
-        remoteUserSettingsObject[privateField] = currentSettings[privateField];
-      } else {
-        logger.debug(`currentSettings doesn't have private field ${privateField}`);
-      }
+  let remoteUserSettingsObject = JSON.parse(remoteUserSettingsJson);
+  verifyRemoteUserSettingsObject(remoteUserSettingsObject);
+  const currentSettings = _getUserSettings();
+  for (const privateField of appPrivateFieldNames) {
+    logger.debug(`privateField = ${privateField}`);
+    if (Object.prototype.hasOwnProperty.call(currentSettings, privateField)) {
+      logger.debug(`adding private field ${privateField} to new user settings object`);
+      remoteUserSettingsObject[privateField] = currentSettings[privateField];
+    } else {
+      logger.debug(`currentSettings doesn't have private field ${privateField}`);
     }
-    logger.debug(`new user settings are: ${JSON.stringify(remoteUserSettingsObject)}`);
-    _userSettingsObject = remoteUserSettingsObject;
-    saveUserSettings().then(() => {
-      logger.debug('user settings saved...restart the application to pick up logger settings changes');
-      resolve();
-    }).catch(err => reject(err));
-  });
+  }
+  logger.debug(`new user settings are: ${JSON.stringify(remoteUserSettingsObject)}`);
+  _userSettingsObject = remoteUserSettingsObject;
+  saveUserSettings();
+  logger.debug('user settings saved...restart the application to pick up logger settings changes');
 }
 
 function getHttpsProxyUrl() {
@@ -307,28 +296,42 @@ function verifyRemoteUserSettingsObject(remoteUserSettingsObject) {
   }
 }
 
-async function saveUserSettings() {
+function saveUserSettings() {
   const i18n = require('./i18next.config');
 
   if (!_userSettingsObject) {
     // nothing to save
-    return new Promise(resolve => resolve());
+    return;
   }
   const userSettingsJson = JSON.stringify(_userSettingsObject, null, 2);
 
-  return new Promise((resolve, reject) => {
-    const userSettingsDirectory = getUserSettingsDirectory();
-    const userSettingsFileName = getUserSettingsFileName();
-    fsUtils.makeDirectoryIfNotExists(userSettingsDirectory)
-      .then(() => {
-        fsPromises.writeFile(userSettingsFileName, userSettingsJson, { encoding: 'utf8' })
-          .then(() => resolve())
-          .catch(err => reject(new Error(i18n.t('user-settings-file-save-failed-error-message',
-            { userSettingsFile: userSettingsFileName, error: getErrorMessage(err) }))));
-      })
-      .catch(err => reject(new Error(i18n.t('user-settings-make-directory-failed-error-message',
-        { userSettingsDirectory: userSettingsDirectory, error: getErrorMessage(err) }))));
-  });
+  const userSettingsDirectory = getUserSettingsDirectory();
+  let dirExists;
+  try {
+    dirExists = fs.existsSync(userSettingsDirectory);
+  } catch (err) {
+    throw new Error(i18n.t('user-settings-check-directory-failed-error-message',
+      { userSettingsDirectory: userSettingsDirectory, error: getErrorMessage(err) }));
+  }
+
+  if (!dirExists) {
+    try {
+      fs.mkdirSync(userSettingsDirectory, {
+        recursive: true
+      });
+    } catch (err) {
+      throw new Error(i18n.t('user-settings-make-directory-failed-error-message',
+        { userSettingsDirectory: userSettingsDirectory, error: getErrorMessage(err) }));
+    }
+  }
+
+  const userSettingsFileName = getUserSettingsFileName();
+  try {
+    fs.writeFileSync(userSettingsFileName, userSettingsJson, { encoding: 'utf8' });
+  } catch (err) {
+    throw new Error(i18n.t('user-settings-file-save-failed-error-message',
+      { userSettingsFile: userSettingsFileName, error: getErrorMessage(err) }));
+  }
 }
 
 function _constructFilteredCopy(settings) {

electron/app/locales/en/electron.json

@@ -299,6 +299,7 @@
   "user-settings-directory-not-initialized-error-message": "Unable to get the user settings directory because electron is not yet initialized",
   "user-settings-file-exists-checked-failed-error-message": "Existence check for user settings file {{userSettingsFile}} failed: {{error}}",
   "user-settings-illegal-fields-error-message": "Remote User Settings object contains illegal fields: {{fieldNames}}",
+  "user-settings-check-directory-failed-error-message": "Failed to test the existence of {{userSettingsDirectory}} directory: {{error}}",
   "user-settings-make-directory-failed-error-message": "Failed to create {{userSettingsDirectory}} directory: {{error}}",
   "user-settings-file-save-failed-error-message": "Failed to save file {{userSettingsFile}}: {{error}}",
   "user-settings-deep-copy-failed-error-message": "Failed to make a deep copy of the user settings object: {{error}}",

electron/app/main.js

@@ -189,18 +189,14 @@ class Main {
       this._forceQuit = true;
     });
 
-    app.on('will-quit', (event) => {
+    app.on('will-quit', () => {
       this._logger.debug('Received will-quit event');
-      event.preventDefault();
-      userSettings.saveUserSettings()
-        .then(() => {
-          this._logger.info('User Settings saved');
-          app.exit();
-        })
-        .catch(err => {
-          this._logger.error('User settings save failed: %s', err);
-          app.exit();
-        });
+      try {
+        userSettings.saveUserSettings();
+        this._logger.info('User Settings saved');
+      } catch (err) {
+        this._logger.error('User settings save failed: %s', err);
+      }
     });
   }
 
@@ -524,33 +520,30 @@ class Main {
 
     ipcMain.handle('save-user-settings', async (event, userSettingsObj) => {
       const currentWindow = event.sender.getOwnerBrowserWindow();
-      return new Promise(resolve => {
-        userSettings.applyUserSettingsFromRemote(userSettingsObj)
-          .then(() => {
-            dialog.showMessageBox(currentWindow, {
-              type: 'info',
-              title: i18n.t('dialog-preference-save-success-title'),
-              message: i18n.t('dialog-preference-save-success-message'),
-              buttons: [
-                i18n.t('button-ok')
-              ],
-              defaultId: 0,
-              cancelId: 0
-            }).then(() => resolve());
-          })
-          .catch(err => {
-            dialog.showMessageBox(currentWindow, {
-              type: 'error',
-              title: i18n.t('dialog-preference-save-error-title'),
-              message: i18n.t('dialog-preference-save-error-message', { error: err }),
-              buttons: [
-                i18n.t('button-ok')
-              ],
-              defaultId: 0,
-              cancelId: 0
-            }).then(() => resolve());
-          });
-      });
+      try {
+        userSettings.applyUserSettingsFromRemote(userSettingsObj);
+        dialog.showMessageBox(currentWindow, {
+          type: 'info',
+          title: i18n.t('dialog-preference-save-success-title'),
+          message: i18n.t('dialog-preference-save-success-message'),
+          buttons: [
+            i18n.t('button-ok')
+          ],
+          defaultId: 0,
+          cancelId: 0
+        }).then();
+      } catch (err) {
+        dialog.showMessageBox(currentWindow, {
+          type: 'error',
+          title: i18n.t('dialog-preference-save-error-title'),
+          message: i18n.t('dialog-preference-save-error-message', { error: err }),
+          buttons: [
+            i18n.t('button-ok')
+          ],
+          defaultId: 0,
+          cancelId: 0
+        }).then();
+      }
     });
 
     // eslint-disable-next-line no-unused-vars
@@ -846,7 +839,7 @@ class Main {
     ipcMain.handle('restart-network-settings', async (event, settings) => {
       userSettings.setHttpsProxyUrl(settings['proxyUrl']);
       userSettings.setBypassProxyHosts(settings['bypassHosts']);
-      await userSettings.saveUserSettings();
+      userSettings.saveUserSettings();
       app.relaunch();
       app.quit();
     });