[PM-8297][PM-955] Improve updater behavior (#14732)

* [PM-8297] Improve updater behavior

* Remove logs

* Unused args

* Test version number

* Revert "Test version number"

This reverts commit 39ef057662.

apps/desktop/src/main/updater.main.ts

@@ -1,6 +1,6 @@
 import { dialog, shell } from "electron";
 import log from "electron-log";
-import { autoUpdater } from "electron-updater";
+import { autoUpdater, UpdateDownloadedEvent, VerifyUpdateSupport } from "electron-updater";
 
 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
 
@@ -15,6 +15,8 @@ export class UpdaterMain {
   private doingUpdateCheck = false;
   private doingUpdateCheckWithFeedback = false;
   private canUpdate = false;
+  private updateDownloaded: UpdateDownloadedEvent = null;
+  private originalRolloutFunction: VerifyUpdateSupport = null;
 
   constructor(
     private i18nService: I18nService,
@@ -22,6 +24,8 @@ export class UpdaterMain {
   ) {
     autoUpdater.logger = log;
 
+    this.originalRolloutFunction = autoUpdater.isUserWithinRollout;
+
     const linuxCanUpdate = process.platform === "linux" && isAppImage();
     const windowsCanUpdate =
       process.platform === "win32" && !isWindowsStore() && !isWindowsPortable();
@@ -57,20 +61,16 @@ export class UpdaterMain {
         });
 
         if (result.response === 0) {
-          // FIXME: Verify that this floating promise is intentional. If it is, add an explanatory comment and ensure there is proper error handling.
+          await autoUpdater.downloadUpdate();
-          // eslint-disable-next-line @typescript-eslint/no-floating-promises
-          autoUpdater.downloadUpdate();
         } else {
           this.reset();
         }
       }
     });
 
