fix(vscode): avoid keeping progress when spamming stop server (#1053)

Author: alestiago

extensions/vscode/src/commands/stop-dev-server.ts

@@ -85,7 +85,9 @@ export const stopDevServer = async (): Promise<void> => {
 
       const stopDaemonResponse = await daemon.send(stopRequest);
       if (stopDaemonResponse.error) {
-        window.showErrorMessage(stopDaemonResponse.error.message);
+        if (stopDaemonResponse.error.message !== "Application not found") {
+          window.showErrorMessage(stopDaemonResponse.error.message);
+        }
         return;
       }
 

extensions/vscode/src/daemon/dart-frog-daemon.ts

@@ -233,7 +233,7 @@ export class DartFrogDaemon {
 
     const responsePromise = new Promise<DaemonResponse>((resolve) => {
       const responseListener = (message: DaemonResponse) => {
-        if (message.id === request.id && message.result) {
+        if (message.id === request.id && (message.result || message.error)) {
           this.off(DartFrogDaemonEventEmitterTypes.response, responseListener);
           resolve(message);
         }

extensions/vscode/src/test/suite/commands/stop-dev-server.test.ts

@@ -305,31 +305,60 @@ suite("stop-dev-server command", () => {
       });
     });
 
-    test("shows error message when error occurs", async () => {
-      const stopResponse: DaemonResponse = {
-        id: stopRequest.id,
-        result: undefined,
-        error: {
-          message: "error message",
-        },
-      };
-      daemon.send.withArgs(stopRequest).resolves(stopResponse);
+    suite("stop error message", () => {
+      test("is shown when error occurs", async () => {
+        const stopResponse: DaemonResponse = {
+          id: stopRequest.id,
+          result: undefined,
+          error: {
+            message: "error message",
+          },
+        };
+        daemon.send.withArgs(stopRequest).resolves(stopResponse);
 
-      await command.stopDevServer();
+        await command.stopDevServer();
 
-      const deregistrationListener =
-        daemon.applicationRegistry.on.getCall(0).args[1];
-      deregistrationListener(application);
+        const deregistrationListener =
+          daemon.applicationRegistry.on.getCall(0).args[1];
+        deregistrationListener(application);
 
-      const progressFunction =
-        vscodeStub.window.withProgress.getCall(0).args[1];
-      await progressFunction(progress);
+        const progressFunction =
+          vscodeStub.window.withProgress.getCall(0).args[1];
+        await progressFunction(progress);
 
-      sinon.assert.calledWith(
-        vscodeStub.window.showErrorMessage,
-        stopResponse.error.message
-      );
-      sinon.assert.calledOnce(progress.report);
+        sinon.assert.calledWith(
+          vscodeStub.window.showErrorMessage,
+          stopResponse.error.message
+        );
+        sinon.assert.calledOnce(progress.report);
+      });
+
+      test('is not shown when error is "Application not found"', async () => {
+        const stopResponse: DaemonResponse = {
+          id: stopRequest.id,
+          result: undefined,
+          error: {
+            message: "Application not found",
+          },
+        };
+        daemon.send.withArgs(stopRequest).resolves(stopResponse);
+
+        await command.stopDevServer();
+
+        const deregistrationListener =
+          daemon.applicationRegistry.on.getCall(0).args[1];
+        deregistrationListener(application);
+
+        const progressFunction =
+          vscodeStub.window.withProgress.getCall(0).args[1];
+        await progressFunction(progress);
+
+        sinon.assert.neverCalledWith(
+          vscodeStub.window.showErrorMessage,
+          stopResponse.error.message
+        );
+        sinon.assert.calledOnce(progress.report);
+      });
     });
 
     test("takes at least 250ms before resolving", async () => {

extensions/vscode/src/test/suite/daemon/dart-frog-daemon.test.ts

@@ -411,6 +411,29 @@ suite("DartFrogDaemon", () => {
 
         assert.deepEqual(actualResponse, expectedResponse);
       });
+
+      test("resolves correct response upon error", async () => {
+        const request = new RequestVersionDaemonRequest("1");
+
+        const responsePromise = daemon.send(request);
+
+        const anotherResponse = `[{"id":"2","result":{"version":"0.0.1"}}]`;
+        stdout.emit("data", anotherResponse);
+
+        const response = `[{"id":"1","error":{"version":"0.0.1"}}]`;
+        stdout.emit("data", response);
+
+        const actualResponse = await responsePromise;
+
+        const expectedResponse = {
+          id: "1",
+          error: {
+            version: "0.0.1",
+          },
+        };
+
+        assert.deepEqual(actualResponse, expectedResponse);
+      });
     });
   });
 });

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

@@ -27,28 +27,28 @@ suite("readDartFrogCLIVersion", () => {
     "returns the version of Dart Frog CLI installed in the user's system",
     () => {
       test("when on latest version", () => {
-        const dartFrogVersionCommandResult = "0.3.7\n";
+        const dartFrogVersionCommandResult = "1.1.1\n";
         const encodedDartFrogVersionCommandResult = new TextEncoder().encode(
           dartFrogVersionCommandResult
         );
         cpStub.execSync.returns(encodedDartFrogVersionCommandResult);
 
-        assert.strictEqual(cliVersion.readDartFrogCLIVersion(), "0.3.7");
+        assert.strictEqual(cliVersion.readDartFrogCLIVersion(), "1.1.1");
       });
 
       test("when new version is available", () => {
-        const dartFrogVersionCommandResult = `0.3.7
+        const dartFrogVersionCommandResult = `1.1.1
 
-        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\\
+        Update available! 1.1.1 → 1.1.2
+        Changelog: \u001b]8;;https://github.com/verygoodopensource/dart_frog/releases/tag/dart_frog_cli-v1.1.2\u001b\\https://github.com/verygoodopensource/dart_frog/releases/tag/dart_frog_cli-v1.1.2\u001b]8;;\u001b\\
         Run dart_frog update to update
         `;
         const encodedDartFrogVersionCommandResult = new TextEncoder().encode(
           dartFrogVersionCommandResult
         );
         cpStub.execSync.returns(encodedDartFrogVersionCommandResult);
 
-        assert.strictEqual(cliVersion.readDartFrogCLIVersion(), "0.3.7");
+        assert.strictEqual(cliVersion.readDartFrogCLIVersion(), "1.1.1");
       });
     }
   );
@@ -81,28 +81,28 @@ suite("readLatestDartFrogCLIVersion", () => {
 
   suite("returns the latest version of Dart Frog CLI", () => {
     test("when on latest version", () => {
-      const dartFrogVersionCommandResult = "0.3.9\n";
+      const dartFrogVersionCommandResult = "1.1.2\n";
       const encodedDartFrogVersionCommandResult = new TextEncoder().encode(
         dartFrogVersionCommandResult
       );
       cpStub.execSync.returns(encodedDartFrogVersionCommandResult);
 
-      assert.strictEqual(cliVersion.readLatestDartFrogCLIVersion(), "0.3.9");
+      assert.strictEqual(cliVersion.readLatestDartFrogCLIVersion(), "1.1.2");
     });
 
     test("when new version is available", () => {
-      const dartFrogVersionCommandResult = `0.3.7
+      const dartFrogVersionCommandResult = `1.1.1
 
-        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\\
+        Update available! 1.1.1 → 1.1.2
+        Changelog: \u001b]8;;https://github.com/verygoodopensource/dart_frog/releases/tag/dart_frog_cli-v1.1.2\u001b\\https://github.com/verygoodopensource/dart_frog/releases/tag/dart_frog_cli-v1.1.2\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");
+      assert.strictEqual(cliVersion.readLatestDartFrogCLIVersion(), "1.1.2");
     });
   });
 
@@ -122,15 +122,11 @@ suite("isCompatibleDartFrogCLIVersion", () => {
 
   test("returns true if the version of Dart Frog CLI installed in the user's system is compatible with this extension", () => {
     assert.strictEqual(
-      cliVersion.isCompatibleDartFrogCLIVersion("0.3.8"),
+      cliVersion.isCompatibleDartFrogCLIVersion("1.1.1"),
       true
     );
     assert.strictEqual(
-      cliVersion.isCompatibleDartFrogCLIVersion("0.3.7"),
-      true
-    );
-    assert.strictEqual(
-      cliVersion.isCompatibleDartFrogCLIVersion("1.0.0"),
+      cliVersion.isCompatibleDartFrogCLIVersion("1.1.2"),
       true
     );
   });
@@ -141,7 +137,7 @@ suite("isCompatibleDartFrogCLIVersion", () => {
       false
     );
     assert.strictEqual(
-      cliVersion.isCompatibleDartFrogCLIVersion("0.3.6"),
+      cliVersion.isCompatibleDartFrogCLIVersion("0.3.8"),
       false
     );
   });

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

@@ -6,7 +6,7 @@ const semver = require("semver");
  * The semantic version constraints for Dart Frog CLI to be compatible with this
  * extension.
  */
-const compatibleCLIVersion = ">=0.3.7 <2.0.0";
+const compatibleCLIVersion = ">=1.1.1 <2.0.0";
 
 /**
  * Collects the version of Dart Frog CLI installed in the user's system.