Add pre-release channel support for updates

Fixes buttercup#1277
annie-maria · Mar 31, 2024 · 4d7f2c9 · 4d7f2c9
1 parent 266fe5c
commit 4d7f2c9
Show file tree

Hide file tree

Showing 19 changed files with 47 additions and 25 deletions.
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.1";
+export const VERSION = "2.26.4";
diff --git a/source/main/services/config.ts b/source/main/services/config.ts
@@ -36,14 +36,23 @@ export async function getVaultSettings(sourceID: VaultSourceID): Promise<VaultSe
 }
 
 export async function initialise(): Promise<void> {
-    // Run migrations
+    // Initialise config
     const storage = getConfigStorage();
     const config = (await storage.getValues()) as unknown as Config;
+    // Run migrations
     const [updatedConfig, didMigrate] = runConfigMigrations(config);
     if (didMigrate) {
         logInfo("Detected config migration changes");
         await storage.setValues(updatedConfig);
     }
+    // Fill empty config values
+    for (const key in DEFAULT_CONFIG) {
+        const configKey = key as keyof Config;
+        if (typeof config[configKey] === "undefined") {
+            // Fill value
+            await setConfigValue(configKey, DEFAULT_CONFIG[configKey]);
+        }
+    }
     // Initialise preferences
     const preferences = naiveClone(await getConfigValue("preferences"));
     for (const key in PREFERENCES_DEFAULT) {

diff --git a/source/main/services/update.ts b/source/main/services/update.ts
@@ -8,6 +8,7 @@ import { clearDelayedInterval, setDelayedInterval } from "delayable-setinterval"
 import { getMainWindow } from "./windows";
 import { logErr, logInfo, logWarn } from "../library/log";
 import { fileExists } from "../library/file";
+import { getConfigValue } from "./config";
 import { UpdateProgressInfo } from "../types";
 
 const UPDATE_AUTO_CHECK = ms("30m");
@@ -80,6 +81,9 @@ async function checkForUpdateInternal() {
     __currentUpdate = null;
     __readyUpdate = null;
     __updateErrored = false;
+    const usePrerelease = await getConfigValue("prereleaseUpdates");
+    logInfo(`Using pre-release channel for updates: ${usePrerelease ? "yes" : "no"}`);
+    autoUpdater.allowPrerelease = usePrerelease;
     autoUpdater.autoDownload = false;
     autoUpdater.setFeedURL({
         provider: "github",

diff --git a/source/renderer/components/PreferencesDialog.tsx b/source/renderer/components/PreferencesDialog.tsx
@@ -26,6 +26,7 @@ const LOCK_VAULTS_TIME_MAX = ms("1d") / 1000;
 const PAGE_CONNECTIVITY = "connectivity";
 const PAGE_GENERAL = "general";
 const PAGE_SECURITY = "security";
+const PAGE_UPDATES = "updates";
 const THEME_AUTO_NAME = "Auto (OS)";
 
 const DialogFreeWidth = styled(Dialog)`
@@ -252,6 +253,23 @@ export function PreferencesDialog() {
             </FormGroup>
         </>
     );
+    const pageUpdates = () => (
+        <>
+            <FormGroup label={t("preferences.item.pre-release.title")}>
+                <Callout icon="lab-test" intent={Intent.WARNING}>
+                    <div dangerouslySetInnerHTML={{ __html: t("preferences.item.pre-release.description") }} />
+                </Callout>
+                <Switch
+                    checked={preferences.prereleaseUpdates}
+                    label={t("preferences.item.pre-release.label")}
+                    onChange={(evt: React.ChangeEvent<HTMLInputElement>) => setPreferences({
+                        ...naiveClone(preferences),
+                        prereleaseUpdates: evt.target.checked
+                    })}
+                />
+            </FormGroup>
+        </>
+    );
     // Render
     return (
         <DialogFreeWidth isOpen={showPreferences.get()} onClose={close}>
@@ -283,21 +301,18 @@ export function PreferencesDialog() {
                                     text={t("preferences.section.connectivity")}
                                 />
                                 <Button
-                                    disabled
-                                    icon="eye-off"
-                                    text={t("preferences.section.privacy")}
-                                />
-                                <Button
-                                    disabled
-                                    icon="lab-test"
-                                    text={t("preferences.section.debug")}
+                                    active={currentPage === PAGE_UPDATES}
+                                    icon="updated"
+                                    onClick={() => setCurrentPage(PAGE_UPDATES)}
+                                    text={t("preferences.section.updates")}
                                 />
                             </PreferencesMenu>
                         </PreferencesSidebar>
                         <PageContent>
                             {currentPage === PAGE_GENERAL && pageGeneral()}
                             {currentPage === PAGE_SECURITY && pageSecurity()}
                             {currentPage === PAGE_CONNECTIVITY && pageConnectivity()}
+                            {currentPage === PAGE_UPDATES && pageUpdates()}
                         </PageContent>
                     </PreferencesContent>
                 )}

diff --git a/source/shared/i18n/translations/ca_es.json b/source/shared/i18n/translations/ca_es.json
@@ -223,7 +223,6 @@
         },
         "section": {
             "connectivity": "Connectivitat",
-            "debug": "Depurar",
             "general": "General",
             "privacy": "Privacitat",
             "security": "Seguretat"

diff --git a/source/shared/i18n/translations/de.json b/source/shared/i18n/translations/de.json
@@ -250,7 +250,6 @@
         },
         "section": {
             "connectivity": "Konnektivität",
-            "debug": "Debug",
             "general": "Allgemein",
             "privacy": "Datenschutz",
             "security": "Sicherheit"

diff --git a/source/shared/i18n/translations/en.json b/source/shared/i18n/translations/en.json
@@ -263,6 +263,11 @@
             "lock-vaults-after-time-desc": "Automatically lock vaults after some period of inactivity.",
             "lock-vaults-window-closed": "Lock vaults if vault window closed",
             "lock-vaults-window-closed-label": "Lock on close",
+            "pre-release": {
+                "description": "Allow Buttercup to update from the <strong>pre-release channel</strong> in addition to the stable channel. <strong>Use at your own risk</strong>. Pre-release versions are rarely stable and can corrupt vault contents and preferences.",
+                "label": "Enable the pre-release update channel",
+                "title": "Pre-release updates"
+            },
             "secure-file-host": {
                 "description": "The secure file host allows the <strong>Buttercup Browser Extension</strong> to connect to local vaults on this PC via this application.",
                 "label": "Enable secure file host",
@@ -282,10 +287,9 @@
         },
         "section": {
             "connectivity": "Connectivity",
-            "debug": "Debug",
             "general": "General",
-            "privacy": "Privacy",
-            "security": "Security"
+            "security": "Security",
+            "updates": "Updates"
         },
         "title": "Preferences"
     },

diff --git a/source/shared/i18n/translations/es.json b/source/shared/i18n/translations/es.json
@@ -223,7 +223,6 @@
         },
         "section": {
             "connectivity": "Conectividad",
-            "debug": "Depurar",
             "general": "General",
             "privacy": "Privacidad",
             "security": "Seguridad"

diff --git a/source/shared/i18n/translations/fi.json b/source/shared/i18n/translations/fi.json
@@ -250,7 +250,6 @@
         },
         "section": {
             "connectivity": "Yhteydet",
-            "debug": "Vianmääritys",
             "general": "Yleinen",
             "privacy": "Yksityisyys",
             "security": "Turvallisuus"

diff --git a/source/shared/i18n/translations/fr.json b/source/shared/i18n/translations/fr.json
@@ -277,7 +277,6 @@
         },
         "section": {
             "connectivity": "Connexion",
-            "debug": "Débogage",
             "general": "Général",
             "privacy": "Vie privée",
             "security": "Sécurité"

diff --git a/source/shared/i18n/translations/it.json b/source/shared/i18n/translations/it.json
@@ -282,7 +282,6 @@
         },
         "section": {
             "connectivity": "Connettività",
-            "debug": "Debug",
             "general": "Generale",
             "privacy": "Privacy",
             "security": "Sicurezza"

diff --git a/source/shared/i18n/translations/ja.json b/source/shared/i18n/translations/ja.json
@@ -250,7 +250,6 @@
         },
         "section": {
             "connectivity": "接続性",
-            "debug": "デバッグ",
             "general": "一般的",
             "privacy": "プライバシー",
             "security": "セキュリティ"

diff --git a/source/shared/i18n/translations/nl.json b/source/shared/i18n/translations/nl.json
@@ -282,7 +282,6 @@
         },
         "section": {
             "connectivity": "Verbinding",
-            "debug": "Debug",
             "general": "Algemeen",
             "privacy": "Privacy",
             "security": "Beveiliging"

diff --git a/source/shared/i18n/translations/pl.json b/source/shared/i18n/translations/pl.json
@@ -183,7 +183,6 @@
         },
         "section": {
             "connectivity": "Łączność",
-            "debug": "Debugowanie",
             "general": "Ogólne",
             "privacy": "Prywatność",
             "security": "Bezpieczeństwo"

diff --git a/source/shared/i18n/translations/pt-br.json b/source/shared/i18n/translations/pt-br.json
@@ -250,7 +250,6 @@
         },
         "section": {
             "connectivity": "Conectividade",
-            "debug": "Depuração",
             "general": "Geral",
             "privacy": "Privacidade",
             "security": "Segurança"

diff --git a/source/shared/i18n/translations/ro.json b/source/shared/i18n/translations/ro.json
@@ -228,7 +228,6 @@
         },
         "section": {
             "connectivity": "Conectivitate",
-            "debug": "Debug",
             "general": "General",
             "privacy": "Confidențialitate",
             "security": "Securitate"

diff --git a/source/shared/i18n/translations/zh_cn.json b/source/shared/i18n/translations/zh_cn.json
@@ -250,7 +250,6 @@
         },
         "section": {
             "connectivity": "连接",
-            "debug": "调试",
             "general": "常规",
             "privacy": "隐私",
             "security": "安全"

diff --git a/source/shared/symbols.ts b/source/shared/symbols.ts
@@ -22,6 +22,7 @@ export const PREFERENCES_DEFAULT: Preferences = {
     language: null,
     lockVaultsAfterTime: false, // seconds
     lockVaultsOnWindowClose: false,
+    prereleaseUpdates: false,
     startMode: AppStartMode.None,
     startWithSession: false,
     uiTheme: ThemeSource.System

diff --git a/source/shared/types.ts b/source/shared/types.ts
@@ -63,6 +63,7 @@ export interface Preferences {
     language: null | string;
     lockVaultsAfterTime: false | number;
     lockVaultsOnWindowClose: boolean;
+    prereleaseUpdates: boolean;
     startMode: AppStartMode;
     startWithSession: boolean;
     uiTheme: ThemeSource;