Chrome DevTools for coding agents
feat: add optional stack traces to list_console_messages (#2505)
Zayan Khan85c73a0abc85
diff --git a/docs/tool-reference.md b/docs/tool-reference.mdindex 7bf9e766..5c5a7398 100644--- a/docs/tool-reference.md+++ b/docs/tool-reference.md@@ -391,6 +391,7 @@**Parameters:**- **includePreservedMessages** (boolean) _(optional)_: Set to true to return the preserved messages over the last 3 navigations.+- **includeStackTraces** (boolean) _(optional)_: Set to true to include the stack trace for each message when available. Increases the response size.- **pageIdx** (integer) _(optional)_: Page number to return (0-based). When omitted, returns the first page.- **pageSize** (integer) _(optional)_: Maximum number of messages to return. When omitted, returns all messages.- **serviceWorkerId** (string) _(optional)_: Filter messages to only return messages of the specified service worker.diff --git a/src/McpResponse.ts b/src/McpResponse.tsindex 27e1c846..c1cea408 100644--- a/src/McpResponse.ts+++ b/src/McpResponse.ts@@ -106,6 +106,7 @@ export class McpResponse implements Response {pagination?: PaginationOptions;types?: string[];includePreservedMessages?: boolean;+ includeStackTraces?: boolean;serviceWorkerId?: string;};#listExtensions?: boolean;@@ -212,6 +213,7 @@ export class McpResponse implements Response {options?: PaginationOptions & {types?: string[];includePreservedMessages?: boolean;+ includeStackTraces?: boolean;serviceWorkerId?: string;},): void {@@ -231,6 +233,7 @@ export class McpResponse implements Response {: undefined,types: options?.types,includePreservedMessages: options?.includePreservedMessages,+ includeStackTraces: options?.includeStackTraces,serviceWorkerId: options?.serviceWorkerId,};}@@ -598,6 +601,7 @@ export class McpResponse implements Response {return await ConsoleFormatter.from(consoleMessage, {id: consoleMessageStableId,fetchDetailedData: false,+ fetchStackTrace: this.#consoleDataOptions?.includeStackTraces,devTools: page ? page.devtoolsUniverse : undefined,});}@@ -1345,6 +1349,15 @@ Call ${handleDialog.name} to handle it before continuing.`);} else {response.push(...paginationData.items.map(item => item.toString()));}+ if (+ structuredContent.consoleMessages.some(+ message => 'stackTrace' in message,+ )+ ) {+ response.push(+ 'Note: stack trace line and column numbers use 1-based indexing',+ );+ }} else {response.push('<no console messages found>');}diff --git a/src/bin/chrome-devtools-cli-options.ts b/src/bin/chrome-devtools-cli-options.tsindex 010421f5..4e01c776 100644--- a/src/bin/chrome-devtools-cli-options.ts+++ b/src/bin/chrome-devtools-cli-options.ts@@ -758,6 +758,14 @@ export const commands: Commands = {required: false,default: false,},+ includeStackTraces: {+ name: 'includeStackTraces',+ type: 'boolean',+ description:+ 'Set to true to include the stack trace for each message when available. Increases the response size.',+ required: false,+ default: false,+ },serviceWorkerId: {name: 'serviceWorkerId',type: 'string',diff --git a/src/formatters/ConsoleFormatter.ts b/src/formatters/ConsoleFormatter.tsindex 5c77c216..a1f2eddc 100644--- a/src/formatters/ConsoleFormatter.ts+++ b/src/formatters/ConsoleFormatter.ts@@ -17,6 +17,8 @@ import type {IssueFormatter} from './IssueFormatter.js';export interface ConsoleFormatterOptions {fetchDetailedData?: boolean;+ // Fetches the stack trace and includes it in the concise output.+ fetchStackTrace?: boolean;id: number;devTools?: TargetUniverse;resolvedArgsForTesting?: unknown[];@@ -35,6 +37,8 @@ interface ConsoleMessageConcise {argsCount: number;id: number;count?: number;+ // pre-formatted stacktrace.+ stackTrace?: string;}interface ConsoleMessageDetailed extends ConsoleMessageConcise {@@ -54,6 +58,7 @@ export class ConsoleFormatter {readonly #stack?: DevTools.DevTools.StackTrace.StackTrace.StackTrace;readonly #cause?: SymbolizedError;+ readonly #includeStackInConcise: boolean;readonly isIgnored: IgnoreCheck;@@ -65,6 +70,7 @@ export class ConsoleFormatter {resolvedArgs?: unknown[];stack?: DevTools.DevTools.StackTrace.StackTrace.StackTrace;cause?: SymbolizedError;+ includeStackInConcise?: boolean;isIgnored: IgnoreCheck;}) {this.#id = params.id;@@ -74,6 +80,7 @@ export class ConsoleFormatter {this.#resolvedArgs = params.resolvedArgs ?? [];this.#stack = params.stack;this.#cause = params.cause;+ this.#includeStackInConcise = params.includeStackInConcise ?? false;this.isIgnored = params.isIgnored;}@@ -110,7 +117,8 @@ export class ConsoleFormatter {devTools: options?.devTools,details: msg.details,targetId: msg.targetId,- includeStackAndCause: options?.fetchDetailedData,+ includeStackAndCause:+ options?.fetchDetailedData || options?.fetchStackTrace,resolvedStackTraceForTesting: options?.resolvedStackTraceForTesting,resolvedCauseForTesting: options?.resolvedCauseForTesting,});@@ -120,6 +128,7 @@ export class ConsoleFormatter {text: error.message,stack: error.stackTrace,cause: error.cause,+ includeStackInConcise: options.fetchStackTrace,isIgnored,});}@@ -154,7 +163,10 @@ export class ConsoleFormatter {let stack: DevTools.DevTools.StackTrace.StackTrace.StackTrace | undefined;if (options.resolvedStackTraceForTesting) {stack = options.resolvedStackTraceForTesting;- } else if (options.fetchDetailedData && options.devTools) {+ } else if (+ (options.fetchDetailedData || options.fetchStackTrace) &&+ options.devTools+ ) {try {stack = await createStackTraceForConsoleMessage(options.devTools, msg);} catch {@@ -169,6 +181,7 @@ export class ConsoleFormatter {argCount: resolvedArgs.length || msg.args().length,resolvedArgs,stack,+ includeStackInConcise: options.fetchStackTrace,isIgnored,});}@@ -196,12 +209,18 @@ export class ConsoleFormatter {}toJSON(): ConsoleMessageConcise {- return {+ const json: ConsoleMessageConcise = {type: this.#type,text: this.#text,argsCount: this.#argCount,id: this.#id,};+ if (this.#includeStackInConcise && this.#stack) {+ json.stackTrace = formatStackTrace(this.#stack, this.#cause, this, {+ includeNote: false,+ });+ }+ return json;}/**@@ -238,6 +257,9 @@ export class ConsoleFormatter {type: message.#type,text: message.#text,argCount: message.#argCount,+ stack: message.#stack,+ cause: message.#cause,+ includeStackInConcise: message.#includeStackInConcise,isIgnored: message.isIgnored,},count,@@ -269,6 +291,9 @@ export class GroupedConsoleFormatter extends ConsoleFormatter {type: string;text: string;argCount: number;+ stack?: DevTools.DevTools.StackTrace.StackTrace.StackTrace;+ cause?: SymbolizedError;+ includeStackInConcise?: boolean;isIgnored: IgnoreCheck;},count: number,@@ -290,7 +315,15 @@ export class GroupedConsoleFormatter extends ConsoleFormatter {function convertConsoleMessageConciseToString(msg: ConsoleMessageConcise) {const countSuffix = msg.count && msg.count > 1 ? ` [${msg.count} times]` : '';- return `msgid=${msg.id} [${msg.type}] ${msg.text} (${msg.argsCount} args)${countSuffix}`;+ const messageLine = `msgid=${msg.id} [${msg.type}] ${msg.text} (${msg.argsCount} args)${countSuffix}`;+ if (!msg.stackTrace) {+ return messageLine;+ }+ const indentedStackTrace = msg.stackTrace+ .split('\n')+ .map(line => ` ${line}`)+ .join('\n');+ return `${messageLine}\n${indentedStackTrace}`;}function convertConsoleMessageConciseDetailedToString(@@ -341,6 +374,7 @@ function formatStackTrace(stackTrace: DevTools.DevTools.StackTrace.StackTrace.StackTrace,cause: SymbolizedError | undefined,formatter: {isIgnored: IgnoreCheck},+ options?: {includeNote?: boolean},): string {const lines = formatStackTraceInner(stackTrace, cause, formatter);const includedLines = lines.slice(0, STACK_TRACE_MAX_LINES);@@ -349,7 +383,9 @@ function formatStackTrace(return [...includedLines,reminderCount > 0 ? `... and ${reminderCount} more frames` : '',- 'Note: line and column numbers use 1-based indexing',+ options?.includeNote === false+ ? ''+ : 'Note: line and column numbers use 1-based indexing',].filter(line => !!line).join('\n');diff --git a/src/telemetry/tool_call_metrics.json b/src/telemetry/tool_call_metrics.jsonindex 194ac0dd..55675e14 100644--- a/src/telemetry/tool_call_metrics.json+++ b/src/telemetry/tool_call_metrics.json@@ -258,6 +258,10 @@{"name": "service_worker_id_length","argType": "number"+ },+ {+ "name": "include_stack_traces",+ "argType": "boolean"}]},diff --git a/src/tools/ToolDefinition.ts b/src/tools/ToolDefinition.tsindex 7689e5a0..52d34d6f 100644--- a/src/tools/ToolDefinition.ts+++ b/src/tools/ToolDefinition.ts@@ -151,6 +151,7 @@ export interface Response {options?: PaginationOptions & {types?: string[];includePreservedMessages?: boolean;+ includeStackTraces?: boolean;serviceWorkerId?: string;},): void;diff --git a/src/tools/console.ts b/src/tools/console.tsindex 8f2be8e0..6be3b9b2 100644--- a/src/tools/console.ts+++ b/src/tools/console.ts@@ -77,6 +77,13 @@ export const listConsoleMessages = definePageTool(cliArgs => {.describe('Set to true to return the preserved messages over the last 3 navigations.',),+ includeStackTraces: zod+ .boolean()+ .default(false)+ .optional()+ .describe(+ 'Set to true to include the stack trace for each message when available. Increases the response size.',+ ),serviceWorkerId: zod.string().optional()@@ -92,6 +99,7 @@ export const listConsoleMessages = definePageTool(cliArgs => {pageIdx: request.params.pageIdx,types: request.params.types,includePreservedMessages: request.params.includePreservedMessages,+ includeStackTraces: request.params.includeStackTraces,serviceWorkerId: request.params.serviceWorkerId,});},diff --git a/tests/formatters/ConsoleFormatter.test.js.snapshot b/tests/formatters/ConsoleFormatter.test.js.snapshotindex 9f449027..b24b7c91 100644--- a/tests/formatters/ConsoleFormatter.test.js.snapshot+++ b/tests/formatters/ConsoleFormatter.test.js.snapshot@@ -1,3 +1,21 @@+exports[`ConsoleFormatter > toString/toJSON > formats a console message with a stack trace when fetchStackTrace is set toJSON 1`] = `+{+ "type": "log",+ "text": "Hello stack trace!",+ "argsCount": 0,+ "id": 1,+ "stackTrace": "at foo (foo.ts:10:2)\\nat bar (foo.ts:20:2)\\n--- setTimeout -------------------------\\nat schedule (util.ts:5:2)"+}+`;++exports[`ConsoleFormatter > toString/toJSON > formats a console message with a stack trace when fetchStackTrace is set toString 1`] = `+msgid=1 [log] Hello stack trace! (0 args)+ at foo (foo.ts:10:2)+ at bar (foo.ts:20:2)+ --- setTimeout -------------------------+ at schedule (util.ts:5:2)+`;+exports[`ConsoleFormatter > toString/toJSON > formats a console.log message toJSON 1`] = `{"type": "log",@@ -50,6 +68,34 @@ exports[`ConsoleFormatter > toString/toJSON > formats an UncaughtError toStringmsgid=1 [error] Uncaught TypeError: Cannot read properties of undefined (0 args)`;+exports[`ConsoleFormatter > toString/toJSON > formats an UncaughtError with a stack trace when fetchStackTrace is set toJSON 1`] = `+{+ "type": "error",+ "text": "Uncaught TypeError: Cannot read properties of undefined",+ "argsCount": 0,+ "id": 2,+ "stackTrace": "at foo (foo.ts:10:2)"+}+`;++exports[`ConsoleFormatter > toString/toJSON > formats an UncaughtError with a stack trace when fetchStackTrace is set toString 1`] = `+msgid=2 [error] Uncaught TypeError: Cannot read properties of undefined (0 args)+ at foo (foo.ts:10:2)+`;++exports[`ConsoleFormatter > toString/toJSON > omits the stack trace when fetchStackTrace is not set toJSON 1`] = `+{+ "type": "log",+ "text": "Hello stack trace!",+ "argsCount": 0,+ "id": 1+}+`;++exports[`ConsoleFormatter > toString/toJSON > omits the stack trace when fetchStackTrace is not set toString 1`] = `+msgid=1 [log] Hello stack trace! (0 args)+`;+exports[`ConsoleFormatter > toStringDetailed/toJSONDetailed > does not show call frames with ignore listed scripts toJSONDetailed 1`] = `{"id": 12,diff --git a/tests/formatters/ConsoleFormatter.test.ts b/tests/formatters/ConsoleFormatter.test.tsindex 2213f429..f018b9bb 100644--- a/tests/formatters/ConsoleFormatter.test.ts+++ b/tests/formatters/ConsoleFormatter.test.ts@@ -125,6 +125,118 @@ describe('ConsoleFormatter', () => {);return await ConsoleFormatter.from(error, {id: 1});});++ formatterTestConcise(+ 'omits the stack trace when fetchStackTrace is not set',+ async () => {+ const message = createMockMessage({+ type: () => 'log',+ text: () => 'Hello stack trace!',+ });+ const stackTrace = {+ syncFragment: {+ frames: [+ {+ line: 10,+ column: 2,+ url: 'foo.ts',+ name: 'foo',+ },+ ],+ },+ asyncFragments: [],+ } as unknown as DevTools.StackTrace.StackTrace.StackTrace;++ return await ConsoleFormatter.from(message, {+ id: 1,+ resolvedStackTraceForTesting: stackTrace,+ });+ },+ );++ formatterTestConcise(+ 'formats a console message with a stack trace when fetchStackTrace is set',+ async () => {+ const message = createMockMessage({+ type: () => 'log',+ text: () => 'Hello stack trace!',+ });+ const stackTrace = {+ syncFragment: {+ frames: [+ {+ line: 10,+ column: 2,+ url: 'foo.ts',+ name: 'foo',+ },+ {+ line: 20,+ column: 2,+ url: 'foo.ts',+ name: 'bar',+ },+ ],+ },+ asyncFragments: [+ {+ description: 'setTimeout',+ frames: [+ {+ line: 5,+ column: 2,+ url: 'util.ts',+ name: 'schedule',+ },+ ],+ },+ ],+ } as unknown as DevTools.StackTrace.StackTrace.StackTrace;++ return await ConsoleFormatter.from(message, {+ id: 1,+ fetchStackTrace: true,+ resolvedStackTraceForTesting: stackTrace,+ });+ },+ );++ formatterTestConcise(+ 'formats an UncaughtError with a stack trace when fetchStackTrace is set',+ async () => {+ const stackTrace = {+ syncFragment: {+ frames: [+ {+ line: 10,+ column: 2,+ url: 'foo.ts',+ name: 'foo',+ },+ ],+ },+ asyncFragments: [],+ } as unknown as DevTools.StackTrace.StackTrace.StackTrace;+ const error = new UncaughtError(+ {+ exceptionId: 1,+ lineNumber: 0,+ columnNumber: 5,+ exception: {+ type: 'object',+ description: 'TypeError: Cannot read properties of undefined',+ },+ text: 'Uncaught',+ },+ '<mock target ID>',+ );+ return await ConsoleFormatter.from(error, {+ id: 2,+ fetchStackTrace: true,+ resolvedStackTraceForTesting: stackTrace,+ });+ },+ );});describe('toStringDetailed/toJSONDetailed', () => {diff --git a/tests/tools/console.test.ts b/tests/tools/console.test.tsindex 0fc9e57e..e22692e4 100644--- a/tests/tools/console.test.ts+++ b/tests/tools/console.test.ts@@ -188,6 +188,59 @@ describe('console', () => {});});+ it('includes stack traces when includeStackTraces is set', async () => {+ await withMcpContext(async (response, context) => {+ const page = context.getSelectedMcpPage();+ await page.pptrPage.setContent(+ '<script>function failingFn() { console.error("This is an error"); } failingFn();</script>',+ );+ await listConsoleMessages().handler(+ {+ params: {includeStackTraces: true},+ page: context.getSelectedMcpPage(),+ },+ response,+ context,+ );+ const formattedResponse = await response.handle(context);+ const textContent = getTextContent(formattedResponse.content[0]);+ assert.ok(textContent.includes('msgid=1 [error] This is an error'));+ assert.match(textContent, /at failingFn/);+ const structuredContent = formattedResponse.structuredContent as {+ consoleMessages: Array<{stackTrace?: string}>;+ };+ assert.match(+ structuredContent.consoleMessages[0].stackTrace ?? '',+ /at failingFn/,+ );+ });+ });++ it('omits stack traces by default', async () => {+ await withMcpContext(async (response, context) => {+ const page = context.getSelectedMcpPage();+ await page.pptrPage.setContent(+ '<script>function failingFn() { console.error("This is an error"); } failingFn();</script>',+ );+ await listConsoleMessages().handler(+ {params: {}, page: context.getSelectedMcpPage()},+ response,+ context,+ );+ const formattedResponse = await response.handle(context);+ const textContent = getTextContent(formattedResponse.content[0]);+ assert.ok(textContent.includes('msgid=1 [error] This is an error'));+ assert.ok(!textContent.includes('at failingFn'));+ const structuredContent = formattedResponse.structuredContent as {+ consoleMessages: Array<{stackTrace?: string}>;+ };+ assert.strictEqual(+ structuredContent.consoleMessages[0].stackTrace,+ undefined,+ );+ });+ });+it('work with primitive unhandled errors', async () => {await withMcpContext(async (response, context) => {const page = context.getSelectedMcpPage();