chore: reset page/context for reuse in component tests (#13264)

Author: pavelfeldman

packages/playwright-core/src/client/browserContext.ts

@@ -242,11 +242,20 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
     await this._channel.addInitScript({ source });
   }
 
+  async _removeInitScripts() {
+    await this._channel.removeInitScripts();
+  }
+
   async exposeBinding(name: string, callback: (source: structs.BindingSource, ...args: any[]) => any, options: { handle?: boolean } = {}): Promise<void> {
     await this._channel.exposeBinding({ name, needsHandle: options.handle });
     this._bindings.set(name, callback);
   }
 
+  async _removeExposedBindings() {
+    this._bindings.clear();
+    await this._channel.removeExposedBindings();
+  }
+
   async exposeFunction(name: string, callback: Function): Promise<void> {
     await this._channel.exposeBinding({ name });
     const binding = (source: structs.BindingSource, ...args: any[]) => callback(...args);
@@ -265,6 +274,11 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
       await this._disableInterception();
   }
 
+  async _unrouteAll() {
+    this._routes = [];
+    await this._disableInterception();
+  }
+
   private async _disableInterception() {
     await this._channel.setNetworkInterceptionEnabled({ enabled: false });
   }
@@ -346,6 +360,12 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
   }) {
     await this._channel.recorderSupplementEnable(params);
   }
+
+  async _resetForReuse() {
+    await this._unrouteAll();
+    await this._removeInitScripts();
+    await this._removeExposedBindings();
+  }
 }
 
 async function prepareStorageState(options: BrowserContextOptions): Promise<channels.BrowserNewContextParams['storageState']> {

packages/playwright-core/src/client/page.ts

@@ -329,6 +329,11 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
     this._bindings.set(name, callback);
   }
 
+  async _removeExposedBindings() {
+    this._bindings.clear();
+    await this._channel.removeExposedBindings();
+  }
+
   async setExtraHTTPHeaders(headers: Headers) {
     validateHeaders(headers);
     await this._channel.setExtraHTTPHeaders({ headers: headersObjectToArray(headers) });
@@ -449,6 +454,10 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
     await this._channel.addInitScript({ source });
   }
 
+  async _removeInitScripts() {
+    await this._channel.removeInitScripts();
+  }
+
   async route(url: URLMatch, handler: RouteHandlerCallback, options: { times?: number } = {}): Promise<void> {
     this._routes.unshift(new RouteHandler(this._browserContext._options.baseURL, url, handler, options.times));
     if (this._routes.length === 1)
@@ -461,6 +470,11 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
       await this._disableInterception();
   }
 
+  async _unrouteAll() {
+    this._routes = [];
+    await this._disableInterception();
+  }
+
   private async _disableInterception() {
     await this._channel.setNetworkInterceptionEnabled({ enabled: false });
   }
@@ -715,6 +729,12 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
     }
     return buffer;
   }
+
+  async _resetForReuse() {
+    await this._unrouteAll();
+    await this._removeInitScripts();
+    await this._removeExposedBindings();
+  }
 }
 
 export class BindingCall extends ChannelOwner<channels.BindingCallChannel> {

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

@@ -125,6 +125,10 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
     });
   }
 
+  async removeExposedBindings() {
+    await this._context.removeExposedBindings();
+  }
+
   async newPage(params: channels.BrowserContextNewPageParams, metadata: CallMetadata): Promise<channels.BrowserContextNewPageResult> {
     return { page: lookupDispatcher<PageDispatcher>(await this._context.newPage(metadata)) };
   }
@@ -169,6 +173,10 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
     await this._context.addInitScript(params.source);
   }
 
+  async removeInitScripts(): Promise<void> {
+    await this._context.removeInitScripts();
+  }
+
   async setNetworkInterceptionEnabled(params: channels.BrowserContextSetNetworkInterceptionEnabledParams): Promise<void> {
     if (!params.enabled) {
       await this._context.setRequestInterceptor(undefined);

packages/playwright-core/src/dispatchers/pageDispatcher.ts

@@ -107,6 +107,10 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel> imple
     });
   }
 
