What it does

Use vscode-messenger library for communication of extension and webviews.

The extension returns also a Diagnostic object (appended to the vscode-trace-extension's ExternalAPI so that message exchanges can be logged using the VS Code Messenger Developer Tool. This is purely for trouble shooting purposes.

Fixes #78.

Note: There is a non-backward compatible change for third-party extension using interfacing the vscode-trace-extension with this change. The messenger library is using method instead of command for message keys. Downstream projects will need to update their callback methods (see message.method below).

for (const webview of importedApi.getActiveWebviews()) {
    webview.webview.onDidReceiveMessage((message) => {
        switch (message.method) {
            case "webviewReady":
            console.log("From adopter extension - webviewReady signal received");
            break;
            default:
            break;
        }
    });
}

How to test

Run and use the extension. No change in behavior is expected.

Follow-ups

Use vscode-messenger capabilities to send messages directly webview <-> webview/set of webviews instead of going through the extension host which forwards them is using node signals as described here. This would simplify webview synchronization. However, the implementation for persisting of webview states (e.g. selected experiment) need to be changed. Not using Node signals would affect the external API of the vscode-trace-extension, regarding onSignalManagerSignal and onSignalManagerSignal as described here, and this has to be addressed when implementing it.

We can also use message types Request and Response instead of Notification where applicable.

We also have the possibility to introduce typing of the message data.

Review checklist

• As an author, I have thoroughly tested my changes and carefully followed the instructions in this template