test(trace-viewer): embedded trace viewer tests

src/extension.ts

@@ -771,6 +771,10 @@ export class Extension implements RunHooks {
     this._treeItemSelected(testItem);
   }
 
+  traceViewerInfoForTest() {
+    return this._currentTraceViewer?.infoForTest();
+  }
+
   private _showTrace(testItem: vscodeTypes.TestItem) {
     const traceUrl = (testItem as any)[traceUrlSymbol];
     if (traceUrl)

src/traceViewer.ts

@@ -37,6 +37,7 @@ export class SpawnTraceViewer extends DisposableBase {
   private _traceViewerProcess: ChildProcess | undefined;
   private _settingsModel: SettingsModel;
   private _config: TestConfig;
+  private _serverUrlPrefix?: string;
 
   constructor(vscode: vscodeTypes.VSCode, settingsModel: SettingsModel, envProvider: () => NodeJS.ProcessEnv, config: TestConfig) {
     super();
@@ -107,6 +108,13 @@ export class SpawnTraceViewer extends DisposableBase {
       this._vscode.window.showErrorMessage(error.message);
       this.close().catch(() => {});
     });
+    if (this._vscode.isUnderTest) {
+      traceViewerProcess.stdout?.on('data', data => {
+        const match = data.toString().match(/Listening on (.*)/);
+        if (match)
+          this._serverUrlPrefix = match[1];
+      });
+    }
   }
 
   checkVersion() {
@@ -125,6 +133,14 @@ export class SpawnTraceViewer extends DisposableBase {
     this._traceViewerProcess?.stdin?.end();
     this._traceViewerProcess = undefined;
   }
+
+  infoForTest() {
+    return {
+      type: 'spawn',
+      serverUrlPrefix: this._serverUrlPrefix,
+      testConfigFile: this._config.configFile
+    };
+  }
 }
 
 export class EmbeddedTraceViewer extends DisposableBase {
@@ -227,6 +243,14 @@ export class EmbeddedTraceViewer extends DisposableBase {
     }
     return true;
   }
+
+  infoForTest() {
+    return {
+      type: 'embedded',
+      serverUrlPrefix: this._serverUrlPrefix,
+      testConfigFile: this._config.configFile
+    };
+  }
 }
 
 class EmbeddedTraceViewerPanel extends DisposableBase {

src/vscodeTypes.ts

@@ -57,4 +57,6 @@ export type {
   TerminalLink,
 } from 'vscode';
 
-export type VSCode = typeof import('vscode');
+export type VSCode = typeof import('vscode') & {
+  isUnderTest?: boolean;
+};

tests/mock/vscode.ts

@@ -1066,6 +1066,7 @@ export class VSCode {
       'playwright.env': {},
       'playwright.reuseBrowser': false,
       'playwright.showTrace': false,
+      'playwright.embedTraceViewer': false,
       'workbench.colorTheme': 'Dark Modern',
     };
     this.workspace.getConfiguration = scope => {

tests/trace-viewer-legacy.spec.ts

@@ -0,0 +1,47 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { test, expect, traceViewerInfo } from './utils';
+
+test.beforeEach(({ showBrowser, overridePlaywrightVersion }) => {
+  test.skip(!overridePlaywrightVersion || showBrowser);
+  // prevents spawn trace viewer process from opening in browser
+  process.env.PWTEST_UNDER_TEST = '1';
+});
+
+test.use({ showTrace: true, embedTraceViewer: true, envRemoteName: 'ssh-remote' });
+
+test('should fallback to spawn trace viewer in older @playwright/test projects', async ({ activate }) => {
+  const { vscode, testController } = await activate({
+    'playwright.config.js': `module.exports = { testDir: 'tests' }`,
+    'tests/test.spec.ts': `
+      import { test } from '@playwright/test';
+      test('should pass', async () => {});
+    `,
+  });
+
+  await testController.expandTestItems(/test.spec/);
+  const testItems = testController.findTestItems(/pass/);
+  await testController.run(testItems);
+
+  await expect.poll(() => vscode.warnings).toContain('Playwright v1.46+ is required for embedded trace viewer to work, v1.43 found');
+
+  await expect.poll(() => traceViewerInfo(vscode)).toMatchObject({
+    type: 'spawn',
+    serverUrlPrefix: expect.anything(),
+    testConfigFile: expect.stringContaining('playwright.config.js')
+  });
+});