Handle language server crashes (#106)

* Handle language server crashes

Relates to #91

* test language server crash behavior

* lint

* Update nova editor types

* Update CHANGELOG.md

Author: apexskier

package.json

@@ -30,7 +30,7 @@
     "@rollup/plugin-commonjs": "^15.1.0",
     "@rollup/plugin-node-resolve": "^9.0.0",
     "@types/jest": "^26.0.15",
-    "@types/nova-editor-node": "^1.2.2",
+    "@types/nova-editor-node": "^2.0.0",
     "@typescript-eslint/eslint-plugin": "^4.0.0",
     "@typescript-eslint/parser": "^3.10.1",
     "concurrently": "^5.3.0",

src/main.test.ts

@@ -14,6 +14,7 @@ jest.useFakeTimers();
 (global as any).nova = Object.assign(nova, {
   commands: {
     register: jest.fn(),
+    invoke: jest.fn(),
   },
   workspace: {
     path: "/workspace",
@@ -71,6 +72,7 @@ describe("test suite", () => {
     LanguageClientMock.mockReset().mockImplementation(() => ({
       onRequest: jest.fn(),
       onNotification: jest.fn(),
+      onDidStop: jest.fn(),
       start: jest.fn(),
       stop: jest.fn(),
     }));
@@ -230,6 +232,50 @@ describe("test suite", () => {
       );
     });
 
+    it("handles unexpected crashes", async () => {
+      resetMocks();
+      nova.workspace.showActionPanel = jest.fn();
+
+      await activate();
+
+      const languageClient: LanguageClient =
+        LanguageClientMock.mock.results[0].value;
+      const stopCallback = (languageClient.onDidStop as jest.Mock).mock
+        .calls[0][0];
+
+      stopCallback(new Error("Mock language server crash"));
+
+      expect(nova.workspace.showActionPanel).toBeCalledTimes(1);
+      const actionPanelCall = (nova.workspace.showActionPanel as jest.Mock).mock
+        .calls[0];
+      expect(actionPanelCall[0]).toMatchInlineSnapshot(`
+        "TypeScript Language Server stopped unexpectedly:
+
+        Error: Mock language server crash
+
+        Please report this, along with any output in the Extension Console."
+      `);
+      expect(actionPanelCall[1].buttons).toHaveLength(2);
+
+      const informationView = (informationViewModule.InformationView as jest.Mock<
+        informationViewModule.InformationView
+      >).mock.instances[0];
+      expect(informationView.status).toBe("Stopped");
+
+      const actionCallback = actionPanelCall[2];
+
+      // reload
+      expect(nova.commands.invoke).not.toBeCalled();
+      actionCallback(0);
+      expect(nova.commands.invoke).toBeCalledTimes(1);
+      expect(nova.commands.invoke).toBeCalledWith(
+        "apexskier.typescript.reload"
+      );
+
+      // ignore
+      actionCallback(1);
+    });
+
     test("reload", async () => {
       resetMocks();
 

src/main.ts

@@ -158,14 +158,31 @@ async function asyncActivate() {
     compositeDisposable.add(registerSignatureHelp(client));
   }
 
-  // Not working, I'm guessing Nova intercepts this notification.
-  client.onNotification("initialized", () => {
-    console.log("initialized");
-  });
+  compositeDisposable.add(
+    client.onDidStop((err) => {
+      informationView.status = "Stopped";
 
-  client.onNotification("window/showMessage", (params) => {
-    console.log("window/showMessage", JSON.stringify(params));
-  });
+      let message = "TypeScript Language Server stopped unexpectedly";
+      if (err) {
+        message += `:\n\n${err.toString()}`;
+      } else {
+        message += ".";
+      }
+      message +=
+        "\n\nPlease report this, along with any output in the Extension Console.";
+      nova.workspace.showActionPanel(
+        message,
+        {
+          buttons: ["Restart", "Ignore"],
+        },
+        (index) => {
+          if (index == 0) {
+            nova.commands.invoke("apexskier.typescript.reload");
+          }
+        }
+      );
+    })
+  );
 
   client.start();
 

typescript.novaextension/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## future
+
+## Fixed
+
+- Handle language server crashes more gracefully
+
 ## v2.0.0
 
 ### Fixed

typescript.novaextension/extension.json

@@ -10,6 +10,7 @@
   "bugs": "https://github.com/apexskier/nova-typescript/issues",
 
   "main": "main.dist.js",
+  "min_runtime": "2.0",
 
   "activationEvents": [
     "onLanguage:typescript",

yarn.lock

@@ -678,10 +678,10 @@
   resolved "https://registry.yarnpkg.com/@types/normalize-package-data/-/normalize-package-data-2.4.0.tgz#e486d0d97396d79beedd0a6e33f4534ff6b4973e"
   integrity sha512-f5j5b/Gf71L+dbqxIpQ4Z2WlmI/mPJ0fOkGGmFgtb6sAu97EPczzbS3/tJKxmcYDj55OX6ssqwDAWOHIYDRDGA==
 
-"@types/nova-editor-node@^1.2.2":
-  version "1.2.2"
-  resolved "https://registry.yarnpkg.com/@types/nova-editor-node/-/nova-editor-node-1.2.2.tgz#4da949f86621a46c2e7fc2dfcbb01db06a0e6fb8"
-  integrity sha512-4FgSEzeeGWHIhU3v48+Eap+zjeoddMmXl2fv8zpFbVWIx3bXrIR7ATn+9Z41bHg0+AGdWU8BOenpo0oDpTz0+A==
+"@types/nova-editor-node@^2.0.0":
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/@types/nova-editor-node/-/nova-editor-node-2.0.0.tgz#1e948c0ce355590ca4b69ff25fef5e166fc5f7bd"
+  integrity sha512-vbE4WkHKaR/NJBz/ge+ygdacVlTU1mOtZr75AgZrGK07XrHZUiAoBWp1nMIb6/JEuOM0jgu02N0AJr3iS3JmNw==
 
 "@types/prettier@^2.0.0":
   version "2.0.2"