Merge pull request #1320 from buttercup/feat/disable_updates_cli

Disable updates via launch args
buttercup · Apr 1, 2024 · ba8d225 · ba8d225
2 parents ac89483 + a770174
commit ba8d225
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -92,6 +92,7 @@ The following arguments can be provided to Buttercup, but are all optional.
 |-----------------------|---------------------------------------|
 | `--autostart`         | Flag passed to Buttercup when launched automatically by the OS. |
 | `--hidden`            | Disables the automatic opening of the main window upon launch. |
+| `--no-update`         | Disables automatic update checking. **Not recommended**: Use at your own risk. |
 
 ### App config
 

diff --git a/source/main/ipc.ts b/source/main/ipc.ts
@@ -351,9 +351,9 @@ ipcMain.handle("start-current-update", async () => {
 ipcMain.handle("toggle-auto-update", async (_, enable: boolean) => {
     await toggleAutoUpdate(enable);
     if (enable) {
-        logInfo("Enabled auto-update");
+        logInfo("Enabled vault auto-update");
     } else {
-        logInfo("Disabled auto-update");
+        logInfo("Disabled vault auto-update");
     }
 });
 

diff --git a/source/main/library/build.ts b/source/main/library/build.ts
@@ -1,3 +1,3 @@
 // This file updated automatically: changes made here will be overwritten!
 
-export const VERSION = "2.26.4";
+export const VERSION = "2.26.5";
diff --git a/source/main/services/arguments.ts b/source/main/services/arguments.ts
@@ -1,5 +1,6 @@
 import { app } from "electron";
 import { isOSX } from "../../shared/library/platform";
+import { disableUpdates } from "./update";
 
 let __autostarted = false,
     __showMainWindow = true;
@@ -22,6 +23,9 @@ export function processLaunchConfiguration() {
     if (cl.hasSwitch("autostart")) {
         __autostarted = true;
     }
+    if (cl.hasSwitch("no-update")) {
+        disableUpdates();
+    }
 }
 
 export function shouldShowMainWindow(): boolean {

diff --git a/source/main/services/update.ts b/source/main/services/update.ts
@@ -20,16 +20,17 @@ let __eventListenersAttached = false,
     __readyUpdate: UpdateInfo = null,
     __updateCheckTimer: string = null,
     __updateErrored: boolean = false,
-    __updateMuted: boolean = false;
+    __updateMuted: boolean = false,
+    __updatesDisabled: boolean = false;
 
 function attachEventListeners(updater = autoUpdater) {
     updater.on("error", (err: Error) => {
         __updateErrored = true;
         if (err?.message === "net::ERR_INTERNET_DISCONNECTED") {
-            logInfo("Update failed due to no internet connection");
+            logInfo("Updates: Update failed due to no internet connection");
             return;
         }
-        logErr("Error processing update", err);
+        logErr("Updates: Error processing update", err);
         const win = getMainWindow();
         if (win) {
             win.webContents.send("update-error", err.message);
@@ -42,9 +43,9 @@ function attachEventListeners(updater = autoUpdater) {
         }
     });
     updater.on("update-available", (updateInfo: UpdateInfo) => {
-        logInfo(`Update available: ${updateInfo.version} (${updateInfo.releaseDate})`);
+        logInfo(`Updates: Update available: ${updateInfo.version} (${updateInfo.releaseDate})`);
         if (__updateMuted) {
-            logInfo("Updates muted: will not notify");
+            logInfo("Updates: Updates muted: will not notify");
             return;
         }
         const win = getMainWindow();
@@ -53,16 +54,16 @@ function attachEventListeners(updater = autoUpdater) {
         }
     });
     updater.on("update-not-available", () => {
-        logInfo("No update available");
+        logInfo("Updates: No update available");
     });
     updater.on("update-downloaded", (updateInfo: UpdateInfo) => {
-        logInfo(`Update downloaded: ${updateInfo.version}`);
+        logInfo(`Updates: Updated build downloaded: ${updateInfo.version}`);
         const win = getMainWindow();
         if (win) {
             win.webContents.send("update-progress", JSON.stringify(null));
         }
         if (__updateErrored) {
-            logWarn("Skipping update-ready notification due to preview error");
+            logWarn("Updates: Skipping update-ready notification due to preview error");
             return;
         }
         __readyUpdate = updateInfo;
@@ -74,6 +75,7 @@ function attachEventListeners(updater = autoUpdater) {
 }
 
 async function checkForUpdateInternal() {
+    if (__updatesDisabled) return;
     if (!__eventListenersAttached) {
         __eventListenersAttached = true;
         attachEventListeners();
@@ -82,7 +84,9 @@ async function checkForUpdateInternal() {
     __readyUpdate = null;
     __updateErrored = false;
     const prefs = await getConfigValue("preferences");
-    logInfo(`Using pre-release channel for updates: ${prefs.prereleaseUpdates ? "yes" : "no"}`);
+    logInfo(
+        `Updates: Using pre-release channel for updates: ${prefs.prereleaseUpdates ? "yes" : "no"}`
+    );
     autoUpdater.allowPrerelease = prefs.prereleaseUpdates;
     autoUpdater.autoDownload = false;
     autoUpdater.setFeedURL({
@@ -93,18 +97,26 @@ async function checkForUpdateInternal() {
     if (isDev) {
         const hasDevConfig = await hasDevUpdate();
         if (!hasDevConfig) {
-            logInfo("Will not check for updates: In dev mode with no dev-app-update.yml");
+            logInfo("Updates: Will not check for updates: In dev mode with no dev-app-update.yml");
             return;
         }
     }
     logInfo("Checking for updates");
     try {
         await autoUpdater.checkForUpdates();
-    } catch (err) {}
+    } catch (err) {
+        logErr(`Updates: Update check failed: ${err.message}`);
+        logErr(err);
+    }
+}
+
+export function disableUpdates(): void {
+    __updatesDisabled = true;
+    logInfo("Updates: Updates have been manually disabled");
 }
 
 export function getCurrentUpdate(): UpdateInfo {
-    return !__updateMuted && __currentUpdate ? __currentUpdate : null;
+    return !__updateMuted && __currentUpdate && !__updatesDisabled ? __currentUpdate : null;
 }
 
 export function getReadyUpdate(): UpdateInfo {
@@ -120,7 +132,7 @@ export function installUpdate() {
 }
 
 export function muteUpdate() {
-    logInfo("Update notification muted");
+    logInfo("Updates: Update notification muted");
     __updateMuted = true;
 }