Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore: publish browser list via DebugController (#37027)
Simon Knott58cab06527fa
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex e5368ca120..a6be00e094 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -437,6 +437,16 @@ scheme.DebugControllerSetModeRequestedEvent = tObject({});scheme.DebugControllerStateChangedEvent = tObject({pageCount: tInt,+ browsers: tArray(tObject({+ id: tString,+ name: tString,+ channel: tOptional(tString),+ contexts: tArray(tObject({+ pages: tArray(tObject({+ url: tString,+ })),+ })),+ })),});scheme.DebugControllerSourceChangedEvent = tObject({text: tString,diff --git a/packages/playwright-core/src/server/debugController.ts b/packages/playwright-core/src/server/debugController.tsindex a9c4aafc7d..6871d37775 100644--- a/packages/playwright-core/src/server/debugController.ts+++ b/packages/playwright-core/src/server/debugController.ts@@ -24,6 +24,8 @@ import { unsafeLocatorOrSelectorAsSelector } from '../utils/isomorphic/locatorPaimport { generateCode } from './codegen/language';import { collapseActions } from './recorder/recorderUtils';import { JavaScriptLanguageGenerator } from './codegen/javascript';+import { Frame } from './frames';+import { Page } from './page';import type { Language } from '../utils';import type { BrowserContext } from './browserContext';@@ -42,7 +44,8 @@ export class DebugController extends SdkObject {SetModeRequested: 'setModeRequested',};- private _trackHierarchyListener: InstrumentationListener | undefined;+ private _reportState = false;+ private _disposeListeners = new Set<() => void>();private _playwright: Playwright;_sdkLanguage: Language = 'javascript';_generateAutoExpect = false;@@ -61,16 +64,28 @@ export class DebugController extends SdkObject {}setReportStateChanged(enabled: boolean) {- if (enabled && !this._trackHierarchyListener) {- this._trackHierarchyListener = {- onPageOpen: () => this._emitSnapshot(false),+ if (this._reportState === enabled)+ return;+ this._reportState = enabled;+ if (enabled) {+ const listener: InstrumentationListener = {+ onPageOpen: page => {+ this._emitSnapshot(false);+ const handleNavigation = () => this._emitSnapshot(false);+ page.mainFrame().on(Frame.Events.InternalNavigation, handleNavigation);+ const dispose = () => page.mainFrame().off(Frame.Events.InternalNavigation, handleNavigation);+ this._disposeListeners.add(dispose);+ page.on(Page.Events.Close, () => this._disposeListeners.delete(dispose));+ },onPageClose: () => this._emitSnapshot(false),};- this._playwright.instrumentation.addListener(this._trackHierarchyListener, null);+ this._playwright.instrumentation.addListener(listener, null);+ this._disposeListeners.add(() => this._playwright.instrumentation.removeListener(listener));this._emitSnapshot(true);- } else if (!enabled && this._trackHierarchyListener) {- this._playwright.instrumentation.removeListener(this._trackHierarchyListener);- this._trackHierarchyListener = undefined;+ } else {+ for (const dispose of this._disposeListeners)+ dispose();+ this._disposeListeners.clear();}}@@ -141,7 +156,19 @@ export class DebugController extends SdkObject {const pageCount = this._playwright.allPages().length;if (initial && !pageCount)return;- this.emit(DebugController.Events.StateChanged, { pageCount });+ this.emit(DebugController.Events.StateChanged, {+ pageCount,+ browsers: this._playwright.allBrowsers().map(browser => ({+ id: browser.guid,+ name: browser.options.name,+ channel: browser.options.channel,+ contexts: browser.contexts().map(context => ({+ pages: context.pages().map(page => ({+ url: page.mainFrame().url(),+ }))+ }))+ }))+ });}private async _allRecorders(): Promise<Recorder[]> {diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex 31bde8e1a7..a94b1a75ed 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -742,6 +742,16 @@ export type DebugControllerSetModeRequestedEvent = {};export type DebugControllerStateChangedEvent = {pageCount: number,+ browsers: {+ id: string,+ name: string,+ channel?: string,+ contexts: {+ pages: {+ url: string,+ }[],+ }[],+ }[],};export type DebugControllerSourceChangedEvent = {text: string,diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex f2e9a0bf0e..8bf6248159 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -926,6 +926,25 @@ DebugController:stateChanged:parameters:pageCount: int+ browsers:+ type: array+ items:+ type: object+ properties:+ id: string+ name: string+ channel: string?+ contexts:+ type: array+ items:+ type: object+ properties:+ pages:+ type: array+ items:+ type: object+ properties:+ url: stringsourceChanged:parameters:diff --git a/tests/library/debug-controller.spec.ts b/tests/library/debug-controller.spec.tsindex 309e13fe08..4a67633504 100644--- a/tests/library/debug-controller.spec.ts+++ b/tests/library/debug-controller.spec.ts@@ -107,7 +107,7 @@ test('should pick element', async ({ backend, connectedBrowser }) => {expect(events).toHaveLength(2);});-test('should report pages', async ({ backend, connectedBrowser }) => {+test('should report pages', async ({ backend, connectedBrowser, browserName, channel }) => {const events = [];backend.on('stateChanged', event => events.push(event));await backend.setReportStateChanged({ enabled: true });@@ -116,6 +116,7 @@ test('should report pages', async ({ backend, connectedBrowser }) => {const page1 = await context.newPage();const page2 = await context.newPage();await page1.close();+ await page2.goto('data:text/html,Foo');await page2.close();await backend.setReportStateChanged({ enabled: false });@@ -125,12 +126,63 @@ test('should report pages', async ({ backend, connectedBrowser }) => {expect(events).toEqual([{pageCount: 1,+ browsers: [{+ id: expect.any(String),+ name: browserName,+ channel,+ contexts: [{+ pages: [+ { url: 'about:blank' }+ ]+ }]+ }]}, {pageCount: 2,+ browsers: [{+ id: expect.any(String),+ name: browserName,+ channel,+ contexts: [{+ pages: [+ { url: 'about:blank' },+ { url: 'about:blank' }+ ]+ }]+ }]}, {pageCount: 1,+ browsers: [{+ id: expect.any(String),+ name: browserName,+ channel,+ contexts: [{+ pages: [+ { url: 'about:blank' }+ ]+ }]+ }]+ }, {+ pageCount: 1,+ browsers: [{+ id: expect.any(String),+ name: browserName,+ channel,+ contexts: [{+ pages: [+ { url: 'data:text/html,Foo' }+ ]+ }]+ }]}, {pageCount: 0,+ browsers: [{+ id: expect.any(String),+ name: browserName,+ channel,+ contexts: [{+ pages: []+ }]+ }]}]);});