chore(trace): show playwright version in metadata (#38158)

Author: Skn0tt

packages/playwright-core/src/server/trace/recorder/tracing.ts

@@ -24,6 +24,7 @@ import { assert } from '../../../utils/isomorphic/assert';
 import { monotonicTime } from '../../../utils/isomorphic/time';
 import { eventsHelper  } from '../../utils/eventsHelper';
 import { createGuid  } from '../../utils/crypto';
+import { getPlaywrightVersion } from '../../utils/userAgent';
 import { Artifact } from '../../artifact';
 import { BrowserContext } from '../../browserContext';
 import { Dispatcher } from '../../dispatchers/dispatcher';
@@ -107,6 +108,7 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps
       type: 'context-options',
       origin: 'library',
       browserName: '',
+      playwrightVersion: getPlaywrightVersion(),
       options: {},
       platform: process.platform,
       wallTime: 0,

packages/playwright/src/worker/testTracing.ts

@@ -17,7 +17,7 @@
 import fs from 'fs';
 import path from 'path';
 
-import { ManualPromise, SerializedFS, calculateSha1, createGuid, monotonicTime } from 'playwright-core/lib/utils';
+import { ManualPromise, SerializedFS, calculateSha1, createGuid, getPlaywrightVersion, monotonicTime } from 'playwright-core/lib/utils';
 import { yauzl, yazl } from 'playwright-core/lib/zipBundle';
 
 import { filteredStackTrace } from '../util';
@@ -57,6 +57,7 @@ export class TestTracing {
       type: 'context-options',
       origin: 'testRunner',
       browserName: '',
+      playwrightVersion: getPlaywrightVersion(),
       options: {},
       platform: process.platform,
       wallTime: Date.now(),

packages/trace-viewer/src/sw/traceModernizer.ts

@@ -91,6 +91,7 @@ export class TraceModernizer {
         contextEntry.channel = event.channel;
         contextEntry.title = event.title;
         contextEntry.platform = event.platform;
+        contextEntry.playwrightVersion = event.playwrightVersion;
         contextEntry.wallTime = event.wallTime;
         contextEntry.startTime = event.monotonicTime;
         contextEntry.sdkLanguage = event.sdkLanguage;

packages/trace-viewer/src/types/entries.ts

@@ -27,6 +27,7 @@ export type ContextEntry = {
   browserName: string;
   channel?: string;
   platform?: string;
+  playwrightVersion?: string;
   wallTime: number;
   sdkLanguage?: Language;
   testIdAttributeName?: string;

packages/trace-viewer/src/ui/metadataView.tsx

@@ -35,6 +35,7 @@ export const MetadataView: React.FunctionComponent<{
     <div className='call-line'>engine:<span className='call-value string' title={model.browserName}>{model.browserName}</span></div>
     {model.channel && <div className='call-line'>channel:<span className='call-value string' title={model.channel}>{model.channel}</span></div>}
     {model.platform && <div className='call-line'>platform:<span className='call-value string' title={model.platform}>{model.platform}</span></div>}
+    {model.playwrightVersion && <div className='call-line'>playwright version:<span className='call-value string' title={model.playwrightVersion}>{model.playwrightVersion}</span></div>}
     {model.options.userAgent && <div className='call-line'>user agent:<span className='call-value datetime' title={model.options.userAgent}>{model.options.userAgent}</span></div>}
     {model.options.baseURL && (
       <>

packages/trace-viewer/src/ui/modelUtil.ts

@@ -67,6 +67,7 @@ export class MultiTraceModel {
   readonly browserName: string;
   readonly channel?: string;
   readonly platform?: string;
+  readonly playwrightVersion?: string;
   readonly wallTime?: number;
   readonly title?: string;
   readonly options: trace.BrowserContextEventOptions;
@@ -98,6 +99,7 @@ export class MultiTraceModel {
     this.channel = libraryContext?.channel;
     this.testIdAttributeName = libraryContext?.testIdAttributeName;
     this.platform = libraryContext?.platform || '';
+    this.playwrightVersion = contexts.find(c => c.playwrightVersion)?.playwrightVersion;
     this.title = libraryContext?.title || '';
     this.options = libraryContext?.options || {};
     // Next call updates all timestamps for all events in library contexts, so it must be done first.

packages/trace/src/trace.ts

@@ -38,6 +38,7 @@ export type ContextCreatedTraceEvent = {
   browserName: string,
   channel?: string,
   platform: string,
+  playwrightVersion?: string,
   wallTime: number,
   monotonicTime: number,
   title?: string,

tests/library/trace-viewer.spec.ts

@@ -1088,6 +1088,7 @@ test('should include metainfo', async ({ showTraceViewer }) => {
   await expect(callLine.getByText('duration')).toHaveText(/duration:[\dms]+/);
   await expect(callLine.getByText('engine')).toHaveText(/engine:[\w]+/);
   await expect(callLine.getByText('platform')).toHaveText(/platform:[\w]+/);
+  await expect(callLine.getByText('playwright version')).toHaveText(/playwright version:[\w.]+/);
   await expect(callLine.getByText('width')).toHaveText(/width:[\d]+/);
   await expect(callLine.getByText('height')).toHaveText(/height:[\d]+/);
   await expect(callLine.getByText('pages')).toHaveText(/pages:1/);