Chrome DevTools for coding agents
feat: Add additional params to get_heapsnapshot_edges (#2561)
Dominik Inführb58c613f4b05
diff --git a/docs/tool-reference.md b/docs/tool-reference.mdindex dda9b162..0662a8e7 100644--- a/docs/tool-reference.md+++ b/docs/tool-reference.md@@ -544,8 +544,11 @@ in the DevTools Elements panel (if any).- **filePath** (string) **(required)**: A path to a .heapsnapshot file to read.- **nodeId** (number) **(required)**: The node ID to get outgoing edges for.+- **excludePrimitives** (boolean) _(optional)_: Whether to exclude primitive target nodes. Default is true.+- **minRetainedSize** (number) _(optional)_: Minimum retained size in bytes for target nodes.- **pageIdx** (number) _(optional)_: The page index for pagination.- **pageSize** (number) _(optional)_: The page size for pagination.+- **sortBy** (enum: "retainedSize", "selfSize", "name") _(optional)_: Sort order for edges. Default is retainedSize.---diff --git a/src/HeapSnapshotManager.ts b/src/HeapSnapshotManager.tsindex ae017ed1..cdf5ac48 100644--- a/src/HeapSnapshotManager.ts+++ b/src/HeapSnapshotManager.ts@@ -43,6 +43,12 @@ export interface HeapSnapshotDetailedClassDiff extends HeapSnapshotClassDiff {export type DuplicateStringGroup =DevTools.HeapSnapshotModel.HeapSnapshotModel.DuplicateStringGroup;+export type HeapQueryOptions =+ DevTools.HeapSnapshotModel.HeapSnapshotModel.HeapQueryOptions;++export type HeapEdgesQueryOptions =+ DevTools.HeapSnapshotModel.HeapSnapshotModel.HeapEdgesQueryOptions;+export class HeapSnapshotManager {#snapshotIdGenerator = createIdGenerator();#snapshots = new Map<@@ -241,13 +247,14 @@ export class HeapSnapshotManager {async getEdges(filePath: string,nodeId: number,+ options?: HeapEdgesQueryOptions,): Promise<DevTools.HeapSnapshotModel.HeapSnapshotModel.ItemsRange> {const snapshot = await this.getSnapshot(filePath);const nodeIndex = await snapshot.nodeIndexForId(nodeId);if (nodeIndex === undefined) {throw new Error(`Node with ID ${nodeId} not found`);}- const provider = snapshot.createEdgesProvider(nodeIndex);+ const provider = snapshot.createEdgesProvider(nodeIndex, options);return await provider.serializeItemsRange(0, Infinity);}diff --git a/src/McpContext.ts b/src/McpContext.tsindex fd978f6b..13fd8b2d 100644--- a/src/McpContext.ts+++ b/src/McpContext.ts@@ -16,6 +16,7 @@ import type {HeapSnapshotClassDiff,HeapSnapshotDetailedClassDiff,DuplicateStringGroup,+ HeapEdgesQueryOptions,} from './HeapSnapshotManager.js';import {McpPage} from './McpPage.js';import {type UncaughtError} from './PageCollector.js';@@ -869,8 +870,9 @@ export class McpContext implements Context {async getHeapSnapshotEdges(filePath: string,nodeId: number,+ options?: HeapEdgesQueryOptions,): Promise<DevTools.HeapSnapshotModel.HeapSnapshotModel.ItemsRange> {- return await this.#heapSnapshotManager.getEdges(filePath, nodeId);+ return await this.#heapSnapshotManager.getEdges(filePath, nodeId, options);}async getHeapSnapshotClassDiffs(diff --git a/src/bin/chrome-devtools-cli-options.ts b/src/bin/chrome-devtools-cli-options.tsindex c750aef2..b98a6abe 100644--- a/src/bin/chrome-devtools-cli-options.ts+++ b/src/bin/chrome-devtools-cli-options.ts@@ -500,6 +500,26 @@ export const commands: Commands = {description: 'The node ID to get outgoing edges for.',required: true,},+ sortBy: {+ name: 'sortBy',+ type: 'string',+ description: 'Sort order for edges. Default is retainedSize.',+ required: false,+ enum: ['retainedSize', 'selfSize', 'name'],+ },+ minRetainedSize: {+ name: 'minRetainedSize',+ type: 'number',+ description: 'Minimum retained size in bytes for target nodes.',+ required: false,+ },+ excludePrimitives: {+ name: 'excludePrimitives',+ type: 'boolean',+ description:+ 'Whether to exclude primitive target nodes. Default is true.',+ required: false,+ },pageIdx: {name: 'pageIdx',type: 'number',diff --git a/src/telemetry/tool_call_metrics.json b/src/telemetry/tool_call_metrics.jsonindex b5305f35..3fe3bb49 100644--- a/src/telemetry/tool_call_metrics.json+++ b/src/telemetry/tool_call_metrics.json@@ -824,6 +824,18 @@{"name": "page_size","argType": "number"+ },+ {+ "name": "sort_by",+ "argType": "string"+ },+ {+ "name": "min_retained_size",+ "argType": "number"+ },+ {+ "name": "exclude_primitives",+ "argType": "boolean"}]},diff --git a/src/tools/ToolDefinition.ts b/src/tools/ToolDefinition.tsindex 31a403ce..64b0861a 100644--- a/src/tools/ToolDefinition.ts+++ b/src/tools/ToolDefinition.ts@@ -10,6 +10,7 @@ import type {HeapSnapshotClassDiff,HeapSnapshotDetailedClassDiff,DuplicateStringGroup,+ HeapEdgesQueryOptions,} from '../HeapSnapshotManager.js';import type {McpPage} from '../McpPage.js';import {zod} from '../third_party/index.js';@@ -290,6 +291,7 @@ export type Context = Readonly<{getHeapSnapshotEdges(filePath: string,nodeId: number,+ options?: HeapEdgesQueryOptions,): Promise<DevTools.HeapSnapshotModel.HeapSnapshotModel.ItemsRange>;getHeapSnapshotClassDiffs(baseFilePath: string,diff --git a/src/tools/memory.ts b/src/tools/memory.tsindex 7b9a1a9b..855ab7af 100644--- a/src/tools/memory.ts+++ b/src/tools/memory.ts@@ -276,6 +276,18 @@ export const getHeapSnapshotEdges = defineTool({schema: {filePath: zod.string().describe('A path to a .heapsnapshot file to read.'),nodeId: zod.number().describe('The node ID to get outgoing edges for.'),+ sortBy: zod+ .enum(['retainedSize', 'selfSize', 'name'])+ .optional()+ .describe('Sort order for edges. Default is retainedSize.'),+ minRetainedSize: zod+ .number()+ .optional()+ .describe('Minimum retained size in bytes for target nodes.'),+ excludePrimitives: zod+ .boolean()+ .optional()+ .describe('Whether to exclude primitive target nodes. Default is true.'),pageIdx: zod.number().optional().describe('The page index for pagination.'),pageSize: zod.number().optional().describe('The page size for pagination.'),},@@ -283,6 +295,11 @@ export const getHeapSnapshotEdges = defineTool({const edges = await context.getHeapSnapshotEdges(request.params.filePath,request.params.nodeId,+ {+ sortBy: request.params.sortBy ?? 'retainedSize',+ minRetainedSize: request.params.minRetainedSize,+ excludePrimitives: request.params.excludePrimitives ?? true,+ },);response.setHeapSnapshotNodes(edges, {diff --git a/tests/tools/memory.test.js.snapshot b/tests/tools/memory.test.js.snapshotindex 8f517fbc..2b496bd8 100644--- a/tests/tools/memory.test.js.snapshot+++ b/tests/tools/memory.test.js.snapshot@@ -296,8 +296,8 @@ value,count,totalSelfSize,totalRetainedSize,truncated,nodeIdsexports[`memory > get_heapsnapshot_edges > with pagination 1`] = `## Heap Snapshot Dataname,type,nodeId,nodeName,selfSize,retainedSize+map,internal,25577,system / Map,0.0 kB,0.7 kBconstructor,property,25575,String,0.1 kB,0.4 kB-anchor,property,29295,anchor,0.0 kB,0.0 kBShowing 1-2 of 56 (Page 1 of 28).Next page: 1`;@@ -305,7 +305,10 @@ Next page: 1exports[`memory > get_heapsnapshot_edges > with valid nodeId 1`] = `## Heap Snapshot Dataname,type,nodeId,nodeName,selfSize,retainedSize+map,internal,25577,system / Map,0.0 kB,0.7 kBconstructor,property,25575,String,0.1 kB,0.4 kB+__proto__,property,25329,{constructor, __defineGetter__, __defineSetter__, …, get __proto__, set __proto__, toLocaleString},0.1 kB,0.3 kB+<symbol Symbol.iterator>,property,29391,[Symbol.iterator],0.0 kB,0.0 kBanchor,property,29295,anchor,0.0 kB,0.0 kBat,property,29297,at,0.0 kB,0.0 kBbig,property,29299,big,0.0 kB,0.0 kB@@ -316,9 +319,9 @@ charCodeAt,property,29307,charCodeAt,0.0 kB,0.0 kBcodePointAt,property,29309,codePointAt,0.0 kB,0.0 kBconcat,property,29311,concat,0.0 kB,0.0 kBendsWith,property,29313,endsWith,0.0 kB,0.0 kB+fixed,property,29319,fixed,0.0 kB,0.0 kBfontcolor,property,29315,fontcolor,0.0 kB,0.0 kBfontsize,property,29317,fontsize,0.0 kB,0.0 kB-fixed,property,29319,fixed,0.0 kB,0.0 kBincludes,property,29321,includes,0.0 kB,0.0 kBindexOf,property,29323,indexOf,0.0 kB,0.0 kBisWellFormed,property,29325,isWellFormed,0.0 kB,0.0 kB@@ -338,28 +341,25 @@ search,property,29351,search,0.0 kB,0.0 kBslice,property,29353,slice,0.0 kB,0.0 kBsmall,property,29355,small,0.0 kB,0.0 kBsplit,property,29357,split,0.0 kB,0.0 kB+startsWith,property,29369,startsWith,0.0 kB,0.0 kBstrike,property,29359,strike,0.0 kB,0.0 kBsub,property,29361,sub,0.0 kB,0.0 kBsubstr,property,29363,substr,0.0 kB,0.0 kBsubstring,property,29365,substring,0.0 kB,0.0 kBsup,property,29367,sup,0.0 kB,0.0 kB-startsWith,property,29369,startsWith,0.0 kB,0.0 kB+toLocaleLowerCase,property,29381,toLocaleLowerCase,0.0 kB,0.0 kB+toLocaleUpperCase,property,29383,toLocaleUpperCase,0.0 kB,0.0 kB+toLowerCase,property,29385,toLowerCase,0.0 kB,0.0 kBtoString,property,29371,toString,0.0 kB,0.0 kB+toUpperCase,property,29387,toUpperCase,0.0 kB,0.0 kBtoWellFormed,property,29373,toWellFormed,0.0 kB,0.0 kBtrim,property,29375,trim,0.0 kB,0.0 kB-trimStart,property,29377,trimStart,0.0 kB,0.0 kB-trimLeft,property,29377,trimStart,0.0 kB,0.0 kBtrimEnd,property,29379,trimEnd,0.0 kB,0.0 kB+trimLeft,property,29377,trimStart,0.0 kB,0.0 kBtrimRight,property,29379,trimEnd,0.0 kB,0.0 kB-toLocaleLowerCase,property,29381,toLocaleLowerCase,0.0 kB,0.0 kB-toLocaleUpperCase,property,29383,toLocaleUpperCase,0.0 kB,0.0 kB-toLowerCase,property,29385,toLowerCase,0.0 kB,0.0 kB-toUpperCase,property,29387,toUpperCase,0.0 kB,0.0 kB+trimStart,property,29377,trimStart,0.0 kB,0.0 kBvalueOf,property,29389,valueOf,0.0 kB,0.0 kB-<symbol Symbol.iterator>,property,29391,[Symbol.iterator],0.0 kB,0.0 kB-__proto__,property,25329,{constructor, __defineGetter__, __defineSetter__, …, get __proto__, set __proto__, toLocaleString},0.1 kB,0.3 kBproperties,internal,29393,system / PropertyArray,0.0 kB,0.0 kB-map,internal,25577,system / Map,0.0 kB,0.7 kB1,hidden,71,,0.0 kB,0.0 kBShowing 1-56 of 56 (Page 1 of 1).`;