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
feat(test runner): each worker fixture gets a separate timeout (#38744)
Dmitry Gozmandf2abf231723
diff --git a/docs/src/test-fixtures-js.md b/docs/src/test-fixtures-js.mdindex 16afe6f25e..0646574ab7 100644--- a/docs/src/test-fixtures-js.md+++ b/docs/src/test-fixtures-js.md@@ -354,6 +354,8 @@ Playwright Test uses [worker processes](./test-parallel.md) to run test files. SBelow we'll create an `account` fixture that will be shared by all tests in the same worker, and override the `page` fixture to log in to this account for each test. To generate unique accounts, we'll use the [`property: WorkerInfo.workerIndex`] that is available to any test or fixture. Note the tuple-like syntax for the worker fixture - we have to pass `{scope: 'worker'}` so that test runner sets this fixture up once per worker.+In addition to only being run once per worker, worker-scoped fixtures also get a separate timeout equal to the default test timeout. You can change it by passing the `timeout` option. See [fixture timeout](#fixture-timeout) for more details.+```js title="my-test.ts"import { test as base } from '@playwright/test';@@ -434,7 +436,7 @@ export { expect } from '@playwright/test';## Fixture timeout-By default, the fixture inherits the timeout value of the test. However, for slow fixtures, especially [worker-scoped](#worker-scoped-fixtures) ones, it is convenient to have a separate timeout. This way you can keep the overall test timeout small, and give the slow fixture more time.+Fixture is considered to be a part of a test, and so its setup and teardown running time counts towards the test timeout. Therefore, a slow fixture may cause test timeouts. You can set a separate larger timeout for such a fixture, and keep the overall test timeout small.```jsimport { test as base, expect } from '@playwright/test';@@ -451,6 +453,7 @@ test('example test', async ({ slowFixture }) => {});```+Unlike regular test-scoped fixtures, each [worker-scoped](#worker-scoped-fixtures) fixture has its own timeout, equal to the test timeout. You can change the timeout for a worker-scoped fixture in the same way.## Fixtures-optionsdiff --git a/packages/playwright/src/worker/fixtureRunner.ts b/packages/playwright/src/worker/fixtureRunner.tsindex 6329afaff7..a8d43206cb 100644--- a/packages/playwright/src/worker/fixtureRunner.ts+++ b/packages/playwright/src/worker/fixtureRunner.ts@@ -55,10 +55,13 @@ class Fixture {title,phase: 'setup',location,- slot: this.registration.timeout === undefined ? undefined : {+ slot: this.registration.timeout !== undefined ? {timeout: this.registration.timeout,elapsed: 0,- }+ } : this.registration.scope === 'worker' ? {+ timeout: this.runner.workerFixtureTimeout,+ elapsed: 0,+ } : undefined,};this._teardownDescription = { ...this._setupDescription, phase: 'teardown' };}@@ -179,6 +182,7 @@ export class FixtureRunner {private testScopeClean = true;pool: FixturePool | undefined;instanceForId = new Map<string, Fixture>();+ workerFixtureTimeout = 0;setPool(pool: FixturePool) {if (!this.testScopeClean)diff --git a/packages/playwright/src/worker/workerMain.ts b/packages/playwright/src/worker/workerMain.tsindex ea70b028a7..d1289a46e5 100644--- a/packages/playwright/src/worker/workerMain.ts+++ b/packages/playwright/src/worker/workerMain.ts@@ -212,6 +212,7 @@ export class WorkerMain extends ProcessRunner {this._config = config;this._project = project;this._poolBuilder = PoolBuilder.createForWorker(this._project);+ this._fixtureRunner.workerFixtureTimeout = this._project.project.timeout;}async runTestGroup(runPayload: ipc.RunPayload) {diff --git a/tests/playwright-test/fixture-errors.spec.ts b/tests/playwright-test/fixture-errors.spec.tsindex 51c928f156..ca1c6d7177 100644--- a/tests/playwright-test/fixture-errors.spec.ts+++ b/tests/playwright-test/fixture-errors.spec.ts@@ -46,18 +46,18 @@ test('should handle worker fixture timeout', async ({ runInlineTest }) => {'a.spec.ts': `import { test as base, expect } from '@playwright/test';const test = base.extend({- timeout: [async ({}, runTest) => {+ slowFixture: [async ({}, runTest) => {await runTest();await new Promise(f => setTimeout(f, 100000));}, { scope: 'worker' }]});- test('fails', async ({timeout}) => {+ test('fails', async ({ slowFixture }) => {});`}, { timeout: 500 });expect(result.exitCode).toBe(1);- expect(result.output).toContain('Worker teardown timeout of 500ms exceeded while tearing down "timeout".');+ expect(result.output).toContain('Fixture "slowFixture" timeout of 500ms exceeded during teardown.');});test('should handle worker fixture error', async ({ runInlineTest }) => {@@ -607,7 +607,7 @@ test('should report worker fixture teardown with debug info', async ({ runInlineexpect(result.exitCode).toBe(1);expect(result.passed).toBe(20);expect(result.output).toContain([- 'Worker teardown timeout of 1000ms exceeded while tearing down "fixture".',+ 'Fixture "fixture" timeout of 1000ms exceeded during teardown.','','Failed worker ran 20 tests, last 10 tests were:','a.spec.ts:10:9 › good10',diff --git a/tests/playwright-test/timeout.spec.ts b/tests/playwright-test/timeout.spec.tsindex 9d6001078d..e1d41ef330 100644--- a/tests/playwright-test/timeout.spec.ts+++ b/tests/playwright-test/timeout.spec.ts@@ -532,7 +532,7 @@ test('should report up to 3 timeout errors', async ({ runInlineTest }) => {expect(result.failed).toBe(1);expect(result.output).toContain('Test timeout of 1000ms exceeded.');expect(result.output).toContain('Test timeout of 1000ms exceeded while running "afterEach" hook.');- expect(result.output).toContain('Worker teardown timeout of 1000ms exceeded while tearing down "autoWorker".');+ expect(result.output).toContain('Fixture "autoWorker" timeout of 1000ms exceeded during teardown.');});test('should complain when worker fixture times out during worker cleanup', async ({ runInlineTest }) => {@@ -668,3 +668,39 @@ test('test.setTimeout should be able to change custom fixture timeout', async ({expect(result.failed).toBe(1);expect(result.output).toContain(`Fixture "foo" timeout of 100ms exceeded during setup`);});++test('worker fixtures should each have a separate time slot', async ({ runInlineTest }) => {+ const result = await runInlineTest({+ 'a.spec.ts': `+ import { test as base, expect } from '@playwright/test';+ const test = base.extend({+ worker: [async ({}, use) => {+ console.log('%%before worker');+ await new Promise(f => setTimeout(f, 3000));+ await use('hey');+ console.log('%%after worker');+ }, { scope: 'worker' }],+ auto: [async ({}, use) => {+ console.log('%%before auto');+ await new Promise(f => setTimeout(f, 3000));+ await use('hey');+ console.log('%%after auto');+ }, { scope: 'worker', auto: true }],+ });+ test('passes', async ({ worker }) => {+ console.log('%%before test');+ await new Promise(f => setTimeout(f, 3000));+ console.log('%%after test');+ });+ `+ }, { timeout: 5000 });+ expect(result.exitCode).toBe(0);+ expect(result.outputLines).toEqual([+ 'before auto',+ 'before worker',+ 'before test',+ 'after test',+ 'after worker',+ 'after auto',+ ]);+});