feat(vscode): suggest installing Dart Frog CLI instead of silently installing (#755)

Author: alestiago

extensions/vscode/src/extension.ts

@@ -3,6 +3,7 @@ import { installCLI, newRoute, newMiddleware, updateCLI } from "./commands";
 import {
   readDartFrogCLIVersion,
   isCompatibleDartFrogCLIVersion,
+  isDartFrogCLIInstalled,
 } from "./utils";
 
 /**
@@ -14,10 +15,15 @@ import {
  * @returns The same instance of the extension context passed in.
  */
 export function activate(
-  context: vscode.ExtensionContext
+  context: vscode.ExtensionContext,
+  suggestInstallingCLI: () => Promise<void> = suggestInstallingDartFrogCLI,
+  ensureCompatibleCLI: () => Promise<void> = ensureCompatibleDartFrogCLI
 ): vscode.ExtensionContext {
-  installCLI();
-  ensureCompatibleDartFrogCLI();
+  if (!isDartFrogCLIInstalled()) {
+    suggestInstallingCLI();
+  } else {
+    ensureCompatibleCLI();
+  }
 
   context.subscriptions.push(
     vscode.commands.registerCommand("extension.install-cli", installCLI),
@@ -28,6 +34,35 @@ export function activate(
   return context;
 }
 
+/**
+ * Suggests the user to install Dart Frog CLI.
+ *
+ * This method should be called upon activation of the extension whenever
+ * Dart Frog CLI is not installed in the user's system.
+ *
+ * It prompts the user to install Dart Frog CLI. This is optional, the user
+ * can choose to install Dart Frog CLI at a later time but the extension may
+ * not work as intended until Dart Frog CLI is installed.
+ *
+ * @see {@link isDartFrogCLIInstalled}, to check if Dart Frog CLI is installed
+ */
+export async function suggestInstallingDartFrogCLI(): Promise<void> {
+  const selection = await vscode.window.showWarningMessage(
+    "Dart Frog CLI is not installed. Install Dart Frog CLI to use this extension.",
+    "Install Dart Frog CLI",
+    "Ignore"
+  );
+  switch (selection) {
+    case "Install Dart Frog CLI":
+      await installCLI();
+      break;
+    case "Ignore":
+      break;
+    default:
+      break;
+  }
+}
+
 /**
  * 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.

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

@@ -95,39 +95,120 @@ suite("activate", () => {
     });
   });
 
-  test("calls installCLI", () => {
+  test("calls suggestInstallingDartFrogCLI when Dart Frog CLI is not installed", () => {
+    const vscodeStub = {
+      commands: {
+        registerCommand: sinon.stub(),
+      },
+    };
+
+    const utilsStub = {
+      isDartFrogCLIInstalled: sinon.stub(),
+    };
+    utilsStub.isDartFrogCLIInstalled.returns(false);
+
+    const extension = proxyquire("../../extension", {
+      vscode: vscodeStub,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      "./utils": utilsStub,
+    });
+
+    const context = { subscriptions: [] };
+    const suggestInstallingCLI = sinon.stub();
+    const ensureCompatibleCLI = sinon.stub();
+    extension.activate(context, suggestInstallingCLI, ensureCompatibleCLI);
+
+    sinon.assert.calledOnce(suggestInstallingCLI);
+  });
+
+  test("calls ensureCompatibleDartFrogCLI when Dart Frog CLI is installed", () => {
     const vscodeStub = {
       commands: {
         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 commandsStub = {
+    const extension = proxyquire("../../extension", {
+      vscode: vscodeStub,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      "./utils": utilsStub,
+    });
+
+    const context = { subscriptions: [] };
+    const suggestInstallingCLI = sinon.stub();
+    const ensureCompatibleCLI = sinon.stub();
+    extension.activate(context, suggestInstallingCLI, ensureCompatibleCLI);
+
+    sinon.assert.calledOnce(ensureCompatibleCLI);
+  });
+});
+
+suite("suggestInstallingDartFrogCLI", () => {
+  let vscodeStub: any;
+  let utilsStub: any;
+  let commandsStub: any;
+  let extension: any;
+
+  beforeEach(() => {
+    vscodeStub = {
+      window: {
+        showWarningMessage: sinon.stub(),
+      },
+    };
+
+    utilsStub = {
+      isDartFrogCLIInstalled: sinon.stub(),
+    };
+    utilsStub.isDartFrogCLIInstalled.returns(false);
+
+    commandsStub = {
       installCLI: sinon.stub(),
     };
 
-    const extension = proxyquire("../../extension", {
+    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,
     });
+  });
 
-    const context = { subscriptions: [] };
-    extension.activate(context);
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test("shows warning suggesting to install Dart Frog CLI", async () => {
+    await extension.suggestInstallingDartFrogCLI();
+
+    sinon.assert.calledOnceWithExactly(
+      vscodeStub.window.showWarningMessage,
+      "Dart Frog CLI is not installed. Install Dart Frog CLI to use this extension.",
+      "Install Dart Frog CLI",
+      "Ignore"
+    );
+  });
+
+  test("installs Dart Frog CLI when selected", async () => {
+    vscodeStub.window.showWarningMessage.returns("Install Dart Frog CLI");
+
+    await extension.suggestInstallingDartFrogCLI();
 
     sinon.assert.calledOnce(commandsStub.installCLI);
   });
+
+  test("does not install Dart Frog CLI when ignored", async () => {
+    vscodeStub.window.showWarningMessage.returns("Ignore");
+
+    await extension.suggestInstallingDartFrogCLI();
+
+    sinon.assert.notCalled(commandsStub.installCLI);
+  });
 });
 
 suite("ensureCompatibleDartFrogCLI", () => {