Periodic update check

src/extension.ts

@@ -3,6 +3,7 @@ import {
     hasRecognizedProjectStructureAtWorkspaceRoot,
     isKeyUsed,
     isWindowsNotWSL,
+    startPeriodicChecks,
     Keys,
     Logger,
 } from './utils';
@@ -35,7 +36,8 @@ export function activate(context: vscode.ExtensionContext) {
         .then(() => registerEditorCommands(context))
         .then(() => registerStatusBarItems(context))
         .then(() => registerDataProviders(context))
-        .then(autoStartLspClientIfRequested);
+        .then(autoStartLspClientIfRequested)
+        .then(startPeriodicChecks);
 }
 
 async function autoStartLspClientIfRequested() {

src/utils/index.ts

@@ -10,6 +10,7 @@ import { ensureAderynIsInstalled } from './install';
 import { isKeyUsed, Keys } from './keys';
 import { Logger } from './logger';
 import { readAderynConfigTemplate } from './metadata';
+import { startPeriodicChecks } from './update';
 
 export {
     findProjectRoot,
@@ -21,6 +22,7 @@ export {
     executeCommand,
     ensureAderynIsInstalled,
     isKeyUsed,
+    startPeriodicChecks,
     Keys,
     Logger,
 };

src/utils/update.ts

@@ -0,0 +1,66 @@
+// Run periodic checks to see if there's an update to aderyn available. If yes, invite the user to visit
+// the welcome page. [Update] or [Remind Me Later]
+
+import * as vscode from 'vscode';
+import { Logger } from './logger';
+import { isAderynAvailableOnPath } from './install/aderyn';
+import {
+    latestAderynVersionOnGithub,
+    areAderynVersionsEqual,
+    getLocalAderynVersion,
+} from './install/versions';
+import { EditorCmd } from '../commands/variants';
+
+async function updateIsAvailable(logger: Logger): Promise<boolean> {
+    const isOnPath = await isAderynAvailableOnPath(logger);
+    if (!isOnPath) {
+        return false;
+    }
+    try {
+        const latestAderynVersion = await latestAderynVersionOnGithub(logger);
+        const existingAderynVersion = await getLocalAderynVersion(logger);
+        return !areAderynVersionsEqual(latestAderynVersion, existingAderynVersion);
+    } catch (_) {
+        return false;
+    }
+}
+
+const enum UserAction {
+    YES = 'Yes',
+    LATER = 'Remind me later',
+    NO = 'Undefined', // When the user closes the notification
+}
+
+async function promptUserToUpdate(): Promise<UserAction> {
+    return vscode.window
+        .showInformationMessage(
+            "Aderyn's core tool has an update used by the extension. Update now?",
+            UserAction.YES,
+            UserAction.LATER,
+        )
+        .then((selectedAction) => {
+            if (!selectedAction) {
+                return UserAction.NO;
+            }
+            if (selectedAction === UserAction.YES) {
+                vscode.commands.executeCommand(EditorCmd.ShowOnboardPanel);
+            }
+            return selectedAction;
+        });
+}
+
+async function startPeriodicChecks() {
+    const action = async () => {
+        const can = await updateIsAvailable(new Logger());
+        if (can) {
+            const action = await promptUserToUpdate();
+            if (action == UserAction.YES || action == UserAction.NO) {
+                clearInterval(intervalId);
+            }
+        }
+    };
+    const TIME_PERIOD = 30 * 60 * 1000; // 30 minute
+    const intervalId = setInterval(action, TIME_PERIOD);
+}
+
+export { startPeriodicChecks };