Skip to content

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

chore(debug controller): add per-browser highlight + close (#37061)

Simon Knott78b498cee9bf
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index 7cc9066da7..f290f49e2d 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -475,6 +475,7 @@ scheme.DebugControllerSetReportStateChangedParams = tObject({
});
scheme.DebugControllerSetReportStateChangedResult = tOptional(tObject({}));
scheme.DebugControllerSetRecorderModeParams = tObject({
+ browserId: tOptional(tString),
mode: tEnum(['inspecting', 'recording', 'none']),
testIdAttributeName: tOptional(tString),
generateAutoExpect: tOptional(tBoolean),
@@ -489,6 +490,11 @@ scheme.DebugControllerHideHighlightParams = tOptional(tObject({}));
scheme.DebugControllerHideHighlightResult = tOptional(tObject({}));
scheme.DebugControllerResumeParams = tOptional(tObject({}));
scheme.DebugControllerResumeResult = tOptional(tObject({}));
+scheme.DebugControllerCloseBrowserParams = tObject({
+ id: tString,
+ reason: tOptional(tString),
+});
+scheme.DebugControllerCloseBrowserResult = tOptional(tObject({}));
scheme.DebugControllerKillParams = tOptional(tObject({}));
scheme.DebugControllerKillResult = tOptional(tObject({}));
scheme.SocksSupportInitializer = tOptional(tObject({}));
diff --git a/packages/playwright-core/src/server/debugController.ts b/packages/playwright-core/src/server/debugController.ts
index 6871d37775..4efe0c8f21 100644
--- a/packages/playwright-core/src/server/debugController.ts
+++ b/packages/playwright-core/src/server/debugController.ts
@@ -89,12 +89,12 @@ export class DebugController extends SdkObject {
}
}
- async setRecorderMode(progress: Progress, params: { mode: Mode, testIdAttributeName?: string, generateAutoExpect?: boolean }) {
+ async setRecorderMode(progress: Progress, params: { mode: Mode, testIdAttributeName?: string, generateAutoExpect?: boolean, browserId?: string }) {
await progress.race(this._closeBrowsersWithoutPages());
this._generateAutoExpect = !!params.generateAutoExpect;
if (params.mode === 'none') {
- for (const recorder of await progress.race(this._allRecorders())) {
+ for (const recorder of await progress.race(this._allRecorders(params.browserId))) {
recorder.hideHighlightedSelector();
recorder.setMode('none');
}
@@ -112,11 +112,14 @@ export class DebugController extends SdkObject {
}
// Update test id attribute.
if (params.testIdAttributeName) {
- for (const page of this._playwright.allPages())
+ for (const page of this._playwright.allPages()) {
+ if (params.browserId && page.browserContext._browser.guid !== params.browserId)
+ continue;
page.browserContext.selectors().setTestIdAttributeName(params.testIdAttributeName);
+ }
}
// Toggle the mode.
- for (const recorder of await progress.race(this._allRecorders())) {
+ for (const recorder of await progress.race(this._allRecorders(params.browserId))) {
recorder.hideHighlightedSelector();
recorder.setMode(params.mode);
}
@@ -148,6 +151,13 @@ export class DebugController extends SdkObject {
recorder.resume();
}
+ async closeBrowser(progress: Progress, id: string, reason?: string) {
+ const browser = this._playwright.allBrowsers().find(b => b.guid === id);
+ if (!browser)
+ return;
+ await progress.race(browser.close({ reason }));
+ }
+
kill() {
gracefullyProcessExitDoNotHang(0);
}
@@ -171,10 +181,13 @@ export class DebugController extends SdkObject {
});
}
- private async _allRecorders(): Promise<Recorder[]> {
+ private async _allRecorders(browserId?: string): Promise<Recorder[]> {
const contexts = new Set<BrowserContext>();
- for (const page of this._playwright.allPages())
+ for (const page of this._playwright.allPages()) {
+ if (browserId && page.browserContext._browser.guid !== browserId)
+ continue;
contexts.add(page.browserContext);
+ }
const recorders = await Promise.all([...contexts].map(c => Recorder.forContext(c, { omitCallTracking: true })));
const nonNullRecorders = recorders.filter(Boolean) as Recorder[];
for (const recorder of recorders)
diff --git a/packages/playwright-core/src/server/dispatchers/debugControllerDispatcher.ts b/packages/playwright-core/src/server/dispatchers/debugControllerDispatcher.ts
index 5955359257..28e4e93a2f 100644
--- a/packages/playwright-core/src/server/dispatchers/debugControllerDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/debugControllerDispatcher.ts
@@ -78,6 +78,10 @@ export class DebugControllerDispatcher extends Dispatcher<DebugController, chann
this._object.kill();
}
+ async closeBrowser(params: channels.DebugControllerCloseBrowserParams, progress: Progress) {
+ await this._object.closeBrowser(progress, params.id, params.reason);
+ }
+
override _onDispose() {
eventsHelper.removeEventListeners(this._listeners);
this._object.dispose();
diff --git a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
index 226f8dc6e9..23106604eb 100644
--- a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
+++ b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
@@ -41,6 +41,7 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['DebugController.highlight', { internal: true, }],
['DebugController.hideHighlight', { internal: true, }],
['DebugController.resume', { internal: true, }],
+ ['DebugController.closeBrowser', { internal: true, }],
['DebugController.kill', { internal: true, }],
['SocksSupport.socksConnected', { internal: true, }],
['SocksSupport.socksFailed', { internal: true, }],
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index 9250010ca4..a4ff80f6ad 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -743,6 +743,7 @@ export interface DebugControllerChannel extends DebugControllerEventTarget, Chan
highlight(params: DebugControllerHighlightParams, progress?: Progress): Promise<DebugControllerHighlightResult>;
hideHighlight(params?: DebugControllerHideHighlightParams, progress?: Progress): Promise<DebugControllerHideHighlightResult>;
resume(params?: DebugControllerResumeParams, progress?: Progress): Promise<DebugControllerResumeResult>;
+ closeBrowser(params: DebugControllerCloseBrowserParams, progress?: Progress): Promise<DebugControllerCloseBrowserResult>;
kill(params?: DebugControllerKillParams, progress?: Progress): Promise<DebugControllerKillResult>;
}
export type DebugControllerInspectRequestedEvent = {
@@ -791,11 +792,13 @@ export type DebugControllerSetReportStateChangedOptions = {
};
export type DebugControllerSetReportStateChangedResult = void;
export type DebugControllerSetRecorderModeParams = {
+ browserId?: string,
mode: 'inspecting' | 'recording' | 'none',
testIdAttributeName?: string,
generateAutoExpect?: boolean,
};
export type DebugControllerSetRecorderModeOptions = {
+ browserId?: string,
testIdAttributeName?: string,
generateAutoExpect?: boolean,
};
@@ -815,6 +818,14 @@ export type DebugControllerHideHighlightResult = void;
export type DebugControllerResumeParams = {};
export type DebugControllerResumeOptions = {};
export type DebugControllerResumeResult = void;
+export type DebugControllerCloseBrowserParams = {
+ id: string,
+ reason?: string,
+};
+export type DebugControllerCloseBrowserOptions = {
+ reason?: string,
+};
+export type DebugControllerCloseBrowserResult = void;
export type DebugControllerKillParams = {};
export type DebugControllerKillOptions = {};
export type DebugControllerKillResult = void;
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index 080251712a..337488643b 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -896,6 +896,7 @@ DebugController:
setRecorderMode:
internal: true
parameters:
+ browserId: string?
mode:
type: enum
literals:
@@ -917,6 +918,12 @@ DebugController:
resume:
internal: true
+ closeBrowser:
+ internal: true
+ parameters:
+ id: string
+ reason: string?
+
kill:
internal: true
diff --git a/tests/library/debug-controller.spec.ts b/tests/library/debug-controller.spec.ts
index 1e72ee9b5f..fb560db964 100644
--- a/tests/library/debug-controller.spec.ts
+++ b/tests/library/debug-controller.spec.ts
@@ -34,7 +34,7 @@ const test = baseTest.extend<Fixtures>({
wsEndpoint: async ({ headless }, use) => {
if (headless)
process.env.PW_DEBUG_CONTROLLER_HEADLESS = '1';
- const server = new PlaywrightServer({ mode: 'extension', path: '/' + createGuid(), maxConnections: Number.MAX_VALUE, enableSocksProxy: false });
+ const server = new PlaywrightServer({ mode: 'default', path: '/' + createGuid(), maxConnections: Number.MAX_VALUE, enableSocksProxy: false, debugController: true });
const wsEndpoint = await server.listen();
await use(wsEndpoint);
await server.close();
@@ -111,6 +111,30 @@ test('should pick element', async ({ backend, connectedBrowser }) => {
expect(events).toHaveLength(2);
});
+test('should allow setting recorder mode only for specific browser', async ({ backend, connectedBrowserFactory }) => {
+ const events = [];
+ backend.on('inspectRequested', event => events.push(event));
+
+ const browser1 = await connectedBrowserFactory();
+ const browser2 = await connectedBrowserFactory();
+ expect((browser1 as any)._guid).not.toBe((browser2 as any)._guid);
+ const page1 = await browser1.newPage();
+ await page1.setContent('<button>Submit</button>');
+ const page2 = await browser2.newPage();
+ await page2.setContent('<button>Submit</button>');
+
+ await backend.setRecorderMode({ mode: 'inspecting', browserId: (browser1 as any)._guid });
+ await page1.getByRole('button').click();
+ expect(events).toHaveLength(1);
+
+ await page2.getByRole('button').click();
+ expect(events).toHaveLength(1);
+
+ await backend.setRecorderMode({ mode: 'inspecting', browserId: (browser2 as any)._guid });
+ await page2.getByRole('button').click();
+ expect(events).toHaveLength(2);
+});
+
test('should report pages', async ({ backend, connectedBrowser, browserName, channel }) => {
const events = [];
backend.on('stateChanged', event => events.push(event));
@@ -402,3 +426,8 @@ test('should not work with browser._launchServer(_debugController: false)', asyn
await server.close();
await browser.close();
});
+
+test('should support closing browsers', async ({ backend, connectedBrowser }) => {
+ await backend.closeBrowser({ id: (connectedBrowser as any)._guid, reason: 'some reason' });
+ await expect.poll(() => connectedBrowser.isConnected()).toBe(false);
+});