Remove ERB from document selector for outdated servers

Shopify · Jul 15, 2024 · 22a772d · 22a772d
1 parent e7f54ad
commit 22a772d
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 6 deletions.
diff --git a/lib/ruby_lsp/server.rb b/lib/ruby_lsp/server.rb
@@ -205,6 +205,7 @@ def run_initialize(message)
           type_hierarchy_provider: type_hierarchy_provider,
           experimental: {
             addon_detection: true,
+            erb_support: true,
           },
         ),
         serverInfo: {

diff --git a/vscode/src/client.ts b/vscode/src/client.ts
@@ -21,6 +21,7 @@ import {
   ErrorAction,
   CloseAction,
   State,
+  DocumentFilter,
 } from "vscode-languageclient/node";
 
 import {
@@ -106,6 +107,7 @@ function collectClientOptions(
   outputChannel: WorkspaceChannel,
   ruby: Ruby,
   isMainWorkspace: boolean,
+  erbSupport: boolean,
 ): LanguageClientOptions {
   const pullOn: "change" | "save" | "both" =
     configuration.get("pullDiagnosticsOn")!;
@@ -119,7 +121,7 @@ function collectClientOptions(
   const enabledFeatures = Object.keys(features).filter((key) => features[key]);
 
   const fsPath = workspaceFolder.uri.fsPath.replace(/\/$/, "");
-  const documentSelector: DocumentSelector = SUPPORTED_LANGUAGE_IDS.map(
+  let documentSelector: DocumentSelector = SUPPORTED_LANGUAGE_IDS.map(
     (language) => {
       return { language, pattern: `${fsPath}/**/*` };
     },
@@ -158,6 +160,12 @@ function collectClientOptions(
     });
   }
 
+  if (!erbSupport) {
+    documentSelector = documentSelector.filter((selector) => {
+      return (selector as DocumentFilter).language !== "erb";
+    });
+  }
+
   return {
     documentSelector,
     workspaceFolder,
@@ -234,6 +242,7 @@ export default class Client extends LanguageClient implements ClientInterface {
     workspaceFolder: vscode.WorkspaceFolder,
     outputChannel: WorkspaceChannel,
     isMainWorkspace = false,
+    erbSupport = true,
   ) {
     super(
       LSP_NAME,
@@ -244,6 +253,7 @@ export default class Client extends LanguageClient implements ClientInterface {
         outputChannel,
         ruby,
         isMainWorkspace,
+        erbSupport,
       ),
     );
 

diff --git a/vscode/src/workspace.ts b/vscode/src/workspace.ts
@@ -47,7 +47,7 @@ export class Workspace implements WorkspaceInterface {
     this.registerRebaseWatcher(context);
   }
 
-  async start() {
+  async start(erbSupport = true) {
     await this.ruby.activateRuby();
 
     if (this.ruby.error) {
@@ -105,6 +105,7 @@ export class Workspace implements WorkspaceInterface {
       this.workspaceFolder,
       this.outputChannel,
       this.isMainWorkspace,
+      erbSupport,
     );
 
     try {
@@ -119,6 +120,16 @@ export class Workspace implements WorkspaceInterface {
         this.needsRestart = false;
         await this.restart();
       }
+
+      if (
+        erbSupport &&
+        !this.lspClient.initializeResult?.capabilities.experimental?.erb_support
+      ) {
+        this.outputChannel.warn(
+          "A dependency is blocking the `ruby-lsp` from updating. Restarting the server without ERB support",
+        );
+        await this.restart(false);
+      }
     } catch (error: any) {
       this.error = true;
       this.outputChannel.error(`Error starting the server: ${error.message}`);
@@ -129,7 +140,7 @@ export class Workspace implements WorkspaceInterface {
     await this.lspClient?.stop();
   }
 
-  async restart() {
+  async restart(erbSupport = true) {
     try {
       if (this.#rebaseInProgress) {
         return;
@@ -139,7 +150,7 @@ export class Workspace implements WorkspaceInterface {
 
       // If there's no client, then we can just start a new one
       if (!this.lspClient) {
-        return this.start();
+        return this.start(erbSupport);
       }
 
       switch (this.lspClient.state) {
@@ -154,13 +165,13 @@ export class Workspace implements WorkspaceInterface {
           await this.stop();
           await this.lspClient.dispose();
           this.lspClient = undefined;
-          await this.start();
+          await this.start(erbSupport);
           break;
         // If the server is already stopped, then we need to dispose it and start a new one
         case State.Stopped:
           await this.lspClient.dispose();
           this.lspClient = undefined;
-          await this.start();
+          await this.start(erbSupport);
           break;
       }
     } catch (error: any) {