feat(core): adding support for checking for updates on schedule

Using a cron pattern for update schedules.

Author: markmcdowell

docs/config/updatePolicy/README.md

@@ -21,6 +21,7 @@ The specification for an update policy.
 | checkForUpdates | `boolean`          | Whether to check for updates.                                          |
 | parameters      | `UpdateParameters` | Key value map to override parameters in the specified update provider. |
 | provider        | `string`           | The update source.                                                     |
+| schedule        | `string`           | Sets an update schedule using a cron format.                           |
 
 ## Example
 
@@ -33,4 +34,5 @@ metadata:
   namespace: desktop
 spec:
   checkForUpdates: true
+  schedule: 0 * * * *
 ```

package-lock.json

@@ -44,6 +44,7 @@
   "devDependencies": {
     "@types/compression": "^1.7.0",
     "@types/cors": "2.8.8",
+    "@types/cron": "^1.7.2",
     "@types/express": "^4.17.9",
     "@types/express-useragent": "^1.0.0",
     "@types/express-ws": "^3.0.0",
@@ -75,6 +76,7 @@
     "copy-webpack-plugin": "^6.4.0",
     "copyfiles": "^2.4.1",
     "cors": "^2.8.5",
+    "cron": "1.7.2",
     "cross-var": "^1.1.0",
     "csp-html-webpack-plugin": "^4.0.0",
     "css-loader": "^5.0.1",

package.json

@@ -21,8 +21,8 @@ export class TrayLauncherService implements ILauncherService {
 
         this.logger.verbose(`Configuring tray: ${name} in ${namespace}`);
 
-        await this.trayService.create(configuration);
+        const instance = await this.trayService.create(configuration);
 
-        return configuration;
+        return instance.configuration;
     }
 }

packages/desktop-core/src/main/launcher/trayLauncherService.ts

@@ -21,6 +21,6 @@ export class UpdatePolicyLauncherService implements ILauncherService {
 
         this.logger.verbose(`Configuring updates: ${name} in ${namespace}`);
 
-        return this.updateService.configure(configuration);
+        return this.updateService.create(configuration);
     }
 }

packages/desktop-core/src/main/launcher/updatePolicyLauncherService.ts

@@ -1,11 +1,15 @@
 import { IConfiguration, IUpdatePolicySpecification } from "@reactivemarkets/desktop-types";
-import { autoUpdater } from "electron-updater";
+import { app, Notification } from "electron";
+import { autoUpdater, UpdateDownloadedEvent } from "electron-updater";
+import { CronJob, job } from "cron";
 import numeral from "numeral";
 import { logger } from "../logging";
 import { IUpdateService } from "./iUpdateService";
 
 export class DefaultUpdateService implements IUpdateService {
-    public configure(configuration: IConfiguration): Promise<IConfiguration> {
+    private cronJob?: CronJob;
+
+    public create(configuration: IConfiguration): Promise<IConfiguration> {
         const spec = configuration.spec as IUpdatePolicySpecification | undefined;
         if (!spec?.checkForUpdates) {
             return Promise.resolve(configuration);
@@ -18,12 +22,14 @@ export class DefaultUpdateService implements IUpdateService {
             })
             .on("update-available", () => {
                 logger.info("Update available.");
+
+                this.cronJob?.stop();
             })
             .on("update-not-available", () => {
                 logger.info("Update not available.");
             })
             .on("error", (error) => {
-                logger.info(`Error in auto-updater. ${error}`);
+                logger.info(`Error in auto-updater. ${error?.message}`);
             })
             .on("download-progress", (progress) => {
                 const { bytesPerSecond, percent, total, transferred } = progress;
@@ -38,24 +44,41 @@ export class DefaultUpdateService implements IUpdateService {
 
                 logger.info(`${percentComplete}% => (${transferredBytes}/${totalBytes}) ${downloadSpeed}/s`);
             })
-            .on("update-downloaded", () => {
-                logger.info("Update downloaded.");
+            .once("update-downloaded", (update: UpdateDownloadedEvent) => {
+                const { version } = update;
+                logger.info(`${version} downloaded.`);
+
+                const notification = new Notification({
+                    title: "A new update is ready to install",
+                    body: `${app.name} version ${version} has been downloaded, click to restart now.`,
+                });
+                notification.once("click", () => {
+                    autoUpdater.quitAndInstall(true, true);
+                });
+                notification.show();
             });
 
-        if (spec?.channel !== undefined) {
+        if (spec.channel !== undefined) {
             autoUpdater.channel = spec.channel;
         }
 
-        if (spec?.provider !== undefined) {
+        if (spec.provider !== undefined) {
             autoUpdater.setFeedURL({
                 ...spec?.parameters,
                 provider: spec.provider,
             });
         }
 
+        if (spec.schedule !== undefined) {
+            this.cronJob = job(spec.schedule, () => {
+                autoUpdater.checkForUpdates();
+            });
+            this.cronJob.start();
+        }
+
         autoUpdater.allowDowngrade = spec?.allowDowngrade ?? true;
         autoUpdater.allowPrerelease = spec?.allowPrerelease ?? false;
-        autoUpdater.checkForUpdatesAndNotify();
+        autoUpdater.checkForUpdates();
 
         return Promise.resolve(configuration);
     }

packages/desktop-core/src/main/updates/defaultUpdateService.ts

@@ -2,8 +2,8 @@ import { IConfiguration } from "@reactivemarkets/desktop-types";
 
 export interface IUpdateService {
     /**
-     * Configure updates based on the given configuration.
+     * Configure updates based on the given `configuration`.
      * @param configuration The update configuration.
      */
-    configure(configuration: IConfiguration): Promise<IConfiguration>;
+    create(configuration: IConfiguration): Promise<IConfiguration>;
 }

packages/desktop-core/src/main/updates/iUpdateService.ts

@@ -30,4 +30,16 @@ export interface IUpdatePolicySpecification {
      * The update source.
      */
     readonly provider?: "generic" | "github" | "s3";
+
+    /**
+     * Cron based update schedule.
+     *
+     * ### Examples
+     *
+     * Hourly check:
+     * ```
+     * 0 * * * *
+     * ```
+     */
+    readonly schedule?: string;
 }

packages/desktop-types/src/configuration/iUpdatePolicySpecification.ts

@@ -20,6 +20,7 @@ metadata:
   namespace: desktop
 spec:
   checkForUpdates: true
+  schedule: 0 * * * *
 ---
 kind: applicationSecurityPolicy
 metadata: