Add automatic updates for imandrax-cli (#82)

Author: wintersteiger

package-lock.json

@@ -6,16 +6,31 @@
   "publisher": "Imandra",
   "icon": "assets/marketplace.png",
   "galleryBanner": {
-    "color": "#3B3F49",
+    "color": "#221B32",
     "theme": "dark"
   },
   "license": "MIT",
-  "version": "0.0.50",
+  "version": "0.0.51",
   "repository": {
     "type": "git",
     "url": "https://github.com/imandra-ai/imandrax-vscode"
   },
-  "categories": [],
+  "categories": [
+    "Programming Languages",
+    "AI",
+    "Visualization",
+    "Other"
+  ],
+  "keywords": [
+    "formalization",
+    "formal",
+    "reasoning",
+    "verification",
+    "testing",
+    "AI",
+    "safety",
+    "neurosymbolic"
+  ],
   "engines": {
     "vscode": "^1.96.2"
   },
@@ -216,6 +231,7 @@
     "@vscode/vsce": "^3.7.1",
     "async-mutex": "^0.5.0",
     "jest": "^30.2.0",
+    "node-fetch": "^3.3.2",
     "ovsx": "^0.10.8",
     "prettier": "^3.7.4",
     "vscode-languageclient": "^8.1.0"

package.json

@@ -56,7 +56,7 @@ export async function activate(context: ExtensionContext) {
     const openUri = Uri.parse(
       `command:workbench.action.openWorkspaceSettingsFile?${encodeURIComponent(JSON.stringify(args))}`
     );
-    await installer.promptToInstall(openUri);
+    await installer.promptToInstall(openUri, false);
   } else if (languageClientConfig.binPathAvailability.status === "onWindows") {
     const item = { title: "Go to docs" };
     const itemT = await window.showErrorMessage(`ImandraX can't run natively on Windows. Please start a remote VSCode session against WSL`, item);
@@ -66,5 +66,15 @@ export async function activate(context: ExtensionContext) {
   }
   if (context.extensionMode === ExtensionMode.Test || context.extensionMode === undefined) {
     (global as any).testExtensionContext = context;
+  } else {
+    if (await installer.installedByUs()) {
+      if (await installer.updateAvailable()) {
+        const args = { revealSetting: { key: "imandrax.lsp.binary", edit: true } };
+        const openUri = Uri.parse(
+          `command:workbench.action.openWorkspaceSettingsFile?${encodeURIComponent(JSON.stringify(args))}`
+        );
+        await installer.promptToInstall(openUri, true);
+      }
+    }
   }
 }

src/extension.ts

@@ -6,6 +6,11 @@ import * as Which from "which";
 import { commands, ConfigurationTarget, env, MessageItem, ProgressLocation, QuickPickItem, QuickPickOptions, Uri, window, workspace } from "vscode";
 import { exec } from 'child_process';
 
+import { stat, writeFile, utimes } from 'fs/promises';
+
+import fetch, { Response } from 'node-fetch';
+
+
 async function getApiKeyInput() {
   const result = await window.showInputBox({
     placeHolder: 'Paste your API key here',
@@ -82,10 +87,33 @@ async function setBinaryPaths(openUri: Uri) {
   await config.update('terminal.binary', binaryPath, ConfigurationTarget.Global);
 }
 
+async function markerFilename(): Promise<string> {
+  const config = workspace.getConfiguration('imandrax');
+  const binaryPath = await config.get('lsp.binary');
+  const binaryDir = Path.dirname(binaryPath as string);
+  return Path.join(binaryDir, 'imandrax-cli.installed_by_vscode');
+}
+
+async function markInstalled(): Promise<void> {
+  const markerFile = await markerFilename();
+  await writeFile(markerFile, '');
+  await utimes(markerFile, Date.now(), Date.now());
+}
+
+export async function installedByUs(): Promise<boolean> {
+  try {
+    await stat(await markerFilename());
+    return true;
+  } catch {
+    return false;
+  }
+}
+
 async function handleSuccess(openUri: Uri) {
   await setBinaryPaths(openUri);
   await promptForApiKey();
   await promptToReloadWindow();
+  await markInstalled();
 }
 
 async function runInstallerForUnix(itemT: MessageItem, title: string): Promise<void> {
@@ -127,12 +155,15 @@ async function runInstallerForUnix(itemT: MessageItem, title: string): Promise<v
   }
 }
 
-export async function promptToInstall(openUri: Uri) {
+export async function promptToInstall(openUri: Uri, update?: boolean) {
   const launchInstallerItem = { title: "Launch installer" } as const;
   const items: readonly MessageItem[] = [launchInstallerItem];
-
-  const itemT: MessageItem | undefined = await window.showErrorMessage(`Could not find ImandraX. Please install it or ensure the imandrax-cli binary is in your PATH or its location is set in [Workspace Settings](${openUri.toString()}).`, ...items);
-
+  let itemT: MessageItem | undefined;
+  if (update) {
+    itemT = await window.showInformationMessage(`An updated imandrax-cli binary is available.`, ...items);
+  } else {
+    itemT = await window.showErrorMessage(`Could not find ImandraX. Please install it or ensure the imandrax-cli binary is in your PATH or its location is set in [Workspace Settings](${openUri.toString()}).`, ...items);
+  }
   if (itemT) {
     await window.withProgress(
       {
@@ -141,7 +172,56 @@ export async function promptToInstall(openUri: Uri) {
       },
       () => runInstallerForUnix(itemT, launchInstallerItem.title)).then(
         () => handleSuccess(openUri),
-        async (reason) => { await window.showErrorMessage(`ImandraX install failed\n ${reason}`); }
+        async (reason) => { await window.showErrorMessage(`ImandraX installation failed\n ${reason}`); }
       );
   }
 }
+
+interface ReleaseObject {
+  name: string;
+  generation: string; // not guaranteed to increase
+  meta_generation: string; // guaranteed to increase, but not a time
+  timeCreated: string;
+  timeFinalized: string;
+  timeStorageClassUpdated: string;
+  updated: string
+}
+
+export async function updateAvailable() {
+  try {
+    async function getFileModificationDate(filePath: string): Promise<Date> {
+      const stats = await stat(filePath);
+      return stats.mtime;
+    }
+
+    async function getData(pkg_name: string): Promise<ReleaseObject> {
+      const url = `https://storage.googleapis.com/storage/v1/b/imandra-prod-imandrax-releases/o/${pkg_name}`;
+      const response: Response = await fetch(url);
+      if (!response.ok) {
+        throw new Error(`Response status: ${response.status}`);
+      }
+      return await response.json() as ReleaseObject;
+    }
+
+    let pkg_name = "";
+    if (process.platform == "linux" && process.arch == "x64")
+      pkg_name = "imandrax-linux-x86_64-latest.tar.gz";
+    else if (process.platform == "darwin" && process.arch == "arm64")
+      pkg_name = "imandrax-macos-aarch64-latest.pkg";
+    else if (process.platform == "darwin" && process.arch == "x64")
+      pkg_name = "imandrax-macos-x64-latest.pkg";
+    else {
+      throw new Error(`Unsupported platform/architecture ${process.platform}-${process.arch}`);
+    }
+
+    const data: ReleaseObject = await getData(pkg_name);
+    const marker: string = await markerFilename();
+    const remoteTime: number = Date.parse(data.updated)
+    const markerTime: number | undefined = (await getFileModificationDate(marker))?.getTime();
+
+    return markerTime && remoteTime > markerTime;
+  } catch (e) {
+    // Don't annoy the user with a showErrorMessage about our bugs or network outages, just log them.
+    console.log(`Update check failed: ${(e as Error).message}.`);
+  }
+}

src/installer.ts

@@ -45,7 +45,7 @@ export class Listeners {
       const all_bad: DecorationOptions[] = [];
       const diags = languages.getDiagnostics(uri);
       diags.forEach(d => {
-        if (d.source === "lsp") {
+        if (d.source == "lsp" || d.source === "ImandraX") {
           const good = d.severity === DiagnosticSeverity.Information || d.severity === DiagnosticSeverity.Hint;
           const range = d.range.with(d.range.start, d.range.start);
           const decoration_options: DecorationOptions = { range: range };

src/listeners.ts

@@ -125,8 +125,8 @@ suite('Commands Test Suite', () => {
               resolveSawDiagnostic(true);
           });
         }
-        // We received some diagnostics, but they were not for us
         else
+          // We received some diagnostics, but they were not for us
           resolveSawDiagnostic(false);
       }
     }