Skip to content

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

fix(clock): support AbortSignal.timeout (#39306)

Simon Knott456097c316df
diff --git a/packages/injected/src/clock.ts b/packages/injected/src/clock.ts
index c623e0f54f..418bdb7a8f 100644
--- a/packages/injected/src/clock.ts
+++ b/packages/injected/src/clock.ts
@@ -18,6 +18,7 @@ export type ClockConfig = {
export type InstallConfig = ClockConfig & {
toFake?: (keyof Builtins)[];
+ browserName?: string;
};
enum TimerType {
@@ -612,10 +613,11 @@ function platformOriginals(globalObject: WindowOrWorkerGlobalScope): { raw: Buil
Date: (globalObject as any).Date,
performance: globalObject.performance,
Intl: (globalObject as any).Intl,
+ AbortSignal: (globalObject as any).AbortSignal,
};
const bound = { ...raw };
for (const key of Object.keys(bound) as (keyof Builtins)[]) {
- if (key !== 'Date' && typeof bound[key] === 'function')
+ if (key !== 'Date' && key !== 'AbortSignal' && typeof bound[key] === 'function')
bound[key] = (bound[key] as any).bind(globalObject);
}
return { raw, bound };
@@ -631,7 +633,7 @@ function getScheduleHandler(type: TimerType) {
return `set${type}`;
}
-function createApi(clock: ClockController, originals: Builtins): Builtins {
+function createApi(clock: ClockController, originals: Builtins, browserName?: string): Builtins {
return {
setTimeout: (func: TimerHandler, timeout?: number | undefined, ...args: any[]) => {
const delay = timeout ? +timeout : timeout;
@@ -688,6 +690,7 @@ function createApi(clock: ClockController, originals: Builtins): Builtins {
Intl: originals.Intl ? createIntl(clock, originals.Intl) : (undefined as unknown as Builtins['Intl']),
Date: createDate(clock, originals.Date),
performance: originals.performance ? fakePerformance(clock, originals.performance) : (undefined as unknown as Builtins['performance']),
+ AbortSignal: originals.AbortSignal ? fakeAbortSignal(clock, originals.AbortSignal, browserName) : (undefined as unknown as Builtins['AbortSignal']),
};
}
@@ -715,7 +718,27 @@ function fakePerformance(clock: ClockController, performance: Builtins['performa
return result;
}
-export function createClock(globalObject: WindowOrWorkerGlobalScope): { clock: ClockController, api: Builtins, originals: Builtins } {
+function fakeAbortSignal(clock: ClockController, abortSignal: Builtins['AbortSignal'], browserName?: string): Builtins['AbortSignal'] {
+ Object.defineProperty(abortSignal, 'timeout', {
+ value(ms: number) {
+ const controller = new AbortController();
+ clock.addTimer({
+ delay: ms,
+ type: TimerType.Timeout,
+ func: () => controller.abort(
+ new DOMException(
+ browserName === 'chromium' ? 'signal timed out' : 'The operation timed out.',
+ 'TimeoutError'
+ )
+ ),
+ });
+ return controller.signal;
+ }
+ });
+ return abortSignal;
+}
+
+export function createClock(globalObject: WindowOrWorkerGlobalScope, config: InstallConfig = {}): { clock: ClockController, api: Builtins, originals: Builtins } {
const originals = platformOriginals(globalObject);
const embedder: Embedder = {
dateNow: () => originals.raw.Date.now(),
@@ -731,7 +754,7 @@ export function createClock(globalObject: WindowOrWorkerGlobalScope): { clock: C
};
const clock = new ClockController(embedder);
- const api = createApi(clock, originals.bound);
+ const api = createApi(clock, originals.bound, config.browserName);
return { clock, api, originals: originals.raw };
}
@@ -742,7 +765,7 @@ export function install(globalObject: WindowOrWorkerGlobalScope, config: Install
throw new TypeError(`Can't install fake timers twice on the same global object.`);
}
- const { clock, api, originals } = createClock(globalObject);
+ const { clock, api, originals } = createClock(globalObject, config);
const toFake = config.toFake?.length ? config.toFake : Object.keys(originals) as (keyof Builtins)[];
for (const method of toFake) {
@@ -750,6 +773,8 @@ export function install(globalObject: WindowOrWorkerGlobalScope, config: Install
(globalObject as any).Date = mirrorDateProperties(api.Date, (globalObject as any).Date);
} else if (method === 'Intl') {
(globalObject as any).Intl = api[method]!;
+ } else if (method === 'AbortSignal') {
+ (globalObject as any).AbortSignal = api[method]!;
} else if (method === 'performance') {
(globalObject as any).performance = api[method]!;
const kEventTimeStamp = Symbol('playwrightEventTimeStamp');
@@ -773,9 +798,9 @@ export function install(globalObject: WindowOrWorkerGlobalScope, config: Install
return { clock, api, originals };
}
-export function inject(globalObject: WindowOrWorkerGlobalScope) {
+export function inject(globalObject: WindowOrWorkerGlobalScope, browserName?: string) {
const builtins = platformOriginals(globalObject).bound;
- const { clock: controller } = install(globalObject);
+ const { clock: controller } = install(globalObject, { browserName });
controller.resume();
return {
controller,
diff --git a/packages/injected/src/utilityScript.ts b/packages/injected/src/utilityScript.ts
index e61ad96d45..5c54d9ed98 100644
--- a/packages/injected/src/utilityScript.ts
+++ b/packages/injected/src/utilityScript.ts
@@ -29,6 +29,7 @@ export type Builtins = {
performance: Window['performance'],
Intl: typeof window['Intl'],
Date: typeof window['Date'],
+ AbortSignal: typeof window['AbortSignal'],
};
export class UtilityScript {
@@ -55,6 +56,7 @@ export class UtilityScript {
performance: global.performance,
Intl: global.Intl,
Date: global.Date,
+ AbortSignal: global.AbortSignal,
} satisfies Builtins;
}
if (this.isUnderTest)
diff --git a/packages/playwright-core/src/server/clock.ts b/packages/playwright-core/src/server/clock.ts
index 59964b2807..86427c7b84 100644
--- a/packages/playwright-core/src/server/clock.ts
+++ b/packages/playwright-core/src/server/clock.ts
@@ -98,7 +98,7 @@ export class Clock {
const module = {};
${rawClockSource.source}
if (!globalThis.__pwClock)
- globalThis.__pwClock = (module.exports.inject())(globalThis);
+ globalThis.__pwClock = (module.exports.inject())(globalThis, ${JSON.stringify(this._browserContext._browser.options.name)});
})();`;
const initScript = await this._browserContext.addInitScript(progress, script);
await progress.race(this._evaluateInFrames(script));
diff --git a/tests/library/page-clock.spec.ts b/tests/library/page-clock.spec.ts
index 277ec46726..8d653da944 100644
--- a/tests/library/page-clock.spec.ts
+++ b/tests/library/page-clock.spec.ts
@@ -534,6 +534,53 @@ it.describe('Date.now', () => {
});
});
+it('AbortSignal.timeout', { annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/39293' } }, async ({ page, browserName }) => {
+ await page.clock.install({ time: 0 });
+ const controller = await page.evaluateHandle(() => {
+ const signal = AbortSignal.any([
+ AbortSignal.timeout(100)
+ ]);
+ const handle = {
+ signal,
+ event: false,
+ handler: false,
+ };
+ signal.addEventListener('abort', () => handle.event = true);
+ signal.onabort = () => handle.handler = true;
+ return handle;
+ });
+ expect(await controller.evaluate(handle => ({
+ signal: handle.signal.aborted,
+ event: handle.event,
+ handler: handle.handler,
+ }))).toEqual({
+ signal: false,
+ event: false,
+ handler: false,
+ });
+ await page.clock.runFor(200);
+ expect(await controller.evaluate(handle => ({
+ signal: handle.signal.aborted,
+ event: handle.event,
+ handler: handle.handler,
+ reason: {
+ name: handle.signal.reason.name,
+ message: handle.signal.reason.message,
+ code: handle.signal.reason.code,
+ },
+ }))).toEqual({
+ signal: true,
+ event: true,
+ handler: true,
+ reason: {
+ name: 'TimeoutError',
+ message: browserName === 'chromium' ? 'signal timed out' : 'The operation timed out.',
+ code: 23,
+ },
+ });
+ expect(await page.evaluate(() => AbortSignal.abort().aborted)).toBe(true);
+});
+
it('correctly increments Date.now()/performance.now() during blocking execution', {
annotation: {
type: 'issue',