test: wait for ChatSearch to initialize

Update the chat integration tests so they wait for ChatSearch to fully initialize before continuing.
getappmap · Sep 14, 2024 · 3d4773b · 3d4773b
1 parent b829dbf
commit 3d4773b
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 15 deletions.
diff --git a/src/webviews/chatSearchWebview.ts b/src/webviews/chatSearchWebview.ts
@@ -39,6 +39,7 @@ export type ExplainResponse = {
 export default class ChatSearchWebview {
   private webviewList = new WebviewList();
   private filterStore: FilterStore;
+  private _onWebview?: (wv: vscode.Webview) => void;
 
   private constructor(
     private readonly context: vscode.ExtensionContext,
@@ -58,6 +59,10 @@ export default class ChatSearchWebview {
     return this.webviewList.currentWebview;
   }
 
+  set onWebview(cb: (wv: vscode.Webview) => void) {
+    this._onWebview = cb;
+  }
+
   async doPinFiles(panel: vscode.WebviewPanel, reqs: PinFileRequest[]) {
     const maxPinnedFileSize = ExtensionSettings.maxPinnedFileSizeKB * 1024;
     type PinFileRequestWithLength = PinFileRequest & { contentLength?: number };
@@ -144,6 +149,9 @@ export default class ChatSearchWebview {
       }
     );
     this.webviewList.enroll(panel);
+    if (this._onWebview) {
+      this._onWebview(panel.webview);
+    }
 
     panel.webview.html = getWebviewContent(
       panel.webview,

diff --git a/test/integration/chat/chat.test.ts b/test/integration/chat/chat.test.ts
@@ -29,7 +29,7 @@ describe('chat', () => {
 
   beforeEach(() => (sandbox = sinon.createSandbox()));
   afterEach(async () => {
-    vscode.commands.executeCommand('workbench.action.closeActiveEditor');
+    await vscode.commands.executeCommand('workbench.action.closeActiveEditor');
     sandbox.restore();
   });
 
@@ -44,23 +44,23 @@ describe('chat', () => {
     let chatView: vscode.Webview;
 
     beforeEach(async () => {
-      await vscode.commands.executeCommand('appmap.explain');
-      const v = chatSearchWebview.currentWebview;
-      assert(v);
-
-      await new Promise<void>((resolve) => {
-        v.onDidReceiveMessage(async (msg) => {
-          if (msg.command === 'chat-search-ready') {
-            resolve();
-          }
-        });
+      const p = new Promise<vscode.Webview>((resolve) => {
+        const waitForLoaded = (wv: vscode.Webview): void => {
+          wv.onDidReceiveMessage((msg) => {
+            if (msg.command === 'chat-search-loaded') {
+              resolve(wv);
+            }
+          });
+        };
+        chatSearchWebview.onWebview = waitForLoaded;
       });
-      chatView = v;
+      await vscode.commands.executeCommand('appmap.explain');
+      chatView = await p;
     });
 
     const waitForPin = () =>
       new Promise<PinFileEvent>((resolve) => {
-        chatView.onDidReceiveMessage(async (msg) => {
+        chatView.onDidReceiveMessage((msg) => {
           if (msg.command === 'pin') {
             resolve(msg.event);
           }
@@ -82,7 +82,7 @@ describe('chat', () => {
 
     describe('appmap.addToContext', () => {
       it('pins a file', async () => {
-        return withTmpDir(async (tmpDir) => {
+        await withTmpDir(async (tmpDir) => {
           const files = await newTmpFiles(tmpDir);
           sandbox.stub(chatSearchWebview, 'chooseFilesToPin').resolves(files);
           const p = waitForPin();
@@ -107,7 +107,7 @@ describe('chat', () => {
 
     describe('appmap.editor.title.addToContext', () => {
       it('pins a file', async () => {
-        return withTmpDir(async (tmpDir) => {
+        await withTmpDir(async (tmpDir) => {
           const files = await newTmpFiles(tmpDir);
           const p = waitForPin();
           await vscode.commands.executeCommand('appmap.editor.title.addToContext', files[0]);

diff --git a/web/src/chatSearchView.js b/web/src/chatSearchView.js
@@ -113,6 +113,10 @@ export default function mountChatSearchView() {
     app.$on('pin', (event) => {
       vscode.postMessage({ command: 'pin', event });
     });
+
+    app.$on('chat-search-loaded', () => {
+      vscode.postMessage({ command: 'chat-search-loaded'});
+    });
   });
 
   vscode.postMessage({ command: 'chat-search-ready' });