-    autoUpdater.on("update-not-available", () => {
+    autoUpdater.on("update-not-available", async () => {
       if (this.doingUpdateCheckWithFeedback && this.windowMain.win != null) {
-        // FIXME: Verify that this floating promise is intentional. If it is, add an explanatory comment and ensure there is proper error handling.
+        await dialog.showMessageBox(this.windowMain.win, {
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        dialog.showMessageBox(this.windowMain.win, {
           message: this.i18nService.t("noUpdatesAvailable"),
           buttons: [this.i18nService.t("ok")],
           defaultId: 0,
@@ -86,6 +86,65 @@ export class UpdaterMain {
         return;
       }
 
+      this.updateDownloaded = info;
+      await this.promptRestartUpdate(info);
+    });
+
+    autoUpdater.on("error", (error) => {
+      if (this.doingUpdateCheckWithFeedback) {
+        dialog.showErrorBox(
+          this.i18nService.t("updateError"),
+          error == null ? this.i18nService.t("unknown") : (error.stack || error).toString(),
+        );
+      }
+
+      this.reset();
+    });
+  }
+
+  async checkForUpdate(withFeedback = false) {
+    if (isDev()) {
+      return;
+    }
+
+    if (this.updateDownloaded && withFeedback) {
+      await this.promptRestartUpdate(this.updateDownloaded);
+      return;
+    }
+
+    if (this.doingUpdateCheck) {
+      return;
+    }
+
+    if (!this.canUpdate) {
+      if (withFeedback) {
+        void shell.openExternal("https://github.com/bitwarden/clients/releases");
+      }
+
+      return;
+    }
+
+    this.doingUpdateCheckWithFeedback = withFeedback;
+    if (withFeedback) {
+      autoUpdater.autoDownload = false;
+
+      // If the user has explicitly checked for updates, we want to bypass
+      // the current staging rollout percentage
+      autoUpdater.isUserWithinRollout = (info) => true;
+    }
+
+    await autoUpdater.checkForUpdates();
+  }
+
+  private reset() {
+    autoUpdater.autoDownload = true;
+    // Reset the rollout check to the default behavior
+    autoUpdater.isUserWithinRollout = this.originalRolloutFunction;
+    this.doingUpdateCheck = false;
+    this.updateDownloaded = null;
+  }
+
+  private async promptRestartUpdate(info: UpdateDownloadedEvent) {
     const result = await dialog.showMessageBox(this.windowMain.win, {
       type: "info",
       title: this.i18nService.t("bitwarden") + " - " + this.i18nService.t("restartToUpdate"),
@@ -102,46 +161,6 @@ export class UpdaterMain {
       this.windowMain.isQuitting = true;
       autoUpdater.quitAndInstall(true, true);
     }
-    });
-
-    autoUpdater.on("error", (error) => {
-      if (this.doingUpdateCheckWithFeedback) {
-        dialog.showErrorBox(
-          this.i18nService.t("updateError"),
-          error == null ? this.i18nService.t("unknown") : (error.stack || error).toString(),
-        );
-      }
-
-      this.reset();
-    });
-  }
-
-  async checkForUpdate(withFeedback = false) {
-    if (this.doingUpdateCheck || isDev()) {
-      return;
-    }
-
-    if (!this.canUpdate) {
-      if (withFeedback) {
-        // FIXME: Verify that this floating promise is intentional. If it is, add an explanatory comment and ensure there is proper error handling.
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        shell.openExternal("https://github.com/bitwarden/clients/releases");
-      }
-
-      return;
-    }
-
-    this.doingUpdateCheckWithFeedback = withFeedback;
-    if (withFeedback) {
-      autoUpdater.autoDownload = false;
-    }
-
-    await autoUpdater.checkForUpdates();
-  }
-
-  private reset() {
-    autoUpdater.autoDownload = true;
-    this.doingUpdateCheck = false;
   }
 
   private userDisabledUpdates(): boolean {

package-lock.json

@@ -135,7 +135,7 @@
         "electron-log": "5.2.4",
         "electron-reload": "2.0.0-alpha.1",
         "electron-store": "8.2.0",
-        "electron-updater": "6.3.9",
+        "electron-updater": "6.6.4",
         "eslint": "8.57.1",
         "eslint-config-prettier": "10.1.2",
         "eslint-import-resolver-typescript": "4.3.4",
@@ -18500,13 +18500,13 @@
       "license": "ISC"
     },
     "node_modules/electron-updater": {
-      "version": "6.3.9",
+      "version": "6.6.4",
-      "resolved": "https://registry.npmjs.org/electron-updater/-/electron-updater-6.3.9.tgz",
+      "resolved": "https://registry.npmjs.org/electron-updater/-/electron-updater-6.6.4.tgz",
-      "integrity": "sha512-2PJNONi+iBidkoC5D1nzT9XqsE8Q1X28Fn6xRQhO3YX8qRRyJ3mkV4F1aQsuRnYPqq6Hw+E51y27W75WgDoofw==",
+      "integrity": "sha512-RcuWXbXTQkI5X3vir/eJ9S0VZQJ73eaQdlrA2J0mVrb0sbkHtnkjBMGo9umFtX8axn6r/pShN3CORxdmiF4OOw==",
       "dev": true,
       "license": "MIT",
       "dependencies": {
-        "builder-util-runtime": "9.2.10",
+        "builder-util-runtime": "9.3.2",
         "fs-extra": "^10.1.0",
         "js-yaml": "^4.1.0",
         "lazy-val": "^1.0.5",
@@ -18517,9 +18517,9 @@
       }
     },
     "node_modules/electron-updater/node_modules/builder-util-runtime": {
-      "version": "9.2.10",
+      "version": "9.3.2",
-      "resolved": "https://registry.npmjs.org/builder-util-runtime/-/builder-util-runtime-9.2.10.tgz",
+      "resolved": "https://registry.npmjs.org/builder-util-runtime/-/builder-util-runtime-9.3.2.tgz",
-      "integrity": "sha512-6p/gfG1RJSQeIbz8TK5aPNkoztgY1q5TgmGFMAXcY8itsGW6Y2ld1ALsZ5UJn8rog7hKF3zHx5iQbNQ8uLcRlw==",
+      "integrity": "sha512-7QDXJ1FwT6d9ZhG4kuObUUPY8/ENBS/Ky26O4hR5vbeoRGavgekS2Jxv+8sCn/v23aPGU2DXRWEeJuijN2ooYA==",
       "dev": true,
       "license": "MIT",
       "dependencies": {

package.json

@@ -101,7 +101,7 @@
     "electron-log": "5.2.4",
     "electron-reload": "2.0.0-alpha.1",
     "electron-store": "8.2.0",
-    "electron-updater": "6.3.9",
+    "electron-updater": "6.6.4",
     "eslint": "8.57.1",
     "eslint-config-prettier": "10.1.2",
     "eslint-import-resolver-typescript": "4.3.4",