feat(vscode): ensure CLI version is compatible (#752)

Author: alestiago

extensions/vscode/src/commands/install-cli.ts

@@ -1,7 +1,7 @@
 const cp = require("child_process");
 
 import { window, ProgressOptions } from "vscode";
-import { isDartFrogCLIInstalled } from "../utils/utils";
+import { isDartFrogCLIInstalled } from "../utils";
 
 /**
  * Installs Dart Frog CLI in the user's system if not already installed.

extensions/vscode/src/commands/update-cli.ts

@@ -1,7 +1,7 @@
 const cp = require("child_process");
 
 import { window, ProgressOptions } from "vscode";
-import { isDartFrogCLIInstalled } from "../utils/utils";
+import { isDartFrogCLIInstalled } from "../utils";
 
 /**
  * Update Dart Frog CLI in the user's system.

extensions/vscode/src/extension.ts

@@ -1,5 +1,9 @@
 import * as vscode from "vscode";
 import { installCLI, newRoute, newMiddleware, updateCLI } from "./commands";
+import {
+  readDartFrogCLIVersion,
+  isCompatibleDartFrogCLIVersion,
+} from "./utils";
 
 /**
  * This method is called when the extension is activated.
@@ -13,6 +17,7 @@ export function activate(
   context: vscode.ExtensionContext
 ): vscode.ExtensionContext {
   installCLI();
+  ensureCompatibleDartFrogCLI();
 
   context.subscriptions.push(
     vscode.commands.registerCommand("extension.install-cli", installCLI),
@@ -22,3 +27,51 @@ export function activate(
   );
   return context;
 }
+
+/**
+ * Checks if the version of Dart Frog CLI installed in the user's system is
+ * compatible with this extension, suggesting to install if it is not.
+ *
+ * This method should be called upon activation of the extension to ensure that
+ * the version of Dart Frog CLI installed in the user's system is compatible
+ * with this extension.
+ *
+ * If the version of Dart Frog CLI installed in the user's system is not
+ * compatible with this extension, the user is prompted to update Dart Frog CLI
+ * or ignore the warning. If the user chooses to update Dart Frog CLI, the
+ * extension will attempt to update Dart Frog CLI. Otherwise, the user will
+ * proceed to use the extension at their own risk.
+ *
+ * If Dart Frog CLI is not installed in the user's system, this method will
+ * do nothing and returns immediately.
+ *
+ * @see {@link isCompatibleDartFrogCLIVersion}, to check if the version of
+ * Dart Frog CLI installed in the user's system is compatible with this
+ * extension.
+ */
+export async function ensureCompatibleDartFrogCLI(): Promise<void> {
+  const version = readDartFrogCLIVersion();
+  if (!version) {
+    return;
+  }
+
+  const versionIsCompatible = isCompatibleDartFrogCLIVersion(version);
+  if (versionIsCompatible) {
+    return;
+  }
+
+  const selection = await vscode.window.showWarningMessage(
+    `Dart Frog CLI version ${version} is not compatible with this extension.`,
+    "Update Dart Frog CLI",
+    "Ignore"
+  );
+  switch (selection) {
+    case "Update Dart Frog CLI":
+      updateCLI();
+      break;
+    case "Ignore":
+      break;
+    default:
+      break;
+  }
+}

extensions/vscode/src/test/suite/commands/install-cli.test.ts

@@ -32,7 +32,7 @@ suite("install-cli command", () => {
       // eslint-disable-next-line @typescript-eslint/naming-convention
       child_process: childProcessStub,
       // eslint-disable-next-line @typescript-eslint/naming-convention
-      "../utils/utils": utilsStub,
+      "../utils": utilsStub,
     });
   });
 

extensions/vscode/src/test/suite/commands/update-cli.test.ts

@@ -32,7 +32,7 @@ suite("update-cli", () => {
       // eslint-disable-next-line @typescript-eslint/naming-convention
       child_process: childProcessStub,
       // eslint-disable-next-line @typescript-eslint/naming-convention
-      "../utils/utils": utilsStub,
+      "../utils": utilsStub,
     });
   });
 

extensions/vscode/src/test/suite/extension.test.ts

@@ -26,13 +26,26 @@ suite("activate", () => {
           registerCommand: sinon.stub(),
         },
       };
