feat(vscode): add changelog button to warning message (#822)

Author: jsgalarraga

extensions/vscode/src/extension.ts

@@ -10,6 +10,8 @@ import {
   readDartFrogCLIVersion,
   isCompatibleDartFrogCLIVersion,
   isDartFrogCLIInstalled,
+  openChangelog,
+  readLatestDartFrogCLIVersion,
 } from "./utils";
 
 /**
@@ -105,15 +107,24 @@ export async function ensureCompatibleDartFrogCLI(): Promise<void> {
     return;
   }
 
+  const latestVersion = readLatestDartFrogCLIVersion();
+  if (!latestVersion) {
+    return;
+  }
+
   const selection = await vscode.window.showWarningMessage(
     `Dart Frog CLI version ${version} is not compatible with this extension.`,
     "Update Dart Frog CLI",
+    "Changelog",
     "Ignore"
   );
   switch (selection) {
     case "Update Dart Frog CLI":
       updateCLI();
       break;
+    case "Changelog":
+      openChangelog(latestVersion);
+      break;
     case "Ignore":
       break;
     default:

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

@@ -222,11 +222,16 @@ suite("ensureCompatibleDartFrogCLI", () => {
       window: {
         showWarningMessage: sinon.stub(),
       },
+      commands: {
+        executeCommand: sinon.stub(),
+      },
     };
 
     utilsStub = {
       readDartFrogCLIVersion: sinon.stub(),
       isCompatibleDartFrogCLIVersion: sinon.stub(),
+      readLatestDartFrogCLIVersion: sinon.stub(),
+      openChangelog: sinon.stub(),
     };
     commandsStub = {
       updateCLI: sinon.stub(),
@@ -262,12 +267,23 @@ suite("ensureCompatibleDartFrogCLI", () => {
     sinon.assert.notCalled(vscodeStub.window.showWarningMessage);
   });
 
+  test("does not show warning when latest version cannot be retrieved", async () => {
+    utilsStub.readDartFrogCLIVersion.returns("1.0.0");
+    utilsStub.isCompatibleDartFrogCLIVersion.returns(false);
+    utilsStub.readLatestDartFrogCLIVersion.returns(undefined);
+
+    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);
+      utilsStub.readLatestDartFrogCLIVersion.returns(version);
     });
 
     afterEach(() => {
@@ -281,6 +297,7 @@ suite("ensureCompatibleDartFrogCLI", () => {
         vscodeStub.window.showWarningMessage,
         `Dart Frog CLI version ${version} is not compatible with this extension.`,
         "Update Dart Frog CLI",
+        "Changelog",
         "Ignore"
       );
     });
@@ -293,6 +310,15 @@ suite("ensureCompatibleDartFrogCLI", () => {
       sinon.assert.calledOnce(commandsStub.updateCLI);
     });
 
+    test("opens changelog when selected", async () => {
+      vscodeStub.window.showWarningMessage.returns("Changelog");
+
+      await extension.ensureCompatibleDartFrogCLI();
+
+      sinon.assert.calledOnceWithExactly(utilsStub.openChangelog, version);
+      sinon.assert.notCalled(commandsStub.updateCLI);
+    });
+
     test("does not update CLI when ignored", async () => {
       vscodeStub.window.showWarningMessage.returns("Ignore");
 

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

@@ -60,6 +60,59 @@ suite("readDartFrogCLIVersion", () => {
   });
 });
 
+suite("readLatestDartFrogCLIVersion", () => {
+  let cpStub: any;
+  let cliVersion: any;
+
+  beforeEach(() => {
+    cpStub = {
+      execSync: sinon.stub(),
+    };
+
+    cliVersion = proxyquire("../../../utils/cli-version", {
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      child_process: cpStub,
+    });
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  suite("returns the latest version of Dart Frog CLI", () => {
+    test("when on latest version", () => {
+      const dartFrogVersionCommandResult = "0.3.9\n";
+      const encodedDartFrogVersionCommandResult = new TextEncoder().encode(
+        dartFrogVersionCommandResult
+      );
+      cpStub.execSync.returns(encodedDartFrogVersionCommandResult);
+
+      assert.strictEqual(cliVersion.readLatestDartFrogCLIVersion(), "0.3.9");
+    });
+
+    test("when new version is available", () => {
+      const dartFrogVersionCommandResult = `0.3.7
+
+        Update available! 0.3.7 → 0.3.9
+        Changelog: \u001b]8;;https://github.com/verygoodopensource/dart_frog/releases/tag/dart_frog_cli-v0.3.9\u001b\\https://github.com/verygoodopensource/dart_frog/releases/tag/dart_frog_cli-v0.3.9\u001b]8;;\u001b\\
+        Run dart_frog update to update
+        `;
+      const encodedDartFrogVersionCommandResult = new TextEncoder().encode(
+        dartFrogVersionCommandResult
+      );
+      cpStub.execSync.returns(encodedDartFrogVersionCommandResult);
+
+      assert.strictEqual(cliVersion.readLatestDartFrogCLIVersion(), "0.3.9");
+    });
+  });
+
+  test("returns undefined if Dart Frog CLI is not installed", () => {
+    cpStub.execSync.throws();
+
+    assert.strictEqual(cliVersion.readLatestDartFrogCLIVersion(), undefined);
+  });
+});
+
 suite("isCompatibleDartFrogCLIVersion", () => {
   let cliVersion: any;
 
@@ -89,3 +142,42 @@ suite("isCompatibleDartFrogCLIVersion", () => {
     );
   });
 });
+
+suite("openChangelog", () => {
+  let vscodeStub: any;
+  let cliVersion: any;
+
+  beforeEach(() => {
+    vscodeStub = {
+      commands: {
+        executeCommand: sinon.stub(),
+      },
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      Uri: {
+        parse: sinon.stub(),
+      },
+    };
+
+    cliVersion = proxyquire("../../../utils/cli-version", {
+      vscode: vscodeStub,
+    });
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test("triggers vscode.open command with correct url", async () => {
+    const version = "0.0.0";
+    const url = "https://github.com";
+    vscodeStub.Uri.parse.returns(url);
+
+    await cliVersion.openChangelog(version);
+
+    sinon.assert.calledOnceWithExactly(
+      vscodeStub.commands.executeCommand,
+      "vscode.open",
+      url
+    );
+  });
+});

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

@@ -1,3 +1,4 @@
+import * as vscode from "vscode";
 const cp = require("child_process");
 const semver = require("semver");
 
@@ -23,6 +24,26 @@ export function readDartFrogCLIVersion(): String | undefined {
   }
 }
 
+/**
+ * Collects the latest available version of Dart Frog CLI.
+ *
+ * @returns {String | undefined} The latest available semantic version of
+ * Dart Frog CLI, or undefined if Dart Frog CLI is not installed.
+ */
+export function readLatestDartFrogCLIVersion(): String | undefined {
+  try {
+    const result = cp.execSync(`dart_frog --version`);
+    const decodedResult = new TextDecoder().decode(result);
+    const lines = decodedResult.split("\n");
+    if (lines.length <= 2) {
+      return lines.at(0);
+    }
+    return lines.at(2)?.split(" ").at(-1);
+  } catch (error) {
+    return undefined;
+  }
+}
+
 /**
  * Checks if the version of Dart Frog CLI installed in the user's system is
  * compatible with this extension.
@@ -46,3 +67,18 @@ export function isCompatibleDartFrogCLIVersion(version: String): Boolean {
 export function isDartFrogCLIInstalled(): boolean {
   return readDartFrogCLIVersion() !== undefined;
 }
+
+/**
+ * Opens the changelog for the specified version in a browser.
+ *
+ * @param {String} version The semantic version of Dart Frog CLI which changelog
+ * is requested to open.
+ */
+export async function openChangelog(version: String): Promise<void> {
+  vscode.commands.executeCommand(
+    "vscode.open",
+    vscode.Uri.parse(
+      `https://github.com/verygoodopensource/dart_frog/releases/tag/dart_frog_cli-v${version}`
+    )
+  );
+}