feat(vscode): ensure dart_frog_cli is installed when used (#726)

Author: alestiago

extensions/vscode/README.md

@@ -11,10 +11,11 @@ Dart Frog can be installed from the [VS Code Marketplace](https://marketplace.vi
 
 ## Commands
 
-| Command                 | Description                |
-| ----------------------- | -------------------------- |
-| `Route: New Route`      | Generates a new route      |
-| `Route: New Middleware` | Generates a new middleware |
+| Command                     | Description                |
+| --------------------------- | -------------------------- |
+| `Dart Frog: Install CLI`    | Installs Dart Frog CLI     |
+| `Dart Frog: New Route`      | Generates a new route      |
+| `Dart Frog: New Middleware` | Generates a new middleware |
 
 You can activate the commands by launching the command palette (View -> Command Palette) and entering the command name or you can right click on the directory or file in which you'd like to create the route and select the command from the context menu.
 

extensions/vscode/package.json

@@ -31,6 +31,10 @@
   "main": "./out/extension.js",
   "contributes": {
     "commands": [
+      {
+        "command": "extension.install-cli",
+        "title": "Dart Frog: Install CLI"
+      },
       {
         "command": "extension.new-route",
         "title": "Dart Frog: New Route"
@@ -55,6 +59,9 @@
       ]
     }
   },
+  "extensionDependencies": [
+    "Dart-Code.dart-code"
+  ],
   "scripts": {
     "vscode:prepublish": "npm run compile",
     "compile": "tsc -p ./",

extensions/vscode/src/commands/index.ts

@@ -1,2 +1,3 @@
+export * from "./install-cli";
 export * from "./new-route";
 export * from "./new-middleware";

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

@@ -0,0 +1,48 @@
+const cp = require("child_process");
+
+import { window, ProgressOptions } from "vscode";
+
+/**
+ * Installs Dart Frog CLI in the user's system if not already installed.
+ */
+export const installCLI = async (): Promise<void> => {
+  if (!hasDartFrogCliInstalled()) {
+    const options: ProgressOptions = {
+      location: 15,
+      title: "Installing Dart Frog CLI...",
+    };
+    window.withProgress(options, installDartFrogCliVersion);
+  }
+};
+
+/**
+ * Whether the user has Dart Frog CLI installed in their system.
+ *
+ * @returns {boolean} True if the user has Dart Frog CLI installed in their
+ * system, false otherwise.
+ */
+function hasDartFrogCliInstalled(): boolean {
+  try {
+    cp.execSync(`dart_frog --version`);
+    return true;
+  } catch (error) {
+    return false;
+  }
+}
+
+/**
+ * Installs Dart Frog CLI from pub.dev.
+ *
+ * @returns {Promise<void>} A promise that resolves when the installation is
+ * 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);
+      }
+    }
+  );
+}

extensions/vscode/src/extension.ts

@@ -1,5 +1,5 @@
 import * as vscode from "vscode";
-import { newRoute, newMiddleware } from "./commands";
+import { installCLI, newRoute, newMiddleware } from "./commands";
 
 /**
  * This method is called when the extension is activated.
@@ -12,11 +12,12 @@ import { newRoute, newMiddleware } from "./commands";
 export function activate(
   context: vscode.ExtensionContext
 ): vscode.ExtensionContext {
+  installCLI();
+
   context.subscriptions.push(
+    vscode.commands.registerCommand("extension.install-cli", installCLI),
     vscode.commands.registerCommand("extension.new-route", newRoute),
     vscode.commands.registerCommand("extension.new-middleware", newMiddleware)
   );
   return context;
 }
-
-export function deactivate() {}

extensions/vscode/src/test/runTest.ts

@@ -7,19 +7,37 @@
  * @see https://github.com/prettier/prettier-vscode/blob/main/src/test/runTests.ts
  */
 
+import * as cp from "child_process";
 import * as path from "path";
-import { runTests } from "@vscode/test-electron";
+import {
+  runTests,
+  downloadAndUnzipVSCode,
+  resolveCliArgsFromVSCodeExecutablePath,
+} from "@vscode/test-electron";
 
 async function main() {
   try {
     const extensionDevelopmentPath = path.resolve(__dirname, "../../");
     const extensionTestsPath = path.resolve(__dirname, "./suite/index");
+    const vscodeExecutablePath = await downloadAndUnzipVSCode();
+    const [cliPath, ...args] =
+      resolveCliArgsFromVSCodeExecutablePath(vscodeExecutablePath);
+
+    // Install Dart Code extension
+    cp.spawnSync(
+      cliPath,
+      [...args, "--install-extension", "Dart-Code.dart-code"],
+      {
+        encoding: "utf-8",
+        stdio: "inherit",
+      }
+    );
 
     // Download VS Code, unzip it and run the integration test
     await runTests({
+      vscodeExecutablePath,
       extensionDevelopmentPath,
       extensionTestsPath,
-      launchArgs: ["--disable-extensions"],
     });
   } catch (err) {
     console.error("❌ Failed to run tests");

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

@@ -0,0 +1,89 @@
+const sinon = require("sinon");
+var proxyquire = require("proxyquire");
+
+import { afterEach, beforeEach } from "mocha";
+import * as assert from "assert";
+
+suite("install-cli command", () => {
+  const updateCommand = `dart pub global activate dart_frog_cli`;
+
+  let vscodeStub: any;
+  let childProcessStub: any;
+  let command: any;
+
+  beforeEach(() => {
+    vscodeStub = {
+      window: {
+        showErrorMessage: sinon.stub(),
+        withProgress: sinon.stub(),
+      },
+    };
+    childProcessStub = {
+      exec: sinon.stub(),
+      execSync: sinon.stub(),
+    };
+
+    command = proxyquire("../../../commands/install-cli", {
+      vscode: vscodeStub,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      child_process: childProcessStub,
+    });
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test("does not install if Dart Frog CLI is already installed", async () => {
+    childProcessStub.execSync.withArgs("dart_frog --version").returns("0.0.0");
+
+    await command.installCLI();
+
+    const wantedCalls = childProcessStub.exec
+      .getCalls()
+      .filter((call: any) => call.args[0] === updateCommand);
+    assert.equal(wantedCalls.length, 0);
+  });
+
+  suite("installs Dart Frog CLI", () => {
+    beforeEach(() => {
+      childProcessStub.execSync
+        .withArgs("dart_frog --version")
+        .throws("Command failed");
+    });
+
+    test("when not already installed", async () => {
+      await command.installCLI();
+
+      let progressFunction = vscodeStub.window.withProgress.getCall(0).args[1];
+      await progressFunction();
+
+      sinon.assert.calledWith(childProcessStub.exec, updateCommand);
+    });
+
+    test("shows progress", async () => {
+      await command.installCLI();
+
+      const progressOptions = vscodeStub.window.withProgress.getCall(0).args[0];
+
+      assert.strictEqual(progressOptions.title, "Installing Dart Frog CLI...");
+      assert.strictEqual(progressOptions.location, 15);
+    });
+
+    test("shows error message on failure", async () => {
+      const error = new Error("Command failed");
+      childProcessStub.exec.withArgs(updateCommand).yields(error);
+
+      await command.installCLI();
+
+      const progressFunction =
+        vscodeStub.window.withProgress.getCall(0).args[1];
+      await progressFunction();
+
+      sinon.assert.calledWith(
+        vscodeStub.window.showErrorMessage,
+        error.message
+      );
+    });
+  });
+});

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

@@ -3,7 +3,7 @@ var proxyquire = require("proxyquire");
 
 import * as assert from "assert";
 import * as vscode from "vscode";
-import { newMiddleware, newRoute } from "../../commands";
+import { installCLI, newMiddleware, newRoute } from "../../commands";
 import { afterEach, beforeEach } from "mocha";
 
 suite("activate", () => {
@@ -26,14 +26,31 @@ suite("activate", () => {
           registerCommand: sinon.stub(),
         },
       };
-      extension = proxyquire("../../extension", { vscode: vscodeStub });
+      const childProcessStub = {
+        execSync: sinon.stub(),
+      };
+      extension = proxyquire("../../extension", {
+        vscode: vscodeStub,
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        child_process: childProcessStub,
+      });
       context = { subscriptions: [] };
     });
 
     afterEach(() => {
       sinon.restore();
     });
 
+    test("install-cli", async () => {
+      extension.activate(context);
+
+      sinon.assert.calledWith(
+        vscodeStub.commands.registerCommand,
+        "extension.install-cli",
+        installCLI
+      );
+    });
+
     test("new-route", async () => {
       extension.activate(context);
 
@@ -54,4 +71,23 @@ suite("activate", () => {
       );
     });
   });
+
+  test("calls installCLI", async () => {
+    const vscodeStub = {
+      commands: {
+        registerCommand: sinon.stub(),
+      },
+    };
+    const installCLIStub = sinon.stub();
+    const extension = proxyquire("../../extension", {
+      vscode: vscodeStub,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      "./commands": { installCLI: installCLIStub },
+    });
+    const context = { subscriptions: [] };
+
+    extension.activate(context);
+
+    sinon.assert.calledOnce(installCLIStub);
+  });
 });