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: clock.uninstall (#36856)
Dmitry Gozmanc2763fe7792a
diff --git a/docs/src/api/class-clock.md b/docs/src/api/class-clock.mdindex e5610b4242..6b199e4685 100644--- a/docs/src/api/class-clock.md+++ b/docs/src/api/class-clock.md@@ -340,3 +340,8 @@ Time to be set.- `time` <[string]|[Date]>Time to be set.++## async method: Clock.uninstall+* since: v1.55++Uninstall fake clock. Note that any currently open page will be still affected by the fake clock, until it navigates away to a new document.diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.tsindex 63a2a2d9c9..01cc047648 100644--- a/packages/playwright-client/types/types.d.ts+++ b/packages/playwright-client/types/types.d.ts@@ -18798,6 +18798,12 @@ export interface Clock {* @param time Time to be set in milliseconds.*/setSystemTime(time: number|string|Date): Promise<void>;++ /**+ * Uninstall fake clock. Note that any currently open page will be still affected by the fake clock, until it+ * navigates away to a new document.+ */+ uninstall(): Promise<void>;}/**diff --git a/packages/playwright-core/src/client/clock.ts b/packages/playwright-core/src/client/clock.tsindex fdc7789b59..e9622c272a 100644--- a/packages/playwright-core/src/client/clock.ts+++ b/packages/playwright-core/src/client/clock.ts@@ -51,6 +51,10 @@ export class Clock implements api.Clock {async setSystemTime(time: string | number | Date) {await this._browserContext._channel.clockSetSystemTime(parseTime(time));}++ async uninstall() {+ await this._browserContext._channel.clockUninstall();+ }}function parseTime(time: string | number | Date): { timeNumber?: number, timeString?: string } {diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex 03cc7c57ce..8eb22ce61a 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -1158,6 +1158,8 @@ scheme.BrowserContextClockSetSystemTimeParams = tObject({timeString: tOptional(tString),});scheme.BrowserContextClockSetSystemTimeResult = tOptional(tObject({}));+scheme.BrowserContextClockUninstallParams = tOptional(tObject({}));+scheme.BrowserContextClockUninstallResult = tOptional(tObject({}));scheme.PageInitializer = tObject({mainFrame: tChannel(['Frame']),viewportSize: tOptional(tObject({diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.tsindex 839554fdc8..28a11977b6 100644--- a/packages/playwright-core/src/server/browserContext.ts+++ b/packages/playwright-core/src/server/browserContext.ts@@ -210,7 +210,7 @@ export abstract class BrowserContext extends SdkObject {// Note: we only need to reset properties from the "paramsThatAllowContextReuse" list.// All other properties force a new context.await this._resetStorage(progress);- await progress.race(this.clock.resetForReuse());+ await this.clock.uninstall(progress);await progress.race(this.setUserAgent(this._options.userAgent));await progress.race(this.clearCache());await progress.race(this.doClearCookies());diff --git a/packages/playwright-core/src/server/clock.ts b/packages/playwright-core/src/server/clock.tsindex 5972e99799..59964b2807 100644--- a/packages/playwright-core/src/server/clock.ts+++ b/packages/playwright-core/src/server/clock.ts@@ -28,8 +28,8 @@ export class Clock {this._browserContext = browserContext;}- async resetForReuse() {- await this._browserContext.removeInitScripts(this._initScripts);+ async uninstall(progress: Progress) {+ await progress.race(this._browserContext.removeInitScripts(this._initScripts));this._initScripts = [];}diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.tsindex 2dc4bf68ac..15c8f84fd0 100644--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts@@ -400,6 +400,10 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channelawait this._context.clock.setSystemTime(progress, params.timeString ?? params.timeNumber ?? 0);}+ async clockUninstall(params: channels.BrowserContextClockUninstallParams, progress: Progress): Promise<channels.BrowserContextClockUninstallResult> {+ await this._context.clock.uninstall(progress);+ }+async updateSubscription(params: channels.BrowserContextUpdateSubscriptionParams, progress: Progress): Promise<void> {if (params.enabled)this._subscriptions.add(params.event);diff --git a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.tsindex ce1be44af8..87121b0bed 100644--- a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts+++ b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts@@ -97,6 +97,7 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri['BrowserContext.clockRunFor', { title: 'Run clock "{ticksNumber}{ticksString}"', }],['BrowserContext.clockSetFixedTime', { title: 'Set fixed time "{timeNumber}{timeString}"', }],['BrowserContext.clockSetSystemTime', { title: 'Set system time "{timeNumber}{timeString}"', }],+ ['BrowserContext.clockUninstall', { title: 'Uninstall clock', }],['Page.addInitScript', { }],['Page.close', { title: 'Close page', }],['Page.emulateMedia', { title: 'Emulate media', snapshot: true, }],diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.tsindex 63a2a2d9c9..01cc047648 100644--- a/packages/playwright-core/types/types.d.ts+++ b/packages/playwright-core/types/types.d.ts@@ -18798,6 +18798,12 @@ export interface Clock {* @param time Time to be set in milliseconds.*/setSystemTime(time: number|string|Date): Promise<void>;++ /**+ * Uninstall fake clock. Note that any currently open page will be still affected by the fake clock, until it+ * navigates away to a new document.+ */+ uninstall(): Promise<void>;}/**diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex 10749d68c6..33fce000bf 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -1627,6 +1627,7 @@ export interface BrowserContextChannel extends BrowserContextEventTarget, EventTclockRunFor(params: BrowserContextClockRunForParams, progress?: Progress): Promise<BrowserContextClockRunForResult>;clockSetFixedTime(params: BrowserContextClockSetFixedTimeParams, progress?: Progress): Promise<BrowserContextClockSetFixedTimeResult>;clockSetSystemTime(params: BrowserContextClockSetSystemTimeParams, progress?: Progress): Promise<BrowserContextClockSetSystemTimeResult>;+ clockUninstall(params?: BrowserContextClockUninstallParams, progress?: Progress): Promise<BrowserContextClockUninstallResult>;}export type BrowserContextBindingCallEvent = {binding: BindingCallChannel,@@ -2005,6 +2006,9 @@ export type BrowserContextClockSetSystemTimeOptions = {timeString?: string,};export type BrowserContextClockSetSystemTimeResult = void;+export type BrowserContextClockUninstallParams = {};+export type BrowserContextClockUninstallOptions = {};+export type BrowserContextClockUninstallResult = void;export interface BrowserContextEvents {'bindingCall': BrowserContextBindingCallEvent;diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex b5b89cf251..5bd36be29a 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -1450,6 +1450,9 @@ BrowserContext:timeNumber: number?timeString: string?+ clockUninstall:+ title: Uninstall clock+events:bindingCall:diff --git a/tests/library/page-clock.spec.ts b/tests/library/page-clock.spec.tsindex 277ec46726..8545f8ef67 100644--- a/tests/library/page-clock.spec.ts+++ b/tests/library/page-clock.spec.ts@@ -565,3 +565,16 @@ it('correctly increments Date.now()/performance.now() during blocking execution'await page.goto(server.PREFIX + '/repro.html');await waitForDone;});++it('should uninstall', async ({ page }) => {+ await page.clock.install({ time: 0 });+ await page.clock.pauseAt(1000);+ expect(await page.evaluate(() => Date.now())).toBe(1000);++ await page.goto('about:blank');+ expect(await page.evaluate(() => Date.now())).toBe(1000);++ await page.clock.uninstall();+ await page.goto('about:blank');+ expect(await page.evaluate(() => Date.now())).not.toBe(1000);+});