Fix build completion monitoring for testing

Author: jdesrosiers

language-server/src/services/schemas-neovim.test.ts

@@ -24,6 +24,7 @@ describe("Feature - workspace (neovim)", () => {
 
     documentUriA = await client.writeDocument("./subjectA.schema.json", `{ "$schema": "https://json-schema.org/draft/2020-12/schema" }`);
     documentUriB = await client.writeDocument("./subjectB.schema.json", `{ "$schema": "https://json-schema.org/draft/2020-12/schema" }`);
+    await client.ready();
   });
 
   afterAll(async () => {
@@ -42,11 +43,13 @@ describe("Feature - workspace (neovim)", () => {
   test("a change to a watched file should validate the workspace", async () => {
     const schemaUris: string[] = [];
 
+    await client.ready();
     client.onNotification(PublishDiagnosticsNotification.type, (params) => {
       schemaUris.push(params.uri);
     });
 
     await client.writeDocument("./subjectB.schema.json", `{ "$schema": "https://json-schema.org/draft/2020-12/schema" }`);
+    await client.ready();
 
     expect(schemaUris).to.eql([documentUriA, documentUriB]);
   });

language-server/src/test/test-client.ts

@@ -44,6 +44,7 @@ export class TestClient<Configuration> {
   private openDocuments: Set<string>;
   private workspaceFolder: Promise<string>;
   private watchEnabled: boolean;
+  private buildCompleted;
 
   onRequest: Connection["onRequest"];
   sendRequest: Connection["sendRequest"];
@@ -97,8 +98,21 @@ export class TestClient<Configuration> {
       }
     });
 
-    this.client.onRequest(WorkDoneProgressCreateRequest.type, () => {
-      // Nothing to do
+    this.buildCompleted = createPromise();
+    let builds = 0;
+
+    this.client.onRequest(WorkDoneProgressCreateRequest.type, ({ token }) => {
+      this.client.onProgress(WorkDoneProgress.type, token, ({ kind }) => {
+        if (kind === "begin") {
+          builds++;
+        } else if (kind === "end") {
+          builds--;
+          if (builds === 0) {
+            this.buildCompleted.resolve();
+            this.buildCompleted = createPromise();
+          }
+        }
+      });
     });
 
     this.client.onRequest(ConfigurationRequest.type, (params) => {
@@ -221,8 +235,6 @@ export class TestClient<Configuration> {
   async changeConfiguration(settings: Partial<Configuration>) {
     this._settings = settings;
 
-    const buildCompleted = this.buildCompleted();
-
     if (this.configurationChangeNotificationOptions === null) {
       await this.client.sendNotification(DidChangeConfigurationNotification.type, {
         settings: null
@@ -235,7 +247,7 @@ export class TestClient<Configuration> {
       });
     }
 
-    await buildCompleted;
+    await this.buildCompleted.promise;
   }
 
   async writeDocument(uri: string, text: string) {
@@ -244,8 +256,6 @@ export class TestClient<Configuration> {
 
     await writeFile(fileURLToPath(fullUri), text, "utf-8");
 
-    const buildCompleted = this.buildCompleted();
-
     if (this.watchEnabled) {
       await this.client.sendNotification(DidChangeWatchedFilesNotification.type, {
         changes: [{
@@ -255,7 +265,7 @@ export class TestClient<Configuration> {
       });
     }
 
-    await buildCompleted;
+    await this.buildCompleted.promise;
 
     return fullUri;
   }
@@ -265,8 +275,6 @@ export class TestClient<Configuration> {
 
     await rm(fileURLToPath(fullUri));
 
-    const buildCompleted = this.buildCompleted();
-
     if (this.watchEnabled) {
       await this.client.sendNotification(DidChangeWatchedFilesNotification.type, {
         changes: [{
@@ -276,7 +284,7 @@ export class TestClient<Configuration> {
       });
     }
 
-    await buildCompleted;
+    await this.buildCompleted.promise;
 
     return fullUri;
   }
@@ -308,17 +316,8 @@ export class TestClient<Configuration> {
     });
   }
 
-  // TODO: Duplicated code
-  private buildCompleted() {
-    return new Promise<void>((resolve) => {
-      this.client.onRequest(WorkDoneProgressCreateRequest.type, ({ token }) => {
-        this.client.onProgress(WorkDoneProgress.type, token, ({ kind }) => {
-          if (kind === "end") {
-            resolve();
-          }
-        });
-      });
-    });
+  async ready() {
+    await this.buildCompleted.promise;
   }
 }
 
@@ -331,3 +330,15 @@ export class TestStream extends Duplex {
   _read() {
   }
 }
+
+const createPromise = () => {
+  let resolve: () => void;
+  let reject: (reason?: any) => void; // eslint-disable-line @typescript-eslint/no-explicit-any
+  const promise = new Promise<void>((resolveFn, rejectFn) => {
+    resolve = resolveFn;
+    reject = rejectFn;
+  });
+
+  // @ts-expect-error TypeScript doesn't think resolve and reject have been assigned
+  return { promise, resolve, reject };
+};