+
+      const utilsStub = {
+        readDartFrogCLIVersion: sinon.stub(),
+        isCompatibleDartFrogCLIVersion: sinon.stub(),
+        isDartFrogCLIInstalled: sinon.stub(),
+      };
+      utilsStub.readDartFrogCLIVersion.returns("0.0.0");
+      utilsStub.isCompatibleDartFrogCLIVersion.returns(true);
+      utilsStub.isDartFrogCLIInstalled.returns(true);
+
       const childProcessStub = {
         execSync: sinon.stub(),
       };
+
       extension = proxyquire("../../extension", {
         vscode: vscodeStub,
         // eslint-disable-next-line @typescript-eslint/naming-convention
         child_process: childProcessStub,
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        "./utils": utilsStub,
       });
       context = { subscriptions: [] };
     });
@@ -41,7 +54,7 @@ suite("activate", () => {
       sinon.restore();
     });
 
-    test("install-cli", async () => {
+    test("install-cli", () => {
       extension.activate(context);
 
       sinon.assert.calledWith(
@@ -51,7 +64,7 @@ suite("activate", () => {
       );
     });
 
-    test("update-cli", async () => {
+    test("update-cli", () => {
       extension.activate(context);
 
       sinon.assert.calledWith(
@@ -61,7 +74,7 @@ suite("activate", () => {
       );
     });
 
-    test("new-route", async () => {
+    test("new-route", () => {
       extension.activate(context);
 
       sinon.assert.calledWith(
@@ -71,7 +84,7 @@ suite("activate", () => {
       );
     });
 
-    test("new-middleware", async () => {
+    test("new-middleware", () => {
       extension.activate(context);
 
       sinon.assert.calledWith(
@@ -82,22 +95,129 @@ suite("activate", () => {
     });
   });
 
-  test("calls installCLI", async () => {
+  test("calls installCLI", () => {
     const vscodeStub = {
       commands: {
         registerCommand: sinon.stub(),
       },
     };
-    const installCLIStub = sinon.stub();
+
+    const utilsStub = {
+      readDartFrogCLIVersion: sinon.stub(),
+      isCompatibleDartFrogCLIVersion: sinon.stub(),
+      isDartFrogCLIInstalled: sinon.stub(),
+    };
+    utilsStub.readDartFrogCLIVersion.returns("0.0.0");
+    utilsStub.isCompatibleDartFrogCLIVersion.returns(true);
+    utilsStub.isDartFrogCLIInstalled.returns(true);
+
+    const commandsStub = {
+      installCLI: sinon.stub(),
+    };
+
     const extension = proxyquire("../../extension", {
       vscode: vscodeStub,
       // eslint-disable-next-line @typescript-eslint/naming-convention
-      "./commands": { installCLI: installCLIStub },
+      "./utils": utilsStub,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      "./commands": commandsStub,
     });
-    const context = { subscriptions: [] };
 
+    const context = { subscriptions: [] };
     extension.activate(context);
 
-    sinon.assert.calledOnce(installCLIStub);
+    sinon.assert.calledOnce(commandsStub.installCLI);
+  });
+});
+
+suite("ensureCompatibleDartFrogCLI", () => {
+  let vscodeStub: any;
+  let utilsStub: any;
+  let commandsStub: any;
+  let extension: any;
+
+  beforeEach(() => {
+    vscodeStub = {
+      window: {
+        showWarningMessage: sinon.stub(),
+      },
+    };
+
+    utilsStub = {
+      readDartFrogCLIVersion: sinon.stub(),
+      isCompatibleDartFrogCLIVersion: sinon.stub(),
+    };
+    commandsStub = {
+      updateCLI: sinon.stub(),
+    };
+
+    extension = proxyquire("../../extension", {
+      vscode: vscodeStub,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      "./utils": utilsStub,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      "./commands": commandsStub,
+    });
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test("does not show warning when CLI is not installed", async () => {
+    utilsStub.readDartFrogCLIVersion.returns(undefined);
+
+    await extension.ensureCompatibleDartFrogCLI();
+
+    sinon.assert.notCalled(vscodeStub.window.showWarningMessage);
+  });
+
+  test("does not show warning when CLI is compatible", async () => {
+    utilsStub.readDartFrogCLIVersion.returns("1.0.0");
+    utilsStub.isCompatibleDartFrogCLIVersion.returns(true);
+
+    await extension.ensureCompatibleDartFrogCLI();
+
+    sinon.assert.notCalled(vscodeStub.window.showWarningMessage);
+  });
+
+  suite("incompatible CLI", () => {
+    const version = "0.0.0";
+
+    beforeEach(() => {
+      utilsStub.readDartFrogCLIVersion.returns(version);
+      utilsStub.isCompatibleDartFrogCLIVersion.returns(false);
+    });
+
+    afterEach(() => {
+      sinon.restore();
+    });
+
+    test("shows warning", async () => {
+      await extension.ensureCompatibleDartFrogCLI();
+
+      sinon.assert.calledOnceWithExactly(
+        vscodeStub.window.showWarningMessage,
+        `Dart Frog CLI version ${version} is not compatible with this extension.`,
+        "Update Dart Frog CLI",
+        "Ignore"
+      );
+    });
+
+    test("updates CLI when selected", async () => {
+      vscodeStub.window.showWarningMessage.returns("Update Dart Frog CLI");
+
+      await extension.ensureCompatibleDartFrogCLI();
+
+      sinon.assert.calledOnce(commandsStub.updateCLI);
+    });
+
+    test("does not update CLI when ignored", async () => {
+      vscodeStub.window.showWarningMessage.returns("Ignore");
+
+      await extension.ensureCompatibleDartFrogCLI();
+
+      sinon.assert.notCalled(commandsStub.updateCLI);
+    });
   });
 });

extensions/vscode/src/test/suite/index.ts

@@ -13,6 +13,7 @@ export function run(): Promise<void> {
   const mocha = new Mocha({
     ui: "tdd",
     color: true,
+    timeout: 60000,
   });
 
   const testsRoot = path.resolve(__dirname, "..");

extensions/vscode/src/test/suite/utils/cli-version.test.ts

@@ -4,7 +4,7 @@ var proxyquire = require("proxyquire");
 import { afterEach, beforeEach } from "mocha";
 import * as assert from "assert";
 
-suite("readDartFrogVersion", () => {
+suite("readDartFrogCLIVersion", () => {
   let cpStub: any;
   let cliVersion: any;
 
@@ -24,32 +24,48 @@ suite("readDartFrogVersion", () => {
   });
 
   test("returns the version of Dart Frog CLI installed in the user's system", () => {
-    cpStub.execSync.returns("0.3.7");
+    const dartFrogVersionCommandResult = "0.3.7\n";
+    const encoededDartFrogVersionCommandResult = new TextEncoder().encode(
+      dartFrogVersionCommandResult
+    );
+    cpStub.execSync.returns(encoededDartFrogVersionCommandResult);
 
-    assert.strictEqual(cliVersion.readDartFrogVersion(), "0.3.7");
+    assert.strictEqual(cliVersion.readDartFrogCLIVersion(), "0.3.7");
   });
 
   test("returns undefined if Dart Frog CLI is not installed", () => {
     cpStub.execSync.throws();
 
-    assert.strictEqual(cliVersion.readDartFrogVersion(), undefined);
+    assert.strictEqual(cliVersion.readDartFrogCLIVersion(), undefined);
   });
 });
 
-suite("isCompatibleCLIVersion", () => {
+suite("isCompatibleDartFrogCLIVersion", () => {
   let cliVersion: any;
 
   beforeEach(() => {
     cliVersion = proxyquire("../../../utils/cli-version", {});
   });
 
   test("returns true if the version of Dart Frog CLI installed in the user's system is compatible with this extension", () => {
-    assert.strictEqual(cliVersion.isCompatibleCLIVersion("0.3.8"), true);
-    assert.strictEqual(cliVersion.isCompatibleCLIVersion("0.3.7"), true);
+    assert.strictEqual(
+      cliVersion.isCompatibleDartFrogCLIVersion("0.3.8"),
+      true
+    );
+    assert.strictEqual(
+      cliVersion.isCompatibleDartFrogCLIVersion("0.3.7"),
+      true
+    );
   });
 
   test("returns false if the version of Dart Frog CLI installed in the user's system is not compatible with this extension", () => {
-    assert.strictEqual(cliVersion.isCompatibleCLIVersion("1.0.0"), false);
-    assert.strictEqual(cliVersion.isCompatibleCLIVersion("0.3.6"), false);
+    assert.strictEqual(
+      cliVersion.isCompatibleDartFrogCLIVersion("1.0.0"),
+      false
+    );
+    assert.strictEqual(
+      cliVersion.isCompatibleDartFrogCLIVersion("0.3.6"),
+      false
+    );
   });
 });