Allow other extensions to programmatically remove a trace.

This adds a new command, traces.removeTrace, that accepts an experiment
uuid and endeavors to remove the experiment if present. Enhances
traces.openTraceFile to return an experiment UUID, which can later
be used as an argument to traces.removeTrace.

Author: GregSavin

vscode-trace-extension/src/extension.ts

@@ -13,7 +13,8 @@ import {
     resetZoomHandler,
     undoRedoHandler,
     zoomHandler,
-    keyboardShortcutsHandler
+    keyboardShortcutsHandler,
+    deleteExperiment
 } from './trace-explorer/trace-utils';
 import { TraceServerConnectionStatusService } from './utils/trace-server-status';
 import {
@@ -96,9 +97,23 @@ export async function activate(context: vscode.ExtensionContext): Promise<Extern
     const fileOpenHandler = fileHandler();
     context.subscriptions.push(
         vscode.commands.registerCommand('traces.openTraceFile', async (file: vscode.Uri) => {
+            let result = undefined;
             await startTraceServerIfAvailable(file.fsPath);
             if (await isTraceServerUp()) {
-                await fileOpenHandler(context, file);
+                const experiment = await fileOpenHandler(context, file);
+                if (experiment) {
+                    result = experiment.UUID;
+                }
+                vscode.commands.executeCommand('trace-explorer.refreshContext');
+            }
+            return result;
+        })
+    );
+
+    context.subscriptions.push(
+        vscode.commands.registerCommand('traces.removeTrace', async (uuid: string | undefined) => {
+            if (uuid) {
+                await deleteExperiment(context.extensionUri, uuid);
                 vscode.commands.executeCommand('trace-explorer.refreshContext');
             }
         })

vscode-trace-extension/src/trace-explorer/trace-utils.ts

@@ -6,6 +6,7 @@ import { getExperimentManager, getTraceManager } from '../utils/backend-tsp-clie
 import { updateNoExperimentsContext } from '../utils/backend-tsp-client-provider';
 import { messenger, traceLogger } from '../extension';
 import { KeyboardShortcutsPanel } from '../trace-viewer-panel/keyboard-shortcuts-panel';
+import { Experiment } from 'tsp-typescript-client';
 
 // eslint-disable-next-line no-shadow
 export enum ProgressMessages {
@@ -53,7 +54,7 @@ export const openDialog = async (selectFiles = false): Promise<vscode.Uri | unde
 
 export const fileHandler =
     () =>
-    async (context: vscode.ExtensionContext, traceUri: vscode.Uri): Promise<void> => {
+    async (context: vscode.ExtensionContext, traceUri: vscode.Uri): Promise<Experiment | undefined> => {
         const resolvedTraceURI: vscode.Uri = traceUri;
         const { traceManager, experimentManager } = getManagers();
         return vscode.window.withProgress(
@@ -66,15 +67,15 @@ export const fileHandler =
                 try {
                     if (token.isCancellationRequested) {
                         progress.report({ message: ProgressMessages.COMPLETE, increment: 100 });
-                        return;
+                        return undefined;
                     }
 
                     const filePath: string = resolvedTraceURI.fsPath;
                     if (!filePath) {
                         traceLogger.showError(
                             'Cannot open trace: could not retrieve path from URI for trace ' + resolvedTraceURI
                         );
-                        return;
+                        return undefined;
                     }
 
                     const name = path.basename(filePath);
@@ -153,16 +154,31 @@ export const fileHandler =
                         rollbackTraces(traces, 20, progress);
                         progress.report({ message: ProgressMessages.COMPLETE, increment: 10 });
                         panel.dispose();
-                        return;
+                        return undefined;
                     }
                     progress.report({ message: ProgressMessages.COMPLETE, increment: 30 });
+                    return experiment;
                 } finally {
                     updateNoExperimentsContext();
                 }
             }
         );
     };
 
+export const deleteExperiment = async (extensionUri: vscode.Uri, uuid: string) => {
+    // dispose any open panels associated with the experiment
+    for (const key of Object.keys(TraceViewerPanel.activePanels)) {
+        const panel = TraceViewerPanel.activePanels[key];
+        const experimentUuid = panel?.getExperiment()?.UUID;
+        if (experimentUuid === uuid) {
+            TraceViewerPanel.disposePanel(extensionUri, key);
+        }
+    }
+    // remove experiment from the experiment manager
+    const experimentManager = getManagers().experimentManager;
+    experimentManager.deleteExperiment(uuid);
+};
+
 const rollbackTraces = async (
     traces: Array<TspTrace>,
     progressIncrement: number,

vscode-trace-extension/src/trace-viewer-panel/trace-viewer-webview-panel.ts

@@ -431,6 +431,9 @@ export class TraceViewerPanel {
         signalManager().emit('EXPERIMENT_OPENED', experiment);
         signalManager().emit('TRACEVIEWERTAB_ACTIVATED', experiment);
     }
+    getExperiment(): Experiment | undefined {
+        return this._experiment;
+    }
 
     addOutput(descriptor: OutputDescriptor): void {
         const wrapper = JSONBigUtils.stringify(descriptor);