feat: clock.uninstall (microsoft#36856)

Author: dgozman

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.

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>;
 }
 
 /**

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 } {

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({

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());

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 = [];
   }
 

packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts

@@ -400,6 +400,10 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
     await 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);

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, }],

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>;
 }
 
 /**

packages/protocol/src/channels.d.ts

@@ -1627,6 +1627,7 @@ export interface BrowserContextChannel extends BrowserContextEventTarget, EventT
   clockRunFor(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;