Add option to disable auto-update

changelog.d/62.added.md

@@ -0,0 +1 @@
+Add option to disable auto-update

package.json

@@ -120,6 +120,11 @@
 					],
 					"default": null,
 					"description": "Path to local mirrord installation."
+				},
+				"mirrord.autoUpdate": {
+					"type": ["string", "boolean"],
+					"default": true,
+					"description": "Automatically update mirrord binary."					
 				}
 			}
 		},
@@ -226,7 +231,7 @@
 	},
 	"dependencies": {
 		"axios": "^1.4.0",
-		"semver": "^7.3.7",
+		"semver": "^7.5.4",
 		"toml": "^3.0.0",
 		"vscode-uri": "^3.0.7",
 		"which": "^3.0.1",

src/binaryManager.ts

@@ -1,4 +1,5 @@
 import axios, { AxiosResponse } from 'axios';
+import * as vscode from 'vscode';
 import which from 'which';
 import { globalContext } from './extension';
 import { MirrordAPI } from './api';
@@ -7,6 +8,7 @@ import * as fs from 'node:fs';
 import { platform } from 'os';
 import { Uri, workspace, window, ProgressLocation, ExtensionMode } from 'vscode';
 import { NotificationBuilder } from './notification';
+import * as semver from 'semver';
 
 const mirrordBinaryEndpoint = 'https://version.mirrord.dev/v1/version';
 // const binaryCheckInterval = 1000 * 60 * 3;
@@ -19,37 +21,42 @@ function getExtensionMirrordPath(): Uri {
 
 /**
  * Tries to find local mirrord in path or in extension storage.
+ * @param version If specified, then the version of the binary is checked and matched path is returned if it matches.
+ * @returns Path to mirrord binary or null if not found
  */
 export async function getLocalMirrordBinary(version?: string): Promise<string | null> {
     try {
-        const mirrordPath = await which("mirrord");
+        const mirrordPath = getExtensionMirrordPath();
+        await workspace.fs.stat(mirrordPath);
         if (version) {
-            const api = new MirrordAPI(mirrordPath);
+            const api = new MirrordAPI(mirrordPath.fsPath);
             const installedVersion = await api.getBinaryVersion();
             if (installedVersion === version) {
-                return mirrordPath;
+                return mirrordPath.fsPath;
             }
         } else {
-            return mirrordPath;
+            return mirrordPath.fsPath;
         }
+
     } catch (e) {
-        console.debug("couldn't find mirrord in path");
+        console.log("couldn't find mirrord in extension storage");
     }
     try {
-        const mirrordPath = getExtensionMirrordPath();
-        await workspace.fs.stat(mirrordPath);
+        const mirrordPath = await which("mirrord");
         if (version) {
-            const api = new MirrordAPI(mirrordPath.fsPath);
+            const api = new MirrordAPI(mirrordPath);
             const installedVersion = await api.getBinaryVersion();
-            if (installedVersion === version) {
-                return mirrordPath.fsPath;
+
+            // we use semver.get here because installedVersion can be greater than the latest version
+            // if we are running on the release CI.
+            if (installedVersion && semver.gte(installedVersion, version)) {
+                return mirrordPath;
             }
         } else {
-            return mirrordPath.fsPath;
+            return mirrordPath;
         }
-
     } catch (e) {
-        console.log("couldn't find mirrord in extension storage");
+        console.debug("couldn't find mirrord in path");
     }
     return null;
 }
@@ -93,33 +100,76 @@ async function getConfiguredMirrordBinary(): Promise<string | null> {
 }
 
 /**
- * Downloads mirrord binary (if needed) and returns its path
- */
-export async function getMirrordBinary(): Promise<string> {
+ * Toggles auto-update of mirrord binary.
+ * Criteria for auto-update:
+ * - Auto-update is enabled by default
+ * - if mirrord binary path is mentioned in workspace settings, then that is used
+ * - if a version is specified, that version is downloaded
+ * - if auto-update is enabled, then latest supported version is downloaded
+ * - if auto-update is disabled, any local mirrord binary is used
+ * 
+ * @param extensionActivate If true, then a global state is set so that any changes to the workspace settings pertaining
+ * to mirrord binary auto-update will prompt the user to reload the window.
+ * @returns Path to mirrord binary
+*/
+export async function getMirrordBinary(extensionActivate?: boolean): Promise<string> {
     const configured = await getConfiguredMirrordBinary();
+
     if (configured) {
+        vscode.window.showInformationMessage(`Using mirrord binary specified in settings: ${configured}`);
         return configured;
     }
+    const latestVersion = await getLatestSupportedVersion(10000);
+    const autoUpdateConfigured = vscode.workspace.getConfiguration().get("mirrord.autoUpdate");
+    const extensionPath = getExtensionMirrordPath().fsPath;
 
-    let foundLocal = await getLocalMirrordBinary();
-    // timeout is 1s if we have alternative or 10s if we don't
-    let timeout = foundLocal ? 1000 : 10000;
-    const latestVersion = await getLatestSupportedVersion(timeout);
-
-    // See if maybe we have it installed already, in correct version.
-    const localMirrord = await getLocalMirrordBinary(latestVersion);
-    if (localMirrord) {
-        const api = new MirrordAPI(localMirrord);
-        const installedVersion = await api.getBinaryVersion();
-        if (installedVersion === latestVersion) {
-            return localMirrord;
+    // if extension is activating, then set a global state to what was read in the workspace settings
+    if (extensionActivate) {
+        globalContext.workspaceState.update('autoUpdate', autoUpdateConfigured);
+    } else {
+        // extension is active, check if auto-update setting has changed
+        const autoUpdate = globalContext.workspaceState.get('autoUpdate');
+        if (autoUpdate !== autoUpdateConfigured) {
+            await new NotificationBuilder()
+                .withMessage("mirrord binary auto-update setting has changed, please reload the window for the change to take effect.")
+                .withGenericAction("Reload", async () => {
+                    await vscode.commands.executeCommand("workbench.action.reloadWindow");
+                })
+                .warning();
         }
+        return extensionPath;
     }
 
-    const extensionMirrordPath = getExtensionMirrordPath();
-    await downloadMirrordBinary(extensionMirrordPath, latestVersion);
+    if (typeof autoUpdateConfigured === 'string') {
+        if (semver.valid(autoUpdateConfigured)) {
+            const localMirrordBinary = await getLocalMirrordBinary(autoUpdateConfigured);
+            if (localMirrordBinary) {
+                return localMirrordBinary;
+            }
+            await downloadMirrordBinary(getExtensionMirrordPath(), autoUpdateConfigured);
+            return extensionPath;
+        } else {
+            vscode.window.showErrorMessage(`Invalid version format ${autoUpdateConfigured}: must follow semver format`);
+        }
+    }
 
-    return extensionMirrordPath.fsPath;
+    if (typeof autoUpdateConfigured === 'boolean') {
+        if (!autoUpdateConfigured) {
+            const localMirrordBinary = await getLocalMirrordBinary();
+            if (localMirrordBinary) {
+                return localMirrordBinary;
+            }
+            return extensionPath;
+        }
+    }
+
+    // Auto-update is enabled or no specific version specified.    
+    const localMirrordBinary = await getLocalMirrordBinary(latestVersion);
+    if (localMirrordBinary) {
+        return localMirrordBinary;
+    }
+    await downloadMirrordBinary(getExtensionMirrordPath(), latestVersion);
+    return extensionPath;
 }
 
 /**

src/extension.ts

@@ -1,6 +1,7 @@
 import * as vscode from 'vscode';
 import { ConfigurationProvider } from './debugger';
 import { MirrordStatus } from './status';
+import { getMirrordBinary } from './binaryManager';
 
 export let globalContext: vscode.ExtensionContext;
 
@@ -11,6 +12,9 @@ export async function activate(context: vscode.ExtensionContext) {
 
 	context.workspaceState.update('enabled', false);
 	vscode.debug.registerDebugConfigurationProvider('*', new ConfigurationProvider(), 2);
+
+	// start mirrord binary updates, so that we avoid downloading mid session
+	await getMirrordBinary(true);
 
 	new MirrordStatus(vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 0))
 		.register()

src/tests/e2e.ts

@@ -15,7 +15,7 @@ const podToSelect = process.env.POD_TO_SELECT;
  * - Send traffic to the pod
  * - Tests successfully exit if "GET: Request completed" is found in the terminal
 */
-describe("mirrord sample flow test", function() {
+describe("mirrord sample flow test", function () {
 
   this.timeout("6 minutes"); // --> mocha tests timeout
   this.bail(true); // --> stop tests on first failure
@@ -26,7 +26,7 @@ describe("mirrord sample flow test", function() {
   const fileName = "app_flask.py";
   const defaultTimeout = 10000; // = 10 seconds
 
-  before(async function() {
+  before(async function () {
     console.log("podToSelect: " + podToSelect);
     console.log("kubeService: " + kubeService);
 
@@ -48,7 +48,7 @@ describe("mirrord sample flow test", function() {
     await ew.openEditor('app_flask.py');
   });
 
-  it("enable mirrord button", async function() {
+  it("enable mirrord button", async function () {
     const statusBar = new StatusBar();
 
     await browser.driver.wait(async () => {
@@ -80,7 +80,7 @@ describe("mirrord sample flow test", function() {
     }, defaultTimeout, "mirrord `enable` button not found -- timed out");
   });
 
-  it("select pod from quickpick", async function() {
+  it("select pod from quickpick", async function () {
     await startDebugging();
     const inputBox = await InputBox.create(defaultTimeout * 2);
     // assertion that podToSelect is not undefined is done in "before" block
@@ -108,7 +108,7 @@ describe("mirrord sample flow test", function() {
     await inputBox.selectQuickPick(podToSelect!);
   });
 
-  it("wait for process to write to terminal", async function() {
+  it("wait for process to write to terminal", async function () {
     const debugToolbar = await DebugToolbar.create(2 * defaultTimeout);
     const panel = new BottomBarPanel();
     await browser.driver.wait(async () => {
@@ -153,4 +153,4 @@ async function startDebugging(configurationFile: string = "Python: Current File"
   const debugView = await activityBar?.openView() as DebugView;
   await debugView.selectLaunchConfiguration(configurationFile);
   await debugView.start();
-}
+}

test-workspace/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "mirrord.autoUpdate": {
+        "enabled": false,
+        "version": "3.70.0"       
+    },
+    "mirrord.binaryPath": null
+}