Chrome DevTools for coding agents
fix: resolve error causes on the session that reported the exception (#3220)
Mankhong Gardenb2d37e851a46
diff --git a/src/collectors/PageCollector.ts b/src/collectors/PageCollector.tsindex c689ee58..bba92a9a 100644--- a/src/collectors/PageCollector.ts+++ b/src/collectors/PageCollector.ts@@ -27,10 +27,16 @@ import {logger} from '../utils/logger.js';export class UncaughtError {readonly details: Protocol.Runtime.ExceptionDetails;readonly targetId: string;+ readonly session?: CDPSession;- constructor(details: Protocol.Runtime.ExceptionDetails, targetId: string) {+ constructor(+ details: Protocol.Runtime.ExceptionDetails,+ targetId: string,+ session?: CDPSession,+ ) {this.details = details;this.targetId = targetId;+ this.session = session;}}@@ -296,7 +302,7 @@ class PageEventSubscriber {#onExceptionThrown = (event: Protocol.Runtime.ExceptionThrownEvent): void => {this.#page.emit('uncaughtError',- new UncaughtError(event.exceptionDetails, this.#targetId),+ new UncaughtError(event.exceptionDetails, this.#targetId, this.#session),);};diff --git a/src/collectors/ServiceWorkerCollector.ts b/src/collectors/ServiceWorkerCollector.tsindex 6bad639b..a2e2a8ae 100644--- a/src/collectors/ServiceWorkerCollector.ts+++ b/src/collectors/ServiceWorkerCollector.ts@@ -61,7 +61,9 @@ export class ServiceWorkerSubscriber {const extensionId = extractExtensionId(url);if (extensionId) {- this.#callback(new UncaughtError(event.exceptionDetails, extensionId));+ this.#callback(+ new UncaughtError(event.exceptionDetails, extensionId, this.#session),+ );}};}diff --git a/src/devtools/DevtoolsUtils.ts b/src/devtools/DevtoolsUtils.tsindex a2128042..53a2a896 100644--- a/src/devtools/DevtoolsUtils.ts+++ b/src/devtools/DevtoolsUtils.ts@@ -255,12 +255,15 @@ export class SymbolizedError {devTools?: TargetUniverse;details: ExceptionDetailsLike;targetId: string;+ // The session that reported `details`. Remote object ids are scoped to+ // the session that issued them, so the cause has to be resolved there.+ session?: CDPSession;includeStackAndCause?: boolean;resolvedStackTraceForTesting?: DevTools.StackTrace.StackTrace.StackTrace;resolvedCauseForTesting?: SymbolizedError;}): Promise<SymbolizedError> {const message = SymbolizedError.#getMessage(opts.details);- if (!opts.includeStackAndCause || !opts.devTools) {+ if (!opts.includeStackAndCause || (!opts.devTools && !opts.session)) {return new SymbolizedError(message,opts.resolvedStackTraceForTesting,@@ -271,7 +274,7 @@ export class SymbolizedError {let stackTrace: DevTools.StackTrace.StackTrace.StackTrace | undefined;if (opts.resolvedStackTraceForTesting) {stackTrace = opts.resolvedStackTraceForTesting;- } else if (opts.details.stackTrace) {+ } else if (opts.devTools && opts.details.stackTrace) {try {stackTrace = await createStackTrace(opts.devTools,@@ -294,12 +297,14 @@ export class SymbolizedError {opts.devTools,opts.details.exception,opts.targetId,+ opts.session,);if (causeRemoteObj) {cause = await SymbolizedError.fromError({devTools: opts.devTools,error: causeRemoteObj,targetId: opts.targetId,+ session: opts.session,});}} catch {@@ -313,17 +318,20 @@ export class SymbolizedError {devTools?: TargetUniverse;error: RemoteObjectLike;targetId: string;+ session?: CDPSession;}): Promise<SymbolizedError> {const details = await SymbolizedError.#getExceptionDetails(opts.devTools,opts.error,opts.targetId,+ opts.session,);if (details) {return await SymbolizedError.fromDetails({details,devTools: opts.devTools,targetId: opts.targetId,+ session: opts.session,includeStackAndCause: true,});}@@ -370,8 +378,24 @@ export class SymbolizedError {devTools: TargetUniverse | undefined,error: RemoteObjectLike,targetId: string,- ): Promise<DevTools.Protocol.Runtime.ExceptionDetails | null> {- if (!devTools || (error.type !== 'object' && error.subtype !== 'error')) {+ session?: CDPSession,+ ): Promise<ExceptionDetailsLike | null> {+ if (error.type !== 'object' && error.subtype !== 'error') {+ return null;+ }++ if (session) {+ if (!error.objectId) {+ return null;+ }+ const {exceptionDetails} = await session.send(+ 'Runtime.getExceptionDetails',+ {errorObjectId: error.objectId},+ );+ return exceptionDetails ?? null;+ }++ if (!devTools) {return null;}@@ -391,8 +415,23 @@ export class SymbolizedError {devTools: TargetUniverse | undefined,error: RemoteObjectLike,targetId: string,- ): Promise<DevTools.Protocol.Runtime.RemoteObject | null> {- if (!devTools || (error.type !== 'object' && error.subtype !== 'error')) {+ session?: CDPSession,+ ): Promise<RemoteObjectLike | null> {+ if (error.type !== 'object' && error.subtype !== 'error') {+ return null;+ }++ if (session) {+ if (!error.objectId) {+ return null;+ }+ const {result} = await session.send('Runtime.getProperties', {+ objectId: error.objectId,+ });+ return result.find(prop => prop.name === 'cause')?.value ?? null;+ }++ if (!devTools) {return null;}diff --git a/src/formatters/ConsoleFormatter.ts b/src/formatters/ConsoleFormatter.tsindex 051536aa..7b5ed301 100644--- a/src/formatters/ConsoleFormatter.ts+++ b/src/formatters/ConsoleFormatter.ts@@ -135,6 +135,7 @@ export class ConsoleFormatter {devTools: options?.devTools,details: msg.details,targetId: msg.targetId,+ session: msg.session,includeStackAndCause:options?.fetchDetailedData || options?.fetchStackTrace,resolvedStackTraceForTesting: options?.resolvedStackTraceForTesting,diff --git a/tests/formatters/ConsoleFormatter.test.ts b/tests/formatters/ConsoleFormatter.test.tsindex 304b94cf..0b9cb943 100644--- a/tests/formatters/ConsoleFormatter.test.ts+++ b/tests/formatters/ConsoleFormatter.test.ts@@ -7,6 +7,8 @@import assert from 'node:assert';import {describe, it} from 'node:test';+import sinon from 'sinon';+import {SymbolizedError} from '../../src/devtools/DevtoolsUtils.js';import {ConsoleFormatter} from '../../src/formatters/ConsoleFormatter.js';import {UncaughtError} from '../../src/collectors/PageCollector.js';@@ -15,6 +17,7 @@ import type {Protocol,DevTools,} from '../../src/third_party/index.js';+import {createMockCDPSession} from '../mocks.js';interface MockConsoleMessage {type: () => string;@@ -850,6 +853,71 @@ describe('ConsoleFormatter', () => {},);});++ it('resolves the cause of an UncaughtError on its session', async t => {+ const session = createMockCDPSession();+ const send: sinon.SinonStub = session.send;+ send.onFirstCall().resolves({+ result: [+ {+ name: 'cause',+ configurable: true,+ enumerable: false,+ value: {+ type: 'object',+ subtype: 'error',+ objectId: 'cause-id',+ description: 'Error: root cause',+ },+ },+ ],+ });+ send.onSecondCall().resolves({+ exceptionDetails: {+ exceptionId: 2,+ lineNumber: 0,+ columnNumber: 0,+ text: 'root cause',+ },+ });+ const error = new UncaughtError(+ {+ exceptionId: 1,+ lineNumber: 0,+ columnNumber: 5,+ exception: {+ type: 'object',+ subtype: 'error',+ objectId: 'error-id',+ description: 'Error: wrapper',+ },+ text: 'Uncaught',+ },+ '<mock target ID>',+ session,+ );++ const formatter = await ConsoleFormatter.from(error, {+ id: 18,+ fetchDetailedData: true,+ resolvedStackTraceForTesting: {+ syncFragment: {+ frames: [{line: 1, column: 1, url: 'main.js', name: 'main'}],+ },+ asyncFragments: [],+ } as unknown as DevTools.StackTrace.StackTrace.StackTrace,+ });++ sinon.assert.calledWithExactly(send.firstCall, 'Runtime.getProperties', {+ objectId: 'error-id',+ });+ sinon.assert.calledWithExactly(+ send.secondCall,+ 'Runtime.getExceptionDetails',+ {errorObjectId: 'cause-id'},+ );+ t.assert.match(formatter.toStringDetailed(), /Caused by: root cause/);+ });});describe('ConsoleFormatter arguments', () => {diff --git a/tests/tools/console.test.ts b/tests/tools/console.test.tsindex ba269442..7caf16df 100644--- a/tests/tools/console.test.ts+++ b/tests/tools/console.test.ts@@ -719,6 +719,37 @@ console.error('inline-line-4');});});+ it('resolves the cause of an uncaught exception thrown after load', async () => {+ server.addHtmlRoute(+ '/index.html',+ `<!DOCTYPE html><script>+ window.addEventListener('load', () => {+ setTimeout(() => {+ window.thrown = true;+ throw new Error('outer', {cause: new Error('inner')});+ }, 100);+ });+ </script>`,+ );++ await withMcpContext(async (response, context, args) => {+ const page = context.getSelectedMcpPage();+ await page.pptrPage.goto(server.getRoute('/index.html'));+ await page.pptrPage.waitForFunction(() => 'thrown' in window);++ await getConsoleMessage(args).handler(+ {params: {msgid: 1}, page: context.getSelectedMcpPage()},+ response,+ context,+ );+ const formattedResponse = await response.handle(context);+ const rawText = getTextContent(formattedResponse.content[0]);++ assert.ok(rawText.includes('Uncaught Error: outer'), rawText);+ assert.ok(rawText.includes('Caused by: Error: inner'), rawText);+ });+ });+it('applies source maps to stack traces of Error object (with cause) console.log arguments', async t => {server.addRoute('/main.min.js', (_req, res) => {res.setHeader('Content-Type', 'text/javascript');