Limit supported client schemes to file and git (#2889)

### Motivation

With the new AI developments for editors, the LSP receives a lot of unnecessary requests coming from "ghost" schemes. They are usually some sort of resource URI related to the chat or something happening in the background, but it's not actually relevant for the user.

In addition to leading to extra work in the server that is completely unnecessary, it also often confuses users because some of these resources don't send a `textDocument/didOpen` notification before starting to request for other features, which leads to the non existing document error and then people think something is broken, when in reality it's not.

### Implementation

Let's limit the schemes we handle to `file` and `git`.

### Automated Tests

Updated existing tests.

Author: vinistock

vscode/src/client.ts

@@ -150,16 +150,19 @@ function collectClientOptions(
 
   const features: EnabledFeatures = configuration.get("enabledFeatures")!;
   const enabledFeatures = Object.keys(features).filter((key) => features[key]);
+  const supportedSchemes = ["file", "git"];
 
   const fsPath = workspaceFolder.uri.fsPath.replace(/\/$/, "");
 
   // For each workspace, the language client is responsible for handling requests for:
   // 1. Files inside of the workspace itself
   // 2. Bundled gems
   // 3. Default gems
-  let documentSelector: DocumentSelector = SUPPORTED_LANGUAGE_IDS.map(
+  let documentSelector: DocumentSelector = SUPPORTED_LANGUAGE_IDS.flatMap(
     (language) => {
-      return { language, pattern: `${fsPath}/**/*` };
+      return supportedSchemes.map((scheme) => {
+        return { scheme, language, pattern: `${fsPath}/**/*` };
+      });
     },
   );
 
@@ -175,26 +178,30 @@ function collectClientOptions(
   }
 
   ruby.gemPath.forEach((gemPath) => {
-    documentSelector.push({
-      language: "ruby",
-      pattern: `${gemPath}/**/*`,
-    });
-
-    // Because of how default gems are installed, the gemPath location is actually not exactly where the files are
-    // located. With the regex, we are correcting the default gem path from this (where the files are not located)
-    // /opt/rubies/3.3.1/lib/ruby/gems/3.3.0
-    //
-    // to this (where the files are actually stored)
-    // /opt/rubies/3.3.1/lib/ruby/3.3.0
-    //
-    // Notice that we still need to add the regular path to the selector because some version managers will install gems
-    // under the non-corrected path
-    if (/lib\/ruby\/gems\/(?=\d)/.test(gemPath)) {
+    supportedSchemes.forEach((scheme) => {
       documentSelector.push({
+        scheme,
         language: "ruby",
-        pattern: `${gemPath.replace(/lib\/ruby\/gems\/(?=\d)/, "lib/ruby/")}/**/*`,
+        pattern: `${gemPath}/**/*`,
       });
-    }
+
+      // Because of how default gems are installed, the gemPath location is actually not exactly where the files are
+      // located. With the regex, we are correcting the default gem path from this (where the files are not located)
+      // /opt/rubies/3.3.1/lib/ruby/gems/3.3.0
+      //
+      // to this (where the files are actually stored)
+      // /opt/rubies/3.3.1/lib/ruby/3.3.0
+      //
+      // Notice that we still need to add the regular path to the selector because some version managers will install
+      // gems under the non-corrected path
+      if (/lib\/ruby\/gems\/(?=\d)/.test(gemPath)) {
+        documentSelector.push({
+          scheme,
+          language: "ruby",
+          pattern: `${gemPath.replace(/lib\/ruby\/gems\/(?=\d)/, "lib/ruby/")}/**/*`,
+        });
+      }
+    });
   });
 
   // This is a temporary solution as an escape hatch for users who cannot upgrade the `ruby-lsp` gem to a version that

vscode/src/test/suite/client.test.ts

@@ -21,8 +21,8 @@ import {
   TextEdit,
   SelectionRange,
   CodeAction,
-  TextDocumentFilter,
   LocationLink,
+  TextDocumentFilter,
 } from "vscode-languageclient/node";
 import { after, afterEach, before } from "mocha";
 
@@ -675,48 +675,50 @@ suite("Client", () => {
   }).timeout(20000);
 
   test("document selectors match default gems and bundled gems appropriately", () => {
-    const [
-      workspaceRubyFilter,
-      workspaceERBFilter,
-      bundledGemsFilter,
-      defaultPathFilter,
-      defaultGemsFilter,
-    ] = client.clientOptions.documentSelector!;
-
-    assert.strictEqual(
-      (workspaceRubyFilter as TextDocumentFilter).language!,
-      "ruby",
-    );
-
-    assert.strictEqual(
-      (workspaceRubyFilter as TextDocumentFilter).pattern!,
-      `${workspaceUri.fsPath}/**/*`,
-    );
+    const selector = client.clientOptions
+      .documentSelector! as TextDocumentFilter[];
+    assert.strictEqual(selector.length, 10);
+
+    // We don't care about the order of the document filters, just that they are present. This assertion helper is just
+    // a convenience to search the registered filters
+    const assertSelector = (
+      language: string | undefined,
+      pattern: RegExp | string,
+      scheme: string | undefined,
+    ) => {
+      assert.ok(
+        selector.find(
+          (filter: TextDocumentFilter) =>
+            filter.language === language &&
+            (typeof pattern === "string"
+              ? pattern === filter.pattern
+              : pattern.test(filter.pattern!)) &&
+            filter.scheme === scheme,
+        ),
+      );
+    };
 
-    assert.strictEqual(
-      (workspaceERBFilter as TextDocumentFilter).language!,
-      "erb",
-    );
+    assertSelector("ruby", `${workspaceUri.fsPath}/**/*`, "file");
+    assertSelector("ruby", `${workspaceUri.fsPath}/**/*`, "git");
+    assertSelector("erb", `${workspaceUri.fsPath}/**/*`, "file");
+    assertSelector("erb", `${workspaceUri.fsPath}/**/*`, "git");
 
-    assert.strictEqual(
-      (workspaceERBFilter as TextDocumentFilter).pattern!,
-      `${workspaceUri.fsPath}/**/*`,
+    assertSelector(
+      "ruby",
+      new RegExp(`ruby\\/\\d\\.\\d\\.\\d\\/\\*\\*\\/\\*`),
+      "file",
     );
-
-    assert.match(
-      (bundledGemsFilter as TextDocumentFilter).pattern!,
+    assertSelector(
+      "ruby",
       new RegExp(`ruby\\/\\d\\.\\d\\.\\d\\/\\*\\*\\/\\*`),
+      "git",
     );
 
-    assert.match(
-      (defaultPathFilter as TextDocumentFilter).pattern!,
-      /lib\/ruby\/gems\/\d\.\d\.\d\/\*\*\/\*/,
-    );
+    assertSelector("ruby", /lib\/ruby\/gems\/\d\.\d\.\d\/\*\*\/\*/, "file");
+    assertSelector("ruby", /lib\/ruby\/gems\/\d\.\d\.\d\/\*\*\/\*/, "git");
 
-    assert.match(
-      (defaultGemsFilter as TextDocumentFilter).pattern!,
-      /lib\/ruby\/\d\.\d\.\d\/\*\*\/\*/,
-    );
+    assertSelector("ruby", /lib\/ruby\/\d\.\d\.\d\/\*\*\/\*/, "file");
+    assertSelector("ruby", /lib\/ruby\/\d\.\d\.\d\/\*\*\/\*/, "git");
   });
 
   test("requests for non existing documents do not crash the server", async () => {