feat: Search + Explain with Navie

package.json

@@ -185,6 +185,10 @@
         "command": "appmap.compareSequenceDiagrams",
         "title": "AppMap: Compare Sequence Diagrams"
       },
+      {
+        "command": "appmap.explain",
+        "title": "AppMap AI: Explain"
+      },
       {
         "command": "appmap.login",
         "title": "AppMap: Login"
@@ -487,19 +491,23 @@
     "yaml": "^2.1.1"
   },
   "dependencies": {
-    "@appland/appmap": "^3.80.2",
-    "@appland/client": "^1.9.0",
-    "@appland/components": "^3.13.2",
-    "@appland/diagrams": "^1.7.0",
-    "@appland/models": "^2.9.0",
-    "@appland/scanner": "^1.83.0",
-    "@appland/sequence-diagram": "^1.11.0",
+    "@appland/appmap": "^3.116.0",
+    "@appland/client": "^1.14.0",
+    "@appland/components": "^3.21.0",
+    "@appland/diagrams": "^1.8.0",
+    "@appland/models": "^2.10.0",
+    "@appland/rpc": "^1.0.0",
+    "@appland/scanner": "^1.86.0",
+    "@appland/sequence-diagram": "^1.12.0",
     "@yarnpkg/parsers": "^3.0.0-rc.45",
     "bootstrap": "^4.5.3",
     "bootstrap-autocomplete": "^2.3.7",
     "diff": "^5.1.0",
+    "handlebars": "^4.7.8",
+    "jayson": "^4.1.0",
     "jquery": "^3.5.1",
     "js-yaml": "^4.1.0",
+    "openai": "^4.19.1",
     "popper.js": "^1.16.1",
     "proper-lockfile": "^4.1.2",
     "semver": "^7.3.5",
@@ -514,5 +522,17 @@
     "publisherId": "f7f1004e-6038-49cd-a096-4e618fe53f77",
     "isPreReleaseVersion": false
   },
-  "packageManager": "[email protected]"
+  "packageManager": "[email protected]",
+  "resolutions": {
+    "@appland/appmap": "portal:/Users/kgilpin/source/appland/appmap-js/packages/cli",
+    "@appland/client": "portal:/Users/kgilpin/source/appland/appmap-js/packages/client",
+    "@appland/components": "portal:/Users/kgilpin/source/appland/appmap-js/packages/components",
+    "@appland/diagrams": "portal:/Users/kgilpin/source/appland/appmap-js/packages/diagrams",
+    "@appland/models": "portal:/Users/kgilpin/source/appland/appmap-js/packages/models",
+    "@appland/openapi": "portal:/Users/kgilpin/source/appland/appmap-js/packages/openapi",
+    "@appland/rpc": "portal:/Users/kgilpin/source/appland/appmap-js/packages/rpc",
+    "@appland/scanner": "portal:/Users/kgilpin/source/appland/appmap-js/packages/scanner",
+    "@appland/sequence-diagram": "portal:/Users/kgilpin/source/appland/appmap-js/packages/sequence-diagram",
+    "@appland/appmap-validate": "portal:/Users/kgilpin/source/appland/appmap-js/packages/validate"
+  }
 }

src/appMapService.ts

@@ -17,6 +17,7 @@ import { WorkspaceServices } from './services/workspaceServices';
 import { AppMapTreeDataProvider } from './tree/appMapTreeDataProvider';
 import { ClassMapTreeDataProvider } from './tree/classMapTreeDataProvider';
 import { FindingsTreeDataProvider } from './tree/findingsTreeDataProvider';
