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
feat: console messages in service worker (#38214)
Dmitry Gozman468570ffe9c8
diff --git a/docs/src/api/class-consolemessage.md b/docs/src/api/class-consolemessage.mdindex f856dffe55..b712bca267 100644--- a/docs/src/api/class-consolemessage.md+++ b/docs/src/api/class-consolemessage.md@@ -150,3 +150,9 @@ The text of the console message.One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`,`'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`,`'count'`, `'timeEnd'`.++## method: ConsoleMessage.worker+* since: v1.57+- returns: <[null]|[Worker]>++The web worker or service worker that produced this console message, if any. Note that console messages from web workers also have non-null [`method: ConsoleMessage.page`].diff --git a/docs/src/api/class-worker.md b/docs/src/api/class-worker.mdindex fa7beeda17..bd41abc1cd 100644--- a/docs/src/api/class-worker.md+++ b/docs/src/api/class-worker.md@@ -62,7 +62,7 @@ Emitted when this dedicated [WebWorker](https://developer.mozilla.org/en-US/docs* since: v1.57- argument: <[ConsoleMessage]>-Emitted when JavaScript within the Web Worker calls one of console API methods, e.g. `console.log` or `console.dir`. Console is not supported for Service Workers.+Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.## async method: Worker.evaluate* since: v1.8diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.tsindex 2e5274cd5d..55fb65559d 100644--- a/packages/playwright-client/types/types.d.ts+++ b/packages/playwright-client/types/types.d.ts@@ -10331,8 +10331,7 @@ export interface Worker {on(event: 'close', listener: (worker: Worker) => any): this;/**- * Emitted when JavaScript within the Web Worker calls one of console API methods, e.g. `console.log` or- * `console.dir`. Console is not supported for Service Workers.+ * Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.*/on(event: 'console', listener: (consoleMessage: ConsoleMessage) => any): this;@@ -10353,8 +10352,7 @@ export interface Worker {addListener(event: 'close', listener: (worker: Worker) => any): this;/**- * Emitted when JavaScript within the Web Worker calls one of console API methods, e.g. `console.log` or- * `console.dir`. Console is not supported for Service Workers.+ * Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.*/addListener(event: 'console', listener: (consoleMessage: ConsoleMessage) => any): this;@@ -10385,8 +10383,7 @@ export interface Worker {prependListener(event: 'close', listener: (worker: Worker) => any): this;/**- * Emitted when JavaScript within the Web Worker calls one of console API methods, e.g. `console.log` or- * `console.dir`. Console is not supported for Service Workers.+ * Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.*/prependListener(event: 'console', listener: (consoleMessage: ConsoleMessage) => any): this;@@ -10399,8 +10396,7 @@ export interface Worker {waitForEvent(event: 'close', optionsOrPredicate?: { predicate?: (worker: Worker) => boolean | Promise<boolean>, timeout?: number } | ((worker: Worker) => boolean | Promise<boolean>)): Promise<Worker>;/**- * Emitted when JavaScript within the Web Worker calls one of console API methods, e.g. `console.log` or- * `console.dir`. Console is not supported for Service Workers.+ * Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.*/waitForEvent(event: 'console', optionsOrPredicate?: { predicate?: (consoleMessage: ConsoleMessage) => boolean | Promise<boolean>, timeout?: number } | ((consoleMessage: ConsoleMessage) => boolean | Promise<boolean>)): Promise<ConsoleMessage>;@@ -18886,6 +18882,13 @@ export interface ConsoleMessage {text(): string;type(): "log"|"debug"|"info"|"error"|"warning"|"dir"|"dirxml"|"table"|"trace"|"clear"|"startGroup"|"startGroupCollapsed"|"endGroup"|"assert"|"profile"|"profileEnd"|"count"|"timeEnd";++ /**+ * The web worker or service worker that produced this console message, if any. Note that console messages from web+ * workers also have non-null+ * [consoleMessage.page()](https://playwright.dev/docs/api/class-consolemessage#console-message-page).+ */+ worker(): null|Worker;}/**diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.tsindex c325387467..05178d2e71 100644--- a/packages/playwright-core/src/client/browserContext.ts+++ b/packages/playwright-core/src/client/browserContext.ts@@ -108,9 +108,18 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>this.emit(Events.BrowserContext.ServiceWorker, serviceWorker);});this._channel.on('console', event => {- const consoleMessage = new ConsoleMessage(this._platform, event, Page.fromNullable(event.page));- Worker.fromNullable(event.worker)?.emit(Events.Worker.Console, consoleMessage);- consoleMessage.page()?.emit(Events.Page.Console, consoleMessage);+ const worker = Worker.fromNullable(event.worker);+ const page = Page.fromNullable(event.page);+ const consoleMessage = new ConsoleMessage(this._platform, event, page, worker);+ worker?.emit(Events.Worker.Console, consoleMessage);+ page?.emit(Events.Page.Console, consoleMessage);+ if (worker && this._serviceWorkers.has(worker)) {+ const scope = this._serviceWorkerScope(worker);+ for (const page of this._pages) {+ if (scope && page.url().startsWith(scope))+ page.emit(Events.Page.Console, consoleMessage);+ }+ }this.emit(Events.BrowserContext.Console, consoleMessage);});this._channel.on('pageError', ({ error, page }) => {@@ -253,6 +262,17 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>await bindingCall.call(func);}+ private _serviceWorkerScope(serviceWorker: Worker) {+ try {+ let url = new URL('.', serviceWorker.url()).href;+ if (!url.endsWith('/'))+ url += '/';+ return url;+ } catch {+ return null;+ }+ }+setDefaultNavigationTimeout(timeout: number | undefined) {this._timeoutSettings.setDefaultNavigationTimeout(timeout);}diff --git a/packages/playwright-core/src/client/consoleMessage.ts b/packages/playwright-core/src/client/consoleMessage.tsindex b7b5a9720a..1db351f0c7 100644--- a/packages/playwright-core/src/client/consoleMessage.ts+++ b/packages/playwright-core/src/client/consoleMessage.ts@@ -15,26 +15,33 @@*/import { JSHandle } from './jsHandle';-import { Page } from './page';import type * as api from '../../types/types';import type { Platform } from './platform';import type * as channels from '@protocol/channels';+import type { Page } from './page';+import type { Worker } from './worker';type ConsoleMessageLocation = channels.BrowserContextConsoleEvent['location'];export class ConsoleMessage implements api.ConsoleMessage {private _page: Page | null;+ private _worker: Worker | null;private _event: channels.BrowserContextConsoleEvent | channels.ElectronApplicationConsoleEvent;- constructor(platform: Platform, event: channels.BrowserContextConsoleEvent | channels.ElectronApplicationConsoleEvent, page: Page | null) {+ constructor(platform: Platform, event: channels.BrowserContextConsoleEvent | channels.ElectronApplicationConsoleEvent, page: Page | null, worker: Worker | null) {this._page = page;+ this._worker = worker;this._event = event;if (platform.inspectCustom)(this as any)[platform.inspectCustom] = () => this._inspect();}+ worker() {+ return this._worker;+ }+page() {return this._page;}diff --git a/packages/playwright-core/src/client/electron.ts b/packages/playwright-core/src/client/electron.tsindex efef83d840..ed6505e24d 100644--- a/packages/playwright-core/src/client/electron.ts+++ b/packages/playwright-core/src/client/electron.ts@@ -92,7 +92,7 @@ export class ElectronApplication extends ChannelOwner<channels.ElectronApplicatithis._channel.on('close', () => {this.emit(Events.ElectronApplication.Close);});- this._channel.on('console', event => this.emit(Events.ElectronApplication.Console, new ConsoleMessage(this._platform, event, null)));+ this._channel.on('console', event => this.emit(Events.ElectronApplication.Console, new ConsoleMessage(this._platform, event, null, null)));this._setEventToSubscriptionMapping(new Map<string, channels.ElectronApplicationUpdateSubscriptionParams['event']>([[Events.ElectronApplication.Console, 'console'],]));diff --git a/packages/playwright-core/src/client/page.ts b/packages/playwright-core/src/client/page.tsindex 7c9c68ff99..62891e54bc 100644--- a/packages/playwright-core/src/client/page.ts+++ b/packages/playwright-core/src/client/page.ts@@ -668,7 +668,7 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Pageasync consoleMessages(): Promise<ConsoleMessage[]> {const { messages } = await this._channel.consoleMessages();- return messages.map(message => new ConsoleMessage(this._platform, message, this));+ return messages.map(message => new ConsoleMessage(this._platform, message, this, null));}async pageErrors(): Promise<Error[]> {diff --git a/packages/playwright-core/src/client/worker.ts b/packages/playwright-core/src/client/worker.tsindex fdca07b520..c9d9af5b86 100644--- a/packages/playwright-core/src/client/worker.ts+++ b/packages/playwright-core/src/client/worker.ts@@ -45,6 +45,9 @@ export class Worker extends ChannelOwner<channels.WorkerChannel> implements api.constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.WorkerInitializer) {super(parent, type, guid, initializer);+ this._setEventToSubscriptionMapping(new Map<string, channels.WorkerUpdateSubscriptionParams['event']>([+ [Events.Worker.Console, 'console'],+ ]));this._channel.on('close', () => {if (this._page)this._page._workers.delete(this);diff --git a/packages/playwright-core/src/server/chromium/crServiceWorker.ts b/packages/playwright-core/src/server/chromium/crServiceWorker.tsindex 3ef163e43d..cb3df4a684 100644--- a/packages/playwright-core/src/server/chromium/crServiceWorker.ts+++ b/packages/playwright-core/src/server/chromium/crServiceWorker.ts@@ -14,10 +14,12 @@* limitations under the License.*/import { Worker } from '../page';-import { CRExecutionContext } from './crExecutionContext';+import { createHandle, CRExecutionContext } from './crExecutionContext';import { CRNetworkManager } from './crNetworkManager';import { BrowserContext } from '../browserContext';import * as network from '../network';+import { ConsoleMessage } from '../console';+import { toConsoleMessageLocation } from './crProtocolHelper';import type { CRBrowserContext } from './crBrowser';import type { CRSession } from './crConnection';@@ -49,6 +51,14 @@ export class CRServiceWorker extends Worker {this._networkManager.addSession(session, undefined, true /* isMain */).catch(() => {});}+ session.on('Runtime.consoleAPICalled', event => {+ if (!this.existingExecutionContext)+ return;+ const args = event.args.map(o => createHandle(this.existingExecutionContext!, o));+ const message = new ConsoleMessage(null, this, event.type, undefined, args, toConsoleMessageLocation(event.stackTrace));+ this.browserContext.emit(BrowserContext.Events.Console, message);+ });+session.send('Runtime.enable', {}).catch(e => { });session.send('Runtime.runIfWaitingForDebugger').catch(e => { });session.on('Inspector.targetReloadedAfterCrash', () => {diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.tsindex 49e9560c03..2563e35773 100644--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts@@ -34,6 +34,8 @@ import { createGuid } from '../utils/crypto';import { urlMatches } from '../../utils/isomorphic/urlMatch';import { Recorder } from '../recorder';import { RecorderApp } from '../recorder/recorderApp';+import { ElementHandleDispatcher } from './elementHandlerDispatcher';+import { JSHandleDispatcher } from './jsHandleDispatcher';import type { Artifact } from '../artifact';import type { ConsoleMessage } from '../console';@@ -119,14 +121,13 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channelthis._dispatchEvent('pageError', { error: serializeError(error), page: PageDispatcher.from(this, page) });});this.addObjectListener(BrowserContext.Events.Console, (message: ConsoleMessage) => {- const page = message.page()!;+ const pageDispatcher = PageDispatcher.fromNullable(this, message.page());const workerDispatcher = WorkerDispatcher.fromNullable(this, message.worker());- if (this._shouldDispatchEvent(page, 'console') || workerDispatcher?._subscriptions.has('console')) {- const pageDispatcher = PageDispatcher.from(this, page);+ if (this._shouldDispatchEvent(message.page(), 'console') || workerDispatcher?._subscriptions.has('console')) {this._dispatchEvent('console', {page: pageDispatcher,worker: workerDispatcher,- ...pageDispatcher.serializeConsoleMessage(message),+ ...this.serializeConsoleMessage(message, workerDispatcher || pageDispatcher!),});}});@@ -198,7 +199,7 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channelreturn this._shouldDispatchEvent(request.frame()?._page?.initializedOrUndefined(), event);}- private _shouldDispatchEvent(page: Page | undefined, event: channels.BrowserContextUpdateSubscriptionParams['event'] & channels.PageUpdateSubscriptionParams['event']): boolean {+ private _shouldDispatchEvent(page: Page | null | undefined, event: channels.BrowserContextUpdateSubscriptionParams['event'] & channels.PageUpdateSubscriptionParams['event']): boolean {if (this._subscriptions.has(event))return true;const pageDispatcher = page ? this.connection.existingDispatcher<PageDispatcher>(page) : undefined;@@ -207,6 +208,20 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channelreturn false;}+ serializeConsoleMessage(message: ConsoleMessage, jsScope: PageDispatcher | WorkerDispatcher) {+ return {+ type: message.type(),+ text: message.text(),+ args: message.args().map(a => {+ const elementHandle = a.asElement();+ if (elementHandle)+ return ElementHandleDispatcher.from(FrameDispatcher.from(this, elementHandle._frame), elementHandle);+ return JSHandleDispatcher.fromJSHandle(jsScope, a);+ }),+ location: message.location(),+ };+ }+async createTempFiles(params: channels.BrowserContextCreateTempFilesParams, progress: Progress): Promise<channels.BrowserContextCreateTempFilesResult> {const dir = this._context._browser.options.artifactsDir;const tmpDir = path.join(dir, 'upload-' + createGuid());diff --git a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts b/packages/playwright-core/src/server/dispatchers/pageDispatcher.tsindex 1d460c6472..eb64dbe957 100644--- a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts@@ -40,7 +40,6 @@ import type { RouteHandler } from '../network';import type { InitScript, PageBinding } from '../page';import type * as channels from '@protocol/channels';import type { Progress } from '@protocol/progress';-import type { ConsoleMessage } from '../console';export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, BrowserContextDispatcher> implements channels.PageChannel {_type_EventTarget = true;@@ -61,7 +60,7 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Browsreturn PageDispatcher.fromNullable(parentScope, page)!;}- static fromNullable(parentScope: BrowserContextDispatcher, page: Page | undefined): PageDispatcher | undefined {+ static fromNullable(parentScope: BrowserContextDispatcher, page: Page | null | undefined): PageDispatcher | undefined {if (!page)return undefined;const result = parentScope.connection.existingDispatcher<PageDispatcher>(page);@@ -126,20 +125,6 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Browsreturn this._page;}- serializeConsoleMessage(message: ConsoleMessage) {- return {- type: message.type(),- text: message.text(),- args: message.args().map(a => {- const elementHandle = a.asElement();- if (elementHandle)- return ElementHandleDispatcher.from(FrameDispatcher.from(this.parentScope(), elementHandle._frame), elementHandle);- return JSHandleDispatcher.fromJSHandle(this, a);- }),- location: message.location(),- };- }-async exposeBinding(params: channels.PageExposeBindingParams, progress: Progress): Promise<void> {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,@@ -292,7 +277,7 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows// Otherwise, if subscription is added in a different task from this call (either before or after),// there is a chance for a duplicate or a lost console message.this._subscriptions.add('console');- return { messages: this._page.consoleMessages().map(message => this.serializeConsoleMessage(message)) };+ return { messages: this._page.consoleMessages().map(message => this.parentScope().serializeConsoleMessage(message, this)) };}async pageErrors(params: channels.PagePageErrorsParams, progress: Progress): Promise<channels.PagePageErrorsResult> {diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.tsindex 2e5274cd5d..55fb65559d 100644--- a/packages/playwright-core/types/types.d.ts+++ b/packages/playwright-core/types/types.d.ts@@ -10331,8 +10331,7 @@ export interface Worker {on(event: 'close', listener: (worker: Worker) => any): this;/**- * Emitted when JavaScript within the Web Worker calls one of console API methods, e.g. `console.log` or- * `console.dir`. Console is not supported for Service Workers.+ * Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.*/on(event: 'console', listener: (consoleMessage: ConsoleMessage) => any): this;@@ -10353,8 +10352,7 @@ export interface Worker {addListener(event: 'close', listener: (worker: Worker) => any): this;/**- * Emitted when JavaScript within the Web Worker calls one of console API methods, e.g. `console.log` or- * `console.dir`. Console is not supported for Service Workers.+ * Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.*/addListener(event: 'console', listener: (consoleMessage: ConsoleMessage) => any): this;@@ -10385,8 +10383,7 @@ export interface Worker {prependListener(event: 'close', listener: (worker: Worker) => any): this;/**- * Emitted when JavaScript within the Web Worker calls one of console API methods, e.g. `console.log` or- * `console.dir`. Console is not supported for Service Workers.+ * Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.*/prependListener(event: 'console', listener: (consoleMessage: ConsoleMessage) => any): this;@@ -10399,8 +10396,7 @@ export interface Worker {waitForEvent(event: 'close', optionsOrPredicate?: { predicate?: (worker: Worker) => boolean | Promise<boolean>, timeout?: number } | ((worker: Worker) => boolean | Promise<boolean>)): Promise<Worker>;/**- * Emitted when JavaScript within the Web Worker calls one of console API methods, e.g. `console.log` or- * `console.dir`. Console is not supported for Service Workers.+ * Emitted when JavaScript within the worker calls one of console API methods, e.g. `console.log` or `console.dir`.*/waitForEvent(event: 'console', optionsOrPredicate?: { predicate?: (consoleMessage: ConsoleMessage) => boolean | Promise<boolean>, timeout?: number } | ((consoleMessage: ConsoleMessage) => boolean | Promise<boolean>)): Promise<ConsoleMessage>;@@ -18886,6 +18882,13 @@ export interface ConsoleMessage {text(): string;type(): "log"|"debug"|"info"|"error"|"warning"|"dir"|"dirxml"|"table"|"trace"|"clear"|"startGroup"|"startGroupCollapsed"|"endGroup"|"assert"|"profile"|"profileEnd"|"count"|"timeEnd";++ /**+ * The web worker or service worker that produced this console message, if any. Note that console messages from web+ * workers also have non-null+ * [consoleMessage.page()](https://playwright.dev/docs/api/class-consolemessage#console-message-page).+ */+ worker(): null|Worker;}/**diff --git a/tests/library/chromium/chromium.spec.ts b/tests/library/chromium/chromium.spec.tsindex 5c55850bb6..19dd5d708e 100644--- a/tests/library/chromium/chromium.spec.ts+++ b/tests/library/chromium/chromium.spec.ts@@ -684,3 +684,63 @@ test('PLAYWRIGHT_DISABLE_SERVICE_WORKER_NETWORK', async ({ mode, context, page,delete process.env.PLAYWRIGHT_DISABLE_SERVICE_WORKER_NETWORK;});++test('should emit console messages from service worker', async ({ page, context, server }) => {+ const emptyPage = await context.newPage();+ await emptyPage.goto(server.EMPTY_PAGE);+ const emptyPageMessages = [];+ emptyPage.on('console', message => emptyPageMessages.push(message));++ const [worker] = await Promise.all([+ context.waitForEvent('serviceworker'),+ page.goto(server.PREFIX + '/serviceworkers/empty/sw.html')+ ]);++ const [message, pageMessage] = await Promise.all([+ worker.waitForEvent('console'),+ page.waitForEvent('console'),+ worker.evaluate(() => console.log('hello from service worker', {+ i: 'am',+ am: 1,+ complex: {+ yup: true,+ },+ })),+ ]);++ expect(message).toBe(pageMessage);+ expect(emptyPageMessages).toHaveLength(0);++ // Should be able to access the message after closing the page.+ await page.close();++ expect(message.text()).toContain('hello from service worker');+ expect(message.type()).toBe('log');+ const args = message.args();+ expect(args).toHaveLength(2);+ expect(await args[0].jsonValue()).toBe('hello from service worker');+ expect(await args[1].jsonValue()).toEqual({+ i: 'am',+ am: 1,+ complex: {+ yup: true,+ }+ });+});++test('should capture console.log from ServiceWorker start', async ({ context, page, server }) => {+ server.setRoute('/serviceworkers/empty/sw.js', (req, res) => {+ res.writeHead(200, 'OK', { 'Content-Type': 'text/javascript' });+ res.write(`console.log('Hello from the first line of sw.js');`);+ res.end();+ });++ const [worker] = await Promise.all([+ context.waitForEvent('serviceworker'),+ page.goto(server.PREFIX + '/serviceworkers/empty/sw.html'),+ ]);++ const consoleMessage = await worker.waitForEvent('console');+ expect(consoleMessage.text()).toBe('Hello from the first line of sw.js');+ expect(consoleMessage.type()).toBe('log');+});diff --git a/tests/page/workers.spec.ts b/tests/page/workers.spec.tsindex 6035e8524d..b2f086af84 100644--- a/tests/page/workers.spec.ts+++ b/tests/page/workers.spec.ts@@ -110,6 +110,22 @@ it('should report console event on the worker', async function({ page }) {expect(message1).toBe(message3);});+it('should report console event on the worker when not listening on page or context', async function({ page }) {+ const [worker] = await Promise.all([+ page.waitForEvent('worker'),+ page.evaluate(() => {+ (window as any).worker = new Worker(URL.createObjectURL(new Blob(['42'], { type: 'application/javascript' })));+ }),+ ]);+ const [message] = await Promise.all([+ worker.waitForEvent('console'),+ worker.evaluate(() => {+ console.log('hello from worker');+ }),+ ]);+ expect(message.text()).toBe('hello from worker');+});+it('should report errors', async function({ page }) {const errorPromise = new Promise<Error>(x => page.on('pageerror', x));await page.evaluate(() => new Worker(URL.createObjectURL(new Blob([`