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
chore(client): merge waiter timeout and signal rejection (#41787)
Simon Knott533e8b28211e
diff --git a/packages/playwright-core/src/client/android.ts b/packages/playwright-core/src/client/android.tsindex 5b0e179890..bad1546eab 100644--- a/packages/playwright-core/src/client/android.ts+++ b/packages/playwright-core/src/client/android.ts@@ -272,11 +272,10 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> iasync waitForEvent(event: string, optionsOrPredicate: types.WaitForEventOptions = {}): Promise<any> {return await this._wrapApiCall(async () => {- const { timeout, signal } = this._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);+ const timeoutOptions = this._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;const waiter = Waiter.createForEvent(this, event);- waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);- waiter.rejectOnSignal(signal);+ waiter.rejectOnTimeout(timeoutOptions, `Timeout ${timeoutOptions.timeout}ms exceeded while waiting for event "${event}"`);if (event !== Events.AndroidDevice.Close)waiter.rejectOnEvent(this, Events.AndroidDevice.Close, () => new TargetClosedError());const result = await waiter.waitForEvent(this, event, predicate as any);diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.tsindex 89c160f789..82445b69f0 100644--- a/packages/playwright-core/src/client/browserContext.ts+++ b/packages/playwright-core/src/client/browserContext.ts@@ -449,11 +449,10 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>async waitForEvent(event: string, optionsOrPredicate: WaitForEventOptions = {}): Promise<any> {return await this._wrapApiCall(async () => {- const { timeout, signal } = this._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);+ const timeoutOptions = this._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;const waiter = Waiter.createForEvent(this, event);- waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);- waiter.rejectOnSignal(signal);+ waiter.rejectOnTimeout(timeoutOptions, `Timeout ${timeoutOptions.timeout}ms exceeded while waiting for event "${event}"`);if (event !== Events.BrowserContext.Close)waiter.rejectOnEvent(this, Events.BrowserContext.Close, () => new TargetClosedError(this._effectiveCloseReason()));const result = await waiter.waitForEvent(this, event, predicate as any);diff --git a/packages/playwright-core/src/client/electron.ts b/packages/playwright-core/src/client/electron.tsindex c773ac36f6..d433427c57 100644--- a/packages/playwright-core/src/client/electron.ts+++ b/packages/playwright-core/src/client/electron.ts@@ -139,11 +139,10 @@ export class ElectronApplication extends ChannelOwner<channels.ElectronApplicatiasync waitForEvent(event: string, optionsOrPredicate: WaitForEventOptions = {}): Promise<any> {return await this._wrapApiCall(async () => {- const { timeout, signal } = this._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);+ const timeoutOptions = this._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;const waiter = Waiter.createForEvent(this, event);- waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);- waiter.rejectOnSignal(signal);+ waiter.rejectOnTimeout(timeoutOptions, `Timeout ${timeoutOptions.timeout}ms exceeded while waiting for event "${event}"`);if (event !== Events.ElectronApplication.Close)waiter.rejectOnEvent(this, Events.ElectronApplication.Close, () => new TargetClosedError());const result = await waiter.waitForEvent(this, event, predicate as any);diff --git a/packages/playwright-core/src/client/frame.ts b/packages/playwright-core/src/client/frame.tsindex 6c9de8ecdc..83f1339bf4 100644--- a/packages/playwright-core/src/client/frame.ts+++ b/packages/playwright-core/src/client/frame.ts@@ -129,9 +129,8 @@ export class Frame extends ChannelOwner<channels.FrameChannel> implements api.Frwaiter.rejectOnEvent(this._page!, Events.Page.Close, () => this._page!._closeErrorWithReason());waiter.rejectOnEvent(this._page!, Events.Page.Crash, new Error('Navigation failed because page crashed!'));waiter.rejectOnEvent<Frame>(this._page!, Events.Page.FrameDetached, new Error('Navigating frame was detached!'), frame => frame === this);- const { timeout } = this._page!._timeoutSettings.navigationTimeout(options);- waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded.`);- waiter.rejectOnSignal(options.signal);+ const timeoutOptions = this._page!._timeoutSettings.navigationTimeout(options);+ waiter.rejectOnTimeout(timeoutOptions, `Timeout ${timeoutOptions.timeout}ms exceeded.`);return waiter;}diff --git a/packages/playwright-core/src/client/network.ts b/packages/playwright-core/src/client/network.tsindex 7c4fb67cbf..4d36f5dd0a 100644--- a/packages/playwright-core/src/client/network.ts+++ b/packages/playwright-core/src/client/network.ts@@ -804,11 +804,10 @@ export class WebSocket extends ChannelOwner<channels.WebSocketChannel> implementasync waitForEvent(event: string, optionsOrPredicate: WaitForEventOptions = {}): Promise<any> {return await this._wrapApiCall(async () => {- const { timeout, signal } = this._page._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);+ const timeoutOptions = this._page._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;const waiter = Waiter.createForEvent(this, event);- waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);- waiter.rejectOnSignal(signal);+ waiter.rejectOnTimeout(timeoutOptions, `Timeout ${timeoutOptions.timeout}ms exceeded while waiting for event "${event}"`);if (event !== Events.WebSocket.Error)waiter.rejectOnEvent(this, Events.WebSocket.Error, new Error('Socket error'));if (event !== Events.WebSocket.Close)diff --git a/packages/playwright-core/src/client/page.ts b/packages/playwright-core/src/client/page.tsindex 1fedf84e23..2d5bfbf14f 100644--- a/packages/playwright-core/src/client/page.ts+++ b/packages/playwright-core/src/client/page.ts@@ -477,13 +477,12 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Pageprivate async _waitForEvent(event: string, optionsOrPredicate: WaitForEventOptions, logLine?: string): Promise<any> {return await this._wrapApiCall(async () => {- const { timeout, signal } = this._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);+ const timeoutOptions = this._timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;const waiter = Waiter.createForEvent(this, event);if (logLine)waiter.log(logLine);- waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);- waiter.rejectOnSignal(signal);+ waiter.rejectOnTimeout(timeoutOptions, `Timeout ${timeoutOptions.timeout}ms exceeded while waiting for event "${event}"`);if (event !== Events.Page.Crash)waiter.rejectOnEvent(this, Events.Page.Crash, new Error('Page crashed'));if (event !== Events.Page.Close)diff --git a/packages/playwright-core/src/client/waiter.ts b/packages/playwright-core/src/client/waiter.tsindex a20ae8dc61..d5a5706deb 100644--- a/packages/playwright-core/src/client/waiter.ts+++ b/packages/playwright-core/src/client/waiter.ts@@ -80,25 +80,21 @@ export class Waiter {this._rejectOn(promise.then(() => { throw (typeof error === 'function' ? error() : error); }), dispose);}- rejectOnTimeout(timeout: number, message: string) {- if (!timeout)- return;- const { promise, dispose } = waitForTimeout(timeout);- this._rejectOn(promise.then(() => { throw new TimeoutError(message); }), dispose);- }+ rejectOnTimeout({ timeout, signal }: channels.TimeoutOptions, timeoutMessage: string) {+ if (signal) {+ if (signal.aborted)+ return this.rejectImmediately(new AbortError(undefined, { cause: signal.reason }));+ let rejectPromise: (e: any) => void;+ const promise = new Promise<void>((_, reject) => { rejectPromise = reject; });+ const listener = () => rejectPromise!(new AbortError(undefined, { cause: signal.reason }));+ signal.addEventListener('abort', listener, { once: true });+ this._rejectOn(promise, () => signal.removeEventListener('abort', listener));+ }- rejectOnSignal(signal: AbortSignal | undefined) {- if (!signal)- return;- if (signal.aborted) {- this.rejectImmediately(new AbortError(undefined, { cause: signal.reason }));- return;+ if (timeout) {+ const { promise, dispose } = waitForTimeout(timeout);+ this._rejectOn(promise.then(() => { throw new TimeoutError(timeoutMessage); }), dispose);}- let rejectPromise: (e: any) => void;- const promise = new Promise<void>((_, reject) => { rejectPromise = reject; });- const listener = () => rejectPromise!(new AbortError(undefined, { cause: signal.reason }));- signal.addEventListener('abort', listener, { once: true });- this._rejectOn(promise, () => signal.removeEventListener('abort', listener));}rejectImmediately(error: Error) {diff --git a/packages/playwright-core/src/client/worker.ts b/packages/playwright-core/src/client/worker.tsindex 5b193d6c5b..90987e03a8 100644--- a/packages/playwright-core/src/client/worker.ts+++ b/packages/playwright-core/src/client/worker.ts@@ -89,11 +89,10 @@ export class Worker extends ChannelOwner<channels.WorkerChannel> implements api.async waitForEvent(event: string, optionsOrPredicate: WaitForEventOptions = {}): Promise<any> {return await this._wrapApiCall(async () => {const timeoutSettings = this._page?._timeoutSettings ?? this._context?._timeoutSettings ?? new TimeoutSettings();- const { timeout, signal } = timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);+ const timeoutOptions = timeoutSettings.timeout(typeof optionsOrPredicate === 'function' ? {} : optionsOrPredicate);const predicate = typeof optionsOrPredicate === 'function' ? optionsOrPredicate : optionsOrPredicate.predicate;const waiter = Waiter.createForEvent(this, event);- waiter.rejectOnTimeout(timeout, `Timeout ${timeout}ms exceeded while waiting for event "${event}"`);- waiter.rejectOnSignal(signal);+ waiter.rejectOnTimeout(timeoutOptions, `Timeout ${timeoutOptions.timeout}ms exceeded while waiting for event "${event}"`);if (event !== Events.Worker.Close)waiter.rejectOnEvent(this, Events.Worker.Close, () => this._closeErrorWithReason());const result = await waiter.waitForEvent(this, event, predicate as any);