Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
fix(reporter): spread AggregateError sub-errors into testInfo.errors (#40925)
Simon Knotte8d5386c9a25
diff --git a/packages/playwright/src/worker/testInfo.ts b/packages/playwright/src/worker/testInfo.tsindex 6250ce936a..42b3a7a902 100644--- a/packages/playwright/src/worker/testInfo.ts+++ b/packages/playwright/src/worker/testInfo.ts@@ -413,15 +413,23 @@ export class TestInfoImpl implements TestInfo {this.status = 'interrupted';}- _failWithError(error: Error | unknown) {+ _failWithError(root: Error | unknown) {if (this.status === 'passed' || this.status === 'skipped')- this.status = error instanceof TimeoutManagerError ? 'timedOut' : 'failed';- const serialized = testInfoError(error);- const step: TestStepInternal | undefined = typeof error === 'object' ? (error as any)?.[stepSymbol] : undefined;- if (step && step.boxedStack)- serialized.stack = `${(error as Error).name}: ${(error as Error).message}\n${stringifyStackFrames(step.boxedStack).join('\n')}`;- this.errors.push(serialized);- this._tracing.appendForError(serialized);+ this.status = root instanceof TimeoutManagerError ? 'timedOut' : 'failed';+ const visit = (error: Error | unknown) => {+ const serialized = testInfoError(error);+ const step: TestStepInternal | undefined = error === root && typeof error === 'object' ? (error as any)?.[stepSymbol] : undefined;+ if (step && step.boxedStack)+ serialized.stack = `${(error as Error).name}: ${(error as Error).message}\n${stringifyStackFrames(step.boxedStack).join('\n')}`;+ this.errors.push(serialized);+ this._tracing.appendForError(serialized);+ const children = (error as any)?.errors;+ if (Array.isArray(children)) {+ for (const child of children)+ visit(child);+ }+ };+ visit(root);}async _runAsStep(stepInfo: { title: string, category: 'hook' | 'fixture', location?: Location, group?: string }, cb: () => Promise<any>) {diff --git a/tests/playwright-test/reporter.spec.ts b/tests/playwright-test/reporter.spec.tsindex 8476629f03..e0330b1e83 100644--- a/tests/playwright-test/reporter.spec.ts+++ b/tests/playwright-test/reporter.spec.ts@@ -915,3 +915,75 @@ test('should have static annotations on result when all tests are skipped', asyn'annotation: skip',]);});++test('AggregateError sub-errors are spread into testInfo.errors', async ({ runInlineTest }) => {+ class TestReporter implements Reporter {+ onTestEnd(test: TestCase, result: TestResult): void {+ for (const error of result.errors)+ console.log(`%%${error.message ?? error.value}`);+ // For the boxed-step case, also surface a frame from the test file so+ // we can assert that the boxed-stack rewrite only applies to the+ // top-level error and not to its sub-errors.+ if (test.title === 'boxed step') {+ for (const error of result.errors) {+ const frame = (error.stack ?? '').split('\n').find(l => l.includes('a.spec.ts:'));+ console.log(`%%FRAME ${error.message}: ${frame?.trim()}`);+ }+ }+ }+ }++ const result = await runInlineTest({+ 'reporter.ts': `module.exports = ${TestReporter.toString()}`,+ 'playwright.config.ts': `module.exports = { reporter: './reporter' };`,+ 'a.spec.ts': `+ import { test } from '@playwright/test';+ test('basic', () => {+ throw new AggregateError([new Error('a'), new Error('b')], 'parent');+ });+ test('nested', () => {+ throw new AggregateError([+ new AggregateError([new Error('a'), new Error('b')], 'inner'),+ new Error('c'),+ ], 'outer');+ });+ test('non-error entries', () => {+ const err: any = new Error('parent');+ err.errors = ['oops', { foo: 1 }, new Error('real')];+ throw err;+ });+ test('boxed step', async () => {+ const subA = new Error('sub a');+ const subB = new Error('sub b');+ const helper = async () => {+ await test.step('boxed', async () => {+ throw new AggregateError([subA, subB], 'top');+ }, { box: true });+ };+ await helper();+ });+ `,+ }, { 'reporter': '', 'workers': 1 });++ expect(result.exitCode).toBe(1);+ expect(result.outputLines).toEqual([+ 'AggregateError: parent',+ 'Error: a',+ 'Error: b',+ 'AggregateError: outer',+ 'AggregateError: inner',+ 'Error: a',+ 'Error: b',+ 'Error: c',+ 'Error: parent',+ `'oops'`,+ '{ foo: 1 }',+ 'Error: real',+ 'AggregateError: top',+ 'Error: sub a',+ 'Error: sub b',+ expect.stringMatching(/^FRAME AggregateError: top: at .*a\.spec\.ts:25:/),+ expect.stringMatching(/^FRAME Error: sub a: at .*a\.spec\.ts:18:/),+ expect.stringMatching(/^FRAME Error: sub b: at .*a\.spec\.ts:19:/),+ ]);+});