fix(vscode): suggest again to install the Dart Frog CLI before running a command that requires of Dart Frog CLI if not installed (#870)

Author: alestiago

extensions/vscode/src/commands/create.ts

@@ -8,6 +8,7 @@ import {
   ProgressOptions,
   OpenDialogOptions,
 } from "vscode";
+import { isDartFrogCLIInstalled, suggestInstallingDartFrogCLI } from "../utils";
 
 /**
  * Creates a new Dart Frog project.
@@ -33,6 +34,12 @@ import {
  * @see {@link https://github.com/VeryGoodOpenSource/dart_frog/blob/main/packages/dart_frog_cli/lib/src/commands/create/create.dart Dart Frog CLI `create` command implementation.}
  */
 export const create = async (uri: Uri | undefined): Promise<void> => {
+  if (!isDartFrogCLIInstalled()) {
+    await suggestInstallingDartFrogCLI(
+      "Running this command requires Dart Frog CLI to be installed."
+    );
+  }
+
   let outputDirectory =
     uri === undefined ? await promptForTargetDirectory() : uri.fsPath;
 

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

@@ -23,12 +23,15 @@ export const installCLI = async (): Promise<void> => {
  * complete.
  */
 async function installDartFrogCliVersion(): Promise<void> {
-  await cp.exec(
-    `dart pub global activate dart_frog_cli`,
-    function (error: Error, stdout: string, stderr: string) {
-      if (error) {
-        window.showErrorMessage(error.message);
-      }
+  try {
+    await cp.execSync(`dart pub global activate dart_frog_cli`);
+  } catch (error: any) {
+    if (error instanceof Error) {
+      window.showErrorMessage(error.message);
+    } else {
+      window.showErrorMessage(
+        `An error occurred while installing Dart Frog CLI: ${error}`
+      );
     }
-  );
+  }
 }

extensions/vscode/src/commands/new-middleware.ts

@@ -8,9 +8,11 @@ import {
   InputBoxOptions,
 } from "vscode";
 import {
+  isDartFrogCLIInstalled,
   nearestDartFrogProject,
   normalizeRoutePath,
   resolveDartFrogProjectPathFromWorkspace,
+  suggestInstallingDartFrogCLI,
 } from "../utils";
 
 /**
@@ -34,6 +36,12 @@ import {
  * @param {Uri | undefined} uri
  */
 export const newMiddleware = async (uri: Uri | undefined): Promise<void> => {
+  if (!isDartFrogCLIInstalled()) {
+    await suggestInstallingDartFrogCLI(
+      "Running this command requires Dart Frog CLI to be installed."
+    );
+  }
+
   let selectedPath;
   if (uri === undefined) {
     selectedPath = resolveDartFrogProjectPathFromWorkspace();

extensions/vscode/src/commands/new-route.ts

@@ -8,9 +8,11 @@ import {
   ProgressOptions,
 } from "vscode";
 import {
+  isDartFrogCLIInstalled,
   nearestDartFrogProject,
   normalizeRoutePath,
   resolveDartFrogProjectPathFromWorkspace,
+  suggestInstallingDartFrogCLI,
 } from "../utils";
 
 /**
@@ -34,6 +36,12 @@ import {
  * @param {Uri | undefined} uri
  */
 export const newRoute = async (uri: Uri | undefined): Promise<void> => {
+  if (!isDartFrogCLIInstalled()) {
+    await suggestInstallingDartFrogCLI(
+      "Running this command requires Dart Frog CLI to be installed."
+    );
+  }
+
   let selectedPath;
   if (uri === undefined) {
     selectedPath = resolveDartFrogProjectPathFromWorkspace();

extensions/vscode/src/extension.ts

@@ -12,6 +12,7 @@ import {
   isDartFrogCLIInstalled,
   openChangelog,
   readLatestDartFrogCLIVersion,
+  suggestInstallingDartFrogCLI,
 } from "./utils";
 
 /**
@@ -27,11 +28,10 @@ import {
  */
 export function activate(
   context: vscode.ExtensionContext,
-  suggestInstallingCLI: () => Promise<void> = suggestInstallingDartFrogCLI,
   ensureCompatibleCLI: () => Promise<void> = ensureCompatibleDartFrogCLI
 ): vscode.ExtensionContext {
   if (!isDartFrogCLIInstalled()) {
-    suggestInstallingCLI();
+    suggestInstallingDartFrogCLI();
   } else {
     ensureCompatibleCLI();
   }
@@ -46,35 +46,6 @@ 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/commands/create.test.ts

@@ -8,6 +8,7 @@ suite("create command", () => {
 
   let vscodeStub: any;
   let childProcessStub: any;
+  let utilsStub: any;
   let command: any;
 
   beforeEach(() => {
@@ -22,18 +23,44 @@ suite("create command", () => {
     childProcessStub = {
       exec: sinon.stub(),
     };
+    utilsStub = {
+      isDartFrogCLIInstalled: sinon.stub(),
+      suggestInstallingDartFrogCLI: sinon.stub(),
+    };
+    utilsStub.isDartFrogCLIInstalled.returns(true);
 
     command = proxyquire("../../../commands/create", {
       vscode: vscodeStub,
       // eslint-disable-next-line @typescript-eslint/naming-convention
       child_process: childProcessStub,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      "../utils": utilsStub,
     });
   });
 
   afterEach(() => {
     sinon.restore();
   });
 
+  test("suggests installing Dart Frog CLI when not installed", async () => {
+    utilsStub.isDartFrogCLIInstalled.returns(false);
+
+    await command.create(targetUri);
+
+    sinon.assert.calledWith(
+      utilsStub.suggestInstallingDartFrogCLI,
+      "Running this command requires Dart Frog CLI to be installed."
+    );
+  });
+
+  test("does not suggest installing Dart Frog CLI when installed", async () => {
+    utilsStub.isDartFrogCLIInstalled.returns(true);
+
+    await command.create(targetUri);
+
+    sinon.assert.notCalled(utilsStub.suggestInstallingDartFrogCLI);
+  });
+
   test("project input box is shown with directory name as value", async () => {
     await command.create(targetUri);
 

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

@@ -20,7 +20,6 @@ suite("install-cli command", () => {
       },
     };
     childProcessStub = {
-      exec: sinon.stub(),
       execSync: sinon.stub(),
     };
     utilsStub = {
@@ -45,10 +44,7 @@ suite("install-cli command", () => {
 
     await command.installCLI();
 
-    const wantedCalls = childProcessStub.exec
-      .getCalls()
-      .filter((call: any) => call.args[0] === installCommand);
-    assert.equal(wantedCalls.length, 0);
+    sinon.assert.notCalled(childProcessStub.execSync);
   });
 
   suite("installs Dart Frog CLI", () => {
@@ -62,7 +58,7 @@ suite("install-cli command", () => {
       let progressFunction = vscodeStub.window.withProgress.getCall(0).args[1];
       await progressFunction();
 
-      sinon.assert.calledWith(childProcessStub.exec, installCommand);
+      sinon.assert.calledWith(childProcessStub.execSync, installCommand);
     });
 
     test("shows progress", async () => {
@@ -76,7 +72,7 @@ suite("install-cli command", () => {
 
     test("shows error message on failure", async () => {
       const error = new Error("Command failed");
-      childProcessStub.exec.withArgs(installCommand).yields(error);
+      childProcessStub.execSync.withArgs(installCommand).throws(error);
 
       await command.installCLI();
 
@@ -89,5 +85,21 @@ suite("install-cli command", () => {
         error.message
       );
     });
+
+    test("shows unknown error message on unknown failure", async () => {
+      const error = 2;
+      childProcessStub.execSync.withArgs(installCommand).throws(error);
+
+      await command.installCLI();
+
+      const progressFunction =
+        vscodeStub.window.withProgress.getCall(0).args[1];
+      await progressFunction();
+
+      sinon.assert.calledWith(
+        vscodeStub.window.showErrorMessage,
+        `An error occurred while installing Dart Frog CLI: ${error}`
+      );
+    });
   });
 });

extensions/vscode/src/test/suite/commands/new-middleware.test.ts

@@ -29,7 +29,10 @@ suite("new-middleware command", () => {
       nearestDartFrogProject: sinon.stub(),
       normalizeRoutePath: sinon.stub(),
       resolveDartFrogProjectPathFromWorkspace: sinon.stub(),
+      isDartFrogCLIInstalled: sinon.stub(),
+      suggestInstallingDartFrogCLI: sinon.stub(),
     };
+    utilsStub.isDartFrogCLIInstalled.returns(true);
 
     utilsStub.nearestDartFrogProject
       .withArgs(invalidUri.fsPath)
@@ -51,6 +54,25 @@ suite("new-middleware command", () => {
     sinon.restore();
   });
 
+  test("suggests installing Dart Frog CLI when not installed", async () => {
+    utilsStub.isDartFrogCLIInstalled.returns(false);
+
+    await command.newMiddleware(validUri);
+
+    sinon.assert.calledWith(
+      utilsStub.suggestInstallingDartFrogCLI,
+      "Running this command requires Dart Frog CLI to be installed."
+    );
+  });
+
+  test("does not suggest installing Dart Frog CLI when installed", async () => {
+    utilsStub.isDartFrogCLIInstalled.returns(true);
+
+    await command.newMiddleware(validUri);
+
+    sinon.assert.notCalled(utilsStub.suggestInstallingDartFrogCLI);
+  });
+
   suite("file open dialog", () => {
     test("is shown when Uri is undefined and fails to resolve a path from workspace", async () => {
       vscodeStub.window.showOpenDialog.resolves();

extensions/vscode/src/test/suite/commands/new-route.test.ts

@@ -31,6 +31,8 @@ suite("new-route command", () => {
       nearestDartFrogProject: sinon.stub(),
       normalizeRoutePath: sinon.stub(),
       resolveDartFrogProjectPathFromWorkspace: sinon.stub(),
+      isDartFrogCLIInstalled: sinon.stub(),
+      suggestInstallingDartFrogCLI: sinon.stub(),
     };
 
     utilsStub.nearestDartFrogProject
@@ -39,6 +41,8 @@ suite("new-route command", () => {
     utilsStub.nearestDartFrogProject
       .withArgs(validUri.fsPath)
       .returns(validUri.fsPath);
+    utilsStub.isDartFrogCLIInstalled.returns(true);
+    utilsStub.suggestInstallingDartFrogCLI.resolves();
 
     command = proxyquire("../../../commands/new-route", {
       vscode: vscodeStub,
@@ -53,6 +57,27 @@ suite("new-route command", () => {
     sinon.restore();
   });
 
+  test("suggests installing Dart Frog CLI when not installed", async () => {
+    utilsStub.isDartFrogCLIInstalled.returns(false);
+    utilsStub.normalizeRoutePath.returns("/");
+
+    await command.newRoute(validUri);
+
+    sinon.assert.calledWith(
+      utilsStub.suggestInstallingDartFrogCLI,
+      "Running this command requires Dart Frog CLI to be installed."
+    );
+  });
+
+  test("does not suggest installing Dart Frog CLI when installed", async () => {
+    utilsStub.isDartFrogCLIInstalled.returns(true);
+    utilsStub.normalizeRoutePath.returns("/");
+
+    await command.newRoute(validUri);
+
+    sinon.assert.notCalled(utilsStub.suggestInstallingDartFrogCLI);
+  });
+
   suite("shows input box to input route path", () => {
     test("without suffixing / when not required", async () => {
       utilsStub.normalizeRoutePath.returns("/");