refactor(update): support beta upgrade to stable (netless-io#821)

BlackHole1 · web-flow · commit 75773ea8eeab · 2021-07-27T19:10:56.000+08:00
diff --git a/desktop/main-app/src/utils/IPCActions.ts b/desktop/main-app/src/utils/IPCActions.ts
@@ -3,6 +3,8 @@ import { ipc } from "flat-types";
 import { app, ipcMain, powerSaveBlocker } from "electron";
 import runtime from "./Runtime";
 import { updateService } from "./UpdateService";
+import { update } from "flat-types";
+import { gt } from "semver";
 
 const windowActionAsync = (customWindow: CustomSingleWindow): ipc.WindowActionAsync => {
     const { window, options } = customWindow;
@@ -70,8 +72,8 @@ const windowActionAsync = (customWindow: CustomSingleWindow): ipc.WindowActionAs
                     }
                 };
             })(),
-        "start-update": () => {
-            updateService.update();
+        "start-update": args => {
+            updateService.update(args.prereleaseTag);
         },
         "cancel-update": () => {
             updateService.cancel();
@@ -90,18 +92,31 @@ export const appActionAsync: ipc.AppActionAsync = {
 
 export const appActionSync: ipc.AppActionSync = {
     "get-runtime": () => {
-        return runtime;
+        return Promise.resolve(runtime);
     },
     "get-open-at-login": () => {
-        return app.getLoginItemSettings().openAtLogin;
+        return Promise.resolve(app.getLoginItemSettings().openAtLogin);
     },
-    "get-update-info": () => {
-        return updateService.check().catch((err: Error) => {
-            console.error(err.message);
-            return {
-                hasNewVersion: false,
-            };
-        }) as any;
+    "get-update-info": async () => {
+        const warpUpdateCheck = async (
+            prereleaseTag: update.PrereleaseTag,
+        ): Promise<update.UpdateCheckInfo> => {
+            return await updateService.check(prereleaseTag).catch((err: Error) => {
+                console.error(err.message);
+                return {
+                    hasNewVersion: false,
+                };
+            });
+        };
+
+        const beta = await warpUpdateCheck("beta");
+        const stable = await warpUpdateCheck("stable");
+
+        if (beta.hasNewVersion && stable.hasNewVersion) {
+            return gt(beta.version, stable.version) ? beta : stable;
+        }
+
+        return beta.hasNewVersion ? beta : stable;
     },
 };
 
diff --git a/desktop/main-app/src/utils/Runtime.ts b/desktop/main-app/src/utils/Runtime.ts
@@ -2,7 +2,6 @@ import path from "path";
 import { app } from "electron";
 import { platform } from "os";
 import { runtime as Runtime } from "flat-types";
-import { prerelease } from "semver";
 
 const isDevelopment = process.env.NODE_ENV === "development";
 
@@ -33,19 +32,6 @@ const appVersion = isProduction ? app.getVersion() : require("../../package.json
 
 const downloadsDirectory = path.join(app.getPath("userData"), "downloads");
 
-const prereleaseTag = (() => {
-    // e.g:
-    // version: 1.0.0-beta.1
-    // tag: ["beta", 1];
-    const tag = prerelease(require("../../package.json").version);
-
-    if (tag) {
-        return tag[0] as "alpha" | "beta" | "stable";
-    }
-
-    return "stable";
-})();
-
 const runtime: Runtime.Type = {
     isDevelopment,
     isProduction,
@@ -57,7 +43,6 @@ const runtime: Runtime.Type = {
     appVersion,
     downloadsDirectory,
     assetsPath,
-    prereleaseTag,
 };
 
 export default runtime;
diff --git a/desktop/main-app/src/utils/UpdateService.ts b/desktop/main-app/src/utils/UpdateService.ts
@@ -7,9 +7,9 @@ import { update } from "flat-types";
 class UpdateService {
     private cancellationToken: UpdateCheckResult["cancellationToken"];
 
-    public check(): Promise<update.UpdateCheckInfo> {
+    public check(prereleaseTag: update.PrereleaseTag): Promise<update.UpdateCheckInfo> {
         autoUpdater.autoDownload = false;
-        UpdateService.setUpdateURL();
+        UpdateService.setUpdateURL(prereleaseTag);
 
         return new Promise((resolve, reject) => {
             const updateAvailable = (info: UpdateCheckResult["updateInfo"]) => {
@@ -22,6 +22,7 @@ class UpdateService {
                         typeof info.releaseNotes === "string"
                             ? JSON.parse(info.releaseNotes)
                             : undefined,
+                    prereleaseTag,
                 });
             };
 
@@ -53,7 +54,7 @@ class UpdateService {
         });
     }
 
-    public update(): void {
+    public update(prereleaseTag: update.PrereleaseTag): void {
         autoUpdater.autoDownload = true;
 
         // must be set to false here
@@ -63,7 +64,7 @@ class UpdateService {
         //     domain: 'RACCommandErrorDomain'
         autoUpdater.autoInstallOnAppQuit = false;
 
-        UpdateService.setUpdateURL();
+        UpdateService.setUpdateURL(prereleaseTag);
 
         const updateNotAvailable = () => {
             removeListeners();
@@ -122,9 +123,9 @@ class UpdateService {
         this.cancellationToken?.cancel();
     }
 
-    private static setUpdateURL(): void {
+    private static setUpdateURL(prereleaseTag: update.PrereleaseTag): void {
         const osName = runtime.isWin ? "win" : "mac";
-        const updateURL = `${process.env.UPDATE_DOMAIN}/latest/${runtime.prereleaseTag}/${osName}`;
+        const updateURL = `${process.env.UPDATE_DOMAIN}/latest/${prereleaseTag}/${osName}`;
 
         autoUpdater.setFeedURL({
             provider: "generic",
diff --git a/desktop/renderer-app/src/components/AppUpgradeModal/index.tsx b/desktop/renderer-app/src/components/AppUpgradeModal/index.tsx
@@ -4,16 +4,19 @@ import { observer } from "mobx-react-lite";
 import React, { useEffect, useState } from "react";
 import { ipcAsyncByMainWindow, ipcReceive, ipcReceiveRemove } from "../../utils/ipc";
 import { useTranslation } from "react-i18next";
+import { update } from "flat-types";
 
 export interface AppUpgradeModalProps {
-    /** open modal when newVersion has truthy value */
-    newVersion?: string;
-    /** close modal  */
+    updateInfo:
+        | (update.UpdateCheckInfo & {
+              hasNewVersion: true;
+          })
+        | null;
     onClose: () => void;
 }
 
 export const AppUpgradeModal = observer<AppUpgradeModalProps>(function AppUpgradeModal({
-    newVersion,
+    updateInfo,
     onClose,
 }) {
     const { t } = useTranslation();
@@ -22,7 +25,7 @@ export const AppUpgradeModal = observer<AppUpgradeModalProps>(function AppUpgrad
     const [upgradeFail, setUpgradeFail] = useState(false);
 
     useEffect(() => {
-        if (showUpgradeProgress) {
+        if (showUpgradeProgress && updateInfo !== null) {
             ipcReceive("update-progress", args => {
                 if (args.status) {
                     setUpgradePercent(args.percent);
@@ -31,12 +34,14 @@ export const AppUpgradeModal = observer<AppUpgradeModalProps>(function AppUpgrad
                 }
             });
 
-            ipcAsyncByMainWindow("start-update", undefined);
+            ipcAsyncByMainWindow("start-update", {
+                prereleaseTag: updateInfo.prereleaseTag,
+            });
         }
         return () => {
             ipcReceiveRemove("update-progress");
         };
-    }, [showUpgradeProgress]);
+    }, [showUpgradeProgress, updateInfo]);
 
     const renderModalTitle = (): React.ReactNode => {
         return <div className="app-upgrade-modal-title">{t("version-updates")}</div>;
@@ -58,7 +63,7 @@ export const AppUpgradeModal = observer<AppUpgradeModalProps>(function AppUpgrad
             maskClosable={false}
             title={renderModalTitle()}
             footer={[]}
-            visible={Boolean(newVersion)}
+            visible={updateInfo !== null}
             onCancel={cancelUpgrade}
             wrapClassName="app-upgrade-modal-container"
             closable={false}
@@ -68,11 +73,11 @@ export const AppUpgradeModal = observer<AppUpgradeModalProps>(function AppUpgrad
                     <span className="app-upgrade-modal-font">
                         {t("downloading")} ({upgradePercent.toFixed(2)}%)...
                     </span>
-                    <div className="app-upgrade-modal-progress"></div>
+                    <div className="app-upgrade-modal-progress" />
                     <div
                         className="app-upgrade-active-progress"
                         style={{ width: `${upgradePercent}%` }}
-                    ></div>
+                    />
                     {upgradeFail && (
                         <div>
                             <span className="app-upgrade-modal-font">
@@ -89,7 +94,7 @@ export const AppUpgradeModal = observer<AppUpgradeModalProps>(function AppUpgrad
             ) : (
                 <div>
                     <span className="app-upgrade-modal-font">
-                        {t("new-version-tips", { version: newVersion || " " })}
+                        {t("new-version-tips", { version: updateInfo?.version || " " })}
                     </span>
                     <div className="app-upgrade-modal-btn">
                         <Button type="primary" onClick={upgradeStart}>
diff --git a/desktop/renderer-app/src/pages/HomePage/index.tsx b/desktop/renderer-app/src/pages/HomePage/index.tsx
@@ -10,7 +10,7 @@ import { useLastLocation } from "react-router-last-location";
 import { shouldWindowCenter } from "./utils";
 import { constants } from "flat-types";
 import { MainPageLayoutContainer } from "../../components/MainPageLayoutContainer";
-import { AppUpgradeModal } from "../../components/AppUpgradeModal";
+import { AppUpgradeModal, AppUpgradeModalProps } from "../../components/AppUpgradeModal";
 import { useSafePromise } from "../../utils/hooks/lifecycle";
 import { runtime } from "../../utils/runtime";
 import { globalStore } from "../../stores/GlobalStore";
@@ -20,7 +20,7 @@ export type HomePageProps = {};
 
 export const HomePage = observer<HomePageProps>(function HomePage() {
     const lastLocation = useLastLocation();
-    const [newVersion, setNewVersion] = useState<string>();
+    const [updateInfo, setUpdateInfo] = useState<AppUpgradeModalProps["updateInfo"]>(null);
     const sp = useSafePromise();
 
     useEffect(() => {
@@ -44,7 +44,7 @@ export const HomePage = observer<HomePageProps>(function HomePage() {
                             `[Auto Updater]: Remote Version "${data.version}", Local Version "${runtime.appVersion}"`,
                         );
                         if (data.version !== runtime.appVersion) {
-                            setNewVersion(data.version);
+                            setUpdateInfo(data);
                         }
                     }
                 })
@@ -64,7 +64,7 @@ export const HomePage = observer<HomePageProps>(function HomePage() {
                     <MainRoomHistoryPanel />
                 </div>
             </div>
-            <AppUpgradeModal newVersion={newVersion} onClose={() => setNewVersion(void 0)} />
+            <AppUpgradeModal updateInfo={updateInfo} onClose={() => setUpdateInfo(null)} />
         </MainPageLayoutContainer>
     );
 });
diff --git a/desktop/renderer-app/src/pages/LoginPage/index.tsx b/desktop/renderer-app/src/pages/LoginPage/index.tsx
@@ -9,7 +9,7 @@ import { LoginDisposer } from "./utils";
 import { githubLogin } from "./githubLogin";
 import { RouteNameType, usePushHistory } from "../../utils/routes";
 import { GlobalStoreContext } from "../../components/StoreProvider";
-import { AppUpgradeModal } from "../../components/AppUpgradeModal";
+import { AppUpgradeModal, AppUpgradeModalProps } from "../../components/AppUpgradeModal";
 import { runtime } from "../../utils/runtime";
 import { useSafePromise } from "../../utils/hooks/lifecycle";
 import { WeChatLogin } from "./WeChatLogin";
@@ -21,7 +21,7 @@ export const LoginPage = observer(function LoginPage() {
     const pushHistory = usePushHistory();
     const globalStore = useContext(GlobalStoreContext);
     const loginDisposer = useRef<LoginDisposer>();
-    const [newVersion, setNewVersion] = useState<string>();
+    const [updateInfo, setUpdateInfo] = useState<AppUpgradeModalProps["updateInfo"]>(null);
     const sp = useSafePromise();
 
     useEffect(() => {
@@ -47,7 +47,7 @@ export const LoginPage = observer(function LoginPage() {
                         `[Auto Updater]: Remote Version "${data.version}", Local Version "${runtime.appVersion}"`,
                     );
                     if (data.version !== runtime.appVersion) {
-                        setNewVersion(data.version);
+                        setUpdateInfo(data);
                     }
                 }
             })
@@ -85,7 +85,7 @@ export const LoginPage = observer(function LoginPage() {
     return (
         <div className="login-page-container">
             <LoginPanel onLogin={handleLogin} privacyURL={privacyURL} serviceURL={serviceURL} />
-            <AppUpgradeModal newVersion={newVersion} onClose={() => setNewVersion(void 0)} />
+            <AppUpgradeModal updateInfo={updateInfo} onClose={() => setUpdateInfo(null)} />
         </div>
     );
 });
diff --git a/desktop/renderer-app/src/pages/UserSettingPage/AboutPage/index.tsx b/desktop/renderer-app/src/pages/UserSettingPage/AboutPage/index.tsx
@@ -7,21 +7,21 @@ import { UserSettingLayoutContainer } from "../UserSettingLayoutContainer";
 import { Button, message } from "antd";
 import { runtime } from "../../../utils/runtime";
 import { ipcSyncByApp } from "../../../utils/ipc";
-import { AppUpgradeModal } from "../../../components/AppUpgradeModal";
+import { AppUpgradeModal, AppUpgradeModalProps } from "../../../components/AppUpgradeModal";
 import { useSafePromise } from "../../../utils/hooks/lifecycle";
 import { useTranslation } from "react-i18next";
 
 export const AboutPage = (): React.ReactElement => {
     const { t } = useTranslation();
     const sp = useSafePromise();
-    const [newVersion, setNewVersion] = useState<string>();
+    const [updateInfo, setUpdateInfo] = useState<AppUpgradeModalProps["updateInfo"]>(null);
 
     const checkUpgradeVersion = (): void => {
         void sp(ipcSyncByApp("get-update-info")).then(data => {
             if (!data.hasNewVersion || data.version === runtime.appVersion) {
                 void message.info(t("latest-version-tips"));
             } else {
-                setNewVersion(data.version);
+                setUpdateInfo(data);
             }
         });
     };
@@ -38,11 +38,8 @@ export const AboutPage = (): React.ReactElement => {
                         {t("check-updates")}
                     </Button>
                 </div>
-                {/* <div className="about-page-bottom-container">
-                    <a href="">服务协议</a>｜<a href="">隐私政策</a>｜<a href="">GitHub</a>
-                </div> */}
             </div>
-            <AppUpgradeModal newVersion={newVersion} onClose={() => setNewVersion(void 0)} />
+            <AppUpgradeModal updateInfo={updateInfo} onClose={() => setUpdateInfo(null)} />
         </UserSettingLayoutContainer>
     );
 };
diff --git a/desktop/renderer-app/src/utils/ipc.ts b/desktop/renderer-app/src/utils/ipc.ts
@@ -60,8 +60,8 @@ export const ipcSyncByApp = <
 >(
     action: T,
     args?: U,
-): Promise<ReturnType<ipc.AppActionSync[T]>> => {
-    return ipcRenderer.invoke(action, args);
+): ReturnType<ipc.AppActionSync[T]> => {
+    return ipcRenderer.invoke(action, args) as any;
 };
 
 export const ipcReceive = <T extends keyof ipc.EmitEvents, U extends ipc.EmitEvents[T]>(
diff --git a/desktop/renderer-app/src/utils/runtime.ts b/desktop/renderer-app/src/utils/runtime.ts
@@ -11,5 +11,4 @@ export const runtime: Runtime.Type = {
     assetsPath: "",
     appVersion: "",
     downloadsDirectory: "",
-    prereleaseTag: "stable",
 };
diff --git a/packages/flat-types/src/ipc/index.ts b/packages/flat-types/src/ipc/index.ts
@@ -1,5 +1,5 @@
 import type { Type as RuntimeType } from "../runtime";
-import type { UpdateCheckInfo } from "../update";
+import type { UpdateCheckInfo, PrereleaseTag } from "../update";
 
 export type WindowActionAsync = {
     "set-win-size": (args: {
@@ -18,7 +18,7 @@ export type WindowActionAsync = {
     "disable-window": (args: { disable: boolean }) => void;
     "set-title": (args: { title: string }) => void;
     "set-prevent-sleep": (args: { enable: boolean }) => void;
-    "start-update": () => void;
+    "start-update": (args: { prereleaseTag: PrereleaseTag }) => void;
     "cancel-update": () => void;
 };
 
@@ -27,9 +27,9 @@ export type AppActionAsync = {
 };
 
 export type AppActionSync = {
-    "get-runtime": () => RuntimeType;
-    "get-open-at-login": () => boolean;
-    "get-update-info": () => UpdateCheckInfo;
+    "get-runtime": () => Promise<RuntimeType>;
+    "get-open-at-login": () => Promise<boolean>;
+    "get-update-info": () => Promise<UpdateCheckInfo>;
 };
 
 export interface EmitEvents {
diff --git a/packages/flat-types/src/runtime/index.ts b/packages/flat-types/src/runtime/index.ts
@@ -9,7 +9,6 @@ export type Type = {
     assetsPath: string;
     appVersion: string;
     downloadsDirectory: string;
-    prereleaseTag: "alpha" | "beta" | "stable";
 };
 
 export type Key = keyof Type;
diff --git a/packages/flat-types/src/update/index.ts b/packages/flat-types/src/update/index.ts
