Improve e2e tests to check for a "ready" event emitted by the UI (#117)

Fixes: #116
Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>

Author: jviotti

protocol/types.d.ts

@@ -49,7 +49,7 @@ export interface PanelState {
   noFileSelected?: boolean;
 }
 
-export type WebviewCommand = 'goToPosition' | 'formatSchema' | 'openExternal';
+export type WebviewCommand = 'goToPosition' | 'formatSchema' | 'openExternal' | 'ready';
 
 export interface WebviewToExtensionMessage {
   command: WebviewCommand;

test/vscode/extension.test.ts

@@ -52,7 +52,8 @@ suite('Extension Test Suite', () => {
 
         await new Promise(resolve => setTimeout(resolve, 1000));
 
-        assert.ok(true, 'Command executed without error');
+        const ready = await vscode.commands.executeCommand('sourcemeta-studio.isWebviewReady') as boolean;
+        assert.ok(ready);
     });
 
     test('Should handle JSON file opening', async function() {
@@ -168,8 +169,7 @@ suite('Extension Test Suite', () => {
         assert.ok(diagnostics.length > 0);
 
         const hasLintDiagnostic = diagnostics.some(diagnostic =>
-            diagnostic.message.includes('description') ||
-            diagnostic.source === 'Sourcemeta Lint');
+            diagnostic.source === 'Sourcemeta Studio (Lint)');
 
         assert.ok(hasLintDiagnostic);
     });

vscode/src/extension.ts

@@ -15,6 +15,7 @@ let lastActiveTextEditor: vscode.TextEditor | undefined;
 let cachedCliVersion = 'Loading...';
 let extensionVersion = 'Loading...';
 let currentPanelState: PanelState | null = null;
+let webviewReady = false;
 
 /**
  * Extension activation
@@ -47,10 +48,15 @@ export function activate(context: vscode.ExtensionContext): void {
     });
 
     const openPanelCommand = vscode.commands.registerCommand('sourcemeta-studio.openPanel', () => {
+        webviewReady = false;
         panelManager.createOrReveal(context);
         updatePanelContent();
     });
 
+    const isWebviewReadyCommand = vscode.commands.registerCommand('sourcemeta-studio.isWebviewReady', () => {
+        return webviewReady;
+    });
+
     const activeEditorChangeListener = vscode.window.onDidChangeActiveTextEditor((editor) => {
         handleActiveEditorChange(editor);
     });
@@ -65,6 +71,7 @@ export function activate(context: vscode.ExtensionContext): void {
 
     context.subscriptions.push(
         openPanelCommand,
+        isWebviewReadyCommand,
         activeEditorChangeListener,
         documentSaveListener
     );
@@ -74,6 +81,12 @@ export function activate(context: vscode.ExtensionContext): void {
  * Handle messages from the webview
  */
 function handleWebviewMessage(message: WebviewToExtensionMessage): void {
+    if (message.command === 'ready') {
+        webviewReady = true;
+        console.log('[Sourcemeta Studio] Webview ready');
+        return;
+    }
+
     if (message.command === 'goToPosition' && lastActiveTextEditor && message.position) {
         const range = errorPositionToRange(message.position);
 

webview/src/App.tsx

@@ -1,6 +1,6 @@
 import { useState, useEffect } from 'react';
 import type { PanelState, TabType } from '../../protocol/types';
-import { getActiveTab, setActiveTab as setActiveTabInState } from './message';
+import { getActiveTab, setActiveTab as setActiveTabInState, notifyReady } from './message';
 import { FileInfo } from './components/FileInfo';
 import { HealthBar } from './components/HealthBar';
 import { Tabs } from './components/Tabs';
@@ -30,6 +30,9 @@ function App() {
 
     window.addEventListener('message', handleMessage);
 
+    // Notify the extension that the webview is ready
+    notifyReady();
+
     return () => {
       window.removeEventListener('message', handleMessage);
     };

webview/src/message.ts

@@ -38,3 +38,7 @@ export function getActiveTab(): TabType | undefined {
 export function setActiveTab(tab: TabType): void {
   vsCodeApi.setState({ activeTab: tab } satisfies WebviewState);
 }
+
+export function notifyReady(): void {
+  postMessage({ command: 'ready' });
+}