+import ChatSearchWebview from './webviews/chatSearchWebview';
 
 export type Invocation = {
   command: Command;
@@ -37,6 +38,7 @@ export type AppMapTreeDataProviders = {
 export default interface AppMapService {
   analysisManager: typeof AnalysisManager;
   editorProvider: AppMapEditorProvider;
+  chatSearchWebview: ChatSearchWebview;
   localAppMaps: AppMapsService;
   autoIndexService: AppMapProcessService;
   autoScanService: AppMapProcessService;

src/commands/quickSearch.ts

@@ -0,0 +1,53 @@
+import * as vscode from 'vscode';
+
+export class QuickSearchProvider implements vscode.CodeActionProvider {
+  provideCodeActions(
+    document: vscode.TextDocument,
+    range: vscode.Selection | vscode.Range
+  ): vscode.ProviderResult<(vscode.CodeAction | vscode.Command)[]> {
+    const selectedCode = document.getText(range).trim();
+    if (selectedCode === '') return;
+
+    const workspaceFolder = vscode.workspace.getWorkspaceFolder(document.uri);
+    if (!workspaceFolder) return [];
+
+    const codeAction = new vscode.CodeAction(
+      'Explain with AppMap AI',
+      vscode.CodeActionKind.Refactor
+    );
+    codeAction.command = {
+      command: 'appmap.quickExplain',
+      title: 'Explain with AppMap AI',
+      arguments: [workspaceFolder.uri, selectedCode],
+    };
+    return [codeAction];
+  }
+
+  resolveCodeAction?(codeAction: vscode.CodeAction): vscode.ProviderResult<vscode.CodeAction> {
+    return codeAction;
+  }
+}
+
+export default function quickSearch(context: vscode.ExtensionContext) {
+  context.subscriptions.push(
+    vscode.languages.registerCodeActionsProvider(
+      [
+        { language: 'ruby' },
+        { language: 'java' },
+        { language: 'python' },
+        { language: 'javascript' },
+      ],
+      new QuickSearchProvider()
+    )
+  );
+
+  context.subscriptions.push(
+    vscode.commands.registerCommand(
+      'appmap.quickExplain',
+      (workspaceUri: vscode.Uri, selectedCode: string) => {
+        const workspace = vscode.workspace.getWorkspaceFolder(workspaceUri);
+        vscode.commands.executeCommand('appmap.explain', workspace, selectedCode);
+      }
+    )
+  );
+}

src/editor/appmapEditorProvider.ts

@@ -4,7 +4,6 @@ import { Telemetry, DEBUG_EXCEPTION } from '../telemetry';
 import { version } from '../../package.json';
 import ExtensionState from '../configuration/extensionState';
 import extensionSettings from '../configuration/extensionSettings';
-import { bestFilePath } from '../lib/bestFilePath';
 import AppMapDocument from './AppMapDocument';
 import AnalysisManager from '../services/analysisManager';
 import { getStackLocations, StackLocation } from '../lib/getStackLocations';
@@ -21,6 +20,7 @@ import {
 } from '../services/nodeDependencyProcess';
 import { basename } from 'path';
 import { readFile } from 'fs/promises';
+import viewSource from '../webviews/viewSource';
 
 export type FindingInfo = ResolvedFinding & {
   stackLocations?: StackLocation[];
@@ -379,7 +379,7 @@ export default class AppMapEditorProvider
     webviewPanel.webview.onDidReceiveMessage(async (message) => {
       switch (message.command) {
         case 'viewSource':
-          viewSource(message.text);
+          viewSource(message.text, document.workspaceFolder);
           break;
         case 'ready':
           updateWebview(initialState);
@@ -476,38 +476,13 @@ export default class AppMapEditorProvider
       if (document.workspaceFolder)
         this.extensionState.setClosedAppMap(document.workspaceFolder, true);
     });
-
-    function openFile(uri: vscode.Uri, lineNumber: number) {
-      const showOptions = {
-        viewColumn: vscode.ViewColumn.Beside,
-        selection: new vscode.Range(
-          new vscode.Position(lineNumber - 1, 0),
-          new vscode.Position(lineNumber - 1, 0)
-        ),
-      };
-      vscode.commands.executeCommand('vscode.open', uri, showOptions);
-    }
-
-    async function viewSource(location: string): Promise<void> {
-      const match = location.match(/^(.*?)(?::(\d+))?$/);
-      if (!match) return;
-      const [, path, lineNumberStr] = match;
-
-      let lineNumber = 1;
-      if (lineNumberStr) {
-        lineNumber = Number.parseInt(lineNumberStr, 10);
-      }
-
-      const fileUri = await bestFilePath(path, document.workspaceFolder);
-      if (fileUri) openFile(fileUri, lineNumber);
-    }
   }
 
   /**
    * Get the static html used for the editor webviews.
    */
   private getHtmlForWebview(webview: vscode.Webview): string {
-    return getWebviewContent(webview, this.context, 'AppLand Scenario', 'app');
+    return getWebviewContent(webview, this.context, 'AppMap Diagram', 'app');
   }
 
   //forget usage state set by this class

src/extension.ts

@@ -58,6 +58,8 @@ import getAppmapDir from './commands/getAppmapDir';
 import JavaAssets from './services/javaAssets';
 import checkAndTriggerFirstAppMapNotification from './lib/firstAppMapNotification';
 import Watcher from './services/watcher';
+import ChatSearchWebview from './webviews/chatSearchWebview';
+import quickSearch from './commands/quickSearch';
 
 export async function activate(context: vscode.ExtensionContext): Promise<AppMapService> {
   Telemetry.register(context);
@@ -243,6 +245,8 @@ export async function activate(context: vscode.ExtensionContext): Promise<AppMap
 
     generateOpenApi(context);
     findByName(context, appmapCollectionFile);
+    const chatSearchWebview = ChatSearchWebview.register(context);
+    quickSearch(context);
     resetUsageState(context, extensionState);
     updateAppMapConfigs(context, runConfigService, workspaceServices);
     downloadLatestJavaJar(context);
@@ -270,6 +274,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<AppMap
     return {
       analysisManager: AnalysisManager,
       editorProvider,
+      chatSearchWebview,
       localAppMaps: appmapCollectionFile,
       autoIndexService: autoIndexServiceImpl,
       autoScanService: autoScanServiceImpl,

src/lib/deleteAppMap.ts

@@ -16,6 +16,8 @@ export default async function deleteAppMap(
   // contents, and fs.delete doesn't remove files.
   console.debug(`Deleting AppMap ${uri.fsPath}`);
 
+  appMapCollection.remove(uri);
+
   const indexDir = uri.fsPath.substring(0, uri.fsPath.lastIndexOf('.appmap.json'));
 
   await retry(async () => await rm(`${indexDir}/metadata.json`, { force: true }));

src/services/appmapCollection.ts

@@ -19,5 +19,7 @@ export default interface AppMapCollection {
 
   has(uri: vscode.Uri): boolean;
 
+  remove(uri: vscode.Uri): void;
+
   clear(): void;
 }

src/services/appmapCollectionFile.ts

@@ -20,10 +20,7 @@ export default class AppMapCollectionFile implements AppMapCollection, AppMapsSe
   private currentFilter = '';
 
   async onDelete(uri: vscode.Uri): Promise<void> {
-    if (await fileExists(uri.fsPath)) return;
-
-    this.loaders.delete(uri.fsPath);
-    this.emitUpdated(uri);
+    if (this.loaders.delete(uri.fsPath)) this.emitUpdated(uri);
   }
 
   async onChange(uri: vscode.Uri): Promise<void> {
@@ -141,6 +138,11 @@ export default class AppMapCollectionFile implements AppMapCollection, AppMapsSe
     return this.loaders.has(uri.fsPath);
   }
 
+  // This is basically an alias for onChange.
+  public remove(uri: vscode.Uri): void {
+    this.onDelete(uri);
+  }
+
   public clear(): void {
     console.debug('Clearing AppMap collection from tree', this.loaders.size);
     this.loaders.clear();

src/services/indexProcessWatcher.ts

@@ -1,21 +1,55 @@
+import * as vscode from 'vscode';
+
 import { NodeProcessService } from './nodeProcessService';
-import { ConfigFileProvider, ProcessId, ProcessWatcher } from './processWatcher';
+import {
+  ConfigFileProvider,
+  ProcessId,
+  ProcessWatcher,
+  ProcessWatcherOptions,
+} from './processWatcher';
 
 export default class IndexProcessWatcher extends ProcessWatcher {
+  public rpcPort?: number;
+  stdoutBuffer = '';
+
   constructor(
     configFileProvider: ConfigFileProvider,
     modulePath: string,
     appmapDir: string,
     cwd: string,
     env?: NodeJS.ProcessEnv
   ) {
-    super(configFileProvider, {
+    const options: ProcessWatcherOptions = {
       id: ProcessId.Index,
       modulePath: modulePath,
       log: NodeProcessService.outputChannel,
-      args: ['index', '--watch', '--appmap-dir', appmapDir],
+      args: ['index', '--watch', '--port', '0', '--appmap-dir', appmapDir],
       cwd,
       env,
-    });
+    };
+    super(configFileProvider, options);
+  }
+
+  public isRpcAvailable(): boolean {
+    return !!this.rpcPort;
+  }
+
+  protected onStdout(data: string): void {
+    super.onStdout(data);
+
+    this.stdoutBuffer += data;
+    const lines = this.stdoutBuffer.split('\n');
+    this.stdoutBuffer = this.stdoutBuffer.slice(-100);
+
+    const portStr = lines
+      .map((line) => {
+        const match = line.match(/^Running JSON-RPC server on port: (\d+)$/);
+        if (match) return match[1];
+      })
+      .find(Boolean);
+    if (portStr) {
+      vscode.window.showInformationMessage(`AppMap index process listening on port ${portStr}`);
+      this.rpcPort = parseInt(portStr);
+    }
   }
 }

src/services/nodeDependencyProcess.ts

@@ -2,6 +2,7 @@ import * as childProcess from 'child_process';
 import * as vscode from 'vscode';
 import * as path from 'path';
 import { readFile } from 'fs/promises';
+
 import ExtensionSettings from '../configuration/extensionSettings';
 
 export enum ProgramName {
@@ -27,6 +28,9 @@ export type SpawnOptions = {
 
   // Indicates whether or not log messages should be retained in a buffer
   saveOutput?: boolean;
+
+  // If specified, this function will be called with each line of stdout
+  stdoutListener?: (data: string) => void;
 } & Exclude<childProcess.SpawnOptionsWithoutStdio, 'argv0'>;
 
 export type ProgramOptions = {
@@ -59,7 +63,8 @@ export class ProcessLog extends Array<ProcessLogItem> {
   static appendLogger(
     process: childProcess.ChildProcessWithoutNullStreams,
     outputChannel?: vscode.OutputChannel,
-    save?: boolean
+    save?: boolean,
+    dataListener?: (data: string) => void
   ): ChildProcess {
     if ((process as ChildProcess).log) {
       throw new Error(`process ${process.pid} already has a logger appended`);
@@ -69,7 +74,10 @@ export class ProcessLog extends Array<ProcessLogItem> {
 
     process.stdout.setEncoding('utf8');
     process.stderr.setEncoding('utf8');
-    process.stdout.on('data', (data) => log.append(data, OutputStream.Stdout, true));
+    process.stdout.on('data', (data) => {
+      if (dataListener) dataListener(data);
+      log.append(data, OutputStream.Stdout, true);
+    });
     process.stderr.on('data', (data) => log.append(data, OutputStream.Stderr, true));
     process.once('error', (err) =>
       log.append(`an error occurred: ${String(err)}`, OutputStream.Stderr)
@@ -147,7 +155,8 @@ export function spawn(options: SpawnOptions): ChildProcess {
   const loggedProcess = ProcessLog.appendLogger(
     newProcess as childProcess.ChildProcessWithoutNullStreams,
     options.log,
-    options.saveOutput
+    options.saveOutput,
+    options.stdoutListener
   );
 
   return loggedProcess;