feat: update button enhancements (#2401)

apps/electron/layers/main/src/application-menu.ts

@@ -2,6 +2,7 @@ import { app, Menu } from 'electron';
 
 import { isMacOS } from '../../utils';
 import { subjects } from './events';
+import { checkForUpdatesAndNotify } from './handlers/updater';
 
 // Unique id for menuitems
 const MENUITEM_NEW_PAGE = 'affine:new-page';
@@ -114,6 +115,12 @@ export function createApplicationMenu() {
             await shell.openExternal('https://affine.pro/');
           },
         },
+        {
+          label: 'Check for Updates',
+          click: async () => {
+            await checkForUpdatesAndNotify(true);
+          },
+        },
       ],
     },
   ];

apps/electron/layers/main/src/events/updater.ts

@@ -1,19 +1,34 @@
-import { Subject } from 'rxjs';
+import { BehaviorSubject, Subject } from 'rxjs';
 
 import type { MainEventListener } from './type';
 
 interface UpdateMeta {
   version: string;
+  allowAutoUpdate: boolean;
 }
 
 export const updaterSubjects = {
   // means it is ready for restart and install the new version
-  clientUpdateReady: new Subject<UpdateMeta>(),
+  updateAvailable: new Subject<UpdateMeta>(),
+  updateReady: new Subject<UpdateMeta>(),
+  downloadProgress: new BehaviorSubject<number>(0),
 };
 
 export const updaterEvents = {
-  onClientUpdateReady: (fn: (versionMeta: UpdateMeta) => void) => {
-    const sub = updaterSubjects.clientUpdateReady.subscribe(fn);
+  onUpdateAvailable: (fn: (versionMeta: UpdateMeta) => void) => {
+    const sub = updaterSubjects.updateAvailable.subscribe(fn);
+    return () => {
+      sub.unsubscribe();
+    };
+  },
+  onUpdateReady: (fn: (versionMeta: UpdateMeta) => void) => {
+    const sub = updaterSubjects.updateReady.subscribe(fn);
+    return () => {
+      sub.unsubscribe();
+    };
+  },
+  onDownloadProgress: (fn: (progress: number) => void) => {
+    const sub = updaterSubjects.downloadProgress.subscribe(fn);
     return () => {
       sub.unsubscribe();
     };

apps/electron/layers/main/src/handlers/updater/index.ts

@@ -1,9 +1,17 @@
+import { app } from 'electron';
+
 import type { NamespaceHandlers } from '../type';
+import { checkForUpdatesAndNotify, quitAndInstall } from './updater';
 
 export const updaterHandlers = {
-  updateClient: async () => {
-    const { updateClient } = await import('./updater');
-    return updateClient();
+  currentVersion: async () => {
+    return app.getVersion();
+  },
+  quitAndInstall: async () => {
+    return quitAndInstall();
+  },
+  checkForUpdatesAndNotify: async () => {
+    return checkForUpdatesAndNotify(true);
   },
 } satisfies NamespaceHandlers;
 

apps/electron/layers/main/src/handlers/updater/updater.ts

@@ -1,3 +1,4 @@
+import { app } from 'electron';
 import type { AppUpdater } from 'electron-updater';
 import { z } from 'zod';
 
@@ -21,10 +22,22 @@ const isDev = mode === 'development';
 
 let _autoUpdater: AppUpdater | null = null;
 
-export const updateClient = async () => {
+export const quitAndInstall = async () => {
   _autoUpdater?.quitAndInstall();
 };
 
+let lastCheckTime = 0;
+export const checkForUpdatesAndNotify = async (force = true) => {
+  if (!_autoUpdater) {
+    return; // ?
+  }
+  // check every 30 minutes (1800 seconds) at most
+  if (force || lastCheckTime + 1000 * 1800 < Date.now()) {
+    lastCheckTime = Date.now();
+    return _autoUpdater.checkForUpdatesAndNotify();
+  }
+};
+
 export const registerUpdater = async () => {
   // require it will cause some side effects and will break generate-main-exposed-meta,
   // so we wrap it in a function
@@ -37,6 +50,9 @@ export const registerUpdater = async () => {
     return;
   }
 
+  // TODO: support auto update on windows and linux
+  const allowAutoUpdate = isMacOS();
+
   _autoUpdater.autoDownload = false;
   _autoUpdater.allowPrerelease = buildType !== 'stable';
   _autoUpdater.autoInstallOnAppQuit = false;
@@ -49,24 +65,36 @@ export const registerUpdater = async () => {
     releaseType: buildType === 'stable' ? 'release' : 'prerelease',
   });
 
-  if (isMacOS()) {
-    _autoUpdater.on('update-available', () => {
+  // register events for checkForUpdatesAndNotify
+  _autoUpdater.on('update-available', info => {
+    if (allowAutoUpdate) {
       _autoUpdater!.downloadUpdate();
-      logger.info('Update available, downloading...');
+      logger.info('Update available, downloading...', info);
+    }
+    updaterSubjects.updateAvailable.next({
+      version: info.version,
+      allowAutoUpdate,
     });
-    _autoUpdater.on('download-progress', e => {
-      logger.info(`Download progress: ${e.percent}`);
+  });
+  _autoUpdater.on('download-progress', e => {
+    logger.info(`Download progress: ${e.percent}`);
+    updaterSubjects.downloadProgress.next(e.percent);
+  });
+  _autoUpdater.on('update-downloaded', e => {
+    updaterSubjects.updateReady.next({
+      version: e.version,
+      allowAutoUpdate,
     });
-    _autoUpdater.on('update-downloaded', e => {
-      updaterSubjects.clientUpdateReady.next({
-        version: e.version,
-      });
-      logger.info('Update downloaded, ready to install');
-    });
-    _autoUpdater.on('error', e => {
-      logger.error('Error while updating client', e);
-    });
-    _autoUpdater.forceDevUpdateConfig = isDev;
-    await _autoUpdater.checkForUpdatesAndNotify();
-  }
+    // I guess we can skip it?
+    // updaterSubjects.clientDownloadProgress.next(100);
+    logger.info('Update downloaded, ready to install');
+  });
+  _autoUpdater.on('error', e => {
+    logger.error('Error while updating client', e);
+  });
+  _autoUpdater.forceDevUpdateConfig = isDev;
+
+  app.on('activate', async () => {
+    await checkForUpdatesAndNotify(false);
+  });
 };

apps/electron/layers/preload/preload.d.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/consistent-type-imports */
 
 interface Window {
-  apis?: typeof import('./src/affine-apis').apis;
-  events?: typeof import('./src/affine-apis').events;
-  appInfo?: typeof import('./src/affine-apis').appInfo;
+  apis: typeof import('./src/affine-apis').apis;
+  events: typeof import('./src/affine-apis').events;
+  appInfo: typeof import('./src/affine-apis').appInfo;
 }