+  async removeExposedBindings() {
+    await this._page.removeExposedBindings();
+  }
+
   async setExtraHTTPHeaders(params: channels.PageSetExtraHTTPHeadersParams, metadata: CallMetadata): Promise<void> {
     await this._page.setExtraHTTPHeaders(params.headers);
   }
@@ -140,6 +144,10 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel> imple
     await this._page.addInitScript(params.source);
   }
 
+  async removeInitScripts(): Promise<void> {
+    await this._page.removeInitScripts();
+  }
+
   async setNetworkInterceptionEnabled(params: channels.PageSetNetworkInterceptionEnabledParams, metadata: CallMetadata): Promise<void> {
     if (!params.enabled) {
       await this._page.setClientRequestInterceptor(undefined);

packages/playwright-core/src/protocol/channels.ts

@@ -1056,11 +1056,13 @@ export interface BrowserContextChannel extends BrowserContextEventTarget, EventT
   _type_BrowserContext: boolean;
   addCookies(params: BrowserContextAddCookiesParams, metadata?: Metadata): Promise<BrowserContextAddCookiesResult>;
   addInitScript(params: BrowserContextAddInitScriptParams, metadata?: Metadata): Promise<BrowserContextAddInitScriptResult>;
+  removeInitScripts(params?: BrowserContextRemoveInitScriptsParams, metadata?: Metadata): Promise<BrowserContextRemoveInitScriptsResult>;
   clearCookies(params?: BrowserContextClearCookiesParams, metadata?: Metadata): Promise<BrowserContextClearCookiesResult>;
   clearPermissions(params?: BrowserContextClearPermissionsParams, metadata?: Metadata): Promise<BrowserContextClearPermissionsResult>;
   close(params?: BrowserContextCloseParams, metadata?: Metadata): Promise<BrowserContextCloseResult>;
   cookies(params: BrowserContextCookiesParams, metadata?: Metadata): Promise<BrowserContextCookiesResult>;
   exposeBinding(params: BrowserContextExposeBindingParams, metadata?: Metadata): Promise<BrowserContextExposeBindingResult>;
+  removeExposedBindings(params?: BrowserContextRemoveExposedBindingsParams, metadata?: Metadata): Promise<BrowserContextRemoveExposedBindingsResult>;
   grantPermissions(params: BrowserContextGrantPermissionsParams, metadata?: Metadata): Promise<BrowserContextGrantPermissionsResult>;
   newPage(params?: BrowserContextNewPageParams, metadata?: Metadata): Promise<BrowserContextNewPageResult>;
   setDefaultNavigationTimeoutNoReply(params: BrowserContextSetDefaultNavigationTimeoutNoReplyParams, metadata?: Metadata): Promise<BrowserContextSetDefaultNavigationTimeoutNoReplyResult>;
@@ -1131,6 +1133,9 @@ export type BrowserContextAddInitScriptOptions = {
 
 };
 export type BrowserContextAddInitScriptResult = void;
+export type BrowserContextRemoveInitScriptsParams = {};
+export type BrowserContextRemoveInitScriptsOptions = {};
+export type BrowserContextRemoveInitScriptsResult = void;
 export type BrowserContextClearCookiesParams = {};
 export type BrowserContextClearCookiesOptions = {};
 export type BrowserContextClearCookiesResult = void;
@@ -1157,6 +1162,9 @@ export type BrowserContextExposeBindingOptions = {
   needsHandle?: boolean,
 };
 export type BrowserContextExposeBindingResult = void;
+export type BrowserContextRemoveExposedBindingsParams = {};
+export type BrowserContextRemoveExposedBindingsOptions = {};
+export type BrowserContextRemoveExposedBindingsResult = void;
 export type BrowserContextGrantPermissionsParams = {
   permissions: string[],
   origin?: string,
@@ -1337,9 +1345,11 @@ export interface PageChannel extends PageEventTarget, EventTargetChannel {
   setDefaultTimeoutNoReply(params: PageSetDefaultTimeoutNoReplyParams, metadata?: Metadata): Promise<PageSetDefaultTimeoutNoReplyResult>;
   setFileChooserInterceptedNoReply(params: PageSetFileChooserInterceptedNoReplyParams, metadata?: Metadata): Promise<PageSetFileChooserInterceptedNoReplyResult>;
   addInitScript(params: PageAddInitScriptParams, metadata?: Metadata): Promise<PageAddInitScriptResult>;
+  removeInitScripts(params?: PageRemoveInitScriptsParams, metadata?: Metadata): Promise<PageRemoveInitScriptsResult>;
   close(params: PageCloseParams, metadata?: Metadata): Promise<PageCloseResult>;
   emulateMedia(params: PageEmulateMediaParams, metadata?: Metadata): Promise<PageEmulateMediaResult>;
   exposeBinding(params: PageExposeBindingParams, metadata?: Metadata): Promise<PageExposeBindingResult>;
+  removeExposedBindings(params?: PageRemoveExposedBindingsParams, metadata?: Metadata): Promise<PageRemoveExposedBindingsResult>;
   goBack(params: PageGoBackParams, metadata?: Metadata): Promise<PageGoBackResult>;
   goForward(params: PageGoForwardParams, metadata?: Metadata): Promise<PageGoForwardResult>;
   reload(params: PageReloadParams, metadata?: Metadata): Promise<PageReloadResult>;
@@ -1439,6 +1449,9 @@ export type PageAddInitScriptOptions = {
 
 };
 export type PageAddInitScriptResult = void;
+export type PageRemoveInitScriptsParams = {};
+export type PageRemoveInitScriptsOptions = {};
+export type PageRemoveInitScriptsResult = void;
 export type PageCloseParams = {
   runBeforeUnload?: boolean,
 };
@@ -1467,6 +1480,9 @@ export type PageExposeBindingOptions = {
   needsHandle?: boolean,
 };
 export type PageExposeBindingResult = void;
+export type PageRemoveExposedBindingsParams = {};
+export type PageRemoveExposedBindingsOptions = {};
+export type PageRemoveExposedBindingsResult = void;
 export type PageGoBackParams = {
   timeout?: number,
   waitUntil?: LifecycleEvent,

packages/playwright-core/src/protocol/protocol.yml

@@ -761,6 +761,8 @@ BrowserContext:
       parameters:
         source: string
 
+    removeInitScripts:
+
     clearCookies:
 
     clearPermissions:
@@ -782,6 +784,8 @@ BrowserContext:
         name: string
         needsHandle: boolean?
 
+    removeExposedBindings:
+
     grantPermissions:
       parameters:
         permissions:
@@ -873,7 +877,6 @@ BrowserContext:
       returns:
         writableStream: WritableStream
 
-
   events:
 
     bindingCall:
@@ -960,6 +963,8 @@ Page:
       parameters:
         source: string
 
+    removeInitScripts:
+
     close:
       parameters:
         runBeforeUnload: boolean?
@@ -1001,6 +1006,8 @@ Page:
         name: string
         needsHandle: boolean?
 
+    removeExposedBindings:
+
     goBack:
       parameters:
         timeout: number?

packages/playwright-core/src/protocol/validator.ts

@@ -444,6 +444,7 @@ export function createScheme(tChannel: (name: string) => Validator): Scheme {
   scheme.BrowserContextAddInitScriptParams = tObject({
     source: tString,
   });
+  scheme.BrowserContextRemoveInitScriptsParams = tOptional(tObject({}));
   scheme.BrowserContextClearCookiesParams = tOptional(tObject({}));
   scheme.BrowserContextClearPermissionsParams = tOptional(tObject({}));
   scheme.BrowserContextCloseParams = tOptional(tObject({}));
@@ -454,6 +455,7 @@ export function createScheme(tChannel: (name: string) => Validator): Scheme {
     name: tString,
     needsHandle: tOptional(tBoolean),
   });
+  scheme.BrowserContextRemoveExposedBindingsParams = tOptional(tObject({}));
   scheme.BrowserContextGrantPermissionsParams = tObject({
     permissions: tArray(tString),
     origin: tOptional(tString),
@@ -519,6 +521,7 @@ export function createScheme(tChannel: (name: string) => Validator): Scheme {
   scheme.PageAddInitScriptParams = tObject({
     source: tString,
   });
+  scheme.PageRemoveInitScriptsParams = tOptional(tObject({}));
   scheme.PageCloseParams = tObject({
     runBeforeUnload: tOptional(tBoolean),
   });
@@ -532,6 +535,7 @@ export function createScheme(tChannel: (name: string) => Validator): Scheme {
     name: tString,
     needsHandle: tOptional(tBoolean),
   });
+  scheme.PageRemoveExposedBindingsParams = tOptional(tObject({}));
   scheme.PageGoBackParams = tObject({
     timeout: tOptional(tNumber),
     waitUntil: tOptional(tType('LifecycleEvent')),

packages/playwright-core/src/server/browserContext.ts

@@ -163,7 +163,9 @@ export abstract class BrowserContext extends SdkObject {
   protected abstract doClearPermissions(): Promise<void>;
   protected abstract doSetHTTPCredentials(httpCredentials?: types.Credentials): Promise<void>;
   protected abstract doAddInitScript(expression: string): Promise<void>;
+  protected abstract doRemoveInitScripts(): Promise<void>;
   protected abstract doExposeBinding(binding: PageBinding): Promise<void>;
+  protected abstract doRemoveExposedBindings(): Promise<void>;
   protected abstract doUpdateRequestInterception(): Promise<void>;
   protected abstract doClose(): Promise<void>;
   protected abstract onClosePersistent(): void;
@@ -190,6 +192,11 @@ export abstract class BrowserContext extends SdkObject {
     await this.doExposeBinding(binding);
   }
 
+  async removeExposedBindings() {
+    this._pageBindings.clear();
+    await this.doRemoveExposedBindings();
+  }
+
   async grantPermissions(permissions: string[], origin?: string) {
     let resolvedOrigin = '*';
     if (origin) {
@@ -270,6 +277,11 @@ export abstract class BrowserContext extends SdkObject {
     await this.doAddInitScript(script);
   }
 
+  async removeInitScripts(): Promise<void> {
+    this.initScripts.splice(0, this.initScripts.length);
+    await this.doRemoveInitScripts();
+  }
+
   async setRequestInterceptor(handler: network.RouteHandler | undefined): Promise<void> {
     this._requestInterceptor = handler;
     await this.doUpdateRequestInterception();

packages/playwright-core/src/server/chromium/crBrowser.ts

@@ -464,11 +464,21 @@ export class CRBrowserContext extends BrowserContext {
       await (page._delegate as CRPage).addInitScript(source);
   }
 
+  async doRemoveInitScripts() {
+    for (const page of this.pages())
+      await (page._delegate as CRPage).removeInitScripts();
+  }
+
   async doExposeBinding(binding: PageBinding) {
     for (const page of this.pages())
       await (page._delegate as CRPage).exposeBinding(binding);
   }
 
+  async doRemoveExposedBindings() {
+    for (const page of this.pages())
+      await (page._delegate as CRPage).removeExposedBindings();
+  }
+
   async doUpdateRequestInterception(): Promise<void> {
     for (const page of this.pages())
       await (page._delegate as CRPage).updateRequestInterception();