Skip to content

Chrome DevTools for coding agents

chore(memory): expose retainer logic (#2056)

Nikolay Vitkovb2b05a06702b
diff --git a/README.md b/README.md
index 68c5ef56..930d74d8 100644
--- a/README.md
+++ b/README.md
@@ -514,9 +514,10 @@ If you run into any issues, checkout our [troubleshooting guide](./docs/troubles
- [`take_snapshot`](docs/tool-reference.md#take_snapshot)
- [`screencast_start`](docs/tool-reference.md#screencast_start)
- [`screencast_stop`](docs/tool-reference.md#screencast_stop)
-- **Memory** (4 tools)
+- **Memory** (5 tools)
- [`take_memory_snapshot`](docs/tool-reference.md#take_memory_snapshot)
- [`get_memory_snapshot_details`](docs/tool-reference.md#get_memory_snapshot_details)
+ - [`get_node_retainers`](docs/tool-reference.md#get_node_retainers)
- [`get_nodes_by_class`](docs/tool-reference.md#get_nodes_by_class)
- [`load_memory_snapshot`](docs/tool-reference.md#load_memory_snapshot)
- **Extensions** (5 tools)
diff --git a/docs/tool-reference.md b/docs/tool-reference.md
index 238d5981..578fae1a 100644
--- a/docs/tool-reference.md
+++ b/docs/tool-reference.md
@@ -39,9 +39,10 @@
- [`take_snapshot`](#take_snapshot)
- [`screencast_start`](#screencast_start)
- [`screencast_stop`](#screencast_stop)
-- **[Memory](#memory)** (4 tools)
+- **[Memory](#memory)** (5 tools)
- [`take_memory_snapshot`](#take_memory_snapshot)
- [`get_memory_snapshot_details`](#get_memory_snapshot_details)
+ - [`get_node_retainers`](#get_node_retainers)
- [`get_nodes_by_class`](#get_nodes_by_class)
- [`load_memory_snapshot`](#load_memory_snapshot)
- **[Extensions](#extensions)** (5 tools)
@@ -464,6 +465,19 @@ in the DevTools Elements panel (if any).
---
+### `get_node_retainers`
+
+**Description:** Loads a memory heapsnapshot and returns retainers for a specific node ID. (requires flag: --experimentalMemory=true)
+
+**Parameters:**
+
+- **filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
+- **nodeId** (number) **(required)**: The stable node ID to get retainers for.
+- **pageIdx** (number) _(optional)_: The page index for pagination.
+- **pageSize** (number) _(optional)_: The page size for pagination.
+
+---
+
### `get_nodes_by_class`
**Description:** Loads a memory heapsnapshot and returns instances of a specific class with their stable IDs. (requires flag: --experimentalMemory=true)
diff --git a/src/HeapSnapshotManager.ts b/src/HeapSnapshotManager.ts
index 81d875e3..ff28d71c 100644
--- a/src/HeapSnapshotManager.ts
+++ b/src/HeapSnapshotManager.ts
@@ -7,6 +7,7 @@
import fsSync from 'node:fs';
import path from 'node:path';
+import {isNodeLike} from './formatters/HeapSnapshotFormatter.js';
import {DevTools} from './third_party/index.js';
import {
createIdGenerator,
@@ -112,8 +113,41 @@ export class HeapSnapshotManager {
}
const provider = snapshot.createNodesProviderForClass(className, filter);
- const range = await provider.serializeItemsRange(0, 1);
- return await provider.serializeItemsRange(0, range.totalLength);
+ return await provider.serializeItemsRange(0, Infinity);
+ }
+
+ async findNodeIndexById(
+ filePath: string,
+ nodeId: number,
+ ): Promise<number | undefined> {
+ const snapshot = await this.getSnapshot(filePath);
+ const aggregates = await this.getAggregates(filePath);
+ const filter =
+ new DevTools.HeapSnapshotModel.HeapSnapshotModel.NodeFilter();
+
+ for (const classKey of Object.keys(aggregates)) {
+ const provider = snapshot.createNodesProviderForClass(classKey, filter);
+ const range = await provider.serializeItemsRange(0, Infinity);
+ for (const item of range.items) {
+ if (isNodeLike(item) && item.id === nodeId) {
+ return item.nodeIndex;
+ }
+ }
+ }
+ return undefined;
+ }
+
+ async getRetainers(
+ filePath: string,
+ nodeId: number,
+ ): Promise<DevTools.HeapSnapshotModel.HeapSnapshotModel.ItemsRange> {
+ const nodeIndex = await this.findNodeIndexById(filePath, nodeId);
+ if (nodeIndex === undefined) {
+ throw new Error(`Node with ID ${nodeId} not found`);
+ }
+ const snapshot = await this.getSnapshot(filePath);
+ const provider = snapshot.createRetainingEdgesProvider(nodeIndex);
+ return await provider.serializeItemsRange(0, Infinity);
}
#getCachedSnapshot(filePath: string) {
diff --git a/src/McpContext.ts b/src/McpContext.ts
index 0b810769..f3c39eaf 100644
--- a/src/McpContext.ts
+++ b/src/McpContext.ts
@@ -830,4 +830,11 @@ export class McpContext implements Context {
this.validatePath(filePath);
return await this.#heapSnapshotManager.getNodesByUid(filePath, uid);
}
+
+ async getHeapSnapshotRetainers(
+ filePath: string,
+ nodeId: number,
+ ): Promise<DevTools.HeapSnapshotModel.HeapSnapshotModel.ItemsRange> {
+ return await this.#heapSnapshotManager.getRetainers(filePath, nodeId);
+ }
}
diff --git a/src/McpResponse.ts b/src/McpResponse.ts
index 3c4044b3..64404bca 100644
--- a/src/McpResponse.ts
+++ b/src/McpResponse.ts
@@ -9,7 +9,7 @@ import type {WebMCPTool} from 'puppeteer-core';
import type {ParsedArguments} from './bin/chrome-devtools-mcp-cli-options.js';
import {ConsoleFormatter} from './formatters/ConsoleFormatter.js';
import {HeapSnapshotFormatter} from './formatters/HeapSnapshotFormatter.js';
-import {isNodeLike} from './formatters/HeapSnapshotFormatter.js';
+import {isEdgeLike, isNodeLike} from './formatters/HeapSnapshotFormatter.js';
import {IssueFormatter} from './formatters/IssueFormatter.js';
import {NetworkFormatter} from './formatters/NetworkFormatter.js';
import {SnapshotFormatter} from './formatters/SnapshotFormatter.js';
@@ -984,12 +984,20 @@ Call ${handleDialog.name} to handle it before continuing.`);
}
const nodes = this.#heapSnapshotOptions.nodes;
if (nodes) {
- const sortedItems = nodes.items
- .filter(isNodeLike)
- .sort((a, b) => b.retainedSize - a.retainedSize);
+ let items = Array.from(nodes.items);
+ const firstItem = nodes.items[0];
+ if (firstItem) {
+ if (isNodeLike(firstItem)) {
+ items = items
+ .filter(isNodeLike)
+ .sort((a, b) => b.retainedSize - a.retainedSize);
+ } else if (isEdgeLike(firstItem)) {
+ items = items.filter(isEdgeLike);
+ }
+ }
const paginationData = this.#dataWithPagination(
- sortedItems,
+ items,
this.#heapSnapshotOptions.pagination,
);
diff --git a/src/bin/chrome-devtools-cli-options.ts b/src/bin/chrome-devtools-cli-options.ts
index a0e315c4..60418088 100644
--- a/src/bin/chrome-devtools-cli-options.ts
+++ b/src/bin/chrome-devtools-cli-options.ts
@@ -337,6 +337,37 @@ export const commands: Commands = {
},
},
},
+ get_node_retainers: {
+ description:
+ 'Loads a memory heapsnapshot and returns retainers for a specific node ID. (requires flag: --experimentalMemory=true)',
+ category: 'Memory',
+ args: {
+ filePath: {
+ name: 'filePath',
+ type: 'string',
+ description: 'A path to a .heapsnapshot file to read.',
+ required: true,
+ },
+ nodeId: {
+ name: 'nodeId',
+ type: 'number',
+ description: 'The stable node ID to get retainers for.',
+ required: true,
+ },
+ pageIdx: {
+ name: 'pageIdx',
+ type: 'number',
+ description: 'The page index for pagination.',
+ required: false,
+ },
+ pageSize: {
+ name: 'pageSize',
+ type: 'number',
+ description: 'The page size for pagination.',
+ required: false,
+ },
+ },
+ },
get_nodes_by_class: {
description:
'Loads a memory heapsnapshot and returns instances of a specific class with their stable IDs. (requires flag: --experimentalMemory=true)',
diff --git a/src/formatters/HeapSnapshotFormatter.ts b/src/formatters/HeapSnapshotFormatter.ts
index 20ee4c9c..bb5f8b0f 100644
--- a/src/formatters/HeapSnapshotFormatter.ts
+++ b/src/formatters/HeapSnapshotFormatter.ts
@@ -5,15 +5,15 @@
*/
import type {AggregatedInfoWithUid} from '../HeapSnapshotManager.js';
-import type {DevTools} from '../third_party/index.js';
+import {DevTools} from '../third_party/index.js';
import {stableIdSymbol} from '../utils/id.js';
export interface FormattedSnapshotEntry {
className: string;
classUid?: number;
count: number;
- selfSize: number;
- retainedSize: number;
+ selfSize: string;
+ retainedSize: string;
}
export function isNodeLike(
@@ -24,6 +24,22 @@ export function isNodeLike(
);
}
+export function isEdgeLike(
+ item: unknown,
+): item is DevTools.HeapSnapshotModel.HeapSnapshotModel.Edge {
+ return (
+ typeof item === 'object' &&
+ item !== null &&
+ 'name' in item &&
+ 'node' in item &&
+ 'type' in item &&
+ typeof item.node === 'object' &&
+ item.node !== null &&
+ 'id' in item.node &&
+ 'name' in item.node
+ );
+}
+
export class HeapSnapshotFormatter {
#aggregates: Record<string, AggregatedInfoWithUid>;
@@ -39,14 +55,23 @@ export class HeapSnapshotFormatter {
): string {
const lines: string[] = [];
- if (items.length > 0 && isNodeLike(items[0])) {
- lines.push('id,name,type,distance,selfSize,retainedSize');
+ if (items.length > 0) {
+ const firstItem = items[0];
+ if (isNodeLike(firstItem)) {
+ lines.push('id,name,type,distance,selfSize,retainedSize');
+ } else if (isEdgeLike(firstItem)) {
+ lines.push('edgeIndex,edgeName,edgeType,targetNodeId,targetNodeName');
+ }
}
for (const item of items) {
if (isNodeLike(item)) {
lines.push(
- `${item.id},"${item.name}",${item.type},${item.distance},${item.selfSize},${item.retainedSize}`,
+ `${item.id},${item.name},${item.type},${item.distance},${DevTools.I18n.ByteUtilities.formatBytesToKb(item.selfSize)},${DevTools.I18n.ByteUtilities.formatBytesToKb(item.retainedSize)}`,
+ );
+ } else if (isEdgeLike(item)) {
+ lines.push(
+ `${item.edgeIndex},${item.name},${item.type},${item.node.id},${item.node.name}`,
);
}
}
@@ -66,7 +91,7 @@ export class HeapSnapshotFormatter {
for (const info of sorted) {
const uid = info[stableIdSymbol] ?? '';
lines.push(
- `${uid},"${info.name}",${info.count},${info.self},${info.maxRet}`,
+ `${uid},${info.name},${info.count},${DevTools.I18n.ByteUtilities.formatBytesToKb(info.self)},${DevTools.I18n.ByteUtilities.formatBytesToKb(info.maxRet)}`,
);
}
@@ -79,8 +104,8 @@ export class HeapSnapshotFormatter {
uid: info[stableIdSymbol],
className: info.name,
count: info.count,
- selfSize: info.self,
- retainedSize: info.maxRet,
+ selfSize: DevTools.I18n.ByteUtilities.formatBytesToKb(info.self),
+ retainedSize: DevTools.I18n.ByteUtilities.formatBytesToKb(info.maxRet),
}));
}
diff --git a/src/telemetry/tool_call_metrics.json b/src/telemetry/tool_call_metrics.json
index a86c9c45..fa6c3eeb 100644
--- a/src/telemetry/tool_call_metrics.json
+++ b/src/telemetry/tool_call_metrics.json
@@ -631,5 +631,26 @@
{
"name": "list3p_developer_tools",
"args": []
+ },
+ {
+ "name": "get_node_retainers",
+ "args": [
+ {
+ "name": "file_path_length",
+ "argType": "number"
+ },
+ {
+ "name": "node_id",
+ "argType": "number"
+ },
+ {
+ "name": "page_idx",
+ "argType": "number"
+ },
+ {
+ "name": "page_size",
+ "argType": "number"
+ }
+ ]
}
]
diff --git a/src/tools/ToolDefinition.ts b/src/tools/ToolDefinition.ts
index 54fb1910..5027c6cd 100644
--- a/src/tools/ToolDefinition.ts
+++ b/src/tools/ToolDefinition.ts
@@ -246,6 +246,10 @@ export type Context = Readonly<{
filePath: string,
uid: number,
): Promise<DevTools.HeapSnapshotModel.HeapSnapshotModel.ItemsRange>;
+ getHeapSnapshotRetainers(
+ filePath: string,
+ nodeId: number,
+ ): Promise<DevTools.HeapSnapshotModel.HeapSnapshotModel.ItemsRange>;
}>;
/**
diff --git a/src/tools/memory.ts b/src/tools/memory.ts
index 5e8525b0..487fcef3 100644
--- a/src/tools/memory.ts
+++ b/src/tools/memory.ts
@@ -128,3 +128,34 @@ export const getNodesByClass = defineTool({
});
},
});
+
+export const getNodeRetainers = defineTool({
+ name: 'get_node_retainers',
+ description:
+ 'Loads a memory heapsnapshot and returns retainers for a specific node ID.',
+ annotations: {
+ category: ToolCategory.MEMORY,
+ readOnlyHint: true,
+ conditions: ['experimentalMemory'],
+ },
+ blockedByDialog: false,
+ schema: {
+ filePath: zod.string().describe('A path to a .heapsnapshot file to read.'),
+ nodeId: zod.number().describe('The stable node ID to get retainers for.'),
+ pageIdx: zod.number().optional().describe('The page index for pagination.'),
+ pageSize: zod.number().optional().describe('The page size for pagination.'),
+ },
+ handler: async (request, response, context) => {
+ context.validatePath(request.params.filePath);
+
+ const retainers = await context.getHeapSnapshotRetainers(
+ request.params.filePath,
+ request.params.nodeId,
+ );
+
+ response.setHeapSnapshotNodes(retainers, {
+ pageIdx: request.params.pageIdx,
+ pageSize: request.params.pageSize,
+ });
+ },
+});
diff --git a/tests/formatters/HeapSnapshotFormatter.test.js.snapshot b/tests/formatters/HeapSnapshotFormatter.test.js.snapshot
index 9756c8ab..c2a0afc5 100644
--- a/tests/formatters/HeapSnapshotFormatter.test.js.snapshot
+++ b/tests/formatters/HeapSnapshotFormatter.test.js.snapshot
@@ -1,5 +1,5 @@
exports[`HeapSnapshotFormatter > toString > formats data as CSV and sorts by retained size 1`] = `
uid,className,count,selfSize,maxRetainedSize
-1,"ObjectA",10,100,1000
-2,"ObjectB",5,50,500
+1,ObjectA,10,0.1 kB,1.0 kB
+2,ObjectB,5,0.1 kB,0.5 kB
`;
diff --git a/tests/formatters/HeapSnapshotFormatter.test.ts b/tests/formatters/HeapSnapshotFormatter.test.ts
index d1b29c4c..9fd0e110 100644
--- a/tests/formatters/HeapSnapshotFormatter.test.ts
+++ b/tests/formatters/HeapSnapshotFormatter.test.ts
@@ -8,10 +8,19 @@ import assert from 'node:assert';
import {describe, it} from 'node:test';
import {HeapSnapshotFormatter} from '../../src/formatters/HeapSnapshotFormatter.js';
-import type {DevTools} from '../../src/third_party/index.js';
+import {DevTools} from '../../src/third_party/index.js';
import {stableIdSymbol} from '../../src/utils/id.js';
describe('HeapSnapshotFormatter', () => {
+ DevTools.I18n.DevToolsLocale.DevToolsLocale.instance({
+ create: true,
+ data: {
+ navigatorLanguage: 'en-US',
+ settingLanguage: 'en-US',
+ lookupClosestDevToolsLocale: l => l,
+ },
+ });
+ DevTools.I18n.i18n.registerLocaleDataForTest('en-US', {});
const mockAggregates: Record<
string,
DevTools.HeapSnapshotModel.HeapSnapshotModel.AggregatedInfo
@@ -53,20 +62,74 @@ describe('HeapSnapshotFormatter', () => {
uid: 1,
className: 'ObjectA',
count: 10,
- selfSize: 100,
- retainedSize: 1000,
+ selfSize: DevTools.I18n.ByteUtilities.formatBytesToKb(100),
+ retainedSize: DevTools.I18n.ByteUtilities.formatBytesToKb(1000),
},
{
uid: 2,
className: 'ObjectB',
count: 5,
- selfSize: 50,
- retainedSize: 500,
+ selfSize: DevTools.I18n.ByteUtilities.formatBytesToKb(50),
+ retainedSize: DevTools.I18n.ByteUtilities.formatBytesToKb(500),
},
]);
});
});
+ describe('formatNodes', () => {
+ it('formats edges correctly', () => {
+ const mockEdges = [
+ {
+ name: 'edge1',
+ type: 'property',
+ edgeIndex: 0,
+ isAddedNotRemoved: null,
+ node: {
+ id: 1,
+ name: 'NodeA',
+ distance: 0,
+ nodeIndex: 0,
+ retainedSize: 0,
+ selfSize: 0,
+ type: 'object',
+ canBeQueried: false,
+ detachedDOMTreeNode: false,
+ ignored: false,
+ isAddedNotRemoved: null,
+ },
+ },
+ {
+ name: 'edge2',
+ type: 'element',
+ edgeIndex: 1,
+ isAddedNotRemoved: null,
+ node: {
+ id: 2,
+ name: 'NodeB',
+ distance: 0,
+ nodeIndex: 0,
+ retainedSize: 0,
+ selfSize: 0,
+ type: 'object',
+ canBeQueried: false,
+ detachedDOMTreeNode: false,
+ ignored: false,
+ isAddedNotRemoved: null,
+ },
+ },
+ ];
+
+ const result = HeapSnapshotFormatter.formatNodes(mockEdges);
+ const expected = [
+ 'edgeIndex,edgeName,edgeType,targetNodeId,targetNodeName',
+ '0,edge1,property,1,NodeA',
+ '1,edge2,element,2,NodeB',
+ ].join('\n');
+
+ assert.strictEqual(result, expected);
+ });
+ });
+
describe('sort', () => {
it('sorts aggregates by retained size descending', () => {
const unsortedAggregates: Record<
diff --git a/tests/tools/memory.test.js.snapshot b/tests/tools/memory.test.js.snapshot
index 4bcd2d00..9267d766 100644
--- a/tests/tools/memory.test.js.snapshot
+++ b/tests/tools/memory.test.js.snapshot
@@ -2,176 +2,185 @@ exports[`memory > get_memory_snapshot_details > with default options 1`] = `
## Heap Snapshot Data
Showing 1-157 of 157 (Page 1 of 1).
uid,className,count,selfSize,maxRetainedSize
-2,"(system)",3205,199264,655004
-11,"Function",3581,111464,237120
-16,"(object shape)",2878,181480,184320
-3,"(array)",34,41416,117472
-42,"Window (global*) / https://example.com",2,81068,101832
-94,"Window (prototype) / https://example.com",4,53336,53712
-1,"(compiled code)",713,42812,46988
-6,"(string)",846,27880,27880
-96,"Window (internal cache) / https://example.com",4,400,20256
-15,"Object (global*)",2,3856,13488
-55,"{constructor, toString, toDateString, toTimeString, toISOString, toUTCString, toGMTString, getDate, setDate, getDay}",4,848,8848
-49,"TypedArray",48,1424,8784
-109,"Document",1,8448,8700
-50,"Error",48,1344,7872
-47,"Math",4,816,7792
-19,"Array",8,1056,7728
-39,"{constructor, buffer, get buffer, byteLength, get byteLength, byteOffset, get byteOffset, length, get length}",4,624,7008
-10,"HTMLDocument",1,3288,6192
-44,"console",4,488,6152
-32,"String",4,960,6056
-68,"DataView",4,480,5504
-105,"HTMLElement",1,4728,4768
-62,"Intl.Locale",4,288,4672
-104,"Element",1,4224,4540
-76,"{constructor, getColumnNumber, getEnclosingColumnNumber, getEnclosingLineNumber, getEvalOrigin, getFileName, getFunction}",4,480,4448
-45,"Intl",4,336,4192
-25,"{<symbol Symbol.iterator>, constructor, get constructor, set constructor, reduce, toArray, forEach, some, every, find}",4,288,3600
-89,"system / Context",116,2544,3488
-43,"Atomics",4,336,3056
-91,"DisposableStack",4,240,3040
-92,"AsyncDisposableStack",4,240,3040
-46,"Reflect",4,336,2480
-72,"ArrayBuffer",4,192,2160
-9,"Window / https://example.com",1,904,1944
-37,"WebAssembly",4,416,1904
-58,"{constructor, <symbol Symbol.toStringTag>, resolvedOptions, adoptText, get adoptText, first, get first, next, get next}",4,112,1808
-103,"Node",1,1764,1804
-126,"Performance",1,1040,1784
-30,"Set",4,384,1616
-40,"{constructor}",14,392,1560
-90,"SharedArrayBuffer",4,112,1552
-56,"Intl.NumberFormat",4,192,1536
-66,"Intl.DateTimeFormat",4,192,1536
-27,"Map",4,336,1504
-48,"Number",4,240,1488
-70,"Symbol",4,192,1376
-67,"{at, copyWithin, entries, fill, find, findIndex, findLast, findLastIndex, flat, flatMap, includes, keys, toReversed}",4,336,1344
-106,"HTMLBodyElement (prototype) / https://example.com",1,1188,1228
-54,"Object",22,928,1168
-59,"Intl.PluralRules",4,192,1168
-60,"Intl.RelativeTimeFormat",4,192,1168
-61,"Intl.ListFormat",4,192,1168
-65,"Intl.DurationFormat",4,192,1168
-69,"BigInt",4,192,1168
-28,"{constructor, __defineGetter__, __defineSetter__, hasOwnProperty, __lookupGetter__, __lookupSetter__, isPrototypeOf}",4,288,1128
-17,"{isTraceCategoryEnabled, trace, getContinuationPreservedEmbedderData, setContinuationPreservedEmbedderData, console}",4,192,1120
-130,"StyleEngine",1,912,1104
-118,"CSSStyleRule",8,576,1024
-21,"Generator",4,192,1008
-23,"AsyncGenerator",4,192,1008
-34,"JSON",4,192,1008
-35,"Promise",4,192,1000
-57,"Intl.Collator",4,112,976
-119,"CSSStyleSheet",3,528,976
-33,"WeakMap",4,240,960
-52,"FinalizationRegistry",4,112,928
-63,"Intl.DisplayNames",4,112,928
-64,"Intl.Segmenter",4,112,928
-73,"Async-from-Sync Iterator",4,112,880
-22,"{<symbol Symbol.asyncIterator>, <symbol Symbol.asyncDispose>}",4,112,864
-85,"{containing, <symbol Symbol.iterator>}",4,112,832
-51,"WeakRef",4,112,768
-79,"WebAssembly.Table",4,192,768
-80,"WebAssembly.Memory",4,192,768
-71,"Boolean",4,144,752
-18,"Array Iterator",4,112,720
-24,"Iterator Helper",4,112,720
-26,"Map Iterator",4,112,720
-29,"Set Iterator",4,112,720
-31,"String Iterator",4,112,720
-86,"Segmenter String Iterator",4,112,720
-88,"RegExp String Iterator",4,112,720
-20,"{constructor, name, message, toString}",4,112,704
-87,"{next, return}",4,112,672
-75,"AsyncGeneratorFunction",4,112,656
-84,"GeneratorFunction",4,112,656
-74,"AsyncFunction",4,112,608
-81,"WebAssembly.Global",4,112,592
-93,"WebAssembly.Suspending",4,112,592
-100,"{loadTimes, csi}",2,56,580
-36,"{constructor, exec, dotAll, get dotAll, flags, get flags, global, get global, hasIndices, get hasIndices, ignoreCase}",4,240,576
-78,"WebAssembly.Instance",4,112,544
-83,"WebAssembly.Exception",4,112,544
-110,"Text",6,480,480
-77,"WebAssembly.Module",4,112,448
-82,"WebAssembly.Tag",4,112,448
-101,"EventTarget",2,92,436
-53,"WeakSet",4,192,416
-135,"EventListener",10,400,400
-99,"{parse, stringify}",2,40,384
-127,"Navigation",1,152,384
-4,"{<symbol handler_function>, <symbol feature_name>}",8,224,352
-134,"FontFaceSet",1,328,328
-133,"StylePropertyMap",8,320,320
-139,"MutationObserver",2,320,320
-102,"WindowProperties",2,56,280
-115,"<style>",1,128,264
-123,"IntersectionObserver",1,200,240
-132,"MutationObserver::Delegate",2,64,224
-131,"ScriptedAnimationController",1,208,208
-95,"MutationObserver (prototype) / https://example.com",1,156,196
-7,"(number)",16,192,192
-120,"NavigationHistoryEntry",1,192,192
-129,"StyleSheetCollection",1,192,192
-147,"<a>",1,136,192
-146,"DocumentTimeline",1,184,184
-5,"RegExp",1,100,176
-114,"<title>",1,96,176
-116,"PerformancePaintTiming",2,176,176
-145,"<p>",2,176,176
-111,"<div>",1,88,168
-122,"ServiceWorkerContainer",1,168,168
-125,"Navigator",1,168,168
-155,"PerformanceNavigationTiming",1,168,168
-113,"<head>",1,88,152
-98,"HTMLDocument (prototype) / https://example.com",1,108,148
-117,"PerformanceResourceTiming",1,136,136
-152,"LargestContentfulPaint",1,136,136
-38,"Tag",4,128,128
-136,"CustomElementRegistry",1,128,128
-138,"CSSRuleList",4,128,128
-141,"Storage",2,128,128
-13,"<body>",1,112,112
-14,"Object (global)",2,32,112
-121,"DOMTokenList",2,112,112
-148,"HTMLCollection",1,104,104
-150,"ScriptRunner",1,104,104
-112,"<meta>",1,96,96
-41,"(concatenated string)",2,40,88
-140,"<html>",1,88,88
-144,"<h1>",1,88,88
-149,"Screen",1,88,88
-153,"DocumentType",1,88,88
-156,"VisibilityStateEntry",1,88,88
-137,"MutationObserverRegistration",1,64,64
-8,"Window (global) / https://example.com",1,16,56
-151,"FragmentDirective",1,56,56
-124,"IntersectionObserverDelegate",1,40,40
-128,"NavigationActivation",1,40,40
-154,"PerformanceTiming",1,40,40
-157,"Pending activities",1,40,40
-142,"VisualViewport",1,32,32
-143,"Viewport",1,32,32
-12,"HTMLBodyElement",1,16,16
-97,"HTMLDocument (internal cache) / https://example.com",1,16,16
-107,"MutationObserver (internal cache) / https://example.com",1,16,16
-108,"HTMLBodyElement (internal cache) / https://example.com",1,16,16
+2,(system),3205,199 kB,655 kB
+11,Function,3581,111 kB,237 kB
+16,(object shape),2878,181 kB,184 kB
+3,(array),34,41.4 kB,117 kB
+42,Window (global*) / https://example.com,2,81.1 kB,102 kB
+94,Window (prototype) / https://example.com,4,53.3 kB,53.7 kB
+1,(compiled code),713,42.8 kB,47.0 kB
+6,(string),846,27.9 kB,27.9 kB
+96,Window (internal cache) / https://example.com,4,0.4 kB,20.3 kB
+15,Object (global*),2,3.9 kB,13.5 kB
+55,{constructor, toString, toDateString, toTimeString, toISOString, toUTCString, toGMTString, getDate, setDate, getDay},4,0.8 kB,8.8 kB
+49,TypedArray,48,1.4 kB,8.8 kB
+109,Document,1,8.4 kB,8.7 kB
+50,Error,48,1.3 kB,7.9 kB
+47,Math,4,0.8 kB,7.8 kB
+19,Array,8,1.1 kB,7.7 kB
+39,{constructor, buffer, get buffer, byteLength, get byteLength, byteOffset, get byteOffset, length, get length},4,0.6 kB,7.0 kB
+10,HTMLDocument,1,3.3 kB,6.2 kB
+44,console,4,0.5 kB,6.2 kB
+32,String,4,1.0 kB,6.1 kB
+68,DataView,4,0.5 kB,5.5 kB
+105,HTMLElement,1,4.7 kB,4.8 kB
+62,Intl.Locale,4,0.3 kB,4.7 kB
+104,Element,1,4.2 kB,4.5 kB
+76,{constructor, getColumnNumber, getEnclosingColumnNumber, getEnclosingLineNumber, getEvalOrigin, getFileName, getFunction},4,0.5 kB,4.4 kB
+45,Intl,4,0.3 kB,4.2 kB
+25,{<symbol Symbol.iterator>, constructor, get constructor, set constructor, reduce, toArray, forEach, some, every, find},4,0.3 kB,3.6 kB
+89,system / Context,116,2.5 kB,3.5 kB
+43,Atomics,4,0.3 kB,3.1 kB
+91,DisposableStack,4,0.2 kB,3.0 kB
+92,AsyncDisposableStack,4,0.2 kB,3.0 kB
+46,Reflect,4,0.3 kB,2.5 kB
+72,ArrayBuffer,4,0.2 kB,2.2 kB
+9,Window / https://example.com,1,0.9 kB,1.9 kB
+37,WebAssembly,4,0.4 kB,1.9 kB
+58,{constructor, <symbol Symbol.toStringTag>, resolvedOptions, adoptText, get adoptText, first, get first, next, get next},4,0.1 kB,1.8 kB
+103,Node,1,1.8 kB,1.8 kB
+126,Performance,1,1.0 kB,1.8 kB
+30,Set,4,0.4 kB,1.6 kB
+40,{constructor},14,0.4 kB,1.6 kB
+90,SharedArrayBuffer,4,0.1 kB,1.6 kB
+56,Intl.NumberFormat,4,0.2 kB,1.5 kB
+66,Intl.DateTimeFormat,4,0.2 kB,1.5 kB
+27,Map,4,0.3 kB,1.5 kB
+48,Number,4,0.2 kB,1.5 kB
+70,Symbol,4,0.2 kB,1.4 kB
+67,{at, copyWithin, entries, fill, find, findIndex, findLast, findLastIndex, flat, flatMap, includes, keys, toReversed},4,0.3 kB,1.3 kB
+106,HTMLBodyElement (prototype) / https://example.com,1,1.2 kB,1.2 kB
+54,Object,22,0.9 kB,1.2 kB
+59,Intl.PluralRules,4,0.2 kB,1.2 kB
+60,Intl.RelativeTimeFormat,4,0.2 kB,1.2 kB
+61,Intl.ListFormat,4,0.2 kB,1.2 kB
+65,Intl.DurationFormat,4,0.2 kB,1.2 kB
+69,BigInt,4,0.2 kB,1.2 kB
+28,{constructor, __defineGetter__, __defineSetter__, hasOwnProperty, __lookupGetter__, __lookupSetter__, isPrototypeOf},4,0.3 kB,1.1 kB
+17,{isTraceCategoryEnabled, trace, getContinuationPreservedEmbedderData, setContinuationPreservedEmbedderData, console},4,0.2 kB,1.1 kB
+130,StyleEngine,1,0.9 kB,1.1 kB
+118,CSSStyleRule,8,0.6 kB,1.0 kB
+21,Generator,4,0.2 kB,1.0 kB
+23,AsyncGenerator,4,0.2 kB,1.0 kB
+34,JSON,4,0.2 kB,1.0 kB
+35,Promise,4,0.2 kB,1.0 kB
+57,Intl.Collator,4,0.1 kB,1.0 kB
+119,CSSStyleSheet,3,0.5 kB,1.0 kB
+33,WeakMap,4,0.2 kB,1.0 kB
+52,FinalizationRegistry,4,0.1 kB,0.9 kB
+63,Intl.DisplayNames,4,0.1 kB,0.9 kB
+64,Intl.Segmenter,4,0.1 kB,0.9 kB
+73,Async-from-Sync Iterator,4,0.1 kB,0.9 kB
+22,{<symbol Symbol.asyncIterator>, <symbol Symbol.asyncDispose>},4,0.1 kB,0.9 kB
+85,{containing, <symbol Symbol.iterator>},4,0.1 kB,0.8 kB
+51,WeakRef,4,0.1 kB,0.8 kB
+79,WebAssembly.Table,4,0.2 kB,0.8 kB
+80,WebAssembly.Memory,4,0.2 kB,0.8 kB
+71,Boolean,4,0.1 kB,0.8 kB
+18,Array Iterator,4,0.1 kB,0.7 kB
+24,Iterator Helper,4,0.1 kB,0.7 kB
+26,Map Iterator,4,0.1 kB,0.7 kB
+29,Set Iterator,4,0.1 kB,0.7 kB
+31,String Iterator,4,0.1 kB,0.7 kB
+86,Segmenter String Iterator,4,0.1 kB,0.7 kB
+88,RegExp String Iterator,4,0.1 kB,0.7 kB
+20,{constructor, name, message, toString},4,0.1 kB,0.7 kB
+87,{next, return},4,0.1 kB,0.7 kB
+75,AsyncGeneratorFunction,4,0.1 kB,0.7 kB
+84,GeneratorFunction,4,0.1 kB,0.7 kB
+74,AsyncFunction,4,0.1 kB,0.6 kB
+81,WebAssembly.Global,4,0.1 kB,0.6 kB
+93,WebAssembly.Suspending,4,0.1 kB,0.6 kB
+100,{loadTimes, csi},2,0.1 kB,0.6 kB
+36,{constructor, exec, dotAll, get dotAll, flags, get flags, global, get global, hasIndices, get hasIndices, ignoreCase},4,0.2 kB,0.6 kB
+78,WebAssembly.Instance,4,0.1 kB,0.5 kB
+83,WebAssembly.Exception,4,0.1 kB,0.5 kB
+110,Text,6,0.5 kB,0.5 kB
+77,WebAssembly.Module,4,0.1 kB,0.4 kB
+82,WebAssembly.Tag,4,0.1 kB,0.4 kB
+101,EventTarget,2,0.1 kB,0.4 kB
+53,WeakSet,4,0.2 kB,0.4 kB
+135,EventListener,10,0.4 kB,0.4 kB
+99,{parse, stringify},2,0.0 kB,0.4 kB
+127,Navigation,1,0.2 kB,0.4 kB
+4,{<symbol handler_function>, <symbol feature_name>},8,0.2 kB,0.4 kB
+134,FontFaceSet,1,0.3 kB,0.3 kB
+133,StylePropertyMap,8,0.3 kB,0.3 kB
+139,MutationObserver,2,0.3 kB,0.3 kB
+102,WindowProperties,2,0.1 kB,0.3 kB
+115,<style>,1,0.1 kB,0.3 kB
+123,IntersectionObserver,1,0.2 kB,0.2 kB
+132,MutationObserver::Delegate,2,0.1 kB,0.2 kB
+131,ScriptedAnimationController,1,0.2 kB,0.2 kB
+95,MutationObserver (prototype) / https://example.com,1,0.2 kB,0.2 kB
+7,(number),16,0.2 kB,0.2 kB
+120,NavigationHistoryEntry,1,0.2 kB,0.2 kB
+129,StyleSheetCollection,1,0.2 kB,0.2 kB
+147,<a>,1,0.1 kB,0.2 kB
+146,DocumentTimeline,1,0.2 kB,0.2 kB
+5,RegExp,1,0.1 kB,0.2 kB
+114,<title>,1,0.1 kB,0.2 kB
+116,PerformancePaintTiming,2,0.2 kB,0.2 kB
+145,<p>,2,0.2 kB,0.2 kB
+111,<div>,1,0.1 kB,0.2 kB
+122,ServiceWorkerContainer,1,0.2 kB,0.2 kB
+125,Navigator,1,0.2 kB,0.2 kB
+155,PerformanceNavigationTiming,1,0.2 kB,0.2 kB
+113,<head>,1,0.1 kB,0.2 kB
+98,HTMLDocument (prototype) / https://example.com,1,0.1 kB,0.1 kB
+117,PerformanceResourceTiming,1,0.1 kB,0.1 kB
+152,LargestContentfulPaint,1,0.1 kB,0.1 kB
+38,Tag,4,0.1 kB,0.1 kB
+136,CustomElementRegistry,1,0.1 kB,0.1 kB
+138,CSSRuleList,4,0.1 kB,0.1 kB
+141,Storage,2,0.1 kB,0.1 kB
+13,<body>,1,0.1 kB,0.1 kB
+14,Object (global),2,0.0 kB,0.1 kB
+121,DOMTokenList,2,0.1 kB,0.1 kB
+148,HTMLCollection,1,0.1 kB,0.1 kB
+150,ScriptRunner,1,0.1 kB,0.1 kB
+112,<meta>,1,0.1 kB,0.1 kB
+41,(concatenated string),2,0.0 kB,0.1 kB
+140,<html>,1,0.1 kB,0.1 kB
+144,<h1>,1,0.1 kB,0.1 kB
+149,Screen,1,0.1 kB,0.1 kB
+153,DocumentType,1,0.1 kB,0.1 kB
+156,VisibilityStateEntry,1,0.1 kB,0.1 kB
+137,MutationObserverRegistration,1,0.1 kB,0.1 kB
+8,Window (global) / https://example.com,1,0.0 kB,0.1 kB
+151,FragmentDirective,1,0.1 kB,0.1 kB
+124,IntersectionObserverDelegate,1,0.0 kB,0.0 kB
+128,NavigationActivation,1,0.0 kB,0.0 kB
+154,PerformanceTiming,1,0.0 kB,0.0 kB
+157,Pending activities,1,0.0 kB,0.0 kB
+142,VisualViewport,1,0.0 kB,0.0 kB
+143,Viewport,1,0.0 kB,0.0 kB
+12,HTMLBodyElement,1,0.0 kB,0.0 kB
+97,HTMLDocument (internal cache) / https://example.com,1,0.0 kB,0.0 kB
+107,MutationObserver (internal cache) / https://example.com,1,0.0 kB,0.0 kB
+108,HTMLBodyElement (internal cache) / https://example.com,1,0.0 kB,0.0 kB
+`;
+
+exports[`memory > get_node_retainers > with valid nodeId 1`] = `
+## Heap Snapshot Data
+edgeIndex,edgeName,edgeType,targetNodeId,targetNodeName
+145296,prototype,internal,29287,system / Map
+108096,prototype,property,25575,String
+48828,initial_string_prototype,internal,7199,system / NativeContext
+Showing 1-3 of 3 (Page 1 of 1).
`;
exports[`memory > get_nodes_by_class > with default options 1`] = `
## Heap Snapshot Data
id,name,type,distance,selfSize,retainedSize
-25307,"Array",object,2,192,2056
-46355,"Array",object,2,192,2056
-33187,"Array",object,2,192,1664
-36255,"Array",object,2,192,1664
-45901,"Array",object,5,88,88
-46151,"Array",object,5,88,88
-45899,"Array",object,5,56,56
-46149,"Array",object,5,56,56
+25307,Array,object,2,0.2 kB,2.1 kB
+46355,Array,object,2,0.2 kB,2.1 kB
+33187,Array,object,2,0.2 kB,1.7 kB
+36255,Array,object,2,0.2 kB,1.7 kB
+45901,Array,object,5,0.1 kB,0.1 kB
+46151,Array,object,5,0.1 kB,0.1 kB
+45899,Array,object,5,0.1 kB,0.1 kB
+46149,Array,object,5,0.1 kB,0.1 kB
Showing 1-8 of 8 (Page 1 of 1).
`;
diff --git a/tests/tools/memory.test.ts b/tests/tools/memory.test.ts
index d6c1931f..21a9e75c 100644
--- a/tests/tools/memory.test.ts
+++ b/tests/tools/memory.test.ts
@@ -16,6 +16,7 @@ import {
exploreMemorySnapshot,
getMemorySnapshotDetails,
getNodesByClass,
+ getNodeRetainers,
} from '../../src/tools/memory.js';
import {withMcpContext} from '../utils.js';
@@ -148,4 +149,31 @@ describe('memory', () => {
});
});
});
+
+ describe('get_node_retainers', () => {
+ it('with valid nodeId', async t => {
+ await withMcpContext(async (response, context) => {
+ const filePath = join(
+ process.cwd(),
+ 'tests/fixtures/example.heapsnapshot',
+ );
+
+ await getNodeRetainers.handler(
+ {params: {filePath, nodeId: 25341}},
+ response,
+ context,
+ );
+
+ const responseData = await response.handle(
+ getNodeRetainers.name,
+ context,
+ );
+ const output = responseData.content
+ .map(c => (c.type === 'text' ? c.text : ''))
+ .join('\n');
+
+ t.assert.snapshot?.(output);
+ });
+ });
+ });
});