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): browser.on(context) (#40315)

Simon Knottcb6a61be767b
diff --git a/docs/src/api/class-browser.md b/docs/src/api/class-browser.md
index 0c181f926b..b676c64dc0 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.60
+- argument: <[BrowserContext]>
+
+Emitted when a new browser context is created.
+
## 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 b0a45b471e..ba593c8b90 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -9974,6 +9974,11 @@ export interface Browser {
*/
behavior?: 'wait'|'ignoreErrors'|'default'
}): Promise<void>;
+ /**
+ * Emitted when a new browser context is created.
+ */
+ 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:
@@ -9982,11 +9987,21 @@ 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 browser context is created.
+ */
+ 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:
@@ -9995,16 +10010,31 @@ 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 browser context is created.
+ */
+ 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/browser.ts b/packages/playwright-core/src/client/browser.ts
index 1f19055489..010d16bb5f 100644
--- a/packages/playwright-core/src/client/browser.ts
+++ b/packages/playwright-core/src/client/browser.ts
@@ -109,6 +109,7 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
// and will be configured later in `_connectToBrowserType`.
if (this._browserType)
this._setupBrowserContext(context);
+ this.emit(Events.Browser.Context, context);
}
private _setupBrowserContext(context: BrowserContext) {
diff --git a/packages/playwright-core/src/client/events.ts b/packages/playwright-core/src/client/events.ts
index f244da4dd7..c988ee45d0 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/tools/dashboard/dashboardController.ts b/packages/playwright-core/src/tools/dashboard/dashboardController.ts
index 0bfebe4e67..33e4ff3cc0 100644
--- a/packages/playwright-core/src/tools/dashboard/dashboardController.ts
+++ b/packages/playwright-core/src/tools/dashboard/dashboardController.ts
@@ -41,6 +41,7 @@ class BrowserTracker {
readonly browser: api.Browser;
private _callbacks: BrowserTrackerCallbacks;
private _contextListeners = new Map<api.BrowserContext, Disposable[]>();
+ private _browserListeners: Disposable[] = [];
static async create(descriptor: BrowserDescriptor, callbacks: BrowserTrackerCallbacks): Promise<BrowserTracker | undefined> {
try {
@@ -48,6 +49,9 @@ class BrowserTracker {
const slot = new BrowserTracker(descriptor, browser, callbacks);
for (const context of browser.contexts())
slot._wireContext(context);
+ slot._browserListeners.push(eventsHelper.addEventListener(browser, 'context', (context: api.BrowserContext) => {
+ slot._wireContext(context);
+ }));
return slot;
} catch {
return undefined;
@@ -65,6 +69,8 @@ class BrowserTracker {
}
dispose() {
+ this._browserListeners.forEach(d => d.dispose());
+ this._browserListeners = [];
for (const listeners of this._contextListeners.values())
listeners.forEach(d => d.dispose());
this._contextListeners.clear();
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index b0a45b471e..ba593c8b90 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -9974,6 +9974,11 @@ export interface Browser {
*/
behavior?: 'wait'|'ignoreErrors'|'default'
}): Promise<void>;
+ /**
+ * Emitted when a new browser context is created.
+ */
+ 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:
@@ -9982,11 +9987,21 @@ 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 browser context is created.
+ */
+ 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:
@@ -9995,16 +10010,31 @@ 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 browser context is created.
+ */
+ 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/tests/library/browser.spec.ts b/tests/library/browser.spec.ts
index 19d47f871a..a3db493051 100644
--- a/tests/library/browser.spec.ts
+++ b/tests/library/browser.spec.ts
@@ -63,6 +63,13 @@ test('should dispatch page.on(close) upon browser.close and reject evaluate', as
expect(error.message).toContain(kTargetClosedErrorMessage);
});
+test('should fire context event on newContext', async ({ browser }) => {
+ const events = [];
+ browser.on('context', ctx => events.push(ctx));
+ const context = await browser.newContext();
+ expect(events).toEqual([context]);
+});
+
test('newContext should not leave a context upon failure', async ({ browser, toImpl }) => {
const error = await browser.newContext({
__testHookBeforeSetStorageState: () => Promise.reject(new Error('Oh my')),
diff --git a/tests/library/multiclient.spec.ts b/tests/library/multiclient.spec.ts
index e5896693b2..50e1582bc2 100644
--- a/tests/library/multiclient.spec.ts
+++ b/tests/library/multiclient.spec.ts
@@ -16,7 +16,7 @@
import { kTargetClosedErrorMessage } from '../config/errors';
import { expect, playwrightTest } from '../config/browserTest';
-import type { Browser, BrowserServer, ConnectOptions, Page } from 'playwright-core';
+import type { Browser, BrowserContext, BrowserServer, ConnectOptions, Page } from 'playwright-core';
type ExtraFixtures = {
remoteServer: BrowserServer;
@@ -93,6 +93,19 @@ test('should connect two clients', async ({ connect, remoteServer, server }) =>
await expect(pageB2).toHaveURL(server.PREFIX + '/frames/frame.html');
});
+test('should fire context event on remote newContext', async ({ connect, remoteServer }) => {
+ const browserA = await connect(remoteServer.wsEndpoint());
+ const events: BrowserContext[] = [];
+ browserA.on('context', ctx => events.push(ctx));
+
+ const browserB = await connect(remoteServer.wsEndpoint());
+ const contextB = await browserB.newContext();
+
+ await expect.poll(() => events).toHaveLength(1);
+ expect(browserA.contexts()).toEqual([events[0]]);
+ expect(events[0]).not.toBe(contextB);
+});
+
test('should have separate default timeouts', async ({ twoPages }) => {
const { pageA, pageB } = twoPages;
pageA.setDefaultTimeout(500);
diff --git a/tests/mcp/cli-fixtures.ts b/tests/mcp/cli-fixtures.ts
index c670c4891e..2b578149c1 100644
--- a/tests/mcp/cli-fixtures.ts
+++ b/tests/mcp/cli-fixtures.ts
@@ -91,10 +91,22 @@ export const test = baseTest.extend<{
for (const pid of allPids)
killProcessGroup(pid);
- const daemonDir = path.join(test.info().outputDir, 'daemon');
- const userDataDirs = await fs.promises.readdir(daemonDir).catch(() => []);
- for (const dir of userDataDirs.filter(f => f.startsWith('ud-')))
- await fs.promises.rm(path.join(daemonDir, dir), { recursive: true, force: true }).catch(() => {});
+ const daemonDir = test.info().outputPath('daemon');
+ for (const dir of await fs.promises.readdir(daemonDir).catch<string[]>(() => [])) {
+ if (dir.startsWith('ud-')) {
+ await fs.promises.rm(path.join(daemonDir, dir), { recursive: true, force: true }).catch(() => {});
+ continue;
+ }
+ const workspacePath = path.join(daemonDir, dir);
+ for (const entry of await fs.promises.readdir(workspacePath).catch<string[]>(() => [])) {
+ if (!entry.endsWith('.err'))
+ continue;
+ const errPath = path.join(workspacePath, entry);
+ if ((await fs.promises.stat(errPath)).size === 0)
+ continue;
+ await test.info().attach(entry, { path: errPath, contentType: 'text/plain' });
+ }
+ }
},
boundBrowser: async ({ mcpBrowser, playwright }, use) => {
const browserName = (mcpBrowser === 'chrome' || mcpBrowser === 'msedge') ? 'chromium' : mcpBrowser;
diff --git a/tests/mcp/dashboard.spec.ts b/tests/mcp/dashboard.spec.ts
index a6c5fdbac8..0dc262557b 100644
--- a/tests/mcp/dashboard.spec.ts
+++ b/tests/mcp/dashboard.spec.ts
@@ -56,12 +56,14 @@ test('should show one row per context for a single browser', async ({ boundBrows
const contextA = await boundBrowser.newContext();
const pageA = await contextA.newPage();
await pageA.goto(server.EMPTY_PAGE);
- const contextB = await boundBrowser.newContext();
- const pageB = await contextB.newPage();
- await pageB.goto(server.EMPTY_PAGE);
const dashboard = await startDashboardServer();
const chips = dashboard.locator('.session-chip');
+ await expect(chips).toHaveCount(1);
+
+ const contextB = await boundBrowser.newContext();
+ const pageB = await contextB.newPage();
+ await pageB.goto(server.EMPTY_PAGE);
await expect(chips).toHaveCount(2);
});
@@ -98,8 +100,7 @@ test('should show current workspace sessions first', async ({ cli, server, start
});
});
-test('should activate session when show is called with -s', async ({ cli, server, startDashboardServer, mcpBrowser }) => {
- test.fixme(mcpBrowser === 'firefox', 'race condition gonna be fixed through https://github.com/microsoft/playwright/pull/40315');
+test('should activate session when show is called with -s', async ({ cli, server, startDashboardServer }) => {
await cli('-s=sessA', 'open', server.EMPTY_PAGE);
await cli('-s=sessB', 'open', server.EMPTY_PAGE);