Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

feat: Add test timeout to trace and display it in metadata of UI (#39467)

Chrisee53f6c36ada
diff --git a/packages/playwright-core/src/utils/isomorphic/trace/entries.ts b/packages/playwright-core/src/utils/isomorphic/trace/entries.ts
index b203acb9a1..5fb51f63f4 100644
--- a/packages/playwright-core/src/utils/isomorphic/trace/entries.ts
+++ b/packages/playwright-core/src/utils/isomorphic/trace/entries.ts
@@ -41,6 +41,7 @@ export type ContextEntry = {
errors: trace.ErrorTraceEvent[];
hasSource: boolean;
contextId: string;
+ testTimeout?: number;
};
export type PageEntry = {
diff --git a/packages/playwright-core/src/utils/isomorphic/trace/traceModel.ts b/packages/playwright-core/src/utils/isomorphic/trace/traceModel.ts
index 91cfeb14bf..0ca3b802ba 100644
--- a/packages/playwright-core/src/utils/isomorphic/trace/traceModel.ts
+++ b/packages/playwright-core/src/utils/isomorphic/trace/traceModel.ts
@@ -89,6 +89,7 @@ export class TraceModel {
resources: ResourceEntry[];
readonly actionCounters: Map<string, number>;
readonly traceUri: string;
+ readonly testTimeout?: number;
constructor(traceUri: string, contexts: ContextEntry[]) {
@@ -104,6 +105,7 @@ export class TraceModel {
this.playwrightVersion = contexts.find(c => c.playwrightVersion)?.playwrightVersion;
this.title = libraryContext?.title || '';
this.options = libraryContext?.options || {};
+ this.testTimeout = contexts.find(c => c.origin === 'testRunner')?.testTimeout;
// Next call updates all timestamps for all events in library contexts, so it must be done first.
this.actions = mergeActionsAndUpdateTiming(contexts);
this.pages = ([] as PageEntry[]).concat(...contexts.map(c => c.pages));
diff --git a/packages/playwright-core/src/utils/isomorphic/trace/traceModernizer.ts b/packages/playwright-core/src/utils/isomorphic/trace/traceModernizer.ts
index f2b4f159de..20e703145f 100644
--- a/packages/playwright-core/src/utils/isomorphic/trace/traceModernizer.ts
+++ b/packages/playwright-core/src/utils/isomorphic/trace/traceModernizer.ts
@@ -98,6 +98,7 @@ export class TraceModernizer {
contextEntry.options = event.options;
contextEntry.testIdAttributeName = event.testIdAttributeName;
contextEntry.contextId = event.contextId ?? '';
+ contextEntry.testTimeout = event.testTimeout;
break;
}
case 'screencast-frame': {
diff --git a/packages/playwright/src/worker/testTracing.ts b/packages/playwright/src/worker/testTracing.ts
index fa99c112a9..a82cdb917a 100644
--- a/packages/playwright/src/worker/testTracing.ts
+++ b/packages/playwright/src/worker/testTracing.ts
@@ -168,6 +168,8 @@ export class TestTracing {
}
async stopIfNeeded() {
+ this._contextCreatedEvent.testTimeout = this._testInfo.timeout;
+
if (!this._options)
return;
diff --git a/packages/trace-viewer/src/ui/metadataView.tsx b/packages/trace-viewer/src/ui/metadataView.tsx
index 20d3b6c5a9..1a863f4c4c 100644
--- a/packages/trace-viewer/src/ui/metadataView.tsx
+++ b/packages/trace-viewer/src/ui/metadataView.tsx
@@ -31,6 +31,7 @@ export const MetadataView: React.FunctionComponent<{
<div className='call-section' style={{ paddingTop: 2 }}>Time</div>
{!!wallTime && <div className='call-line'>start time:<span className='call-value datetime' title={wallTime}>{wallTime}</span></div>}
<div className='call-line'>duration:<span className='call-value number' title={msToString(model.endTime - model.startTime)}>{msToString(model.endTime - model.startTime)}</span></div>
+ {model.testTimeout !== undefined && <div className='call-line'>test timeout:<span className='call-value number' title={msToString(model.testTimeout)}>{msToString(model.testTimeout)}</span></div>}
<div className='call-section'>Browser</div>
<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>}
diff --git a/packages/trace/src/trace.ts b/packages/trace/src/trace.ts
index 3ffa6c4586..d11ac4dc91 100644
--- a/packages/trace/src/trace.ts
+++ b/packages/trace/src/trace.ts
@@ -46,6 +46,7 @@ export type ContextCreatedTraceEvent = {
sdkLanguage?: Language,
testIdAttributeName?: string,
contextId?: string,
+ testTimeout?: number,
};
export type ScreencastFrameTraceEvent = {
diff --git a/tests/playwright-test/playwright.trace.spec.ts b/tests/playwright-test/playwright.trace.spec.ts
index a39a0e8d87..e771195992 100644
--- a/tests/playwright-test/playwright.trace.spec.ts
+++ b/tests/playwright-test/playwright.trace.spec.ts
@@ -1389,3 +1389,34 @@ test('should record trace snapshot for more obscure commands', async ({ runInlin
expect(trace.snapshots.snapshotByName(snapshotFrameOrPageId, boundingBoxAction.beforeSnapshot)).toBeTruthy();
expect(trace.snapshots.snapshotByName(snapshotFrameOrPageId, boundingBoxAction.afterSnapshot)).toBeTruthy();
});
+
+test('should record default test timeout in trace', async ({ runInlineTest }, testInfo) => {
+ const result = await runInlineTest({
+ 'a.spec.ts': `
+ import { test, expect } from '@playwright/test';
+ test('pass', async ({}) => {
+ });
+ `,
+ }, { trace: 'on' });
+
+ expect(result.exitCode).toBe(0);
+ expect(result.passed).toBe(1);
+ const trace = await parseTrace(testInfo.outputPath('test-results', 'a-pass', 'trace.zip'));
+ expect(trace.model.testTimeout).toBe(30_000);
+});
+
+test('should record custom test timeout in trace', async ({ runInlineTest }, testInfo) => {
+ const result = await runInlineTest({
+ 'a.spec.ts': `
+ import { test, expect } from '@playwright/test';
+ test('pass', async ({}) => {
+ test.setTimeout(120_000);
+ });
+ `,
+ }, { trace: 'on' });
+
+ expect(result.exitCode).toBe(0);
+ expect(result.passed).toBe(1);
+ const trace = await parseTrace(testInfo.outputPath('test-results', 'a-pass', 'trace.zip'));
+ expect(trace.model.testTimeout).toBe(120_000);
+});