Update TestClient to support multiple config scopes

jdesrosiers · jdesrosiers · commit 0ec64fa4b866 · 2025-03-09T15:58:13.000-07:00
diff --git a/language-server/src/features/completion/completion.test.ts b/language-server/src/features/completion/completion.test.ts
@@ -1,11 +1,9 @@
 import { afterAll, beforeAll, describe, expect, test } from "vitest";
 import { TestClient } from "../../test/test-client.ts";
 
-import type { DocumentSettings } from "../../services/configuration.js";
-
 
 describe("Feature - Completion", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
 
   beforeAll(async () => {
     client = new TestClient();
diff --git a/language-server/src/features/completion/if-then-completion.test.ts b/language-server/src/features/completion/if-then-completion.test.ts
@@ -3,11 +3,9 @@ import { CompletionRequest } from "vscode-languageserver";
 import { TestClient } from "../../test/test-client.ts";
 import { ifThenPatternCompletion } from "./if-then-completion.js";
 
-import type { DocumentSettings } from "../../services/configuration.js";
-
 
 describe("Feature - if/then completion", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
   let documentUri: string;
 
   beforeAll(async () => {
diff --git a/language-server/src/features/completion/keyword-completion.test.ts b/language-server/src/features/completion/keyword-completion.test.ts
@@ -2,11 +2,9 @@ import { afterAll, afterEach, beforeAll, describe, expect, test } from "vitest";
 import { CompletionRequest, CompletionItemKind } from "vscode-languageserver";
 import { TestClient } from "../../test/test-client.ts";
 
-import type { DocumentSettings } from "../../services/configuration.js";
-
 
 describe("Feature - if/then completion", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
   let documentUri: string;
 
   beforeAll(async () => {
diff --git a/language-server/src/features/completion/schema-completion.test.ts b/language-server/src/features/completion/schema-completion.test.ts
@@ -2,11 +2,9 @@ import { afterAll, afterEach, beforeAll, describe, expect, test } from "vitest";
 import { CompletionItemKind, CompletionRequest } from "vscode-languageserver";
 import { TestClient } from "../../test/test-client.ts";
 
-import type { DocumentSettings } from "../../services/configuration.js";
-
 
 describe("Feature - $schema completion", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
   let documentUri: string;
 
   beforeAll(async () => {
diff --git a/language-server/src/features/diagnostics/deprecated.test.ts b/language-server/src/features/diagnostics/deprecated.test.ts
@@ -3,11 +3,10 @@ import { DiagnosticSeverity, DiagnosticTag, PublishDiagnosticsNotification } fro
 import { TestClient } from "../../test/test-client.ts";
 
 import type { Diagnostic } from "vscode-languageserver";
-import type { DocumentSettings } from "../../services/configuration.js";
 
 
 describe("Feature - Deprecated", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
 
   beforeEach(async () => {
     client = new TestClient();
diff --git a/language-server/src/features/diagnostics/validate-dialects.test.ts b/language-server/src/features/diagnostics/validate-dialects.test.ts
@@ -3,11 +3,10 @@ import { PublishDiagnosticsNotification } from "vscode-languageserver";
 import { TestClient } from "../../test/test-client.ts";
 
 import type { Diagnostic } from "vscode-languageserver";
-import type { DocumentSettings } from "../../services/configuration.js";
 
 
 describe("Feature - Custom Dialects", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
   let documentUriB: string;
   let documentUri: string;
 
diff --git a/language-server/src/features/diagnostics/validate-references.test.ts b/language-server/src/features/diagnostics/validate-references.test.ts
@@ -3,11 +3,10 @@ import { PublishDiagnosticsNotification } from "vscode-languageserver";
 import { TestClient } from "../../test/test-client.ts";
 
 import type { Diagnostic } from "vscode-languageserver";
-import type { DocumentSettings } from "../../services/configuration.js";
 
 
 describe("Feature - Validate References Errors", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
 
   beforeEach(async () => {
     client = new TestClient();
diff --git a/language-server/src/features/diagnostics/validate-vocabulary.test.ts b/language-server/src/features/diagnostics/validate-vocabulary.test.ts
@@ -3,11 +3,10 @@ import { DiagnosticSeverity, PublishDiagnosticsNotification } from "vscode-langu
 import { TestClient } from "../../test/test-client.ts";
 
 import type { Diagnostic } from "vscode-languageserver";
-import type { DocumentSettings } from "../../services/configuration.js";
 
 
 describe("Feature - Validate $vocabulary", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
 
   beforeEach(async () => {
     client = new TestClient();
diff --git a/language-server/src/features/diagnostics/validation-errors.test.ts b/language-server/src/features/diagnostics/validation-errors.test.ts
@@ -3,11 +3,10 @@ import { PublishDiagnosticsNotification } from "vscode-languageserver";
 import { TestClient } from "../../test/test-client.ts";
 
 import type { Diagnostic } from "vscode-languageserver";
-import type { DocumentSettings } from "../../services/configuration.js";
 
 
 describe("Feature - Validation Errors", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
 
   beforeEach(async () => {
     client = new TestClient();
diff --git a/language-server/src/features/find-references.test.ts b/language-server/src/features/find-references.test.ts
@@ -2,11 +2,9 @@ import { afterEach, beforeEach, describe, expect, test } from "vitest";
 import { ReferencesRequest } from "vscode-languageserver";
 import { TestClient } from "../test/test-client.ts";
 
-import type { DocumentSettings } from "../services/configuration.js";
-
 
 describe("Feature - References", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
 
   beforeEach(async () => {
     client = new TestClient();
diff --git a/language-server/src/features/goto-definition.test.ts b/language-server/src/features/goto-definition.test.ts
@@ -2,11 +2,9 @@ import { afterEach, beforeEach, describe, expect, test } from "vitest";
 import { DefinitionRequest } from "vscode-languageserver";
 import { TestClient } from "../test/test-client.ts";
 
-import type { DocumentSettings } from "../services/configuration.js";
-
 
 describe("Feature - Goto Definition", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
 
   beforeEach(async () => {
     client = new TestClient();
diff --git a/language-server/src/features/hover.test.ts b/language-server/src/features/hover.test.ts
@@ -3,11 +3,10 @@ import { HoverRequest, MarkupKind } from "vscode-languageserver";
 import { TestClient } from "../test/test-client.ts";
 
 import type { Hover, MarkupContent } from "vscode-languageserver";
-import type { DocumentSettings } from "../services/configuration.js";
 
 
 describe("Feature - Hover", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
 
   beforeAll(async () => {
     client = new TestClient();
diff --git a/language-server/src/features/semantic-tokens.test.ts b/language-server/src/features/semantic-tokens.test.ts
@@ -2,11 +2,9 @@ import { beforeAll, afterAll, afterEach, describe, expect, test } from "vitest";
 import { SemanticTokensRequest } from "vscode-languageserver";
 import { TestClient } from "../test/test-client.ts";
 
-import type { DocumentSettings } from "../services/configuration.js";
-
 
 describe("Feature - Semantic Tokens", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
   let documentUri: string;
 
   beforeAll(async () => {
diff --git a/language-server/src/services/configuration.test.ts b/language-server/src/services/configuration.test.ts
@@ -3,11 +3,10 @@ import { PublishDiagnosticsNotification } from "vscode-languageserver";
 import { TestClient } from "../test/test-client.ts";
 
 import type { Diagnostic } from "vscode-languageserver";
-import type { DocumentSettings } from "./configuration.js";
 
 
 describe("Feature - Document Settings", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
 
   beforeEach(async () => {
     client = new TestClient();
diff --git a/language-server/src/services/schemas-neovim.test.ts b/language-server/src/services/schemas-neovim.test.ts
@@ -2,11 +2,9 @@ import { afterAll, beforeAll, describe, expect, test } from "vitest";
 import { TestClient } from "../test/test-client.ts";
 import { PublishDiagnosticsNotification } from "vscode-languageserver";
 
-import type { DocumentSettings } from "./configuration.js";
-
 
 describe("Feature - workspace (neovim)", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
   let documentUriA: string;
   let documentUriB: string;
 
diff --git a/language-server/src/services/schemas.test.ts b/language-server/src/services/schemas.test.ts
@@ -2,11 +2,9 @@ import { describe, test, expect, beforeAll, afterAll } from "vitest";
 import { PublishDiagnosticsNotification, TextDocumentSyncKind } from "vscode-languageserver";
 import { TestClient } from "../test/test-client.ts";
 
-import type { DocumentSettings } from "./configuration.js";
-
 
 describe("JSON Schema Language Server", () => {
-  let client: TestClient<DocumentSettings>;
+  let client: TestClient;
   let documentUriA: string;
   let documentUriB: string;
 
diff --git a/language-server/src/test/test-client.ts b/language-server/src/test/test-client.ts
@@ -33,13 +33,16 @@ import type {
   InitializeParams,
   ServerCapabilities
 } from "vscode-languageserver";
+import type { EditorSettings, FilesSettings, LanguageServerSettings } from "../services/configuration.js";
 
 
-export class TestClient<Configuration> {
+export class TestClient {
   private client: Connection;
   private serverName: string;
   private _serverCapabilities: ServerCapabilities | undefined;
-  private _settings: Partial<Configuration> | undefined;
+  private languageServerSettings: Partial<LanguageServerSettings> | undefined;
+  private editorSettings: Partial<EditorSettings> | undefined;
+  private filesSettings: Partial<FilesSettings> | undefined;
   private configurationChangeNotificationOptions: DidChangeConfigurationRegistrationOptions | null | undefined;
   private openDocuments: Set<string>;
   private workspaceFolder: Promise<string>;
@@ -102,11 +105,18 @@ export class TestClient<Configuration> {
     });
 
     this.client.onRequest(ConfigurationRequest.type, (params) => {
-      return params.items
-        .filter((configurationItem) => configurationItem.section === this.serverName)
-        .map(() => {
-          return this._settings;
-        });
+      return params.items.map((configurationItem) => {
+        switch (configurationItem.section) {
+          case this.serverName:
+            return this.languageServerSettings;
+          case "editor":
+            return this.editorSettings;
+          case "files":
+            return this.filesSettings;
+          default:
+            throw Error(`Unsupported configuration section: ${configurationItem.section}`);
+        }
+      });
     });
 
     this.client.listen();
@@ -116,10 +126,6 @@ export class TestClient<Configuration> {
     return structuredClone(this._serverCapabilities);
   }
 
-  get settings() {
-    return structuredClone(this._settings);
-  }
-
   async start(params: Partial<InitializeParams> = {}) {
     const defaultInitParams: InitializeParams = {
       processId: null,
@@ -208,7 +214,7 @@ export class TestClient<Configuration> {
     // Wait for dynamic registrations to be completed
     await wait(100);
 
-    await this.changeConfiguration(this._settings ?? {});
+    await this.changeConfiguration();
   }
 
   async stop() {
@@ -218,8 +224,10 @@ export class TestClient<Configuration> {
     this.client.dispose();
   }
 
-  async changeConfiguration(settings: Partial<Configuration>) {
-    this._settings = settings;
+  async changeConfiguration(languageServerSettings?: Partial<LanguageServerSettings>, editorSettings?: Partial<EditorSettings>, filesSettings?: Partial<FilesSettings>) {
+    this.languageServerSettings = languageServerSettings ?? this.languageServerSettings;
+    this.editorSettings = editorSettings ?? this.editorSettings;
+    this.filesSettings = filesSettings ?? this.filesSettings;
 
     const buildCompleted = this.buildCompleted();
 
@@ -230,7 +238,9 @@ export class TestClient<Configuration> {
     } else if (this.configurationChangeNotificationOptions) {
       await this.client.sendNotification(DidChangeConfigurationNotification.type, {
         settings: {
-          [this.serverName]: this._settings
+          [this.serverName]: this.languageServerSettings,
+          editor: this.editorSettings,
+          files: this.filesSettings
         }
       });
     }
