Automatic start trace server when user requests to open a trace

This change uses the vscode-trace-server commands to start a trace
server and when the server is started it will perform the pending
open command.

This change relies on the vscode-trace-server extension.

In a future release an API can be introduced so that an extension
can register the start/stop commands and also the started notification.
This future enhancement would decouple the vscode-trace-extension with
the vscode-trace-server implementation.

Contributes to fixing Issue #15

Signed-off-by: Bernd Hufmann <[email protected]>

Author: bhufmann

vscode-trace-extension/src/extension.ts

@@ -6,11 +6,13 @@ import { TraceExplorerAvailableViewsProvider } from './trace-explorer/available-
 import { TraceExplorerOpenedTracesViewProvider } from './trace-explorer/opened-traces/trace-explorer-opened-traces-webview-provider';
 import { fileHandler, openOverviewHandler, resetZoomHandler, undoRedoHandler, zoomHandler, keyboardShortcutsHandler } from './trace-explorer/trace-tree';
 import { TraceServerConnectionStatusService } from './utils/trace-server-status';
-import { updateTspClient } from './utils/tspClient';
+import { getTspClientUrl, updateTspClient } from './utils/tspClient';
 import { TraceExtensionLogger } from './utils/trace-extension-logger';
 import { VSCODE_MESSAGES } from 'vscode-trace-common/lib/messages/vscode-message-manager';
+import { TspClientProvider } from 'vscode-trace-common/lib/client/tsp-client-provider-impl';
 
 export let traceLogger: TraceExtensionLogger;
+const tspClientProvider = new TspClientProvider(getTspClientUrl(), undefined);
 
 export function activate(context: vscode.ExtensionContext): void {
     traceLogger = new TraceExtensionLogger('Trace Extension');
@@ -41,8 +43,11 @@ export function activate(context: vscode.ExtensionContext): void {
     const analysisProvider = new AnalysisProvider();
     // TODO: For now, a different command opens traces from file explorer. Remove when we have a proper trace finder
     const fileOpenHandler = fileHandler(analysisProvider);
-    context.subscriptions.push(vscode.commands.registerCommand('traces.openTraceFile', file => {
-        fileOpenHandler(context, file);
+    context.subscriptions.push(vscode.commands.registerCommand('traces.openTraceFile', async file => {
+        await startTraceServerIfAvailable();
+        if (await isUp()) {
+            fileOpenHandler(context, file);
+        }
     }));
 
     // Listening to configuration change for the trace server URL
@@ -79,8 +84,11 @@ export function activate(context: vscode.ExtensionContext): void {
         zoomHandler(false);
     }));
 
-    context.subscriptions.push(vscode.commands.registerCommand('openedTraces.openTraceFolder', () => {
-        fileOpenHandler(context, undefined);
+    context.subscriptions.push(vscode.commands.registerCommand('openedTraces.openTraceFolder', async () => {
+        await startTraceServerIfAvailable();
+        if (await isUp()) {
+            fileOpenHandler(context, undefined);
+        }
     }));
 
     context.subscriptions.push(vscode.commands.registerCommand('traceViewer.shortcuts', () => {
@@ -102,3 +110,18 @@ export function activate(context: vscode.ExtensionContext): void {
 export function deactivate(): void {
     traceLogger.disposeChannel();
 }
+
+async function startTraceServerIfAvailable(): Promise<void> {
+    const extensionId = 'vscode-trace-server';
+    const traceServerExtension = vscode.extensions.getExtension('tracecompass-community.' + extensionId);
+    if (!traceServerExtension || await isUp()) {
+        return;
+    }
+    await vscode.commands.executeCommand(extensionId + '.start-if-stopped');
+}
+
+async function isUp() {
+    const health = await tspClientProvider.getTspClient().checkHealth();
+    const status = health.getModel()?.status;
+    return health.isOk() && status === 'UP';
+}