Skip to content

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

feat: page.consoleMessages and page.pageErrors (#37450)

Dmitry Gozman1125381b946b
diff --git a/docs/src/api/class-page.md b/docs/src/api/class-page.md
index a4bb867483..541aebce3c 100644
--- a/docs/src/api/class-page.md
+++ b/docs/src/api/class-page.md
@@ -2677,6 +2677,21 @@ Returns whether the element is [visible](../actionability.md#visible). [`param:
* since: v1.8
- type: <[Keyboard]>
+
+## async method: Page.consoleMessages
+* since: v1.56
+- returns: <[Array]<[ConsoleMessage]>>
+
+Returns up to 200 last console messages from this page. See [`event: Page.console`] for more details.
+
+
+## async method: Page.pageErrors
+* since: v1.56
+- returns: <[Array]<[Error]>>
+
+Returns up to 200 last page errors from this page. See [`event: Page.pageError`] for more details.
+
+
## method: Page.locator
* since: v1.14
- returns: <[Locator]>
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
index 43653cbe80..867dfd391c 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -2284,6 +2284,12 @@ export interface Page {
runBeforeUnload?: boolean;
}): Promise<void>;
+ /**
+ * Returns up to 200 last console messages from this page. See
+ * [page.on('console')](https://playwright.dev/docs/api/class-page#page-event-console) for more details.
+ */
+ consoleMessages(): Promise<Array<ConsoleMessage>>;
+
/**
* Gets the full HTML contents of the page, including the doctype.
*/
@@ -3598,6 +3604,12 @@ export interface Page {
*/
opener(): Promise<null|Page>;
+ /**
+ * Returns up to 200 last page errors from this page. See
+ * [page.on('pageerror')](https://playwright.dev/docs/api/class-page#page-event-page-error) for more details.
+ */
+ pageErrors(): Promise<Array<Error>>;
+
/**
* Pauses script execution. Playwright will stop executing the script and wait for the user to either press the
* 'Resume' button in the page overlay or to call `playwright.resume()` in the DevTools console.
diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.ts
index 7b8015b630..7f0473e7b5 100644
--- a/packages/playwright-core/src/client/browserContext.ts
+++ b/packages/playwright-core/src/client/browserContext.ts
@@ -114,7 +114,7 @@ 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);
+ const consoleMessage = new ConsoleMessage(this._platform, event, Page.fromNullable(event.page));
this.emit(Events.BrowserContext.Console, consoleMessage);
const page = consoleMessage.page();
if (page)
diff --git a/packages/playwright-core/src/client/consoleMessage.ts b/packages/playwright-core/src/client/consoleMessage.ts
index 5f8efee8c2..e186fdad3d 100644
--- a/packages/playwright-core/src/client/consoleMessage.ts
+++ b/packages/playwright-core/src/client/consoleMessage.ts
@@ -26,10 +26,10 @@ type ConsoleMessageLocation = channels.BrowserContextConsoleEvent['location'];
export class ConsoleMessage implements api.ConsoleMessage {
private _page: Page | null;
- private _event: channels.BrowserContextConsoleEvent | channels.ElectronApplicationConsoleEvent;
+ private _event: channels.WorkerConsoleEvent;
- constructor(platform: Platform, event: channels.BrowserContextConsoleEvent | channels.ElectronApplicationConsoleEvent) {
- this._page = ('page' in event && event.page) ? Page.from(event.page) : null;
+ constructor(platform: Platform, event: channels.WorkerConsoleEvent, page: Page | null) {
+ this._page = page;
this._event = event;
if (platform.inspectCustom)
(this as any)[platform.inspectCustom] = () => this._inspect();
diff --git a/packages/playwright-core/src/client/electron.ts b/packages/playwright-core/src/client/electron.ts
index 083e7b6f9f..efef83d840 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.ElectronApplicati
this._channel.on('close', () => {
this.emit(Events.ElectronApplication.Close);
});
- this._channel.on('console', event => this.emit(Events.ElectronApplication.Console, new ConsoleMessage(this._platform, event)));
+ this._channel.on('console', event => this.emit(Events.ElectronApplication.Console, new ConsoleMessage(this._platform, event, 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.ts
index 4dbf85ab03..d838311f14 100644
--- a/packages/playwright-core/src/client/page.ts
+++ b/packages/playwright-core/src/client/page.ts
@@ -22,7 +22,7 @@ import { evaluationScript } from './clientHelper';
import { Coverage } from './coverage';
import { Download } from './download';
import { ElementHandle, determineScreenshotType } from './elementHandle';
-import { TargetClosedError, isTargetClosedError, serializeError } from './errors';
+import { TargetClosedError, isTargetClosedError, parseError, serializeError } from './errors';
import { Events } from './events';
import { FileChooser } from './fileChooser';
import { Frame, verifyLoadState } from './frame';
@@ -41,6 +41,7 @@ import { trimStringWithEllipsis } from '../utils/isomorphic/stringUtils';
import { urlMatches, urlMatchesEqual } from '../utils/isomorphic/urlMatch';
import { LongStandingScope } from '../utils/isomorphic/manualPromise';
import { isObject, isRegExp, isString } from '../utils/isomorphic/rtti';
+import { ConsoleMessage } from './consoleMessage';
import type { BrowserContext } from './browserContext';
import type { Clock } from './clock';
@@ -669,6 +670,16 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
return await this._mainFrame.fill(selector, value, options);
}
+ async consoleMessages(): Promise<ConsoleMessage[]> {
+ const { messages } = await this._channel.consoleMessages();
+ return messages.map(message => new ConsoleMessage(this._platform, message, this));
+ }
+
+ async pageErrors(): Promise<Error[]> {
+ const { errors } = await this._channel.pageErrors();
+ return errors.map(error => parseError(error));
+ }
+
locator(selector: string, options?: LocatorOptions): Locator {
return this.mainFrame().locator(selector, options);
}
diff --git a/packages/playwright-core/src/client/worker.ts b/packages/playwright-core/src/client/worker.ts
index 06e77290c3..fcac272b13 100644
--- a/packages/playwright-core/src/client/worker.ts
+++ b/packages/playwright-core/src/client/worker.ts
@@ -47,7 +47,7 @@ export class Worker extends ChannelOwner<channels.WorkerChannel> implements api.
this.emit(Events.Worker.Close, this);
});
this._channel.on('console', event => {
- this.emit(Events.Worker.Console, new ConsoleMessage(this._page?.context()._platform ?? this._context?._platform!, event));
+ this.emit(Events.Worker.Console, new ConsoleMessage(this._page?.context()._platform ?? this._context?._platform!, event, null));
});
this.once(Events.Worker.Close, () => this._closedScope.close(this._page?._closeErrorWithReason() || new TargetClosedError()));
this._setEventToSubscriptionMapping(new Map<string, channels.WorkerUpdateSubscriptionParams['event']>([
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index 437f1d489a..f5cb173a42 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -1245,6 +1245,19 @@ scheme.PageCloseParams = tObject({
reason: tOptional(tString),
});
scheme.PageCloseResult = tOptional(tObject({}));
+scheme.PageConsoleMessagesParams = tOptional(tObject({}));
+scheme.PageConsoleMessagesResult = tObject({
+ messages: tArray(tObject({
+ type: tString,
+ text: tString,
+ args: tArray(tChannel(['ElementHandle', 'JSHandle'])),
+ location: tObject({
+ url: tString,
+ lineNumber: tInt,
+ columnNumber: tInt,
+ }),
+ })),
+});
scheme.PageEmulateMediaParams = tObject({
media: tOptional(tEnum(['screen', 'print', 'no-override'])),
colorScheme: tOptional(tEnum(['dark', 'light', 'no-preference', 'no-override'])),
@@ -1440,6 +1453,10 @@ scheme.PageAccessibilitySnapshotParams = tObject({
scheme.PageAccessibilitySnapshotResult = tObject({
rootAXNode: tOptional(tType('AXNode')),
});
+scheme.PagePageErrorsParams = tOptional(tObject({}));
+scheme.PagePageErrorsResult = tObject({
+ errors: tArray(tType('SerializedError')),
+});
scheme.PagePdfParams = tObject({
scale: tOptional(tFloat),
displayHeaderFooter: tOptional(tBoolean),
diff --git a/packages/playwright-core/src/server/bidi/bidiPage.ts b/packages/playwright-core/src/server/bidi/bidiPage.ts
index 5b508bce38..f6d4976ec5 100644
--- a/packages/playwright-core/src/server/bidi/bidiPage.ts
+++ b/packages/playwright-core/src/server/bidi/bidiPage.ts
@@ -271,7 +271,7 @@ export class BidiPage implements PageDelegate {
const location = `${f.url}:${f.lineNumber + 1}:${f.columnNumber + 1}`;
return f.functionName ? ` at ${f.functionName} (${location})` : ` at ${location}`;
}).join('\n')}`;
- this._page.emitOnContextOnceInitialized(BidiBrowserContext.Events.PageError, error, this._page);
+ this._page.addPageError(error);
return;
}
if (params.type !== 'console')
diff --git a/packages/playwright-core/src/server/chromium/crPage.ts b/packages/playwright-core/src/server/chromium/crPage.ts
index 33167497ba..a93760f060 100644
--- a/packages/playwright-core/src/server/chromium/crPage.ts
+++ b/packages/playwright-core/src/server/chromium/crPage.ts
@@ -783,7 +783,7 @@ class FrameSession {
const args = event.args.map(o => createHandle(worker.existingExecutionContext!, o));
this._page.addConsoleMessage(event.type, args, toConsoleMessageLocation(event.stackTrace));
});
- session.on('Runtime.exceptionThrown', exception => this._page.emitOnContextOnceInitialized(BrowserContext.Events.PageError, exceptionToError(exception.exceptionDetails), this._page));
+ session.on('Runtime.exceptionThrown', exception => this._page.addPageError(exceptionToError(exception.exceptionDetails)));
}
_onDetachedFromTarget(event: Protocol.Target.detachedFromTargetPayload) {
@@ -873,7 +873,7 @@ class FrameSession {
}
_handleException(exceptionDetails: Protocol.Runtime.ExceptionDetails) {
- this._page.emitOnContextOnceInitialized(BrowserContext.Events.PageError, exceptionToError(exceptionDetails), this._page);
+ this._page.addPageError(exceptionToError(exceptionDetails));
}
async _onTargetCrashed() {
diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
index cc779595e1..8208655bc2 100644
--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
@@ -22,9 +22,7 @@ import { ArtifactDispatcher } from './artifactDispatcher';
import { CDPSessionDispatcher } from './cdpSessionDispatcher';
import { DialogDispatcher } from './dialogDispatcher';
import { Dispatcher } from './dispatcher';
-import { ElementHandleDispatcher } from './elementHandlerDispatcher';
import { FrameDispatcher } from './frameDispatcher';
-import { JSHandleDispatcher } from './jsHandleDispatcher';
import { APIRequestContextDispatcher, RequestDispatcher, ResponseDispatcher, RouteDispatcher } from './networkDispatchers';
import { BindingCallDispatcher, PageDispatcher, WorkerDispatcher } from './pageDispatcher';
import { CRBrowserContext } from '../chromium/crBrowser';
@@ -126,15 +124,7 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
const pageDispatcher = PageDispatcher.from(this, page);
this._dispatchEvent('console', {
page: pageDispatcher,
- 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(pageDispatcher, a);
- }),
- location: message.location(),
+ ...pageDispatcher.serializeConsoleMessage(message),
});
}
});
diff --git a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
index cd48ef9eda..f975bad360 100644
--- a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
@@ -16,7 +16,7 @@
import { Page, Worker } from '../page';
import { Dispatcher } from './dispatcher';
-import { parseError } from '../errors';
+import { parseError, serializeError } from '../errors';
import { ArtifactDispatcher } from './artifactDispatcher';
import { ElementHandleDispatcher } from './elementHandlerDispatcher';
import { FrameDispatcher } from './frameDispatcher';
@@ -126,6 +126,20 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows
return 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,
@@ -273,6 +287,14 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows
await this._page.keyboard.press(progress, params.key, params);
}
+ async consoleMessages(params: channels.PageConsoleMessagesParams, progress: Progress): Promise<channels.PageConsoleMessagesResult> {
+ return { messages: this._page.consoleMessages().map(message => this.serializeConsoleMessage(message)) };
+ }
+
+ async pageErrors(params: channels.PagePageErrorsParams, progress: Progress): Promise<channels.PagePageErrorsResult> {
+ return { errors: this._page.pageErrors().map(error => serializeError(error)) };
+ }
+
async mouseMove(params: channels.PageMouseMoveParams, progress: Progress): Promise<void> {
progress.metadata.point = { x: params.x, y: params.y };
await this._page.mouse.move(progress, params.x, params.y, params);
diff --git a/packages/playwright-core/src/server/firefox/ffPage.ts b/packages/playwright-core/src/server/firefox/ffPage.ts
index c282649e77..16dd3186e7 100644
--- a/packages/playwright-core/src/server/firefox/ffPage.ts
+++ b/packages/playwright-core/src/server/firefox/ffPage.ts
@@ -27,7 +27,6 @@ import { RawKeyboardImpl, RawMouseImpl, RawTouchscreenImpl } from './ffInput';
import { FFNetworkManager } from './ffNetworkManager';
import { debugLogger } from '../utils/debugLogger';
import { splitErrorMessage } from '../../utils/isomorphic/stackTrace';
-import { BrowserContext } from '../browserContext';
import { TargetClosedError } from '../errors';
import type { Progress } from '../progress';
@@ -224,7 +223,7 @@ export class FFPage implements PageDelegate {
const error = new Error(message);
error.stack = params.message + '\n' + params.stack.split('\n').filter(Boolean).map(a => a.replace(/([^@]*)@(.*)/, ' at $1 ($2)')).join('\n');
error.name = name;
- this._page.emitOnContextOnceInitialized(BrowserContext.Events.PageError, error, this._page);
+ this._page.addPageError(error);
}
_onConsole(payload: Protocol.Runtime.consolePayload) {
diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.ts
index 6a7edd191d..b36b062fe3 100644
--- a/packages/playwright-core/src/server/page.ts
+++ b/packages/playwright-core/src/server/page.ts
@@ -138,7 +138,8 @@ export class Page extends SdkObject {
private _closedPromise = new ManualPromise<void>();
private _initialized: Page | Error | undefined;
private _initializedPromise = new ManualPromise<Page | Error>();
- private _eventsToEmitAfterInitialized: { event: string | symbol, args: any[] }[] = [];
+ private _consoleMessages: ConsoleMessage[] = [];
+ private _pageErrors: Error[] = [];
private _crashed = false;
readonly openScope = new LongStandingScope();
readonly browserContext: BrowserContext;
@@ -209,9 +210,10 @@ export class Page extends SdkObject {
this._initialized = error || this;
this.emitOnContext(contextEvent, this);
- for (const { event, args } of this._eventsToEmitAfterInitialized)
- this.browserContext.emit(event, ...args);
- this._eventsToEmitAfterInitialized = [];
+ for (const pageError of this._pageErrors)
+ this.emitOnContext(BrowserContext.Events.PageError, pageError, this);
+ for (const message of this._consoleMessages)
+ this.emitOnContext(BrowserContext.Events.Console, message);
// It may happen that page initialization finishes after Close event has already been sent,
// in that case we fire another Close event to ensure that each reported Page will have
@@ -240,19 +242,6 @@ export class Page extends SdkObject {
this.browserContext.emit(event, ...args);
}
- emitOnContextOnceInitialized(event: string | symbol, ...args: any[]) {
- if (this.isStorageStatePage)
- return;
- // Some events, like console messages, may come before page is ready.
- // In this case, postpone the event until page is initialized,
- // and dispatch it to the client later, either on the live Page,
- // or on the "errored" Page.
- if (this._initialized)
- this.browserContext.emit(event, ...args);
- else
- this._eventsToEmitAfterInitialized.push({ event, args });
- }
-
async resetForReuse(progress: Progress) {
// Re-navigate once init scripts are gone.
await this.mainFrame().gotoImpl(progress, 'about:blank', {});
@@ -374,7 +363,34 @@ export class Page extends SdkObject {
args.forEach(arg => arg.dispose());
return;
}
- this.emitOnContextOnceInitialized(BrowserContext.Events.Console, message);
+
+ this._consoleMessages.push(message);
+ ensureArrayLimit(this._consoleMessages, 200); // Avoid unbounded memory growth.
+
+ // Console messages may come before the page is ready. In this case,
+ // we'll dispatch them to the client later, either on the live Page,
+ // or on the "errored" Page.
+ if (this._initialized)
+ this.emitOnContext(BrowserContext.Events.Console, message);
+ }
+
+ consoleMessages() {
+ return this._consoleMessages;
+ }
+
+ addPageError(pageError: Error) {
+ this._pageErrors.push(pageError);
+ ensureArrayLimit(this._pageErrors, 200); // Avoid unbounded memory growth.
+
+ // Page errors may come before the page is ready. In this case,
+ // we'll dispatch them to the client later, either on the live Page,
+ // or on the "errored" Page.
+ if (this._initialized)
+ this.emitOnContext(BrowserContext.Events.PageError, pageError, this);
+ }
+
+ pageErrors() {
+ return this._pageErrors;
}
async reload(progress: Progress, options: types.NavigateOptions): Promise<network.Response | null> {
@@ -1061,3 +1077,8 @@ async function snapshotFrameForAI(progress: Progress, frame: frames.Frame, frame
}
return result;
}
+
+function ensureArrayLimit(array: any[], limit: number) {
+ if (array.length > limit)
+ array.splice(0, limit / 10);
+}
diff --git a/packages/playwright-core/src/server/webkit/wkPage.ts b/packages/playwright-core/src/server/webkit/wkPage.ts
index 58ab0cc4df..db1c4c639d 100644
--- a/packages/playwright-core/src/server/webkit/wkPage.ts
+++ b/packages/playwright-core/src/server/webkit/wkPage.ts
@@ -24,7 +24,6 @@ import { eventsHelper } from '../utils/eventsHelper';
import { hostPlatform } from '../utils/hostPlatform';
import { splitErrorMessage } from '../../utils/isomorphic/stackTrace';
import { PNG, jpegjs } from '../../utilsBundle';
-import { BrowserContext } from '../browserContext';
import * as dialog from '../dialog';
import * as dom from '../dom';
import { TargetClosedError } from '../errors';
@@ -540,7 +539,7 @@ export class WKPage implements PageDelegate {
error.stack = stack;
error.name = name;
- this._page.emitOnContextOnceInitialized(BrowserContext.Events.PageError, error, this._page);
+ this._page.addPageError(error);
return;
}
diff --git a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
index cb841371fa..76f231b300 100644
--- a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
+++ b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
@@ -101,6 +101,7 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['BrowserContext.clockSetSystemTime', { title: 'Set system time "{timeNumber|timeString}"', }],
['Page.addInitScript', { title: 'Add init script', group: 'configuration', }],
['Page.close', { title: 'Close page', pausesBeforeAction: true, }],
+ ['Page.consoleMessages', { title: 'Get console messages', group: 'getter', }],
['Page.emulateMedia', { title: 'Emulate media', snapshot: true, pausesBeforeAction: true, }],
['Page.exposeBinding', { title: 'Expose binding', group: 'configuration', }],
['Page.goBack', { title: 'Go back', slowMo: true, snapshot: true, pausesBeforeAction: true, }],
@@ -128,6 +129,7 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Page.mouseWheel', { title: 'Mouse wheel', slowMo: true, snapshot: true, pausesBeforeAction: true, }],
['Page.touchscreenTap', { title: 'Tap', slowMo: true, snapshot: true, pausesBeforeAction: true, }],
['Page.accessibilitySnapshot', { title: 'Accessibility snapshot', group: 'getter', }],
+ ['Page.pageErrors', { title: 'Get page errors', group: 'getter', }],
['Page.pdf', { title: 'PDF', }],
['Page.snapshotForAI', { internal: true, }],
['Page.startJSCoverage', { title: 'Start JS coverage', group: 'configuration', }],
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index 43653cbe80..867dfd391c 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -2284,6 +2284,12 @@ export interface Page {
runBeforeUnload?: boolean;
}): Promise<void>;
+ /**
+ * Returns up to 200 last console messages from this page. See
+ * [page.on('console')](https://playwright.dev/docs/api/class-page#page-event-console) for more details.
+ */
+ consoleMessages(): Promise<Array<ConsoleMessage>>;
+
/**
* Gets the full HTML contents of the page, including the doctype.
*/
@@ -3598,6 +3604,12 @@ export interface Page {
*/
opener(): Promise<null|Page>;
+ /**
+ * Returns up to 200 last page errors from this page. See
+ * [page.on('pageerror')](https://playwright.dev/docs/api/class-page#page-event-page-error) for more details.
+ */
+ pageErrors(): Promise<Array<Error>>;
+
/**
* Pauses script execution. Playwright will stop executing the script and wait for the user to either press the
* 'Resume' button in the page overlay or to call `playwright.resume()` in the DevTools console.
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index 73d5efef3a..fe346de7f1 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -2091,6 +2091,7 @@ export interface PageChannel extends PageEventTarget, EventTargetChannel {
_type_Page: boolean;
addInitScript(params: PageAddInitScriptParams, progress?: Progress): Promise<PageAddInitScriptResult>;
close(params: PageCloseParams, progress?: Progress): Promise<PageCloseResult>;
+ consoleMessages(params?: PageConsoleMessagesParams, progress?: Progress): Promise<PageConsoleMessagesResult>;
emulateMedia(params: PageEmulateMediaParams, progress?: Progress): Promise<PageEmulateMediaResult>;
exposeBinding(params: PageExposeBindingParams, progress?: Progress): Promise<PageExposeBindingResult>;
goBack(params: PageGoBackParams, progress?: Progress): Promise<PageGoBackResult>;
@@ -2118,6 +2119,7 @@ export interface PageChannel extends PageEventTarget, EventTargetChannel {
mouseWheel(params: PageMouseWheelParams, progress?: Progress): Promise<PageMouseWheelResult>;
touchscreenTap(params: PageTouchscreenTapParams, progress?: Progress): Promise<PageTouchscreenTapResult>;
accessibilitySnapshot(params: PageAccessibilitySnapshotParams, progress?: Progress): Promise<PageAccessibilitySnapshotResult>;
+ pageErrors(params?: PagePageErrorsParams, progress?: Progress): Promise<PagePageErrorsResult>;
pdf(params: PagePdfParams, progress?: Progress): Promise<PagePdfResult>;
snapshotForAI(params: PageSnapshotForAIParams, progress?: Progress): Promise<PageSnapshotForAIResult>;
startJSCoverage(params: PageStartJSCoverageParams, progress?: Progress): Promise<PageStartJSCoverageResult>;
@@ -2187,6 +2189,20 @@ export type PageCloseOptions = {
reason?: string,
};
export type PageCloseResult = void;
+export type PageConsoleMessagesParams = {};
+export type PageConsoleMessagesOptions = {};
+export type PageConsoleMessagesResult = {
+ messages: {
+ type: string,
+ text: string,
+ args: JSHandleChannel[],
+ location: {
+ url: string,
+ lineNumber: number,
+ columnNumber: number,
+ },
+ }[],
+};
export type PageEmulateMediaParams = {
media?: 'screen' | 'print' | 'no-override',
colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
@@ -2503,6 +2519,11 @@ export type PageAccessibilitySnapshotOptions = {
export type PageAccessibilitySnapshotResult = {
rootAXNode?: AXNode,
};
+export type PagePageErrorsParams = {};
+export type PagePageErrorsOptions = {};
+export type PagePageErrorsResult = {
+ errors: SerializedError[],
+};
export type PagePdfParams = {
scale?: number,
displayHeaderFooter?: boolean,
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index 8da80c373a..ef04a9d3a8 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -1618,6 +1618,17 @@ Page:
flags:
pausesBeforeAction: true
+ consoleMessages:
+ title: Get console messages
+ group: getter
+ returns:
+ messages:
+ type: array
+ items:
+ type: object
+ properties:
+ $mixin: ConsoleMessage
+
emulateMedia:
title: Emulate media
parameters:
@@ -1953,6 +1964,14 @@ Page:
returns:
rootAXNode: AXNode?
+ pageErrors:
+ title: Get page errors
+ group: getter
+ returns:
+ errors:
+ type: array
+ items: SerializedError
+
pdf:
title: PDF
parameters:
diff --git a/tests/page/page-event-console.spec.ts b/tests/page/page-event-console.spec.ts
index 10cfe1823f..2609a6cc27 100644
--- a/tests/page/page-event-console.spec.ts
+++ b/tests/page/page-event-console.spec.ts
@@ -222,3 +222,20 @@ it('do not update console count on unhandled rejections', async ({ page }) => {
await expect.poll(() => messages).toEqual(['begin', 'end']);
});
+
+it('consoleMessages should work', async ({ page }) => {
+ await page.evaluate(() => {
+ for (let i = 0; i < 301; i++)
+ console.log('message' + i);
+ });
+
+ const messages = await page.consoleMessages();
+ const objects = messages.map(m => ({ text: m.text(), type: m.type(), page: m.page() }));
+
+ const expected = [];
+ for (let i = 201; i < 301; i++)
+ expected.push(expect.objectContaining({ text: 'message' + i, type: 'log', page }));
+
+ expect(objects.length, 'should be at least 100 messages').toBeGreaterThanOrEqual(100);
+ expect(objects.slice(objects.length - expected.length), 'should return last messages').toEqual(expected);
+});
diff --git a/tests/page/page-event-pageerror.spec.ts b/tests/page/page-event-pageerror.spec.ts
index 312ddf0d7f..310f4917f0 100644
--- a/tests/page/page-event-pageerror.spec.ts
+++ b/tests/page/page-event-pageerror.spec.ts
@@ -150,3 +150,21 @@ it('should emit error from unhandled rejects', async ({ page, browserName }) =>
]);
expect(error.message).toContain('sad :(');
});
+
+it('pageErrors should work', async ({ page }) => {
+ await page.evaluate(async () => {
+ for (let i = 0; i < 301; i++)
+ window.builtins.setTimeout(() => { throw new Error('error' + i); }, 0);
+ await new Promise(f => window.builtins.setTimeout(f, 100));
+ });
+
+ const errors = await page.pageErrors();
+ const messages = errors.map(e => e.message);
+
+ const expected = [];
+ for (let i = 201; i < 301; i++)
+ expected.push('error' + i);
+
+ expect(messages.length, 'should be at least 100 errors').toBeGreaterThanOrEqual(100);
+ expect(messages.slice(messages.length - expected.length), 'should return last errors').toEqual(expected);
+});