feat: User is prompted to choose a directory for Explain command

src/lib/selectIndexProcess.ts

@@ -0,0 +1,91 @@
+import * as vscode from 'vscode';
+import IndexProcessWatcher from '../services/indexProcessWatcher';
+import { NodeProcessService } from '../services/nodeProcessService';
+import { workspaceServices } from '../services/workspaceServices';
+import { ProcessWatcher } from '../services/processWatcher';
+
+export type IndexProcess = {
+  configFolder: string;
+  rpcPort: number;
+};
+
+export enum ReasonCode {
+  NoIndexProcessWatchers = 1,
+  NoReadyIndexProcessWatchers = 2,
+  NoSelectionMade = 3,
+}
+
+export function readyProcessWatchers(
+  workspace?: vscode.WorkspaceFolder
+): IndexProcessWatcher[] | undefined {
+  const nodeProcessService = workspaceServices().getService(NodeProcessService);
+  if (!nodeProcessService) {
+    console.warn('No node process service found');
+    return;
+  }
+
+  const nodeProcessServices = workspaceServices().getServiceInstances(nodeProcessService);
+  if (nodeProcessServices.length === 0) {
+    console.log('No node process services found');
+    return;
+  }
+
+  const indexProcessWatchers = new Array<IndexProcessWatcher>();
+  for (const nodeProcessServiceInstance of nodeProcessServices) {
+    if (workspace && nodeProcessServiceInstance.folder !== workspace) continue;
+
+    for (const processWatcher of nodeProcessServiceInstance.processes) {
+      if (processWatcher instanceof IndexProcessWatcher) indexProcessWatchers.push(processWatcher);
+    }
+  }
+
+  return indexProcessWatchers;
+}
+
+export default async function selectIndexProcess(
+  workspace?: vscode.WorkspaceFolder
+): Promise<IndexProcess | ReasonCode | undefined> {
+  const indexProcessWatchers = readyProcessWatchers(workspace);
+  if (!indexProcessWatchers) return;
+
+  if (indexProcessWatchers.length === 0) {
+    console.log('No index process watchers found');
+    return ReasonCode.NoIndexProcessWatchers;
+  }
+
+  const readyIndexProcessWatchers = indexProcessWatchers.filter((watcher) =>
+    watcher.isRpcAvailable()
+  );
+  if (readyIndexProcessWatchers.length === 0) {
+    console.log('No ready index process watchers found');
+    return ReasonCode.NoReadyIndexProcessWatchers;
+  }
+
+  let selectedWatcher: IndexProcessWatcher | undefined;
+  if (readyIndexProcessWatchers.length === 1) {
+    selectedWatcher = readyIndexProcessWatchers[0];
+  } else {
+    const pickResult = await vscode.window.showQuickPick(
+      readyIndexProcessWatchers.map((watcher) => ({
+        label: watcher.configFolder,
+        watcher,
+      })),
+      {
+        placeHolder: 'Select an index process',
+      }
+    );
+    if (!pickResult) return ReasonCode.NoSelectionMade;
+
+    selectedWatcher = pickResult.watcher;
+  }
+
+  if (!selectedWatcher.rpcPort) {
+    console.warn(`No RPC port available on index process watcher ${selectedWatcher.configFolder}`);
+    return;
+  }
+
+  return {
+    configFolder: selectedWatcher.configFolder,
+    rpcPort: selectedWatcher.rpcPort,
+  };
+}

src/services/indexProcessWatcher.ts

@@ -1,4 +1,3 @@
-import * as vscode from 'vscode';
 import ExtensionSettings from '../configuration/extensionSettings';
 import { NodeProcessService } from './nodeProcessService';
 import { ProcessId, ProcessWatcher, ProcessWatcherOptions } from './processWatcher';

src/webviews/chatSearchWebview.ts

@@ -1,13 +1,9 @@
 import * as vscode from 'vscode';
 import getWebviewContent from './getWebviewContent';
-import { workspaceServices } from '../services/workspaceServices';
-import { NodeProcessService } from '../services/nodeProcessService';
-import { warn } from 'console';
-import IndexProcessWatcher from '../services/indexProcessWatcher';
-import { ProcessId } from '../services/processWatcher';
 import appmapMessageHandler from './appmapMessageHandler';
 import FilterStore, { SavedFilter } from './filterStore';
 import WebviewList from './WebviewList';
