Skip to content

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

feat: browser.on('context') event (#36046)

Dmitry Gozmana5d1a18ff5d6
diff --git a/docs/src/api/class-browser.md b/docs/src/api/class-browser.md
index 7867ce5c8b..e8fe9daa52 100644
--- a/docs/src/api/class-browser.md
+++ b/docs/src/api/class-browser.md
@@ -72,6 +72,12 @@ await page.GotoAsync("https://www.bing.com");
await browser.CloseAsync();
```
+## event: Browser.context
+* since: v1.53
+- argument: <[BrowserContext]>
+
+Emitted when a new [BrowserContext] is created in the browser.
+
## event: Browser.disconnected
* since: v1.8
- argument: <[Browser]>
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
index cd23c6702f..50bc6273e7 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -9550,6 +9550,12 @@ export interface Browser {
*/
behavior?: 'wait'|'ignoreErrors'|'default'
}): Promise<void>;
+ /**
+ * Emitted when a new [BrowserContext](https://playwright.dev/docs/api/class-browsercontext) is created in the
+ * browser.
+ */
+ on(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Emitted when Browser gets disconnected from the browser application. This might happen because of one of the
* following:
@@ -9558,11 +9564,22 @@ export interface Browser {
*/
on(event: 'disconnected', listener: (browser: Browser) => any): this;
+ /**
+ * Adds an event listener that will be automatically removed after it is triggered once. See `addListener` for more information about this event.
+ */
+ once(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Adds an event listener that will be automatically removed after it is triggered once. See `addListener` for more information about this event.
*/
once(event: 'disconnected', listener: (browser: Browser) => any): this;
+ /**
+ * Emitted when a new [BrowserContext](https://playwright.dev/docs/api/class-browsercontext) is created in the
+ * browser.
+ */
+ addListener(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Emitted when Browser gets disconnected from the browser application. This might happen because of one of the
* following:
@@ -9571,16 +9588,32 @@ export interface Browser {
*/
addListener(event: 'disconnected', listener: (browser: Browser) => any): this;
+ /**
+ * Removes an event listener added by `on` or `addListener`.
+ */
+ removeListener(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Removes an event listener added by `on` or `addListener`.
*/
removeListener(event: 'disconnected', listener: (browser: Browser) => any): this;
+ /**
+ * Removes an event listener added by `on` or `addListener`.
+ */
+ off(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Removes an event listener added by `on` or `addListener`.
*/
off(event: 'disconnected', listener: (browser: Browser) => any): this;
+ /**
+ * Emitted when a new [BrowserContext](https://playwright.dev/docs/api/class-browsercontext) is created in the
+ * browser.
+ */
+ prependListener(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Emitted when Browser gets disconnected from the browser application. This might happen because of one of the
* following:
diff --git a/packages/playwright-core/src/client/android.ts b/packages/playwright-core/src/client/android.ts
index fd94fd2629..1e7e07eaa2 100644
--- a/packages/playwright-core/src/client/android.ts
+++ b/packages/playwright-core/src/client/android.ts
@@ -258,7 +258,6 @@ export class AndroidDevice extends ChannelOwner<channels.AndroidDeviceChannel> i
const contextOptions = await prepareBrowserContextParams(this._platform, options);
const result = await this._channel.launchBrowser(contextOptions);
const context = BrowserContext.from(result.context) as BrowserContext;
- context._setOptions(contextOptions, {});
await context._initializeHarFromOptions(options.recordHar);
return context;
}
diff --git a/packages/playwright-core/src/client/browser.ts b/packages/playwright-core/src/client/browser.ts
index f55e73774a..e6ca6bed5e 100644
--- a/packages/playwright-core/src/client/browser.ts
+++ b/packages/playwright-core/src/client/browser.ts
@@ -24,7 +24,7 @@ import { mkdirIfNeeded } from './fileUtils';
import type { BrowserType } from './browserType';
import type { Page } from './page';
-import type { BrowserContextOptions, LaunchOptions } from './types';
+import type { BrowserContextOptions, LaunchOptions, Logger } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
@@ -46,6 +46,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.BrowserInitializer) {
super(parent, type, guid, initializer);
this._name = initializer.name;
+ this._channel.on('context', ({ context }) => this._didCreateContext(BrowserContext.from(context)));
this._channel.on('close', () => this._didClose());
this._closedPromise = new Promise(f => this.once(Events.Browser.Disconnected, f));
}
@@ -61,7 +62,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
async _newContextForReuse(options: BrowserContextOptions = {}): Promise<BrowserContext> {
return await this._wrapApiCall(async () => {
for (const context of this._contexts) {
- await this._browserType._willCloseContext(context);
+ await this._instrumentation.runBeforeCloseBrowserContext(context);
for (const page of context.pages())
page._onClose();
context._onClose();
@@ -84,11 +85,42 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
const contextOptions = await prepareBrowserContextParams(this._platform, options);
const response = forReuse ? await this._channel.newContextForReuse(contextOptions) : await this._channel.newContext(contextOptions);
const context = BrowserContext.from(response.context);
+ if (options.logger)
+ context._logger = options.logger;
await context._initializeHarFromOptions(options.recordHar);
- await this._browserType._didCreateContext(context, contextOptions, this._options, options.logger || this._logger);
+ await this._instrumentation.runAfterCreateBrowserContext(context);
return context;
}
+ _connectToBrowserType(browserType: BrowserType, browserOptions: LaunchOptions, logger: Logger | undefined) {
+ // Note: when using connect(), `browserType` is different from `this._parent`.
+ // This is why browser type is not wired up in the constructor,
+ // and instead this separate method is called later on.
+ this._browserType = browserType;
+ this._options = browserOptions;
+ this._logger = logger;
+ for (const context of this._contexts)
+ this._setupBrowserContext(context);
+ }
+
+ private _didCreateContext(context: BrowserContext) {
+ context._browser = this;
+ this._contexts.add(context);
+ // Note: when connecting to a browser, initial contexts arrive before `browserType` is set,
+ // and will be configured later in `_connectToBrowserType`.
+ if (this._browserType)
+ this._setupBrowserContext(context);
+ this.emit(Events.Browser.Context, context);
+ }
+
+ private _setupBrowserContext(context: BrowserContext) {
+ context._logger = this._logger;
+ context.tracing._tracesDir = this._options.tracesDir;
+ this._browserType._contexts.add(context);
+ context.setDefaultTimeout(this._browserType._playwright._defaultContextTimeout);
+ context.setDefaultNavigationTimeout(this._browserType._playwright._defaultContextNavigationTimeout);
+ }
+
contexts(): BrowserContext[] {
return [...this._contexts];
}
diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.ts
index f16b6f5d1c..7b196c0d97 100644
--- a/packages/playwright-core/src/client/browserContext.ts
+++ b/packages/playwright-core/src/client/browserContext.ts
@@ -41,8 +41,7 @@ import { urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { isRegExp, isString } from '../utils/isomorphic/rtti';
import { rewriteErrorMessage } from '../utils/isomorphic/stackTrace';
-import type { BrowserType } from './browserType';
-import type { BrowserContextOptions, Headers, LaunchOptions, StorageState, WaitForEventOptions } from './types';
+import type { BrowserContextOptions, Headers, StorageState, WaitForEventOptions } from './types';
import type * as structs from '../../types/structs';
import type * as api from '../../types/types';
import type { URLMatch } from '../utils/isomorphic/urlMatch';
@@ -53,13 +52,13 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
_pages = new Set<Page>();
_routes: network.RouteHandler[] = [];
_webSocketRoutes: network.WebSocketRouteHandler[] = [];
- readonly _browser: Browser | null = null;
- _browserType: BrowserType | undefined;
+ // Browser is null for browser contexts created outside of normal browser, e.g. android or electron.
+ _browser: Browser | null = null;
readonly _bindings = new Map<string, (source: structs.BindingSource, ...args: any[]) => any>();
_timeoutSettings: TimeoutSettings;
_ownerPage: Page | undefined;
private _closedPromise: Promise<void>;
- _options: channels.BrowserNewContextParams = { };
+ readonly _options: channels.BrowserNewContextParams;
readonly request: APIRequestContext;
readonly tracing: Tracing;
@@ -67,7 +66,6 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
readonly _backgroundPages = new Set<Page>();
readonly _serviceWorkers = new Set<Worker>();
- readonly _isChromium: boolean;
private _harRecorders = new Map<string, { path: string, content: 'embed' | 'attach' | 'omit' | undefined }>();
_closingStatus: 'none' | 'closing' | 'closed' = 'none';
private _closeReason: string | undefined;
@@ -83,11 +81,8 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.BrowserContextInitializer) {
super(parent, type, guid, initializer);
+ this._options = initializer.options;
this._timeoutSettings = new TimeoutSettings(this._platform);
- if (parent instanceof Browser)
- this._browser = parent;
- this._browser?._contexts.add(this);
- this._isChromium = this._browser?._name === 'chromium';
this.tracing = Tracing.from(initializer.tracing);
this.request = APIRequestContext.from(initializer.requestContext);
this.request._timeoutSettings = this._timeoutSettings;
@@ -167,11 +162,6 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
});
}
- _setOptions(contextOptions: channels.BrowserNewContextParams, browserOptions: LaunchOptions) {
- this._options = contextOptions;
- this.tracing._tracesDir = browserOptions.tracesDir;
- }
-
private _onPage(page: Page): void {
this._pages.add(page);
this.emit(Events.BrowserContext.Page, page);
@@ -466,9 +456,8 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
_onClose() {
this._closingStatus = 'closed';
- if (this._browser)
- this._browser._contexts.delete(this);
- this._browserType?._contexts?.delete(this);
+ this._browser?._contexts.delete(this);
+ this._browser?._browserType._contexts.delete(this);
this._disposeHarRouters();
this.tracing._resetStackCounter();
this.emit(Events.BrowserContext.Close, this);
@@ -485,7 +474,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
this._closingStatus = 'closing';
await this.request.dispose(options);
await this._wrapApiCall(async () => {
- await this._browserType?._willCloseContext(this);
+ await this._instrumentation.runBeforeCloseBrowserContext(this);
for (const [harId, harParams] of this._harRecorders) {
const har = await this._channel.harExport({ harId });
const artifact = Artifact.from(har.artifact);
diff --git a/packages/playwright-core/src/client/browserType.ts b/packages/playwright-core/src/client/browserType.ts
index 119fbef970..6c53cff9da 100644
--- a/packages/playwright-core/src/client/browserType.ts
+++ b/packages/playwright-core/src/client/browserType.ts
@@ -27,7 +27,7 @@ import { connectOverWebSocket } from './webSocket';
import { TimeoutSettings } from './timeoutSettings';
import type { Playwright } from './playwright';
-import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions, Logger } from './types';
+import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions } from './types';
import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';
import type { ChildProcess } from 'child_process';
@@ -78,7 +78,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
};
return await this._wrapApiCall(async () => {
const browser = Browser.from((await this._channel.launch(launchOptions)).browser);
- this._didLaunchBrowser(browser, options, logger);
+ browser._connectToBrowserType(this, options, logger);
return browser;
});
}
@@ -113,10 +113,10 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
return await this._wrapApiCall(async () => {
const result = await this._channel.launchPersistentContext(persistentParams);
const browser = Browser.from(result.browser);
- this._didLaunchBrowser(browser, options, logger);
+ browser._connectToBrowserType(this, options, logger);
const context = BrowserContext.from(result.context);
await context._initializeHarFromOptions(options.recordHar);
- await this._didCreateContext(context, contextParams, options, logger);
+ await this._instrumentation.runAfterCreateBrowserContext(context);
return context;
});
}
@@ -169,7 +169,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
this._playwright.selectors._playwrights.add(playwright);
connection.on('close', () => this._playwright.selectors._playwrights.delete(playwright));
browser = Browser.from(playwright._initializer.preLaunchedBrowser!);
- this._didLaunchBrowser(browser, {}, logger);
+ browser._connectToBrowserType(this, {}, logger);
browser._shouldCloseConnectionOnClose = true;
browser.on(Events.Browser.Disconnected, () => connection.close());
return browser;
@@ -204,32 +204,9 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
timeout: new TimeoutSettings(this._platform).timeout(params),
});
const browser = Browser.from(result.browser);
- this._didLaunchBrowser(browser, {}, params.logger);
+ browser._connectToBrowserType(this, {}, params.logger);
if (result.defaultContext)
- await this._didCreateContext(BrowserContext.from(result.defaultContext), {}, {}, params.logger);
+ await this._instrumentation.runAfterCreateBrowserContext(BrowserContext.from(result.defaultContext));
return browser;
}
-
- _didLaunchBrowser(browser: Browser, browserOptions: LaunchOptions, logger: Logger | undefined) {
- browser._browserType = this;
- browser._options = browserOptions;
- browser._logger = logger;
- }
-
- async _didCreateContext(context: BrowserContext, contextOptions: channels.BrowserNewContextParams, browserOptions: LaunchOptions, logger: Logger | undefined) {
- context._logger = logger;
- context._browserType = this;
- this._contexts.add(context);
- context._setOptions(contextOptions, browserOptions);
- if (this._playwright._defaultContextTimeout !== undefined)
- context.setDefaultTimeout(this._playwright._defaultContextTimeout);
- if (this._playwright._defaultContextNavigationTimeout !== undefined)
- context.setDefaultNavigationTimeout(this._playwright._defaultContextNavigationTimeout);
- await this._instrumentation.runAfterCreateBrowserContext(context);
- }
-
- async _willCloseContext(context: BrowserContext) {
- this._contexts.delete(context);
- await this._instrumentation.runBeforeCloseBrowserContext(context);
- }
}
diff --git a/packages/playwright-core/src/client/electron.ts b/packages/playwright-core/src/client/electron.ts
index e67ba70b86..702d5bd584 100644
--- a/packages/playwright-core/src/client/electron.ts
+++ b/packages/playwright-core/src/client/electron.ts
@@ -61,7 +61,7 @@ export class Electron extends ChannelOwner<channels.ElectronChannel> implements
};
const app = ElectronApplication.from((await this._channel.launch(params)).electronApplication);
await app._context._initializeHarFromOptions(options.recordHar);
- app._context._setOptions(params, options);
+ app._context.tracing._tracesDir = options.tracesDir;
return app;
}
}
diff --git a/packages/playwright-core/src/client/events.ts b/packages/playwright-core/src/client/events.ts
index a074b26f3d..8c1ee84095 100644
--- a/packages/playwright-core/src/client/events.ts
+++ b/packages/playwright-core/src/client/events.ts
@@ -31,6 +31,7 @@ export const Events = {
},
Browser: {
+ Context: 'context',
Disconnected: 'disconnected'
},
diff --git a/packages/playwright-core/src/client/playwright.ts b/packages/playwright-core/src/client/playwright.ts
index 418530a2e2..00f951b409 100644
--- a/packages/playwright-core/src/client/playwright.ts
+++ b/packages/playwright-core/src/client/playwright.ts
@@ -77,7 +77,7 @@ export class Playwright extends ChannelOwner<channels.PlaywrightChannel> {
_preLaunchedBrowser(): Browser {
const browser = Browser.from(this._initializer.preLaunchedBrowser!);
- browser._browserType = this[browser._name as 'chromium' | 'firefox' | 'webkit'];
+ browser._connectToBrowserType(this[browser._name as 'chromium' | 'firefox' | 'webkit'], {}, undefined);
return browser;
}
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index 66a3b4dc47..dadc791a26 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -658,6 +658,9 @@ scheme.BrowserInitializer = tObject({
version: tString,
name: tString,
});
+scheme.BrowserContextEvent = tObject({
+ context: tChannel(['BrowserContext']),
+});
scheme.BrowserCloseEvent = tOptional(tObject({}));
scheme.BrowserCloseParams = tObject({
reason: tOptional(tString),
@@ -854,6 +857,64 @@ scheme.BrowserContextInitializer = tObject({
isChromium: tBoolean,
requestContext: tChannel(['APIRequestContext']),
tracing: tChannel(['Tracing']),
+ options: tObject({
+ noDefaultViewport: tOptional(tBoolean),
+ viewport: tOptional(tObject({
+ width: tNumber,
+ height: tNumber,
+ })),
+ screen: tOptional(tObject({
+ width: tNumber,
+ height: tNumber,
+ })),
+ ignoreHTTPSErrors: tOptional(tBoolean),
+ clientCertificates: tOptional(tArray(tObject({
+ origin: tString,
+ cert: tOptional(tBinary),
+ key: tOptional(tBinary),
+ passphrase: tOptional(tString),
+ pfx: tOptional(tBinary),
+ }))),
+ javaScriptEnabled: tOptional(tBoolean),
+ bypassCSP: tOptional(tBoolean),
+ userAgent: tOptional(tString),
+ locale: tOptional(tString),
+ timezoneId: tOptional(tString),
+ geolocation: tOptional(tObject({
+ longitude: tNumber,
+ latitude: tNumber,
+ accuracy: tOptional(tNumber),
+ })),
+ permissions: tOptional(tArray(tString)),
+ extraHTTPHeaders: tOptional(tArray(tType('NameValue'))),
+ offline: tOptional(tBoolean),
+ httpCredentials: tOptional(tObject({
+ username: tString,
+ password: tString,
+ origin: tOptional(tString),
+ send: tOptional(tEnum(['always', 'unauthorized'])),
+ })),
+ deviceScaleFactor: tOptional(tNumber),
+ isMobile: tOptional(tBoolean),
+ hasTouch: tOptional(tBoolean),
+ colorScheme: tOptional(tEnum(['dark', 'light', 'no-preference', 'no-override'])),
+ reducedMotion: tOptional(tEnum(['reduce', 'no-preference', 'no-override'])),
+ forcedColors: tOptional(tEnum(['active', 'none', 'no-override'])),
+ acceptDownloads: tOptional(tEnum(['accept', 'deny', 'internal-browser-default'])),
+ contrast: tOptional(tEnum(['no-preference', 'more', 'no-override'])),
+ baseURL: tOptional(tString),
+ recordVideo: tOptional(tObject({
+ dir: tString,
+ size: tOptional(tObject({
+ width: tNumber,
+ height: tNumber,
+ })),
+ })),
+ strictSelectors: tOptional(tBoolean),
+ serviceWorkers: tOptional(tEnum(['allow', 'block'])),
+ selectorEngines: tOptional(tArray(tType('SelectorEngine'))),
+ testIdAttributeName: tOptional(tString),
+ }),
});
scheme.BrowserContextBindingCallEvent = tObject({
binding: tChannel(['BindingCall']),
diff --git a/packages/playwright-core/src/server/browser.ts b/packages/playwright-core/src/server/browser.ts
index f2c9d68692..e165de9729 100644
--- a/packages/playwright-core/src/server/browser.ts
+++ b/packages/playwright-core/src/server/browser.ts
@@ -58,6 +58,7 @@ export type BrowserOptions = {
export abstract class Browser extends SdkObject {
static Events = {
+ Context: 'context',
Disconnected: 'disconnected',
};
@@ -102,6 +103,7 @@ export abstract class Browser extends SdkObject {
context._clientCertificatesProxy = clientCertificatesProxy;
if (options.storageState)
await context.setStorageState(metadata, options.storageState);
+ this.emit(Browser.Events.Context, context);
return context;
}
diff --git a/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts b/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts
index 3eb2ebfc08..b1741a9e16 100644
--- a/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts
@@ -158,7 +158,7 @@ export class AndroidDeviceDispatcher extends Dispatcher<AndroidDevice, channels.
async launchBrowser(params: channels.AndroidDeviceLaunchBrowserParams): Promise<channels.AndroidDeviceLaunchBrowserResult> {
const context = await this._object.launchBrowser(params.pkg, params);
- return { context: new BrowserContextDispatcher(this, context) };
+ return { context: BrowserContextDispatcher.from(this, context) };
}
async close(params: channels.AndroidDeviceCloseParams) {
@@ -166,7 +166,7 @@ export class AndroidDeviceDispatcher extends Dispatcher<AndroidDevice, channels.
}
async connectToWebView(params: channels.AndroidDeviceConnectToWebViewParams): Promise<channels.AndroidDeviceConnectToWebViewResult> {
- return { context: new BrowserContextDispatcher(this, await this._object.connectToWebView(params.socketName)) };
+ return { context: BrowserContextDispatcher.from(this, await this._object.connectToWebView(params.socketName)) };
}
}
diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
index 1210699395..3b58d93d5c 100644
--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
@@ -52,16 +52,21 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
private _subscriptions = new Set<channels.BrowserContextUpdateSubscriptionParams['event']>();
_webSocketInterceptionPatterns: channels.BrowserContextSetWebSocketInterceptionPatternsParams['patterns'] = [];
- constructor(parentScope: DispatcherScope, context: BrowserContext) {
+ static from(parentScope: DispatcherScope, context: BrowserContext): BrowserContextDispatcher {
+ const result = parentScope.connection.existingDispatcher<BrowserContextDispatcher>(context);
+ return result || new BrowserContextDispatcher(parentScope, context);
+ }
+
+ private constructor(parentScope: DispatcherScope, context: BrowserContext) {
// We will reparent these to the context below.
const requestContext = APIRequestContextDispatcher.from(parentScope as BrowserContextDispatcher, context.fetchRequest);
const tracing = TracingDispatcher.from(parentScope as BrowserContextDispatcher, context.tracing);
super(parentScope, context, 'BrowserContext', {
isChromium: context._browser.options.isChromium,
- isLocalBrowserOnServer: context._browser._isCollocatedWithServer,
requestContext,
tracing,
+ options: context._options,
});
this.adopt(requestContext);
diff --git a/packages/playwright-core/src/server/dispatchers/browserDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserDispatcher.ts
index 21fbe32197..bf822ce863 100644
--- a/packages/playwright-core/src/server/dispatchers/browserDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserDispatcher.ts
@@ -33,7 +33,12 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
constructor(scope: BrowserTypeDispatcher, browser: Browser) {
super(scope, browser, 'Browser', { version: browser.version(), name: browser.options.name });
+ this.addObjectListener(Browser.Events.Context, (context: BrowserContext) => this._dispatchEvent('context', { context: BrowserContextDispatcher.from(this, context) }));
this.addObjectListener(Browser.Events.Disconnected, () => this._didClose());
+ if (browser._defaultContext)
+ this._dispatchEvent('context', { context: BrowserContextDispatcher.from(this, browser._defaultContext) });
+ for (const context of browser.contexts())
+ this._dispatchEvent('context', { context: BrowserContextDispatcher.from(this, context) });
}
_didClose() {
@@ -43,7 +48,7 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
async newContext(params: channels.BrowserNewContextParams, metadata: CallMetadata): Promise<channels.BrowserNewContextResult> {
const context = await this._object.newContext(metadata, params);
- return { context: new BrowserContextDispatcher(this, context) };
+ return { context: BrowserContextDispatcher.from(this, context) };
}
async newContextForReuse(params: channels.BrowserNewContextForReuseParams, metadata: CallMetadata): Promise<channels.BrowserNewContextForReuseResult> {
@@ -105,7 +110,9 @@ export class ConnectedBrowserDispatcher extends Dispatcher<Browser, channels.Bro
const context = await this._object.newContext(metadata, params);
this._contexts.add(context);
context.on(BrowserContext.Events.Close, () => this._contexts.delete(context));
- return { context: new BrowserContextDispatcher(this, context) };
+ const contextDispatcher = BrowserContextDispatcher.from(this, context);
+ this._dispatchEvent('context', { context: contextDispatcher });
+ return { context: contextDispatcher };
}
async newContextForReuse(params: channels.BrowserNewContextForReuseParams, metadata: CallMetadata): Promise<channels.BrowserNewContextForReuseResult> {
@@ -162,6 +169,7 @@ async function newContextForReuse(browser: Browser, scope: BrowserDispatcher, pa
oldContextDispatcher._dispose();
await context.resetForReuse(metadata, params);
}
- const contextDispatcher = new BrowserContextDispatcher(scope, context);
+ const contextDispatcher = BrowserContextDispatcher.from(scope, context);
+ scope._dispatchEvent('context', { context: contextDispatcher });
return { context: contextDispatcher };
}
diff --git a/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts
index 2c14c685e7..e97b7cdc75 100644
--- a/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts
@@ -40,7 +40,7 @@ export class BrowserTypeDispatcher extends Dispatcher<BrowserType, channels.Brow
async launchPersistentContext(params: channels.BrowserTypeLaunchPersistentContextParams, metadata: CallMetadata): Promise<channels.BrowserTypeLaunchPersistentContextResult> {
const browserContext = await this._object.launchPersistentContext(metadata, params.userDataDir, params);
const browserDispatcher = new BrowserDispatcher(this, browserContext._browser);
- const contextDispatcher = new BrowserContextDispatcher(browserDispatcher, browserContext);
+ const contextDispatcher = BrowserContextDispatcher.from(browserDispatcher, browserContext);
return { browser: browserDispatcher, context: contextDispatcher };
}
@@ -49,7 +49,7 @@ export class BrowserTypeDispatcher extends Dispatcher<BrowserType, channels.Brow
const browserDispatcher = new BrowserDispatcher(this, browser);
return {
browser: browserDispatcher,
- defaultContext: browser._defaultContext ? new BrowserContextDispatcher(browserDispatcher, browser._defaultContext) : undefined,
+ defaultContext: browser._defaultContext ? BrowserContextDispatcher.from(browserDispatcher, browser._defaultContext) : undefined,
};
}
}
diff --git a/packages/playwright-core/src/server/dispatchers/dispatcher.ts b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
index 5f45296367..72888a99d7 100644
--- a/packages/playwright-core/src/server/dispatchers/dispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
@@ -60,7 +60,7 @@ export class Dispatcher<Type extends { guid: string }, ChannelType, ParentScopeT
_object: Type;
private _openScope = new LongStandingScope();
- constructor(parent: ParentScopeType | DispatcherConnection, object: Type, type: string, initializer: channels.InitializerTraits<Type>, gcBucket?: string) {
+ constructor(parent: ParentScopeType | DispatcherConnection, object: Type, type: string, initializer: channels.InitializerTraits<ChannelType>, gcBucket?: string) {
super();
this.connection = parent instanceof DispatcherConnection ? parent : parent.connection;
diff --git a/packages/playwright-core/src/server/dispatchers/electronDispatcher.ts b/packages/playwright-core/src/server/dispatchers/electronDispatcher.ts
index 57b0b3bb14..5f55385ea4 100644
--- a/packages/playwright-core/src/server/dispatchers/electronDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/electronDispatcher.ts
@@ -47,7 +47,7 @@ export class ElectronApplicationDispatcher extends Dispatcher<ElectronApplicatio
constructor(scope: ElectronDispatcher, electronApplication: ElectronApplication) {
super(scope, electronApplication, 'ElectronApplication', {
- context: new BrowserContextDispatcher(scope, electronApplication.context())
+ context: BrowserContextDispatcher.from(scope, electronApplication.context())
});
this.addObjectListener(ElectronApplication.Events.Close, () => {
this._dispatchEvent('close');
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index cd23c6702f..50bc6273e7 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -9550,6 +9550,12 @@ export interface Browser {
*/
behavior?: 'wait'|'ignoreErrors'|'default'
}): Promise<void>;
+ /**
+ * Emitted when a new [BrowserContext](https://playwright.dev/docs/api/class-browsercontext) is created in the
+ * browser.
+ */
+ on(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Emitted when Browser gets disconnected from the browser application. This might happen because of one of the
* following:
@@ -9558,11 +9564,22 @@ export interface Browser {
*/
on(event: 'disconnected', listener: (browser: Browser) => any): this;
+ /**
+ * Adds an event listener that will be automatically removed after it is triggered once. See `addListener` for more information about this event.
+ */
+ once(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Adds an event listener that will be automatically removed after it is triggered once. See `addListener` for more information about this event.
*/
once(event: 'disconnected', listener: (browser: Browser) => any): this;
+ /**
+ * Emitted when a new [BrowserContext](https://playwright.dev/docs/api/class-browsercontext) is created in the
+ * browser.
+ */
+ addListener(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Emitted when Browser gets disconnected from the browser application. This might happen because of one of the
* following:
@@ -9571,16 +9588,32 @@ export interface Browser {
*/
addListener(event: 'disconnected', listener: (browser: Browser) => any): this;
+ /**
+ * Removes an event listener added by `on` or `addListener`.
+ */
+ removeListener(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Removes an event listener added by `on` or `addListener`.
*/
removeListener(event: 'disconnected', listener: (browser: Browser) => any): this;
+ /**
+ * Removes an event listener added by `on` or `addListener`.
+ */
+ off(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Removes an event listener added by `on` or `addListener`.
*/
off(event: 'disconnected', listener: (browser: Browser) => any): this;
+ /**
+ * Emitted when a new [BrowserContext](https://playwright.dev/docs/api/class-browsercontext) is created in the
+ * browser.
+ */
+ prependListener(event: 'context', listener: (browserContext: BrowserContext) => any): this;
+
/**
* Emitted when Browser gets disconnected from the browser application. This might happen because of one of the
* following:
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index 8e4cdca103..54f2bb873f 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -1163,6 +1163,7 @@ export type BrowserInitializer = {
name: string,
};
export interface BrowserEventTarget {
+ on(event: 'context', callback: (params: BrowserContextEvent) => void): this;
on(event: 'close', callback: (params: BrowserCloseEvent) => void): this;
}
export interface BrowserChannel extends BrowserEventTarget, Channel {
@@ -1177,6 +1178,9 @@ export interface BrowserChannel extends BrowserEventTarget, Channel {
startTracing(params: BrowserStartTracingParams, metadata?: CallMetadata): Promise<BrowserStartTracingResult>;
stopTracing(params?: BrowserStopTracingParams, metadata?: CallMetadata): Promise<BrowserStopTracingResult>;
}
+export type BrowserContextEvent = {
+ context: BrowserContextChannel,
+};
export type BrowserCloseEvent = {};
export type BrowserCloseParams = {
reason?: string,
@@ -1501,6 +1505,7 @@ export type BrowserStopTracingResult = {
};
export interface BrowserEvents {
+ 'context': BrowserContextEvent;
'close': BrowserCloseEvent;
}
@@ -1534,6 +1539,64 @@ export type BrowserContextInitializer = {
isChromium: boolean,
requestContext: APIRequestContextChannel,
tracing: TracingChannel,
+ options: {
+ noDefaultViewport?: boolean,
+ viewport?: {
+ width: number,
+ height: number,
+ },
+ screen?: {
+ width: number,
+ height: number,
+ },
+ ignoreHTTPSErrors?: boolean,
+ clientCertificates?: {
+ origin: string,
+ cert?: Binary,
+ key?: Binary,
+ passphrase?: string,
+ pfx?: Binary,
+ }[],
+ javaScriptEnabled?: boolean,
+ bypassCSP?: boolean,
+ userAgent?: string,
+ locale?: string,
+ timezoneId?: string,
+ geolocation?: {
+ longitude: number,
+ latitude: number,
+ accuracy?: number,
+ },
+ permissions?: string[],
+ extraHTTPHeaders?: NameValue[],
+ offline?: boolean,
+ httpCredentials?: {
+ username: string,
+ password: string,
+ origin?: string,
+ send?: 'always' | 'unauthorized',
+ },
+ deviceScaleFactor?: number,
+ isMobile?: boolean,
+ hasTouch?: boolean,
+ colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
+ reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
+ forcedColors?: 'active' | 'none' | 'no-override',
+ acceptDownloads?: 'accept' | 'deny' | 'internal-browser-default',
+ contrast?: 'no-preference' | 'more' | 'no-override',
+ baseURL?: string,
+ recordVideo?: {
+ dir: string,
+ size?: {
+ width: number,
+ height: number,
+ },
+ },
+ strictSelectors?: boolean,
+ serviceWorkers?: 'allow' | 'block',
+ selectorEngines?: SelectorEngine[],
+ testIdAttributeName?: string,
+ },
};
export interface BrowserContextEventTarget {
on(event: 'bindingCall', callback: (params: BrowserContextBindingCallEvent) => void): this;
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index e62b34698d..8704f7dc0e 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -1146,6 +1146,10 @@ Browser:
events:
+ context:
+ parameters:
+ context: BrowserContext
+
close:
ConsoleMessage:
@@ -1196,6 +1200,10 @@ BrowserContext:
isChromium: boolean
requestContext: APIRequestContext
tracing: Tracing
+ options:
+ type: object
+ properties:
+ $mixin: ContextOptions
commands:
diff --git a/tests/library/browsercontext-basic.spec.ts b/tests/library/browsercontext-basic.spec.ts
index 352b1bca03..5c65e73697 100644
--- a/tests/library/browsercontext-basic.spec.ts
+++ b/tests/library/browsercontext-basic.spec.ts
@@ -22,13 +22,19 @@ import type { Page } from '@playwright/test';
it('should create new context @smoke', async function({ browser }) {
expect(browser.contexts().length).toBe(0);
+ let contextFromEvent;
+ browser.on('context', context => contextFromEvent = context);
const context = await browser.newContext();
- expect(browser.contexts().length).toBe(1);
- expect(browser.contexts().indexOf(context) !== -1).toBe(true);
+ expect(contextFromEvent).toBe(context);
+ expect(browser.contexts()).toEqual([context]);
expect(browser).toBe(context.browser());
+ const context2 = await browser.newContext();
+ expect(contextFromEvent).toBe(context2);
+ expect(browser.contexts()).toEqual([context, context2]);
await context.close();
- expect(browser.contexts().length).toBe(0);
+ expect(browser.contexts()).toEqual([context2]);
expect(browser).toBe(context.browser());
+ await context2.close();
});
it('should be able to click across browser contexts', async function({ browser }) {