Skip to content

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

feat(api): introduce disposable return values (#39504)

Pavel Feldman528c7044a8cc
diff --git a/docs/src/api/class-browsercontext.md b/docs/src/api/class-browsercontext.md
index 384ae34abb..2f345a46e5 100644
--- a/docs/src/api/class-browsercontext.md
+++ b/docs/src/api/class-browsercontext.md
@@ -338,6 +338,7 @@ await context.AddCookiesAsync(new[] { cookie1, cookie2 });
## async method: BrowserContext.addInitScript
* since: v1.8
+- returns: <[Disposable]>
Adds a script which would be evaluated in one of the following scenarios:
* Whenever a page is created in the browser context or is navigated.
@@ -584,6 +585,7 @@ Optional list of URLs.
## async method: BrowserContext.exposeBinding
* since: v1.8
+- returns: <[Disposable]>
The method adds a function called [`param: name`] on the `window` object of every frame in every page in the context.
When called, the function executes [`param: callback`] and returns a [Promise] which resolves to the return value of
@@ -735,6 +737,7 @@ supported. When passing by value, multiple arguments are supported.
## async method: BrowserContext.exposeFunction
* since: v1.8
+- returns: <[Disposable]>
The method adds a function called [`param: name`] on the `window` object of every frame in every page in the context.
When called, the function executes [`param: callback`] and returns a [Promise] which resolves to the return value of
diff --git a/docs/src/api/class-disposable.md b/docs/src/api/class-disposable.md
new file mode 100644
index 0000000000..2453f28252
--- /dev/null
+++ b/docs/src/api/class-disposable.md
@@ -0,0 +1,12 @@
+# class: Disposable
+* since: v1.59
+* langs: js
+
+[Disposable] is returned from various methods to allow undoing the corresponding action. For example,
+[`method: Page.addInitScript`] returns a [Disposable] that can be used to remove the init script.
+
+## async method: Disposable.dispose
+* since: v1.59
+
+Removes the associated resource. For example, removes the init script installed via
+[`method: Page.addInitScript`] or [`method: BrowserContext.addInitScript`].
diff --git a/docs/src/api/class-page.md b/docs/src/api/class-page.md
index 8e89b1af12..5150aaa51e 100644
--- a/docs/src/api/class-page.md
+++ b/docs/src/api/class-page.md
@@ -559,6 +559,7 @@ page.
## async method: Page.addInitScript
* since: v1.8
+- returns: <[Disposable]>
Adds a script which would be evaluated in one of the following scenarios:
* Whenever the page is navigated.
@@ -1717,6 +1718,7 @@ Optional argument to pass to [`param: expression`].
## async method: Page.exposeBinding
* since: v1.8
+- returns: <[Disposable]>
The method adds a function called [`param: name`] on the `window` object of every frame in this page. When called, the
function executes [`param: callback`] and returns a [Promise] which resolves to the return value of [`param: callback`].
@@ -1882,6 +1884,7 @@ supported. When passing by value, multiple arguments are supported.
## async method: Page.exposeFunction
* since: v1.8
+- returns: <[Disposable]>
The method adds a function called [`param: name`] on the `window` object of every frame in the page. When called, the
function executes [`param: callback`] and returns a [Promise] which resolves to the return value of [`param: callback`].
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
index e20be3e3d7..1dc4b7db36 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -315,7 +315,7 @@ export interface Page {
* [`script`](https://playwright.dev/docs/api/class-page#page-add-init-script-option-script) (only supported when
* passing a function).
*/
- addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<void>;
+ addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<Disposable>;
/**
* **NOTE** Use locator-based [page.locator(selector[, options])](https://playwright.dev/docs/api/class-page#page-locator)
@@ -920,7 +920,7 @@ export interface Page {
* @param callback Callback function that will be called in the Playwright's context.
* @param options
*/
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<void>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<Disposable>;
/**
* The method adds a function called
* [`name`](https://playwright.dev/docs/api/class-page#page-expose-binding-option-name) on the `window` object of
@@ -972,7 +972,7 @@ export interface Page {
* @param callback Callback function that will be called in the Playwright's context.
* @param options
*/
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<void>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<Disposable>;
/**
* Removes all the listeners of the given type (or all registered listeners if no type given). Allows to wait for
@@ -2758,7 +2758,7 @@ export interface Page {
* @param name Name of the function on the window object
* @param callback Callback function which will be called in Playwright's context.
*/
- exposeFunction(name: string, callback: Function): Promise<void>;
+ exposeFunction(name: string, callback: Function): Promise<Disposable>;
/**
* **NOTE** Use locator-based [locator.fill(value[, options])](https://playwright.dev/docs/api/class-locator#locator-fill)
@@ -8471,7 +8471,7 @@ export interface BrowserContext {
* @param callback Callback function that will be called in the Playwright's context.
* @param options
*/
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<void>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<Disposable>;
/**
* The method adds a function called
* [`name`](https://playwright.dev/docs/api/class-browsercontext#browser-context-expose-binding-option-name) on the
@@ -8519,7 +8519,7 @@ export interface BrowserContext {
* @param callback Callback function that will be called in the Playwright's context.
* @param options
*/
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<void>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<Disposable>;
/**
* Adds a script which would be evaluated in one of the following scenarios:
@@ -8556,7 +8556,7 @@ export interface BrowserContext {
* [`script`](https://playwright.dev/docs/api/class-browsercontext#browser-context-add-init-script-option-script)
* (only supported when passing a function).
*/
- addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<void>;
+ addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<Disposable>;
/**
* Removes all the listeners of the given type (or all registered listeners if no type given). Allows to wait for
@@ -9345,7 +9345,7 @@ export interface BrowserContext {
* @param name Name of the function on the window object.
* @param callback Callback function that will be called in the Playwright's context.
*/
- exposeFunction(name: string, callback: Function): Promise<void>;
+ exposeFunction(name: string, callback: Function): Promise<Disposable>;
/**
* Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if
@@ -19531,6 +19531,23 @@ export interface Dialog {
type(): string;
}
+/**
+ * [Disposable](https://playwright.dev/docs/api/class-disposable) is returned from various methods to allow undoing
+ * the corresponding action. For example,
+ * [page.addInitScript(script[, arg])](https://playwright.dev/docs/api/class-page#page-add-init-script) returns a
+ * [Disposable](https://playwright.dev/docs/api/class-disposable) that can be used to remove the init script.
+ */
+export interface Disposable {
+ /**
+ * Removes the associated resource. For example, removes the init script installed via
+ * [page.addInitScript(script[, arg])](https://playwright.dev/docs/api/class-page#page-add-init-script) or
+ * [browserContext.addInitScript(script[, arg])](https://playwright.dev/docs/api/class-browsercontext#browser-context-add-init-script).
+ */
+ dispose(): Promise<void>;
+
+ [Symbol.asyncDispose](): Promise<void>;
+}
+
/**
* [Download](https://playwright.dev/docs/api/class-download) objects are dispatched by page via the
* [page.on('download')](https://playwright.dev/docs/api/class-page#page-event-download) event.
diff --git a/packages/playwright-core/src/client/api.ts b/packages/playwright-core/src/client/api.ts
index db6d504267..d84904d0d1 100644
--- a/packages/playwright-core/src/client/api.ts
+++ b/packages/playwright-core/src/client/api.ts
@@ -23,6 +23,7 @@ export { Clock } from './clock';
export { ConsoleMessage } from './consoleMessage';
export { Coverage } from './coverage';
export { Dialog } from './dialog';
+export { Disposable } from './disposable';
export { Download } from './download';
export { Electron, ElectronApplication } from './electron';
export { FrameLocator, Locator } from './locator';
diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.ts
index a123ae698b..2dab10473a 100644
--- a/packages/playwright-core/src/client/browserContext.ts
+++ b/packages/playwright-core/src/client/browserContext.ts
@@ -23,6 +23,7 @@ import { evaluationScript } from './clientHelper';
import { Clock } from './clock';
import { ConsoleMessage } from './consoleMessage';
import { Dialog } from './dialog';
+import { Disposable } from './disposable';
import { TargetClosedError, parseError } from './errors';
import { Events } from './events';
import { APIRequestContext } from './fetch';
@@ -349,20 +350,22 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
await this._channel.setHTTPCredentials({ httpCredentials: httpCredentials || undefined });
}
- async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any): Promise<void> {
+ async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any) {
const source = await evaluationScript(this._platform, script, arg);
- await this._channel.addInitScript({ source });
+ return Disposable.from((await this._channel.addInitScript({ source })).disposable);
}
- async exposeBinding(name: string, callback: (source: structs.BindingSource, ...args: any[]) => any, options: { handle?: boolean } = {}): Promise<void> {
- await this._channel.exposeBinding({ name, needsHandle: options.handle });
+ async exposeBinding(name: string, callback: (source: structs.BindingSource, ...args: any[]) => any, options: { handle?: boolean } = {}): Promise<Disposable> {
+ const result = await this._channel.exposeBinding({ name, needsHandle: options.handle });
this._bindings.set(name, callback);
+ return Disposable.from(result.disposable);
}
- async exposeFunction(name: string, callback: Function): Promise<void> {
- await this._channel.exposeBinding({ name });
+ async exposeFunction(name: string, callback: Function): Promise<Disposable> {
+ const result = await this._channel.exposeBinding({ name });
const binding = (source: structs.BindingSource, ...args: any[]) => callback(...args);
this._bindings.set(name, binding);
+ return Disposable.from(result.disposable);
}
async route(url: URLMatch, handler: network.RouteHandlerCallback, options: { times?: number } = {}): Promise<void> {
diff --git a/packages/playwright-core/src/client/connection.ts b/packages/playwright-core/src/client/connection.ts
index fcd56ee6e6..6b794e68a7 100644
--- a/packages/playwright-core/src/client/connection.ts
+++ b/packages/playwright-core/src/client/connection.ts
@@ -24,6 +24,7 @@ import { CDPSession } from './cdpSession';
import { ChannelOwner } from './channelOwner';
import { createInstrumentation } from './clientInstrumentation';
import { Dialog } from './dialog';
+import { Disposable } from './disposable';
import { Electron, ElectronApplication } from './electron';
import { ElementHandle } from './elementHandle';
import { TargetClosedError, parseError } from './errors';
@@ -270,6 +271,9 @@ export class Connection extends EventEmitter {
case 'Dialog':
result = new Dialog(parent, type, guid, initializer);
break;
+ case 'Disposable':
+ result = new Disposable(parent, type, guid, initializer);
+ break;
case 'Electron':
result = new Electron(parent, type, guid, initializer);
break;
diff --git a/packages/playwright-core/src/client/disposable.ts b/packages/playwright-core/src/client/disposable.ts
new file mode 100644
index 0000000000..fe32640e16
--- /dev/null
+++ b/packages/playwright-core/src/client/disposable.ts
@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ChannelOwner } from './channelOwner';
+import { isTargetClosedError } from './errors';
+
+import type * as channels from '@protocol/channels';
+
+export class Disposable<T extends channels.DisposableChannel = channels.DisposableChannel> extends ChannelOwner<T> {
+ static from(channel: channels.DisposableChannel): Disposable {
+ return (channel as any)._object;
+ }
+
+ async [Symbol.asyncDispose]() {
+ await this.dispose();
+ }
+
+ async dispose() {
+ try {
+ await this._channel.dispose();
+ } catch (e) {
+ if (isTargetClosedError(e))
+ return;
+ throw e;
+ }
+ }
+}
diff --git a/packages/playwright-core/src/client/page.ts b/packages/playwright-core/src/client/page.ts
index 72a4f9eda5..46dededd8a 100644
--- a/packages/playwright-core/src/client/page.ts
+++ b/packages/playwright-core/src/client/page.ts
@@ -19,6 +19,7 @@ import { Artifact } from './artifact';
import { ChannelOwner } from './channelOwner';
import { evaluationScript } from './clientHelper';
import { Coverage } from './coverage';
+import { Disposable } from './disposable';
import { Download } from './download';
import { ElementHandle, determineScreenshotType } from './elementHandle';
import { TargetClosedError, isTargetClosedError, parseError, serializeError } from './errors';
@@ -332,14 +333,16 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
}
async exposeFunction(name: string, callback: Function) {
- await this._channel.exposeBinding({ name });
+ const result = await this._channel.exposeBinding({ name });
const binding = (source: structs.BindingSource, ...args: any[]) => callback(...args);
this._bindings.set(name, binding);
+ return Disposable.from(result.disposable);
}
async exposeBinding(name: string, callback: (source: structs.BindingSource, ...args: any[]) => any, options: { handle?: boolean } = {}) {
- await this._channel.exposeBinding({ name, needsHandle: options.handle });
+ const result = await this._channel.exposeBinding({ name, needsHandle: options.handle });
this._bindings.set(name, callback);
+ return Disposable.from(result.disposable);
}
async setExtraHTTPHeaders(headers: Headers) {
@@ -507,7 +510,7 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any) {
const source = await evaluationScript(this._platform, script, arg);
- await this._channel.addInitScript({ source });
+ return Disposable.from((await this._channel.addInitScript({ source })).disposable);
}
async route(url: URLMatch, handler: RouteHandlerCallback, options: { times?: number } = {}): Promise<void> {
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index fc1fea1a46..a7b44c1542 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -987,7 +987,9 @@ scheme.BrowserContextAddCookiesResult = tOptional(tObject({}));
scheme.BrowserContextAddInitScriptParams = tObject({
source: tString,
});
-scheme.BrowserContextAddInitScriptResult = tOptional(tObject({}));
+scheme.BrowserContextAddInitScriptResult = tObject({
+ disposable: tChannel(['Disposable']),
+});
scheme.BrowserContextClearCookiesParams = tObject({
name: tOptional(tString),
nameRegexSource: tOptional(tString),
@@ -1016,7 +1018,9 @@ scheme.BrowserContextExposeBindingParams = tObject({
name: tString,
needsHandle: tOptional(tBoolean),
});
-scheme.BrowserContextExposeBindingResult = tOptional(tObject({}));
+scheme.BrowserContextExposeBindingResult = tObject({
+ disposable: tChannel(['Disposable']),
+});
scheme.BrowserContextGrantPermissionsParams = tObject({
permissions: tArray(tString),
origin: tOptional(tString),
@@ -1242,7 +1246,9 @@ scheme.PageWorkerEvent = tObject({
scheme.PageAddInitScriptParams = tObject({
source: tString,
});
-scheme.PageAddInitScriptResult = tOptional(tObject({}));
+scheme.PageAddInitScriptResult = tObject({
+ disposable: tChannel(['Disposable']),
+});
scheme.PageCloseParams = tObject({
runBeforeUnload: tOptional(tBoolean),
reason: tOptional(tString),
@@ -1276,7 +1282,9 @@ scheme.PageExposeBindingParams = tObject({
name: tString,
needsHandle: tOptional(tBoolean),
});
-scheme.PageExposeBindingResult = tOptional(tObject({}));
+scheme.PageExposeBindingResult = tObject({
+ disposable: tChannel(['Disposable']),
+});
scheme.PageGoBackParams = tObject({
timeout: tFloat,
waitUntil: tOptional(tType('LifecycleEvent')),
@@ -2028,6 +2036,9 @@ scheme.WorkerUpdateSubscriptionParams = tObject({
enabled: tBoolean,
});
scheme.WorkerUpdateSubscriptionResult = tOptional(tObject({}));
+scheme.DisposableInitializer = tOptional(tObject({}));
+scheme.DisposableDisposeParams = tOptional(tObject({}));
+scheme.DisposableDisposeResult = tOptional(tObject({}));
scheme.JSHandleInitializer = tObject({
preview: tString,
});
diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.ts
index 1dbb020a87..6fd0c6e8f1 100644
--- a/packages/playwright-core/src/server/browserContext.ts
+++ b/packages/playwright-core/src/server/browserContext.ts
@@ -169,7 +169,7 @@ export abstract class BrowserContext<EM extends EventMap = EventMap> extends Sdk
await this.exposeConsoleApi();
if (this._options.serviceWorkers === 'block')
- await this.addInitScript(undefined, `\nif (navigator.serviceWorker) navigator.serviceWorker.register = async () => { console.warn('Service Worker registration blocked by Playwright'); };\n`);
+ await this.addInitScript(`\nif (navigator.serviceWorker) navigator.serviceWorker.register = async () => { console.warn('Service Worker registration blocked by Playwright'); };\n`);
if (this._options.permissions)
await this.grantPermissions(this._options.permissions);
@@ -340,7 +340,7 @@ export abstract class BrowserContext<EM extends EventMap = EventMap> extends Sdk
this._playwrightBindingExposed ??= (async () => {
await this.doExposePlaywrightBinding();
- this.bindingsInitScript = PageBinding.createInitScript();
+ this.bindingsInitScript = PageBinding.createInitScript(this);
this.initScripts.push(this.bindingsInitScript);
await this.doAddInitScript(this.bindingsInitScript);
await this.safeNonStallingEvaluateInAllFrames(this.bindingsInitScript.source, 'main');
@@ -360,7 +360,7 @@ export abstract class BrowserContext<EM extends EventMap = EventMap> extends Sdk
throw new Error(`Function "${name}" has been already registered in one of the pages`);
}
await progress.race(this.exposePlaywrightBindingIfNeeded());
- const binding = new PageBinding(name, playwrightBinding, needsHandle);
+ const binding = new PageBinding(this, name, playwrightBinding, needsHandle);
binding.forClient = forClient;
this._pageBindings.set(name, binding);
try {
@@ -373,12 +373,12 @@ export abstract class BrowserContext<EM extends EventMap = EventMap> extends Sdk
}
}
- async removeExposedBindings(bindings: PageBinding[]) {
- bindings = bindings.filter(binding => this._pageBindings.get(binding.name) === binding);
- for (const binding of bindings)
- this._pageBindings.delete(binding.name);
- await this.doRemoveInitScripts(bindings.map(binding => binding.initScript));
- const cleanup = bindings.map(binding => `{ ${binding.cleanupScript} };\n`).join('');
+ async removeExposedBinding(binding: PageBinding) {
+ if (this._pageBindings.get(binding.name) !== binding)
+ return;
+ this._pageBindings.delete(binding.name);
+ await this.doRemoveInitScripts([binding.initScript]);
+ const cleanup = `{ ${binding.cleanupScript} };`;
await this.safeNonStallingEvaluateInAllFrames(cleanup, 'main');
}
@@ -478,27 +478,22 @@ export abstract class BrowserContext<EM extends EventMap = EventMap> extends Sdk
this._options.httpCredentials = { username, password: password || '' };
}
- async addInitScript(progress: Progress | undefined, source: string) {
- const initScript = new InitScript(source);
+ async addInitScript(source: string) {
+ const initScript = new InitScript(this, source);
this.initScripts.push(initScript);
try {
- const promise = this.doAddInitScript(initScript);
- if (progress)
- await progress.race(promise);
- else
- await promise;
+ await this.doAddInitScript(initScript);
return initScript;
} catch (error) {
// Note: no await, init script will be removed in the background as soon as possible.
- this.removeInitScripts([initScript]).catch(() => {});
+ initScript.dispose().catch(() => {});
throw error;
}
}
- async removeInitScripts(initScripts: InitScript[]) {
- const set = new Set(initScripts);
- this.initScripts = this.initScripts.filter(script => !set.has(script));
- await this.doRemoveInitScripts(initScripts);
+ async removeInitScript(initScript: InitScript) {
+ this.initScripts = this.initScripts.filter(script => initScript !== script);
+ await this.doRemoveInitScripts([initScript]);
}
async addRequestInterceptor(progress: Progress, handler: network.RouteHandler): Promise<void> {
diff --git a/packages/playwright-core/src/server/clock.ts b/packages/playwright-core/src/server/clock.ts
index 86427c7b84..4c15f9ec13 100644
--- a/packages/playwright-core/src/server/clock.ts
+++ b/packages/playwright-core/src/server/clock.ts
@@ -29,69 +29,69 @@ export class Clock {
}
async uninstall(progress: Progress) {
- await progress.race(this._browserContext.removeInitScripts(this._initScripts));
+ await progress.race(Promise.all(this._initScripts.map(script => script.dispose())));
this._initScripts = [];
}
- async fastForward(progress: Progress, ticks: number | string) {
- await this._installIfNeeded(progress);
+ async fastForward(ticks: number | string) {
+ await this._installIfNeeded();
const ticksMillis = parseTicks(ticks);
- this._initScripts.push(await this._browserContext.addInitScript(progress, `globalThis.__pwClock.controller.log('fastForward', ${Date.now()}, ${ticksMillis})`));
- await progress.race(this._evaluateInFrames(`globalThis.__pwClock.controller.fastForward(${ticksMillis})`));
+ this._initScripts.push(await this._browserContext.addInitScript(`globalThis.__pwClock.controller.log('fastForward', ${Date.now()}, ${ticksMillis})`));
+ await this._evaluateInFrames(`globalThis.__pwClock.controller.fastForward(${ticksMillis})`);
}
- async install(progress: Progress, time: number | string | undefined) {
- await this._installIfNeeded(progress);
+ async install(time: number | string | undefined) {
+ await this._installIfNeeded();
const timeMillis = time !== undefined ? parseTime(time) : Date.now();
- this._initScripts.push(await this._browserContext.addInitScript(progress, `globalThis.__pwClock.controller.log('install', ${Date.now()}, ${timeMillis})`));
- await progress.race(this._evaluateInFrames(`globalThis.__pwClock.controller.install(${timeMillis})`));
+ this._initScripts.push(await this._browserContext.addInitScript(`globalThis.__pwClock.controller.log('install', ${Date.now()}, ${timeMillis})`));
+ await this._evaluateInFrames(`globalThis.__pwClock.controller.install(${timeMillis})`);
}
- async pauseAt(progress: Progress, ticks: number | string) {
- await this._installIfNeeded(progress);
+ async pauseAt(ticks: number | string) {
+ await this._installIfNeeded();
const timeMillis = parseTime(ticks);
- this._initScripts.push(await this._browserContext.addInitScript(progress, `globalThis.__pwClock.controller.log('pauseAt', ${Date.now()}, ${timeMillis})`));
- await progress.race(this._evaluateInFrames(`globalThis.__pwClock.controller.pauseAt(${timeMillis})`));
+ this._initScripts.push(await this._browserContext.addInitScript(`globalThis.__pwClock.controller.log('pauseAt', ${Date.now()}, ${timeMillis})`));
+ await this._evaluateInFrames(`globalThis.__pwClock.controller.pauseAt(${timeMillis})`);
}
resumeNoReply() {
if (!this._initScripts.length)
return;
const doResume = async () => {
- this._initScripts.push(await this._browserContext.addInitScript(undefined, `globalThis.__pwClock.controller.log('resume', ${Date.now()})`));
+ this._initScripts.push(await this._browserContext.addInitScript(`globalThis.__pwClock.controller.log('resume', ${Date.now()})`));
await this._evaluateInFrames(`globalThis.__pwClock.controller.resume()`);
};
doResume().catch(() => {});
}
async resume(progress: Progress) {
- await this._installIfNeeded(progress);
- this._initScripts.push(await this._browserContext.addInitScript(progress, `globalThis.__pwClock.controller.log('resume', ${Date.now()})`));
- await progress.race(this._evaluateInFrames(`globalThis.__pwClock.controller.resume()`));
+ await this._installIfNeeded();
+ this._initScripts.push(await this._browserContext.addInitScript(`globalThis.__pwClock.controller.log('resume', ${Date.now()})`));
+ await this._evaluateInFrames(`globalThis.__pwClock.controller.resume()`);
}
- async setFixedTime(progress: Progress, time: string | number) {
- await this._installIfNeeded(progress);
+ async setFixedTime(time: string | number) {
+ await this._installIfNeeded();
const timeMillis = parseTime(time);
- this._initScripts.push(await this._browserContext.addInitScript(progress, `globalThis.__pwClock.controller.log('setFixedTime', ${Date.now()}, ${timeMillis})`));
- await progress.race(this._evaluateInFrames(`globalThis.__pwClock.controller.setFixedTime(${timeMillis})`));
+ this._initScripts.push(await this._browserContext.addInitScript(`globalThis.__pwClock.controller.log('setFixedTime', ${Date.now()}, ${timeMillis})`));
+ await this._evaluateInFrames(`globalThis.__pwClock.controller.setFixedTime(${timeMillis})`);
}
- async setSystemTime(progress: Progress, time: string | number) {
- await this._installIfNeeded(progress);
+ async setSystemTime(time: string | number) {
+ await this._installIfNeeded();
const timeMillis = parseTime(time);
- this._initScripts.push(await this._browserContext.addInitScript(progress, `globalThis.__pwClock.controller.log('setSystemTime', ${Date.now()}, ${timeMillis})`));
- await progress.race(this._evaluateInFrames(`globalThis.__pwClock.controller.setSystemTime(${timeMillis})`));
+ this._initScripts.push(await this._browserContext.addInitScript(`globalThis.__pwClock.controller.log('setSystemTime', ${Date.now()}, ${timeMillis})`));
+ await this._evaluateInFrames(`globalThis.__pwClock.controller.setSystemTime(${timeMillis})`);
}
- async runFor(progress: Progress, ticks: number | string) {
- await this._installIfNeeded(progress);
+ async runFor(ticks: number | string) {
+ await this._installIfNeeded();
const ticksMillis = parseTicks(ticks);
- this._initScripts.push(await this._browserContext.addInitScript(progress, `globalThis.__pwClock.controller.log('runFor', ${Date.now()}, ${ticksMillis})`));
- await progress.race(this._evaluateInFrames(`globalThis.__pwClock.controller.runFor(${ticksMillis})`));
+ this._initScripts.push(await this._browserContext.addInitScript(`globalThis.__pwClock.controller.log('runFor', ${Date.now()}, ${ticksMillis})`));
+ await this._evaluateInFrames(`globalThis.__pwClock.controller.runFor(${ticksMillis})`);
}
- private async _installIfNeeded(progress: Progress) {
+ private async _installIfNeeded() {
if (this._initScripts.length)
return;
const script = `(() => {
@@ -100,8 +100,8 @@ export class Clock {
if (!globalThis.__pwClock)
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));
+ const initScript = await this._browserContext.addInitScript(script);
+ await this._evaluateInFrames(script);
this._initScripts.push(initScript);
}
diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
index 49ba7cbda3..82756d1fa8 100644
--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
@@ -27,6 +27,7 @@ import { APIRequestContextDispatcher, RequestDispatcher, ResponseDispatcher, Rou
import { BindingCallDispatcher, PageDispatcher, WorkerDispatcher } from './pageDispatcher';
import { CRBrowser, CRBrowserContext } from '../chromium/crBrowser';
import { serializeError } from '../errors';
+import { DisposableDispatcher } from './disposableDispatcher';
import { TracingDispatcher } from './tracingDispatcher';
import { WebSocketRouteDispatcher } from './webSocketRouteDispatcher';
import { WritableStreamDispatcher } from './writableStreamDispatcher';
@@ -227,7 +228,7 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
};
}
- async exposeBinding(params: channels.BrowserContextExposeBindingParams, progress: Progress): Promise<void> {
+ async exposeBinding(params: channels.BrowserContextExposeBindingParams, progress: Progress): Promise<channels.BrowserContextExposeBindingResult> {
const binding = await this._context.exposeBinding(progress, params.name, !!params.needsHandle, (source, ...args) => {
// When reusing the context, we might have some bindings called late enough,
// after context and page dispatchers have been disposed.
@@ -239,6 +240,7 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
return binding.promise();
});
this._bindings.push(binding);
+ return { disposable: new DisposableDispatcher(this, binding) };
}
async newPage(params: channels.BrowserContextNewPageParams, progress: Progress): Promise<channels.BrowserContextNewPageResult> {
@@ -294,8 +296,10 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
await progress.race(this._context.setHTTPCredentials(params.httpCredentials));
}
- async addInitScript(params: channels.BrowserContextAddInitScriptParams, progress: Progress): Promise<void> {
- this._initScripts.push(await this._context.addInitScript(progress, params.source));
+ async addInitScript(params: channels.BrowserContextAddInitScriptParams, progress: Progress): Promise<channels.BrowserContextAddInitScriptResult> {
+ const initScript = await this._context.addInitScript(params.source);
+ this._initScripts.push(initScript);
+ return { disposable: new DisposableDispatcher(this, initScript) };
}
async setNetworkInterceptionPatterns(params: channels.BrowserContextSetNetworkInterceptionPatternsParams, progress: Progress): Promise<void> {
@@ -371,15 +375,15 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
}
async clockFastForward(params: channels.BrowserContextClockFastForwardParams, progress: Progress): Promise<channels.BrowserContextClockFastForwardResult> {
- await this._context.clock.fastForward(progress, params.ticksString ?? params.ticksNumber ?? 0);
+ await this._context.clock.fastForward(params.ticksString ?? params.ticksNumber ?? 0);
}
async clockInstall(params: channels.BrowserContextClockInstallParams, progress: Progress): Promise<channels.BrowserContextClockInstallResult> {
- await this._context.clock.install(progress, params.timeString ?? params.timeNumber ?? undefined);
+ await this._context.clock.install(params.timeString ?? params.timeNumber ?? undefined);
}
async clockPauseAt(params: channels.BrowserContextClockPauseAtParams, progress: Progress): Promise<channels.BrowserContextClockPauseAtResult> {
- await this._context.clock.pauseAt(progress, params.timeString ?? params.timeNumber ?? 0);
+ await this._context.clock.pauseAt(params.timeString ?? params.timeNumber ?? 0);
this._clockPaused = true;
}
@@ -389,15 +393,15 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
}
async clockRunFor(params: channels.BrowserContextClockRunForParams, progress: Progress): Promise<channels.BrowserContextClockRunForResult> {
- await this._context.clock.runFor(progress, params.ticksString ?? params.ticksNumber ?? 0);
+ await this._context.clock.runFor(params.ticksString ?? params.ticksNumber ?? 0);
}
async clockSetFixedTime(params: channels.BrowserContextClockSetFixedTimeParams, progress: Progress): Promise<channels.BrowserContextClockSetFixedTimeResult> {
- await this._context.clock.setFixedTime(progress, params.timeString ?? params.timeNumber ?? 0);
+ await this._context.clock.setFixedTime(params.timeString ?? params.timeNumber ?? 0);
}
async clockSetSystemTime(params: channels.BrowserContextClockSetSystemTimeParams, progress: Progress): Promise<channels.BrowserContextClockSetSystemTimeResult> {
- await this._context.clock.setSystemTime(progress, params.timeString ?? params.timeNumber ?? 0);
+ await this._context.clock.setSystemTime(params.timeString ?? params.timeNumber ?? 0);
}
async devtoolsStart(params: channels.BrowserContextDevtoolsStartParams, progress: Progress): Promise<channels.BrowserContextDevtoolsStartResult> {
@@ -429,9 +433,11 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
this._context.dialogManager.removeDialogHandler(this._dialogHandler);
this._interceptionUrlMatchers = [];
this._context.removeRequestInterceptor(this._requestInterceptor).catch(() => {});
- this._context.removeExposedBindings(this._bindings).catch(() => {});
+ for (const binding of this._bindings)
+ binding.dispose().catch(() => {});
this._bindings = [];
- this._context.removeInitScripts(this._initScripts).catch(() => {});
+ for (const initScript of this._initScripts)
+ initScript.dispose().catch(() => {});
this._initScripts = [];
if (this._routeWebSocketInitScript)
WebSocketRouteDispatcher.uninstall(this.connection, this._context, this._routeWebSocketInitScript).catch(() => {});
diff --git a/packages/playwright-core/src/server/dispatchers/disposableDispatcher.ts b/packages/playwright-core/src/server/dispatchers/disposableDispatcher.ts
new file mode 100644
index 0000000000..a262e0684e
--- /dev/null
+++ b/packages/playwright-core/src/server/dispatchers/disposableDispatcher.ts
@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Dispatcher } from './dispatcher';
+
+import type { Disposable } from '../disposable';
+import type { DispatcherScope } from './dispatcher';
+import type * as channels from '@protocol/channels';
+import type { Progress } from '@protocol/progress';
+
+export class DisposableDispatcher extends Dispatcher<Disposable, channels.DisposableChannel, DispatcherScope> implements channels.DisposableChannel {
+ _type_Disposable = true;
+
+ constructor(scope: DispatcherScope, disposable: Disposable) {
+ super(scope, disposable, 'Disposable', {});
+ }
+
+ async dispose(_: any, progress: Progress) {
+ progress.metadata.potentiallyClosesScope = true;
+ await this._object.dispose();
+ this._dispose();
+ }
+}
diff --git a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
index ccfde8ec5a..cd7a40962d 100644
--- a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
@@ -26,6 +26,7 @@ import { RequestDispatcher } from './networkDispatchers';
import { ResponseDispatcher } from './networkDispatchers';
import { RouteDispatcher, WebSocketDispatcher } from './networkDispatchers';
import { WebSocketRouteDispatcher } from './webSocketRouteDispatcher';
+import { DisposableDispatcher } from './disposableDispatcher';
import { SdkObject } from '../instrumentation';
import { deserializeURLMatch, urlMatches } from '../../utils/isomorphic/urlMatch';
import { PageAgentDispatcher } from './pageAgentDispatcher';
@@ -129,7 +130,7 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows
return this._page;
}
- async exposeBinding(params: channels.PageExposeBindingParams, progress: Progress): Promise<void> {
+ async exposeBinding(params: channels.PageExposeBindingParams, progress: Progress): Promise<channels.PageExposeBindingResult> {
const binding = await this._page.exposeBinding(progress, params.name, !!params.needsHandle, (source, ...args) => {
// When reusing the context, we might have some bindings called late enough,
// after context and page dispatchers have been disposed.
@@ -140,6 +141,7 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows
return binding.promise();
});
this._bindings.push(binding);
+ return { disposable: new DisposableDispatcher(this, binding) };
}
async setExtraHTTPHeaders(params: channels.PageSetExtraHTTPHeadersParams, progress: Progress): Promise<void> {
@@ -191,8 +193,10 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows
await this._page.setViewportSize(progress, params.viewportSize);
}
- async addInitScript(params: channels.PageAddInitScriptParams, progress: Progress): Promise<void> {
- this._initScripts.push(await this._page.addInitScript(progress, params.source));
+ async addInitScript(params: channels.PageAddInitScriptParams, progress: Progress): Promise<channels.PageAddInitScriptResult> {
+ const initScript = await this._page.addInitScript(params.source);
+ this._initScripts.push(initScript);
+ return { disposable: new DisposableDispatcher(this, initScript) };
}
async setNetworkInterceptionPatterns(params: channels.PageSetNetworkInterceptionPatternsParams, progress: Progress): Promise<void> {
@@ -421,9 +425,11 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows
// Cleanup properly and leave the page in a good state. Other clients may still connect and use it.
this._interceptionUrlMatchers = [];
this._page.removeRequestInterceptor(this._requestInterceptor).catch(() => {});
- this._page.removeExposedBindings(this._bindings).catch(() => {});
+ for (const binding of this._bindings)
+ this._page.removeExposedBinding(binding).catch(() => {});
this._bindings = [];
- this._page.removeInitScripts(this._initScripts).catch(() => {});
+ for (const initScript of this._initScripts)
+ initScript.dispose().catch(() => {});
this._initScripts = [];
if (this._routeWebSocketInitScript)
WebSocketRouteDispatcher.uninstall(this.connection, this._page, this._routeWebSocketInitScript).catch(() => {});
diff --git a/packages/playwright-core/src/server/dispatchers/webSocketRouteDispatcher.ts b/packages/playwright-core/src/server/dispatchers/webSocketRouteDispatcher.ts
index b32000341b..9015f004ad 100644
--- a/packages/playwright-core/src/server/dispatchers/webSocketRouteDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/webSocketRouteDispatcher.ts
@@ -97,7 +97,7 @@ export class WebSocketRouteDispatcher extends Dispatcher<SdkObject, channels.Web
}
++data.counter;
- return await target.addInitScript(progress, `
+ return await target.addInitScript(`
(() => {
const module = {};
${rawWebSocketMockSource.source}
@@ -112,8 +112,8 @@ export class WebSocketRouteDispatcher extends Dispatcher<SdkObject, channels.Web
if (!data || data.connection !== connection)
return;
if (--data.counter <= 0)
- await context.removeExposedBindings([data.binding]);
- await target.removeInitScripts([initScript]);
+ await data.binding.dispose();
+ await initScript.dispose();
}
async connect(params: channels.WebSocketRouteConnectParams, progress: Progress) {
diff --git a/packages/playwright-core/src/server/disposable.ts b/packages/playwright-core/src/server/disposable.ts
new file mode 100644
index 0000000000..7d7c708f9a
--- /dev/null
+++ b/packages/playwright-core/src/server/disposable.ts
@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { SdkObject } from './instrumentation';
+
+import type { Page } from './page';
+import type { BrowserContext } from './browserContext';
+
+export abstract class Disposable extends SdkObject {
+ readonly parent: Page | BrowserContext;
+
+ constructor(parent: Page | BrowserContext) {
+ super(parent, 'disposable');
+ this.parent = parent;
+ }
+
+ abstract dispose(): Promise<void>;
+}
diff --git a/packages/playwright-core/src/server/firefox/ffPage.ts b/packages/playwright-core/src/server/firefox/ffPage.ts
index 9677ab4493..f896a6196d 100644
--- a/packages/playwright-core/src/server/firefox/ffPage.ts
+++ b/packages/playwright-core/src/server/firefox/ffPage.ts
@@ -106,7 +106,7 @@ export class FFPage implements PageDelegate {
// Ideally, we somehow ensure that utility world is created before Page.ready arrives, but currently it is racy.
// Even worse, sometimes this protocol call never returns, for example when popup opens a dialog synchronously.
// Therefore, we can end up with an initialized page without utility world, although very unlikely.
- this.addInitScript(new InitScript(''), UTILITY_WORLD_NAME).catch(e => this._reportAsNew(e));
+ this.addInitScript(new InitScript(this._page, ''), UTILITY_WORLD_NAME).catch(e => this._reportAsNew(e));
}
_reportAsNew(error?: Error) {
diff --git a/packages/playwright-core/src/server/launchApp.ts b/packages/playwright-core/src/server/launchApp.ts
index ee65f3ca27..d92b83b7af 100644
--- a/packages/playwright-core/src/server/launchApp.ts
+++ b/packages/playwright-core/src/server/launchApp.ts
@@ -108,7 +108,7 @@ export async function syncLocalStorageWithSettings(page: Page, appName: string)
});
const settings = await fs.promises.readFile(settingsFile, 'utf-8').catch(() => ('{}'));
- await page.addInitScript(progress,
+ await page.addInitScript(
`(${String((settings: any) => {
// iframes w/ snapshots, etc.
if (location && location.protocol === 'data:')
diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.ts
index ec708bce58..e756c6bebc 100644
--- a/packages/playwright-core/src/server/page.ts
+++ b/packages/playwright-core/src/server/page.ts
@@ -16,6 +16,7 @@
*/
import { BrowserContext } from './browserContext';
+import { Disposable } from './disposable';
import { ConsoleMessage } from './console';
import { TargetClosedError, TimeoutError } from './errors';
import { FileChooser } from './fileChooser';
@@ -329,7 +330,7 @@ export class Page extends SdkObject<PageEventMap> {
if (this.browserContext._pageBindings.has(name))
throw new Error(`Function "${name}" has been already registered in the browser context`);
await progress.race(this.browserContext.exposePlaywrightBindingIfNeeded());
- const binding = new PageBinding(name, playwrightBinding, needsHandle);
+ const binding = new PageBinding(this, name, playwrightBinding, needsHandle);
this._pageBindings.set(name, binding);
try {
await progress.race(this.delegate.addInitScript(binding.initScript));
@@ -341,12 +342,12 @@ export class Page extends SdkObject<PageEventMap> {
}
}
- async removeExposedBindings(bindings: PageBinding[]) {
- bindings = bindings.filter(binding => this._pageBindings.get(binding.name) === binding);
- for (const binding of bindings)
- this._pageBindings.delete(binding.name);
- await this.delegate.removeInitScripts(bindings.map(binding => binding.initScript));
- const cleanup = bindings.map(binding => `{ ${binding.cleanupScript} };\n`).join('');
+ async removeExposedBinding(binding: PageBinding) {
+ if (this._pageBindings.get(binding.name) !== binding)
+ return;
+ this._pageBindings.delete(binding.name);
+ await this.delegate.removeInitScripts([binding.initScript]);
+ const cleanup = `{ ${binding.cleanupScript} };`;
await this.safeNonStallingEvaluateInAllFrames(cleanup, 'main');
}
@@ -627,23 +628,22 @@ export class Page extends SdkObject<PageEventMap> {
await this.delegate.bringToFront();
}
- async addInitScript(progress: Progress, source: string) {
- const initScript = new InitScript(source);
+ async addInitScript(source: string) {
+ const initScript = new InitScript(this, source);
this.initScripts.push(initScript);
try {
- await progress.race(this.delegate.addInitScript(initScript));
+ await this.delegate.addInitScript(initScript);
} catch (error) {
// Note: no await, script will be removed in the background as soon as possible.
- this.removeInitScripts([initScript]).catch(() => {});
+ initScript.dispose().catch(() => {});
throw error;
}
return initScript;
}
- async removeInitScripts(initScripts: InitScript[]) {
- const set = new Set(initScripts);
- this.initScripts = this.initScripts.filter(script => !set.has(script));
- await this.delegate.removeInitScripts(initScripts);
+ async removeInitScript(initScript: InitScript) {
+ this.initScripts = this.initScripts.filter(script => initScript !== script);
+ await this.delegate.removeInitScripts([initScript]);
}
needsRequestInterception(): boolean {
@@ -933,12 +933,12 @@ export class Worker extends SdkObject<WorkerEventMap> {
}
}
-export class PageBinding {
+export class PageBinding extends Disposable {
private static kController = '__playwright__binding__controller__';
static kBindingName = '__playwright__binding__';
- static createInitScript() {
- return new InitScript(`
+ static createInitScript(browserContext: BrowserContext): InitScript {
+ return new InitScript(browserContext, `
(() => {
const module = {};
${rawBindingsControllerSource.source}
@@ -956,10 +956,11 @@ export class PageBinding {
readonly cleanupScript: string;
forClient?: unknown;
- constructor(name: string, playwrightFunction: frames.FunctionWithSource, needsHandle: boolean) {
+ constructor(parent: BrowserContext | Page, name: string, playwrightFunction: frames.FunctionWithSource, needsHandle: boolean) {
+ super(parent);
this.name = name;
this.playwrightFunction = playwrightFunction;
- this.initScript = new InitScript(`globalThis['${PageBinding.kController}'].addBinding(${JSON.stringify(name)}, ${needsHandle})`);
+ this.initScript = new InitScript(parent, `globalThis['${PageBinding.kController}'].addBinding(${JSON.stringify(name)}, ${needsHandle})`);
this.needsHandle = needsHandle;
this.cleanupScript = `globalThis['${PageBinding.kController}'].removeBinding(${JSON.stringify(name)})`;
}
@@ -986,18 +987,26 @@ export class PageBinding {
context.evaluateExpressionHandle(`arg => globalThis['${PageBinding.kController}'].deliverBindingResult(arg)`, { isFunction: true }, { name, seq, error }).catch(e => debugLogger.log('error', e));
}
}
+
+ override async dispose(): Promise<void> {
+ await this.parent.removeExposedBinding(this);
+ }
}
-export class InitScript {
+export class InitScript extends Disposable {
readonly source: string;
- constructor(source: string) {
+ constructor(owner: BrowserContext | Page, source: string) {
+ super(owner);
this.source = `(() => {
${source}
})();`;
}
-}
+ async dispose() {
+ await this.parent.removeInitScript(this);
+ }
+}
async function snapshotFrameForAI(progress: Progress, frame: frames.Frame, options: { track?: string, doNotRenderActive?: boolean } = {}): Promise<{ full: string[], incremental?: string[] }> {
// Only await the topmost navigations, inner frames will be empty when racing.
diff --git a/packages/playwright-core/src/server/trace/recorder/snapshotter.ts b/packages/playwright-core/src/server/trace/recorder/snapshotter.ts
index 9b55439052..6b0c558507 100644
--- a/packages/playwright-core/src/server/trace/recorder/snapshotter.ts
+++ b/packages/playwright-core/src/server/trace/recorder/snapshotter.ts
@@ -78,7 +78,7 @@ export class Snapshotter {
// Next time we start recording, we will call addInitScript again.
if (this._initScript) {
eventsHelper.removeEventListeners(this._eventListeners);
- await this._context.removeInitScripts([this._initScript]);
+ await this._initScript.dispose();
this._initScript = undefined;
}
}
@@ -92,7 +92,7 @@ export class Snapshotter {
const { javaScriptEnabled } = this._context._options;
const initScriptSource = `(${frameSnapshotStreamer})("${this._snapshotStreamer}", ${javaScriptEnabled || javaScriptEnabled === undefined})`;
- this._initScript = await this._context.addInitScript(undefined, initScriptSource);
+ this._initScript = await this._context.addInitScript(initScriptSource);
await this._context.safeNonStallingEvaluateInAllFrames(initScriptSource, 'main');
}
diff --git a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
index 8b5f29d09b..eecd0a029f 100644
--- a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
+++ b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
@@ -205,6 +205,7 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Worker.evaluateExpression', { title: 'Evaluate', }],
['Worker.evaluateExpressionHandle', { title: 'Evaluate', }],
['Worker.updateSubscription', { internal: true, }],
+ ['Disposable.dispose', { internal: true, }],
['JSHandle.dispose', { internal: true, }],
['ElementHandle.dispose', { internal: true, }],
['JSHandle.evaluateExpression', { title: 'Evaluate', snapshot: true, pausesBeforeAction: true, }],
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index e20be3e3d7..1dc4b7db36 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -315,7 +315,7 @@ export interface Page {
* [`script`](https://playwright.dev/docs/api/class-page#page-add-init-script-option-script) (only supported when
* passing a function).
*/
- addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<void>;
+ addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<Disposable>;
/**
* **NOTE** Use locator-based [page.locator(selector[, options])](https://playwright.dev/docs/api/class-page#page-locator)
@@ -920,7 +920,7 @@ export interface Page {
* @param callback Callback function that will be called in the Playwright's context.
* @param options
*/
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<void>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<Disposable>;
/**
* The method adds a function called
* [`name`](https://playwright.dev/docs/api/class-page#page-expose-binding-option-name) on the `window` object of
@@ -972,7 +972,7 @@ export interface Page {
* @param callback Callback function that will be called in the Playwright's context.
* @param options
*/
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<void>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<Disposable>;
/**
* Removes all the listeners of the given type (or all registered listeners if no type given). Allows to wait for
@@ -2758,7 +2758,7 @@ export interface Page {
* @param name Name of the function on the window object
* @param callback Callback function which will be called in Playwright's context.
*/
- exposeFunction(name: string, callback: Function): Promise<void>;
+ exposeFunction(name: string, callback: Function): Promise<Disposable>;
/**
* **NOTE** Use locator-based [locator.fill(value[, options])](https://playwright.dev/docs/api/class-locator#locator-fill)
@@ -8471,7 +8471,7 @@ export interface BrowserContext {
* @param callback Callback function that will be called in the Playwright's context.
* @param options
*/
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<void>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<Disposable>;
/**
* The method adds a function called
* [`name`](https://playwright.dev/docs/api/class-browsercontext#browser-context-expose-binding-option-name) on the
@@ -8519,7 +8519,7 @@ export interface BrowserContext {
* @param callback Callback function that will be called in the Playwright's context.
* @param options
*/
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<void>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<Disposable>;
/**
* Adds a script which would be evaluated in one of the following scenarios:
@@ -8556,7 +8556,7 @@ export interface BrowserContext {
* [`script`](https://playwright.dev/docs/api/class-browsercontext#browser-context-add-init-script-option-script)
* (only supported when passing a function).
*/
- addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<void>;
+ addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<Disposable>;
/**
* Removes all the listeners of the given type (or all registered listeners if no type given). Allows to wait for
@@ -9345,7 +9345,7 @@ export interface BrowserContext {
* @param name Name of the function on the window object.
* @param callback Callback function that will be called in the Playwright's context.
*/
- exposeFunction(name: string, callback: Function): Promise<void>;
+ exposeFunction(name: string, callback: Function): Promise<Disposable>;
/**
* Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if
@@ -19531,6 +19531,23 @@ export interface Dialog {
type(): string;
}
+/**
+ * [Disposable](https://playwright.dev/docs/api/class-disposable) is returned from various methods to allow undoing
+ * the corresponding action. For example,
+ * [page.addInitScript(script[, arg])](https://playwright.dev/docs/api/class-page#page-add-init-script) returns a
+ * [Disposable](https://playwright.dev/docs/api/class-disposable) that can be used to remove the init script.
+ */
+export interface Disposable {
+ /**
+ * Removes the associated resource. For example, removes the init script installed via
+ * [page.addInitScript(script[, arg])](https://playwright.dev/docs/api/class-page#page-add-init-script) or
+ * [browserContext.addInitScript(script[, arg])](https://playwright.dev/docs/api/class-browsercontext#browser-context-add-init-script).
+ */
+ dispose(): Promise<void>;
+
+ [Symbol.asyncDispose](): Promise<void>;
+}
+
/**
* [Download](https://playwright.dev/docs/api/class-download) objects are dispatched by page via the
* [page.on('download')](https://playwright.dev/docs/api/class-page#page-event-download) event.
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index 8f9ca58401..b941c06c87 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -47,6 +47,7 @@ export type InitializerTraits<T> =
T extends RequestChannel ? RequestInitializer :
T extends ElementHandleChannel ? ElementHandleInitializer :
T extends JSHandleChannel ? JSHandleInitializer :
+ T extends DisposableChannel ? DisposableInitializer :
T extends WorkerChannel ? WorkerInitializer :
T extends FrameChannel ? FrameInitializer :
T extends PageChannel ? PageInitializer :
@@ -85,6 +86,7 @@ export type EventsTraits<T> =
T extends RequestChannel ? RequestEvents :
T extends ElementHandleChannel ? ElementHandleEvents :
T extends JSHandleChannel ? JSHandleEvents :
+ T extends DisposableChannel ? DisposableEvents :
T extends WorkerChannel ? WorkerEvents :
T extends FrameChannel ? FrameEvents :
T extends PageChannel ? PageEvents :
@@ -123,6 +125,7 @@ export type EventTargetTraits<T> =
T extends RequestChannel ? RequestEventTarget :
T extends ElementHandleChannel ? ElementHandleEventTarget :
T extends JSHandleChannel ? JSHandleEventTarget :
+ T extends DisposableChannel ? DisposableEventTarget :
T extends WorkerChannel ? WorkerEventTarget :
T extends FrameChannel ? FrameEventTarget :
T extends PageChannel ? PageEventTarget :
@@ -1739,7 +1742,9 @@ export type BrowserContextAddInitScriptParams = {
export type BrowserContextAddInitScriptOptions = {
};
-export type BrowserContextAddInitScriptResult = void;
+export type BrowserContextAddInitScriptResult = {
+ disposable: DisposableChannel,
+};
export type BrowserContextClearCookiesParams = {
name?: string,
nameRegexSource?: string,
@@ -1789,7 +1794,9 @@ export type BrowserContextExposeBindingParams = {
export type BrowserContextExposeBindingOptions = {
needsHandle?: boolean,
};
-export type BrowserContextExposeBindingResult = void;
+export type BrowserContextExposeBindingResult = {
+ disposable: DisposableChannel,
+};
export type BrowserContextGrantPermissionsParams = {
permissions: string[],
origin?: string,
@@ -2209,7 +2216,9 @@ export type PageAddInitScriptParams = {
export type PageAddInitScriptOptions = {
};
-export type PageAddInitScriptResult = void;
+export type PageAddInitScriptResult = {
+ disposable: DisposableChannel,
+};
export type PageCloseParams = {
runBeforeUnload?: boolean,
reason?: string,
@@ -2259,7 +2268,9 @@ export type PageExposeBindingParams = {
export type PageExposeBindingOptions = {
needsHandle?: boolean,
};
-export type PageExposeBindingResult = void;
+export type PageExposeBindingResult = {
+ disposable: DisposableChannel,
+};
export type PageGoBackParams = {
timeout: number,
waitUntil?: LifecycleEvent,
@@ -3500,6 +3511,21 @@ export interface WorkerEvents {
'close': WorkerCloseEvent;
}
+// ----------- Disposable -----------
+export type DisposableInitializer = {};
+export interface DisposableEventTarget {
+}
+export interface DisposableChannel extends DisposableEventTarget, Channel {
+ _type_Disposable: boolean;
+ dispose(params?: DisposableDisposeParams, progress?: Progress): Promise<DisposableDisposeResult>;
+}
+export type DisposableDisposeParams = {};
+export type DisposableDisposeOptions = {};
+export type DisposableDisposeResult = void;
+
+export interface DisposableEvents {
+}
+
// ----------- JSHandle -----------
export type JSHandleInitializer = {
preview: string,
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index 5add91162a..0f6c9a4d32 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -1206,6 +1206,8 @@ BrowserContext:
group: configuration
parameters:
source: string
+ returns:
+ disposable: Disposable
clearCookies:
title: Clear cookies
@@ -1250,6 +1252,8 @@ BrowserContext:
parameters:
name: string
needsHandle: boolean?
+ returns:
+ disposable: Disposable
grantPermissions:
title: Grant permissions
@@ -1595,6 +1599,8 @@ Page:
group: configuration
parameters:
source: string
+ returns:
+ disposable: Disposable
close:
title: Close page
@@ -1662,6 +1668,8 @@ Page:
parameters:
name: string
needsHandle: boolean?
+ returns:
+ disposable: Disposable
goBack:
title: Go back
@@ -2959,6 +2967,15 @@ Worker:
close:
+Disposable:
+ type: interface
+
+ commands:
+
+ dispose:
+ internal: true
+
+
JSHandle:
type: interface
diff --git a/tests/library/browsercontext-add-init-script.spec.ts b/tests/library/browsercontext-add-init-script.spec.ts
index 53aafd2b0e..c2fd6cf838 100644
--- a/tests/library/browsercontext-add-init-script.spec.ts
+++ b/tests/library/browsercontext-add-init-script.spec.ts
@@ -67,6 +67,25 @@ it('should work with browser context scripts for already created pages', async (
expect(await page.evaluate(() => (window as any)['result'])).toBe(123);
});
+it('should remove context init script after dispose', async ({ context, server }) => {
+ const disposable = await context.addInitScript(() => (window as any)['temp'] = 123);
+ const page = await context.newPage();
+ await page.goto(server.PREFIX + '/tamperable.html');
+ expect(await page.evaluate(() => (window as any)['temp'])).toBe(123);
+
+ await disposable.dispose();
+ await page.goto(server.PREFIX + '/tamperable.html');
+ expect(await page.evaluate(() => (window as any)['temp'])).toBe(undefined);
+});
+
+it('should remove context init script and keep working in new pages', async ({ context, server }) => {
+ const disposable = await context.addInitScript(() => (window as any)['temp'] = 123);
+ await disposable.dispose();
+ const page = await context.newPage();
+ await page.goto(server.PREFIX + '/tamperable.html');
+ expect(await page.evaluate(() => (window as any)['temp'])).toBe(undefined);
+});
+
it('init script should run only once in popup', async ({ context }) => {
await context.addInitScript(() => {
window['callCount'] = (window['callCount'] || 0) + 1;
diff --git a/tests/library/browsercontext-expose-function.spec.ts b/tests/library/browsercontext-expose-function.spec.ts
index c242c8582e..c485dce08b 100644
--- a/tests/library/browsercontext-expose-function.spec.ts
+++ b/tests/library/browsercontext-expose-function.spec.ts
@@ -45,6 +45,23 @@ it('should work', async ({ context, server }) => {
expect(result).toEqual({ mul: 36, add: 13, sub: 5, addHandle: 11 });
});
+it('should dispose', async ({ context, server }) => {
+ const binding = await context.exposeFunction('compute', function(a, b) {
+ return a * b;
+ });
+ const page = await context.newPage();
+ const result = await page.evaluate(async function() {
+ return await window['compute'](9, 4);
+ });
+ expect(result).toBe(36);
+ await binding.dispose();
+
+ const e = await page.evaluate(async function() {
+ return await window['compute'](9, 4);
+ }).catch(e => e);
+ expect(e.message).toContain('is not a function');
+});
+
it('should throw for duplicate registrations', async ({ context, server }) => {
await context.exposeFunction('foo', () => {});
await context.exposeFunction('bar', () => {});
diff --git a/tests/library/channels.spec.ts b/tests/library/channels.spec.ts
index 17901000f7..63741d7555 100644
--- a/tests/library/channels.spec.ts
+++ b/tests/library/channels.spec.ts
@@ -283,6 +283,10 @@ it('exposeFunction should not leak', async ({ page, expectScopeState, server })
{
'_guid': 'page',
'objects': [
+ {
+ '_guid': 'disposable',
+ 'objects': [],
+ },
{
'_guid': 'frame',
'objects': [],
diff --git a/tests/page/page-add-init-script.spec.ts b/tests/page/page-add-init-script.spec.ts
index be4469e6ed..5e569f922f 100644
--- a/tests/page/page-add-init-script.spec.ts
+++ b/tests/page/page-add-init-script.spec.ts
@@ -84,6 +84,35 @@ it('should work after a cross origin navigation', async ({ page, server }) => {
expect(await page.evaluate(() => window['result'])).toBe(123);
});
+it('should remove init script after dispose', async ({ page, server }) => {
+ const disposable = await page.addInitScript(function() {
+ window['injected'] = 123;
+ });
+ await page.goto(server.PREFIX + '/tamperable.html');
+ expect(await page.evaluate(() => window['result'])).toBe(123);
+
+ await disposable.dispose();
+ await page.goto(server.PREFIX + '/tamperable.html');
+ expect(await page.evaluate(() => window['result'])).toBe(undefined);
+});
+
+it('should remove one of multiple init scripts after dispose', async ({ page, server }) => {
+ const disposable1 = await page.addInitScript(function() {
+ window['script1'] = 1;
+ });
+ await page.addInitScript(function() {
+ window['script2'] = 2;
+ });
+ await page.goto(server.PREFIX + '/tamperable.html');
+ expect(await page.evaluate(() => window['script1'])).toBe(1);
+ expect(await page.evaluate(() => window['script2'])).toBe(2);
+
+ await disposable1.dispose();
+ await page.goto(server.PREFIX + '/tamperable.html');
+ expect(await page.evaluate(() => window['script1'])).toBe(undefined);
+ expect(await page.evaluate(() => window['script2'])).toBe(2);
+});
+
it('init script should run only once in iframe', async ({ page, server, browserName, isBidi }) => {
it.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/26992' });
const messages = [];
diff --git a/tests/page/page-expose-function.spec.ts b/tests/page/page-expose-function.spec.ts
index 8bafdff2b3..8e92215ff3 100644
--- a/tests/page/page-expose-function.spec.ts
+++ b/tests/page/page-expose-function.spec.ts
@@ -43,6 +43,22 @@ it('should work', async ({ page, server }) => {
expect(result).toBe(36);
});
+it('should dispose', async ({ page, server }) => {
+ const binding = await page.exposeFunction('compute', function(a, b) {
+ return a * b;
+ });
+ const result = await page.evaluate(async function() {
+ return await window['compute'](9, 4);
+ });
+ expect(result).toBe(36);
+ await binding.dispose();
+
+ const e = await page.evaluate(async function() {
+ return await window['compute'](9, 4);
+ }).catch(e => e);
+ expect(e.message).toContain('is not a function');
+});
+
it('should work with handles and complex objects', async ({ page, server }) => {
const fooHandle = await page.evaluateHandle(() => {
window['fooValue'] = { bar: 2 };
diff --git a/utils/generate_types/overrides.d.ts b/utils/generate_types/overrides.d.ts
index 07a961d769..d34403fb5d 100644
--- a/utils/generate_types/overrides.d.ts
+++ b/utils/generate_types/overrides.d.ts
@@ -44,7 +44,7 @@ export interface Page {
evaluateHandle<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg): Promise<SmartHandle<R>>;
evaluateHandle<R>(pageFunction: PageFunction<void, R>, arg?: any): Promise<SmartHandle<R>>;
- addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<void>;
+ addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<Disposable>;
$<K extends keyof HTMLElementTagNameMap>(selector: K, options?: { strict: boolean }): Promise<ElementHandleForTag<K> | null>;
$(selector: string, options?: { strict: boolean }): Promise<ElementHandle<SVGElement | HTMLElement> | null>;
@@ -70,8 +70,8 @@ export interface Page {
waitForSelector<K extends keyof HTMLElementTagNameMap>(selector: K, options: PageWaitForSelectorOptions): Promise<ElementHandleForTag<K> | null>;
waitForSelector(selector: string, options: PageWaitForSelectorOptions): Promise<null|ElementHandle<SVGElement | HTMLElement>>;
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<void>;
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<void>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<Disposable>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<Disposable>;
removeAllListeners(type?: string): this;
removeAllListeners(type: string | undefined, options: {
@@ -122,10 +122,10 @@ export interface Frame {
}
export interface BrowserContext {
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<void>;
- exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<void>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, arg: JSHandle) => any, options: { handle: true }): Promise<Disposable>;
+ exposeBinding(name: string, playwrightBinding: (source: BindingSource, ...args: any[]) => any, options?: { handle?: boolean }): Promise<Disposable>;
- addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<void>;
+ addInitScript<Arg>(script: PageFunction<Arg, any> | { path?: string, content?: string }, arg?: Arg): Promise<Disposable>;
removeAllListeners(type?: string): this;
removeAllListeners(type: string | undefined, options: {