waveterm/emain/updater.ts

import { isDev } from "@/util/isdev";
import * as electron from "electron";
import { autoUpdater } from "electron-updater";
import * as services from "../frontend/app/store/services";
import { fireAndForget } from "../frontend/util/util";

export let updater: Updater;

export class Updater {
    interval: NodeJS.Timeout | null;
    availableUpdateReleaseName: string | null;
    availableUpdateReleaseNotes: string | null;
    private _status: UpdaterStatus;
    lastUpdateCheck: Date;

    constructor() {
        autoUpdater.removeAllListeners();

        autoUpdater.on("error", (err) => {
            console.log("updater error");
            console.log(err);
            this.status = "error";
        });

        autoUpdater.on("checking-for-update", () => {
            console.log("checking-for-update");
            this.status = "checking";
        });

        autoUpdater.on("update-available", () => {
            console.log("update-available; downloading...");
        });

        autoUpdater.on("update-not-available", () => {
            console.log("update-not-available");
        });

        autoUpdater.on("update-downloaded", (event) => {
            console.log("update-downloaded", [event]);
            this.availableUpdateReleaseName = event.releaseName;
            this.availableUpdateReleaseNotes = event.releaseNotes as string | null;

            // Display the update banner and create a system notification
            this.status = "ready";
            const updateNotification = new electron.Notification({
                title: "Wave Terminal",
                body: "A new version of Wave Terminal is ready to install.",
            });
            updateNotification.on("click", () => {
                fireAndForget(() => this.promptToInstallUpdate());
            });
            updateNotification.show();
        });

        this._status = "up-to-date";
        this.lastUpdateCheck = new Date(0);
        this.interval = null;
        this.availableUpdateReleaseName = null;
    }

    get status(): UpdaterStatus {
        return this._status;
    }

    /**
     * Sets the app update status and sends it to the main window
     * @param value The status to set
     */
    private set status(value: UpdaterStatus) {
        this._status = value;
        electron.BrowserWindow.getAllWindows().forEach((window) => {
            window.webContents.send("app-update-status", value);
        });
    }

    /**
     * Starts the auto update check interval.
     * @param [runCheckNow=true] Determines whether the update check should run immediately. Defaults to true.
     * @returns The timeout object for the auto update checker.
     */
    startInterval(runCheckNow = true): NodeJS.Timeout {
        // check for updates right away and keep checking later
        if (runCheckNow) this.checkForUpdates(false);
        return setInterval(() => {
            this.checkForUpdates(false);
        }, 600000); // intervals are unreliable when an app is suspended so we will check every 10 mins if the interval has passed.
    }

    /**
     * Checks if the configured interval time has passed since the last update check, and if so, checks for updates using the `autoUpdater` object
     * @param userInput Whether the user is requesting this. If so, an alert will report the result of the check.
     */
    async checkForUpdates(userInput: boolean) {
        console.log("checkForUpdates");
        const autoUpdateOpts = (await services.FileService.GetSettingsConfig()).autoupdate;

        // If there's an active update check interval, check that the user still has auto update checks enabled. If not, remove the interval.
        if (this.interval && !autoUpdateOpts.enabled) {
            console.log("Auto update is disabled in settings. Removing the auto update interval.");
            clearInterval(this.interval);
            this.interval = null;
        } else if (!this.interval && autoUpdateOpts.enabled) {
            this.startInterval(false);
        }

        const now = new Date();

        // Run an update check always if the user requests it, otherwise only if there's an active update check interval and enough time has elapsed.
        if (
            userInput ||
            (this.interval &&
                (!this.lastUpdateCheck ||
                    Math.abs(now.getTime() - this.lastUpdateCheck.getTime()) > autoUpdateOpts.intervalms))
        ) {
            const result = await autoUpdater.checkForUpdates();

            // If the user requested this check and we do not have an available update, let them know with a popup dialog. No need to tell them if there is an update, because we show a banner once the update is ready to install.
            if (userInput && !result.downloadPromise) {
                const dialogOpts: Electron.MessageBoxOptions = {
                    type: "info",
                    message: "There are currently no updates available.",
                };
                electron.dialog.showMessageBox(electron.BrowserWindow.getFocusedWindow(), dialogOpts);
            }

            // Only update the last check time if this is an automatic check. This ensures the interval remains consistent.
            if (!userInput) this.lastUpdateCheck = now;
        }
    }

    /**
     * Prompts the user to install the downloaded application update and restarts the application
     */
    async promptToInstallUpdate() {
        const dialogOpts: Electron.MessageBoxOptions = {
            type: "info",
            buttons: ["Restart", "Later"],
            title: "Application Update",
            message: process.platform === "win32" ? this.availableUpdateReleaseNotes : this.availableUpdateReleaseName,
            detail: "A new version has been downloaded. Restart the application to apply the updates.",
        };

        const allWindows = electron.BrowserWindow.getAllWindows();
        if (allWindows.length > 0) {
            await electron.dialog
                .showMessageBox(electron.BrowserWindow.getFocusedWindow() ?? allWindows[0], dialogOpts)
                .then(({ response }) => {
                    if (response === 0) {
                        this.installUpdate();
                    }
                });
        }
    }

    /**
     * Restarts the app and installs an update if it is available.
     */
    installUpdate() {
        if (this.status == "ready") {
            this.status = "installing";
            autoUpdater.quitAndInstall();
        }
    }
}

electron.ipcMain.on("install-app-update", () => fireAndForget(() => updater?.promptToInstallUpdate()));
electron.ipcMain.on("get-app-update-status", (event) => {
    event.returnValue = updater?.status;
});

let autoUpdateLock = false;

/**
 * Configures the auto-updater based on the user's preference
 * @param enabled Whether the auto-updater should be enabled
 */
export async function configureAutoUpdater() {
    if (isDev()) {
        console.log("skipping auto-updater in dev mode");
        return;
    }

    // simple lock to prevent multiple auto-update configuration attempts, this should be very rare
    if (autoUpdateLock) {
        console.log("auto-update configuration already in progress, skipping");
        return;
    }

    console.log("configureAutoUpdater");
    autoUpdateLock = true;

    const autoUpdateOpts = (await services.FileService.GetSettingsConfig()).autoupdate;

    try {
        console.log("Configuring updater");
        updater = new Updater();
        autoUpdater.autoInstallOnAppQuit = autoUpdateOpts.installonquit;
    } catch (e) {
        console.warn("error configuring updater", e.toString());
    }

    if (autoUpdateOpts.enabled && updater?.interval == null) {
        try {
            console.log("configuring auto update interval");
            updater?.startInterval();
        } catch (e) {
            console.log("error configuring auto update interval", e.toString());
        }
    } else if (!autoUpdateOpts.enabled && updater?.interval != null) {
        console.log("disabling auto updater");
        clearInterval(updater.interval);
        updater = null;
    }
    autoUpdateLock = false;
}