+import selectIndexProcess, { IndexProcess, ReasonCode } from '../lib/selectIndexProcess';
 
 export default class ChatSearchWebview {
   private webviewList = new WebviewList();
@@ -27,54 +23,31 @@ export default class ChatSearchWebview {
     return this.webviewList.currentWebview;
   }
 
-  readyIndexProcess(workspace: vscode.WorkspaceFolder): IndexProcessWatcher | undefined {
-    const processServiceInstance = workspaceServices().getServiceInstanceFromClass(
-      NodeProcessService,
-      workspace
-    );
-    if (!processServiceInstance) return;
-
-    const indexProcess = processServiceInstance.processes.find(
-      (proc) => proc.id === ProcessId.Index
-    ) as IndexProcessWatcher;
-    if (!indexProcess) {
-      warn(`No ${ProcessId.Index} helper process found for workspace: ${workspace.name}`);
-      return;
-    }
-
-    if (!indexProcess.isRpcAvailable()) return;
-
-    return indexProcess;
-  }
-
-  isReady(workspace: vscode.WorkspaceFolder): boolean {
-    return !!this.readyIndexProcess(workspace);
-  }
-
   async explain(workspace?: vscode.WorkspaceFolder, question?: string) {
-    if (!workspace) {
-      const workspaces = vscode.workspace.workspaceFolders;
-      if (!workspaces) return;
-
-      if (workspaces.length === 1) {
-        workspace = workspaces[0];
-      } else {
-        workspace = await vscode.window.showWorkspaceFolderPick({
-          placeHolder: 'Select a workspace folder',
-        });
-      }
-      if (!workspace) return;
+    const selectIndexProcessResult = await selectIndexProcess(workspace);
+    if (!selectIndexProcessResult) return;
+
+    let selectedWatcher: IndexProcess | undefined;
+    switch (selectIndexProcessResult) {
+      case ReasonCode.NoIndexProcessWatchers:
+        vscode.window.showInformationMessage(
+          `${workspace?.name || 'Your workspace'} does not have AppMaps`
+        );
+        break;
+      case ReasonCode.NoReadyIndexProcessWatchers:
+        vscode.window.showInformationMessage(
+          `AppMap AI is not ready yet. Please try again in a few seconds.`
+        );
+        break;
+      case ReasonCode.NoSelectionMade:
+        break;
+      default:
+        selectedWatcher = selectIndexProcessResult;
+        break;
     }
+    if (!selectedWatcher) return;
 
-    const showError = async (message: string): Promise<string | undefined> => {
-      return vscode.window.showErrorMessage(message);
-    };
-
-    const indexProcess = this.readyIndexProcess(workspace);
-    if (!indexProcess)
-      return showError('AppMap Explain is not ready yet. Please try again in a few seconds.');
-
-    const { rpcPort: appmapRpcPort } = indexProcess;
+    const { rpcPort: appmapRpcPort } = selectedWatcher;
 
     const panel = vscode.window.createWebviewPanel(
       'chatSearch',

test/integration/explain/explain.test.ts

@@ -1,6 +1,7 @@
 import * as vscode from 'vscode';
 import { initializeWorkspace, waitFor, waitForExtension, withAuthenticatedUser } from '../util';
 import assert from 'assert';
+import { readyProcessWatchers } from '../../../src/lib/selectIndexProcess';
 
 describe('appmap.explain', () => {
   withAuthenticatedUser();
@@ -15,7 +16,10 @@ describe('appmap.explain', () => {
     const workspace = vscode.workspace.workspaceFolders?.[0];
     assert(workspace);
 
-    await waitFor('Explain service is not ready', () => chatSearchWebview.isReady(workspace));
+    await waitFor(
+      'Explain service is not ready',
+      () => readyProcessWatchers(workspace)?.length !== 0
+    );
 
     await waitFor('Invoking appmap.explain opens a new text document', async () => {
       await vscode.commands.executeCommand('appmap.explain');