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: Add `location()` to `WebError` (#39767)
Chris6949e055c650
diff --git a/docs/src/api/class-weberror.md b/docs/src/api/class-weberror.mdindex 36a1bf7653..3c2b3351af 100644--- a/docs/src/api/class-weberror.md+++ b/docs/src/api/class-weberror.md@@ -65,3 +65,18 @@ Unhandled error that was thrown.- returns: <[string]>Unhandled error that was thrown.++## method: WebError.location+* since: v1.60+* langs: js, python+- returns: <[Object]>+ - `url` <[string]> URL of the resource.+ - `line` <[int]> 0-based line number in the resource.+ - `column` <[int]> 0-based column number in the resource.++## method: WebError.location+* since: v1.60+* langs: csharp, java+- returns: <[string]>++URL of the resource followed by 0-based line and column numbers in the resource formatted as `URL:line:column`.diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.tsindex 452fbe353a..6f688c7191 100644--- a/packages/playwright-client/types/types.d.ts+++ b/packages/playwright-client/types/types.d.ts@@ -21982,6 +21982,23 @@ export interface WebError {*/error(): Error;+ location(): {+ /**+ * URL of the resource.+ */+ url: string;++ /**+ * 0-based line number in the resource.+ */+ line: number;++ /**+ * 0-based column number in the resource.+ */+ column: number;+ };+/*** The page that produced this unhandled exception, if any.*/diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.tsindex 4d593e83dd..fa903eea9e 100644--- a/packages/playwright-core/src/client/browserContext.ts+++ b/packages/playwright-core/src/client/browserContext.ts@@ -125,10 +125,10 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>}this.emit(Events.BrowserContext.Console, consoleMessage);});- this._channel.on('pageError', ({ error, page }) => {+ this._channel.on('pageError', ({ error, page, location }) => {const pageObject = Page.from(page);const parsedError = parseError(error);- this.emit(Events.BrowserContext.WebError, new WebError(pageObject, parsedError));+ this.emit(Events.BrowserContext.WebError, new WebError(pageObject, parsedError, location));if (pageObject)pageObject.emit(Events.Page.PageError, parsedError);});diff --git a/packages/playwright-core/src/client/webError.ts b/packages/playwright-core/src/client/webError.tsindex 3993113796..413317633b 100644--- a/packages/playwright-core/src/client/webError.ts+++ b/packages/playwright-core/src/client/webError.ts@@ -16,14 +16,19 @@import type { Page } from './page';import type * as api from '../../types/types';+import type * as channels from '@protocol/channels';++type WebErrorLocation = channels.BrowserContextPageErrorEvent['location'];export class WebError implements api.WebError {private _page: Page | null;private _error: Error;+ private _location: WebErrorLocation;- constructor(page: Page | null, error: Error) {+ constructor(page: Page | null, error: Error, location: WebErrorLocation) {this._page = page;this._error = error;+ this._location = location;}page() {@@ -33,4 +38,8 @@ export class WebError implements api.WebError {error() {return this._error;}++ location() {+ return this._location;+ }}diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex 7826167045..c44a77298c 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -962,6 +962,11 @@ scheme.BrowserContextPageEvent = tObject({scheme.BrowserContextPageErrorEvent = tObject({error: tType('SerializedError'),page: tChannel(['Page']),+ location: tObject({+ url: tString,+ line: tInt,+ column: tInt,+ }),});scheme.BrowserContextRouteEvent = tObject({route: tChannel(['Route']),diff --git a/packages/playwright-core/src/server/bidi/bidiPage.ts b/packages/playwright-core/src/server/bidi/bidiPage.tsindex 3d1a747005..0b4b10558e 100644--- a/packages/playwright-core/src/server/bidi/bidiPage.ts+++ b/packages/playwright-core/src/server/bidi/bidiPage.ts@@ -281,7 +281,9 @@ 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.addPageError(error);+ const callFrame = params.stackTrace?.callFrames[0];+ const location = callFrame ?? { url: '', lineNumber: 1, columnNumber: 1 };+ this._page.addPageError(error, location);return;}if (params.type !== 'console')diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.tsindex b9a2ec2cd7..ac66c000d4 100644--- a/packages/playwright-core/src/server/browserContext.ts+++ b/packages/playwright-core/src/server/browserContext.ts@@ -38,6 +38,7 @@ import type { Browser, BrowserOptions } from './browser';import type { ConsoleMessage } from './console';import type { Download } from './download';import type * as frames from './frames';+import type { PageError } from './page';import type { Progress } from './progress';import type { ClientCertificatesProxy } from './socksClientCertificatesInterceptor';import type { SerializedStorage } from '@injected/storageScript';@@ -68,7 +69,7 @@ export type BrowserContextEventMap = {[BrowserContextEvent.Console]: [message: ConsoleMessage];[BrowserContextEvent.Close]: [];[BrowserContextEvent.Page]: [page: Page];- [BrowserContextEvent.PageError]: [error: Error, page: Page];+ [BrowserContextEvent.PageError]: [pageError: PageError, page: Page];[BrowserContextEvent.Request]: [request: network.Request];[BrowserContextEvent.Response]: [response: network.Response];[BrowserContextEvent.RequestFailed]: [request: network.Request];diff --git a/packages/playwright-core/src/server/chromium/chromium.ts b/packages/playwright-core/src/server/chromium/chromium.tsindex a64d074a26..27841eea9c 100644--- a/packages/playwright-core/src/server/chromium/chromium.ts+++ b/packages/playwright-core/src/server/chromium/chromium.ts@@ -42,7 +42,7 @@ import { Browser } from '../browser';import { Worker } from '../page';import { CRExecutionContext, createHandle } from './crExecutionContext';import { ConsoleMessage } from '../console';-import { toConsoleMessageLocation } from './crProtocolHelper';+import { stackTraceToLocation } from './crProtocolHelper';import type { HTTPRequestParams } from '@utils/network';import type { BrowserOptions, BrowserProcess } from '../browser';@@ -180,7 +180,7 @@ export class Chromium extends BrowserType {if (!worker.existingExecutionContext)return;const args = event.args.map(o => createHandle(worker.existingExecutionContext!, o));- const message = new ConsoleMessage(null, worker, event.type, undefined, args, toConsoleMessageLocation(event.stackTrace), event.timestamp);+ const message = new ConsoleMessage(null, worker, event.type, undefined, args, stackTraceToLocation(event.stackTrace), event.timestamp);worker.emit(Worker.Events.Console, message);});connection.on(ConnectionEvents.Disconnected, () => worker.didClose());diff --git a/packages/playwright-core/src/server/chromium/crPage.ts b/packages/playwright-core/src/server/chromium/crPage.tsindex 3693957aa5..907f4a4790 100644--- a/packages/playwright-core/src/server/chromium/crPage.ts+++ b/packages/playwright-core/src/server/chromium/crPage.ts@@ -31,7 +31,7 @@ import { createHandle, CRExecutionContext } from './crExecutionContext';import { RawKeyboardImpl, RawMouseImpl, RawTouchscreenImpl } from './crInput';import { CRNetworkManager } from './crNetworkManager';import { CRPDF } from './crPdf';-import { exceptionToError, releaseObject, toConsoleMessageLocation } from './crProtocolHelper';+import { exceptionToError, releaseObject, stackTraceToLocation } from './crProtocolHelper';import { platformToFontFamilies } from './defaultFontFamilies';import { TargetClosedError } from '../errors';import { isSessionClosedError } from '../protocolError';@@ -749,9 +749,9 @@ class FrameSession {session.on('Target.detachedFromTarget', event => this._onDetachedFromTarget(event));session.on('Runtime.consoleAPICalled', event => {const args = event.args.map(o => createHandle(worker.existingExecutionContext!, o));- this._page.addConsoleMessage(worker, event.type, args, toConsoleMessageLocation(event.stackTrace), undefined, event.timestamp);+ this._page.addConsoleMessage(worker, event.type, args, stackTraceToLocation(event.stackTrace), undefined, event.timestamp);});- session.on('Runtime.exceptionThrown', exception => this._page.addPageError(exceptionToError(exception.exceptionDetails)));+ session.on('Runtime.exceptionThrown', exception => this._page.addPageError(exceptionToError(exception.exceptionDetails), stackTraceToLocation(exception.exceptionDetails.stackTrace)));}_onDetachedFromTarget(event: Protocol.Target.detachedFromTargetPayload) {@@ -812,7 +812,7 @@ class FrameSession {if (!context)return;const values = event.args.map(arg => createHandle(context, arg));- this._page.addConsoleMessage(null, event.type, values, toConsoleMessageLocation(event.stackTrace), undefined, event.timestamp);+ this._page.addConsoleMessage(null, event.type, values, stackTraceToLocation(event.stackTrace), undefined, event.timestamp);}async _onBindingCalled(event: Protocol.Runtime.bindingCalledPayload) {@@ -841,7 +841,7 @@ class FrameSession {}_handleException(exceptionDetails: Protocol.Runtime.ExceptionDetails) {- this._page.addPageError(exceptionToError(exceptionDetails));+ this._page.addPageError(exceptionToError(exceptionDetails), stackTraceToLocation(exceptionDetails.stackTrace));}async _onTargetCrashed() {diff --git a/packages/playwright-core/src/server/chromium/crProtocolHelper.ts b/packages/playwright-core/src/server/chromium/crProtocolHelper.tsindex 71af3758c2..cd45d5d13e 100644--- a/packages/playwright-core/src/server/chromium/crProtocolHelper.ts+++ b/packages/playwright-core/src/server/chromium/crProtocolHelper.ts@@ -70,7 +70,7 @@ export async function readProtocolStream(client: CRSession, handle: string): Proreturn Buffer.concat(chunks);}-export function toConsoleMessageLocation(stackTrace: Protocol.Runtime.StackTrace | undefined): types.ConsoleMessageLocation {+export function stackTraceToLocation(stackTrace: Protocol.Runtime.StackTrace | undefined): types.ConsoleMessageLocation {return stackTrace && stackTrace.callFrames.length ? {url: stackTrace.callFrames[0].url,lineNumber: stackTrace.callFrames[0].lineNumber,diff --git a/packages/playwright-core/src/server/chromium/crServiceWorker.ts b/packages/playwright-core/src/server/chromium/crServiceWorker.tsindex 37c4357f1b..da83759bca 100644--- a/packages/playwright-core/src/server/chromium/crServiceWorker.ts+++ b/packages/playwright-core/src/server/chromium/crServiceWorker.ts@@ -19,7 +19,7 @@ import { CRNetworkManager } from './crNetworkManager';import { BrowserContext } from '../browserContext';import * as network from '../network';import { ConsoleMessage } from '../console';-import { toConsoleMessageLocation } from './crProtocolHelper';+import { stackTraceToLocation } from './crProtocolHelper';import type { CRBrowserContext } from './crBrowser';import type { CRSession } from './crConnection';@@ -60,7 +60,7 @@ export class CRServiceWorker extends Worker {if (!this.existingExecutionContext || process.env.PLAYWRIGHT_DISABLE_SERVICE_WORKER_CONSOLE)return;const args = event.args.map(o => createHandle(this.existingExecutionContext!, o));- const message = new ConsoleMessage(null, this, event.type, undefined, args, toConsoleMessageLocation(event.stackTrace), event.timestamp);+ const message = new ConsoleMessage(null, this, event.type, undefined, args, stackTraceToLocation(event.stackTrace), event.timestamp);this.browserContext.emit(BrowserContext.Events.Console, message);});diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.tsindex 69453cfacc..1770310e05 100644--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts@@ -42,7 +42,7 @@ import { disposeAll } from '../disposable';import type { ConsoleMessage } from '../console';import type { Dialog } from '../dialog';import type { Request, Response, RouteHandler } from '../network';-import type { InitScript, Page } from '../page';+import type { InitScript, Page, PageError } from '../page';import type { Disposable } from '../disposable';import type { DispatcherScope } from './dispatcher';import type * as channels from '@protocol/channels';@@ -109,8 +109,16 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channelthis._dispatchEvent('close');this._dispose();});- this.addObjectListener(BrowserContext.Events.PageError, (error: Error, page: Page) => {- this._dispatchEvent('pageError', { error: serializeError(error), page: PageDispatcher.from(this, page) });+ this.addObjectListener(BrowserContext.Events.PageError, (pageError: PageError, page: Page) => {+ this._dispatchEvent('pageError', {+ error: serializeError(pageError.error),+ page: PageDispatcher.from(this, page),+ location: {+ url: pageError.location.url,+ line: pageError.location.lineNumber,+ column: pageError.location.columnNumber,+ },+ });});this.addObjectListener(BrowserContext.Events.Console, (message: ConsoleMessage) => {const pageDispatcher = PageDispatcher.fromNullable(this, message.page());diff --git a/packages/playwright-core/src/server/firefox/ffPage.ts b/packages/playwright-core/src/server/firefox/ffPage.tsindex 038c90c9a5..661e612269 100644--- a/packages/playwright-core/src/server/firefox/ffPage.ts+++ b/packages/playwright-core/src/server/firefox/ffPage.ts@@ -222,7 +222,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.addPageError(error);+ this._page.addPageError(error, params.location);}_onConsole(payload: Protocol.Runtime.consolePayload) {diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.tsindex 281ad0a6a1..2c604e778f 100644--- a/packages/playwright-core/src/server/page.ts+++ b/packages/playwright-core/src/server/page.ts@@ -157,6 +157,11 @@ export type PageEventMap = {const navigationMarkSymbol = Symbol('navigationMark');+export type PageError = {+ error: Error,+ location: types.ConsoleMessageLocation,+};+export class Page extends SdkObject<PageEventMap> {static Events = PageEvent;@@ -165,7 +170,7 @@ export class Page extends SdkObject<PageEventMap> {private _initialized: Page | Error | undefined;private _initializedPromise = new ManualPromise<Page | Error>();private _consoleMessages: ConsoleMessage[] = [];- private _pageErrors: Error[] = [];+ private _pageErrors: PageError[] = [];private _crashed = false;readonly openScope = new LongStandingScope();readonly browserContext: BrowserContext;@@ -422,7 +427,8 @@ export class Page extends SdkObject<PageEventMap> {return marked === -1 ? this._consoleMessages : this._consoleMessages.slice(marked + 1);}- addPageError(pageError: Error) {+ addPageError(error: Error, location: types.ConsoleMessageLocation) {+ const pageError: PageError = { error, location };this._pageErrors.push(pageError);ensureArrayLimit(this._pageErrors, 200); // Avoid unbounded memory growth.@@ -439,9 +445,9 @@ export class Page extends SdkObject<PageEventMap> {pageErrors(filter?: 'all' | 'since-navigation') {if (filter === 'all')- return this._pageErrors;+ return this._pageErrors.map(e => e.error);const marked = this._pageErrors.findLastIndex(e => (e as any)[navigationMarkSymbol]);- return marked === -1 ? this._pageErrors : this._pageErrors.slice(marked + 1);+ return (marked === -1 ? this._pageErrors : this._pageErrors.slice(marked + 1)).map(e => e.error);}async reload(progress: Progress, options: types.NavigateOptions): Promise<network.Response | null> {diff --git a/packages/playwright-core/src/server/trace/recorder/tracing.ts b/packages/playwright-core/src/server/trace/recorder/tracing.tsindex aa8b4b8b9d..80addbab78 100644--- a/packages/playwright-core/src/server/trace/recorder/tracing.ts+++ b/packages/playwright-core/src/server/trace/recorder/tracing.ts@@ -47,6 +47,7 @@ import type { Download } from '../../download';import type { APIRequestContext } from '../../fetch';import type { HarTracerDelegate } from '../../har/harTracer';import type { CallMetadata, InstrumentationListener } from '../../instrumentation';+import type { PageError } from '../../page';import type { RecordHarOptions, StackFrame, TracingTracingStopChunkParams } from '@protocol/channels';import type * as har from '@trace/har';import type { FrameSnapshot } from '@trace/snapshot';@@ -632,13 +633,20 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snapsthis._started = false;}- private _onPageError(error: Error, page: Page) {+ private _onPageError(pageError: PageError, page: Page) {const event: trace.EventTraceEvent = {type: 'event',time: monotonicTime(),class: 'BrowserContext',method: 'pageError',- params: { error: serializeError(error) },+ params: {+ error: serializeError(pageError.error),+ location: {+ url: pageError.location.url,+ line: pageError.location.lineNumber,+ column: pageError.location.columnNumber,+ },+ },pageId: page.guid,};this._appendTraceEvent(event);diff --git a/packages/playwright-core/src/server/webkit/wkPage.ts b/packages/playwright-core/src/server/webkit/wkPage.tsindex 03c345b351..731c02989b 100644--- a/packages/playwright-core/src/server/webkit/wkPage.ts+++ b/packages/playwright-core/src/server/webkit/wkPage.ts@@ -549,7 +549,11 @@ export class WKPage implements PageDelegate {error.stack = stack;error.name = name;- this._page.addPageError(error);+ this._page.addPageError(error, {+ url: url || '',+ lineNumber: (lineNumber || 1) - 1,+ columnNumber: (columnNumber || 1) - 1,+ });return;}diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.tsindex 452fbe353a..6f688c7191 100644--- a/packages/playwright-core/types/types.d.ts+++ b/packages/playwright-core/types/types.d.ts@@ -21982,6 +21982,23 @@ export interface WebError {*/error(): Error;+ location(): {+ /**+ * URL of the resource.+ */+ url: string;++ /**+ * 0-based line number in the resource.+ */+ line: number;++ /**+ * 0-based column number in the resource.+ */+ column: number;+ };+/*** The page that produced this unhandled exception, if any.*/diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex f44c9f9517..3d7bcdf94f 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -1718,6 +1718,11 @@ export type BrowserContextPageEvent = {export type BrowserContextPageErrorEvent = {error: SerializedError,page: PageChannel,+ location: {+ url: string,+ line: number,+ column: number,+ },};export type BrowserContextRouteEvent = {route: RouteChannel,diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex 04384e56b6..fbb20b6100 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -1536,6 +1536,12 @@ BrowserContext:parameters:error: SerializedErrorpage: Page+ location:+ type: object+ properties:+ url: string+ line: int+ column: introute:parameters:diff --git a/tests/library/browsercontext-events.spec.ts b/tests/library/browsercontext-events.spec.tsindex 84aef8f923..9afc08def2 100644--- a/tests/library/browsercontext-events.spec.ts+++ b/tests/library/browsercontext-events.spec.ts@@ -182,6 +182,33 @@ test('weberror event should work', async ({ page }) => {expect(webError.error().stack).toContain('boom');});+test('weberror event should include location', async ({ page, server }) => {+ server.setRoute('/error.js', (req, res) => {+ res.setHeader('content-type', 'application/javascript');+ res.end(`+ function foo() {+ throw new Error('boom');+ }+ foo();+ `);+ });++ server.setRoute('/error.html', (req, res) => {+ res.setHeader('content-type', 'text/html');+ res.end('<script src="/error.js"></script>');+ });++ const [webError] = await Promise.all([+ page.context().waitForEvent('weberror'),+ page.goto(server.PREFIX + '/error.html'),+ ]);++ const location = webError.location();+ expect(location.url).toBe(`${server.PREFIX}/error.js`);+ expect(location.line).toBe(2);+ expect(location.column).toBeGreaterThan(0); // column is not consistent across browsers+});+test('pageload event should work @smoke', async ({ page, server }) => {const [eventPage] = await Promise.all([page.context().waitForEvent('pageload'),