feat(updates): add automatic updates via electron-updater (#822)

* feat(updates): add auto-update via electron-updater

* polish(updates): use vertical layout for what's new toast

* polish(updates): replace hardcoded what's new toast with generic version-change toast

Author: antonreshetov

electron-builder.json

@@ -11,8 +11,13 @@
     "build/shared/**/*",
     "!build/**/*.map"
   ],
+  "publish": {
+    "provider": "github",
+    "owner": "massCodeIO",
+    "repo": "massCode"
+  },
   "mac": {
-    "target": "dmg",
+    "target": ["dmg", "zip"],
     "icon": "build/icons/icon.icns",
     "entitlements": "build/entitlements.mac.inherit.plist",
     "category": "public.app-category.productivity",

package.json

@@ -94,6 +94,7 @@
     "date-fns": "^4.1.0",
     "dom-to-image": "^2.6.0",
     "electron-store": "^8.2.0",
+    "electron-updater": "^6.8.9",
     "elysia": "^1.4.16",
     "fs-extra": "^11.3.0",
     "i18next": "^24.2.2",

pnpm-lock.yaml

@@ -98,6 +98,13 @@
   "release": {},
   "update": {
     "available": "Version {{newVersion}} is now available for download.\nYour version is {{oldVersion}}.",
-    "noAvailable": "There are currently no updates available."
+    "noAvailable": "There are currently no updates available.",
+    "downloading": "Update v{{version}} is downloading in the background. You will be prompted to restart when it is ready.",
+    "availableToast": "Update available",
+    "goToGitHub": "Go to GitHub",
+    "downloaded": "Update v{{version}} is ready. Restart massCode to apply it.",
+    "restart": "Restart",
+    "whatsNewToast": "See what's new in massCode v{{version}}",
+    "releaseNotes": "Release notes"
   }
 }

src/main/i18n/locales/en_US/messages.json

@@ -209,5 +209,15 @@
       "action": "Request a key",
       "description": "If you have ever donated to massCode through any channel, send any proof of donation by email and you will receive a key."
     }
+  },
+  "updates": {
+    "label": "Updates",
+    "autoUpdate": {
+      "label": "Automatic updates",
+      "description": "Download updates in the background and install them on restart. When disabled, massCode only notifies you about new versions. Major versions are never installed automatically."
+    },
+    "version": {
+      "label": "Current version"
+    }
   }
 }

src/main/i18n/locales/en_US/preferences.json

@@ -93,6 +93,13 @@
   "release": {},
   "update": {
     "available": "Версия {{newVersion}} доступна для загрузки.\nВаша версия {{oldVersion}}.",
-    "noAvailable": "В настоящее время обновления недоступны."
+    "noAvailable": "В настоящее время обновления недоступны.",
+    "downloading": "Обновление v{{version}} скачивается в фоне. Когда оно будет готово, появится предложение перезапустить приложение.",
+    "availableToast": "Доступно обновление",
+    "goToGitHub": "Открыть GitHub",
+    "downloaded": "Обновление v{{version}} готово. Перезапустите massCode, чтобы применить его.",
+    "restart": "Перезапустить",
+    "whatsNewToast": "Узнайте, что нового в massCode v{{version}}",
+    "releaseNotes": "Release notes"
   }
 }

src/main/i18n/locales/ru_RU/messages.json

@@ -176,5 +176,15 @@
       "action": "Запросить ключ",
       "description": "Если вы когда-либо донатили massCode любым способом, отправьте любое подтверждение доната по почте и получите ключ."
     }
+  },
+  "updates": {
+    "label": "Обновления",
+    "autoUpdate": {
+      "label": "Автоматические обновления",
+      "description": "Скачивать обновления в фоне и устанавливать при перезапуске. Если выключено, massCode только уведомляет о новых версиях. Новые мажорные версии никогда не устанавливаются автоматически."
+    },
+    "version": {
+      "label": "Текущая версия"
+    }
   }
 }

src/main/i18n/locales/ru_RU/preferences.json

@@ -31,12 +31,18 @@ import {
 } from '../../storage/providers/markdown/runtime/moveVault'
 import { getVaultPath } from '../../storage/providers/markdown/runtime/paths'
 import { store } from '../../store'
+import { installDownloadedUpdate } from '../../updates'
 
 export function registerSystemHandlers() {
   ipcMain.handle('system:activate-license', (_, payload: { key: string }) => {
     return activateLicense(payload.key)
   })
 
+  ipcMain.handle('system:install-update', () => {
+    installDownloadedUpdate()
+    return true
+  })
+
   ipcMain.handle('system:api-token-generate', () => {
     return generateIntegrationToken()
   })

src/main/ipc/handlers/system.ts

@@ -14,10 +14,9 @@ import {
   type MenuItemConstructorOptions,
   shell,
 } from 'electron'
-import { repository } from '../../../package.json'
 import i18n from '../i18n'
 import { send } from '../ipc'
-import { fetchUpdates } from '../updates'
+import { checkForUpdatesFromMenu } from '../updates'
 import { createMenu, createPlatformMenuItems } from './utils'
 
 const year = new Date().getFullYear()
@@ -84,33 +83,7 @@ const appMenuItems: MenuConfig[] = [
   {
     id: 'update',
     label: i18n.t('menu:app.update'),
-    click: async () => {
-      const latestVersion = await fetchUpdates()
-
-      if (latestVersion) {
-        const buttonId = dialog.showMessageBoxSync(
-          BrowserWindow.getFocusedWindow()!,
-          {
-            message: i18n.t('messages:update.available', {
-              newVersion: latestVersion,
-              oldVersion: version,
-            }),
-            buttons: [i18n.t('button.update.0'), i18n.t('button.update.1')],
-            defaultId: 0,
-            cancelId: 1,
-          },
-        )
-
-        if (buttonId === 0) {
-          shell.openExternal(`${repository}/releases`)
-        }
-      }
-      else {
-        dialog.showMessageBoxSync(BrowserWindow.getFocusedWindow()!, {
-          message: i18n.t('messages:update.noAvailable'),
-        })
-      }
-    },
+    click: () => checkForUpdatesFromMenu(),
   },
   {
     type: 'separator',

src/main/menu/main.ts

@@ -68,6 +68,7 @@ const APP_STORE_DEFAULTS: AppStore = {
   },
   notifications: {
     lastNotifiedUpdateVersion: '',
+    lastWhatsNewVersion: '',
   },
   license: {
     key: null,
@@ -648,6 +649,10 @@ function sanitizeAppStore(value: unknown): AppStore {
           : typeof source.lastNotifiedUpdateVersion === 'string'
             ? source.lastNotifiedUpdateVersion
             : APP_STORE_DEFAULTS.notifications.lastNotifiedUpdateVersion,
+      lastWhatsNewVersion:
+        typeof notificationsSource.lastWhatsNewVersion === 'string'
+          ? notificationsSource.lastWhatsNewVersion
+          : APP_STORE_DEFAULTS.notifications.lastWhatsNewVersion,
     },
     license: (() => {
       const licenseSource = asRecord(source.license)