chore(memory): update names and exposed information (#2079)

Update the tools to all include the `heapsnapshot` term for easier
handling.
Renames UID to ID to reduce confusion with the snapshot UIDs.
Renames Id to NodeId to better differentiate from the base Id.
Remove EdgeIndex as it was not useful.

Closes:
#1970

Author: Lightning00Blade

README.md

@@ -515,11 +515,11 @@ If you run into any issues, checkout our [troubleshooting guide](./docs/troubles
   - [`screencast_start`](docs/tool-reference.md#screencast_start)
   - [`screencast_stop`](docs/tool-reference.md#screencast_stop)
 - **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)
+  - [`take_heapsnapshot`](docs/tool-reference.md#take_heapsnapshot)
+  - [`get_heapsnapshot_class_nodes`](docs/tool-reference.md#get_heapsnapshot_class_nodes)
+  - [`get_heapsnapshot_details`](docs/tool-reference.md#get_heapsnapshot_details)
+  - [`get_heapsnapshot_retainers`](docs/tool-reference.md#get_heapsnapshot_retainers)
+  - [`get_heapsnapshot_summary`](docs/tool-reference.md#get_heapsnapshot_summary)
 - **Extensions** (5 tools)
   - [`install_extension`](docs/tool-reference.md#install_extension)
   - [`list_extensions`](docs/tool-reference.md#list_extensions)

docs/tool-reference.md

@@ -40,11 +40,11 @@
   - [`screencast_start`](#screencast_start)
   - [`screencast_stop`](#screencast_stop)
 - **[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)
+  - [`take_heapsnapshot`](#take_heapsnapshot)
+  - [`get_heapsnapshot_class_nodes`](#get_heapsnapshot_class_nodes)
+  - [`get_heapsnapshot_details`](#get_heapsnapshot_details)
+  - [`get_heapsnapshot_retainers`](#get_heapsnapshot_retainers)
+  - [`get_heapsnapshot_summary`](#get_heapsnapshot_summary)
 - **[Extensions](#extensions)** (5 tools)
   - [`install_extension`](#install_extension)
   - [`list_extensions`](#list_extensions)
@@ -443,7 +443,7 @@ in the DevTools Elements panel (if any).
 
 ## Memory
 
-### `take_memory_snapshot`
+### `take_heapsnapshot`
 
 **Description:** Capture a heap snapshot of the currently selected page. Use to analyze the memory distribution of JavaScript objects and debug memory leaks.
 
@@ -453,45 +453,45 @@ in the DevTools Elements panel (if any).
 
 ---
 
-### `get_memory_snapshot_details`
+### `get_heapsnapshot_class_nodes`
 
-**Description:** Loads a memory heapsnapshot and returns all available information including statistics, static data, and aggregated node information. Supports pagination for aggregates. (requires flag: --experimentalMemory=true)
+**Description:** Loads a memory heapsnapshot and returns instances of a specific class with their IDs. (requires flag: --experimentalMemory=true)
 
 **Parameters:**
 
 - **filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
-- **pageIdx** (number) _(optional)_: The page index for pagination of aggregates.
-- **pageSize** (number) _(optional)_: The page size for pagination of aggregates.
+- **id** (number) **(required)**: The ID for the class, obtained from details.
+- **pageIdx** (number) _(optional)_: The page index for pagination.
+- **pageSize** (number) _(optional)_: The page size for pagination.
 
 ---
 
-### `get_node_retainers`
+### `get_heapsnapshot_details`
 
-**Description:** Loads a memory heapsnapshot and returns retainers for a specific node ID. (requires flag: --experimentalMemory=true)
+**Description:** Loads a memory heapsnapshot and returns all available information including statistics, static data, and aggregated node information. Supports pagination for aggregates. (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.
+- **pageIdx** (number) _(optional)_: The page index for pagination of aggregates.
+- **pageSize** (number) _(optional)_: The page size for pagination of aggregates.
 
 ---
 
-### `get_nodes_by_class`
+### `get_heapsnapshot_retainers`
 
-**Description:** Loads a memory heapsnapshot and returns instances of a specific class with their stable IDs. (requires flag: --experimentalMemory=true)
+**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.
-- **uid** (number) **(required)**: The unique UID for the class, obtained from aggregates listing.
+- **nodeId** (number) **(required)**: The node ID to get retainers for.
 - **pageIdx** (number) _(optional)_: The page index for pagination.
 - **pageSize** (number) _(optional)_: The page size for pagination.
 
 ---
 
-### `load_memory_snapshot`
+### `get_heapsnapshot_summary`
 
 **Description:** Loads a memory heapsnapshot and returns snapshot summary stats. (requires flag: --experimentalMemory=true)
 

src/HeapSnapshotManager.ts

@@ -15,7 +15,7 @@ import {
   type WithSymbolId,
 } from './utils/id.js';
 
-export type AggregatedInfoWithUid =
+export type AggregatedInfoWithId =
   WithSymbolId<DevTools.HeapSnapshotModel.HeapSnapshotModel.AggregatedInfo>;
 
 export class HeapSnapshotManager {
@@ -25,8 +25,8 @@ export class HeapSnapshotManager {
       snapshot: DevTools.HeapSnapshotModel.HeapSnapshotProxy.HeapSnapshotProxy;
       worker: DevTools.HeapSnapshotModel.HeapSnapshotProxy.HeapSnapshotWorkerProxy;
       // TODO: use a multimap
-      uidToClassKey: Map<number, string>;
-      classKeyToUid: Map<string, number>;
+      idToClassKey: Map<number, string>;
+      classKeyToId: Map<string, number>;
       idGenerator: () => number;
     }
   >();
@@ -44,8 +44,8 @@ export class HeapSnapshotManager {
     this.#snapshots.set(absolutePath, {
       snapshot,
       worker,
-      uidToClassKey: new Map<number, string>(),
-      classKeyToUid: new Map<string, number>(),
+      idToClassKey: new Map<number, string>(),
+      classKeyToId: new Map<string, number>(),
       idGenerator: createIdGenerator(),
     });
 
@@ -54,18 +54,18 @@ export class HeapSnapshotManager {
 
   async getAggregates(
     filePath: string,
-  ): Promise<Record<string, AggregatedInfoWithUid>> {
+  ): Promise<Record<string, AggregatedInfoWithId>> {
     const snapshot = await this.getSnapshot(filePath);
     const filter =
       new DevTools.HeapSnapshotModel.HeapSnapshotModel.NodeFilter();
-    const aggregates: Record<string, AggregatedInfoWithUid> =
+    const aggregates: Record<string, AggregatedInfoWithId> =
       await snapshot.aggregatesWithFilter(filter);
 
     for (const key of Object.keys(aggregates)) {
-      const uid = await this.getOrCreateUidForClassKey(filePath, key);
+      const id = await this.getOrCreateIdForClassKey(filePath, key);
       const aggregate = aggregates[key];
       if (aggregate) {
-        aggregate[stableIdSymbol] = uid;
+        aggregate[stableIdSymbol] = id;
       }
     }
 
@@ -86,30 +86,30 @@ export class HeapSnapshotManager {
     return snapshot.staticData;
   }
 
-  async getOrCreateUidForClassKey(
+  async getOrCreateIdForClassKey(
     filePath: string,
     classKey: string,
   ): Promise<number> {
     const cached = this.#getCachedSnapshot(filePath);
-    let uid = cached.classKeyToUid.get(classKey);
-    if (!uid) {
-      uid = cached.idGenerator();
-      cached.classKeyToUid.set(classKey, uid);
-      cached.uidToClassKey.set(uid, classKey);
+    let id = cached.classKeyToId.get(classKey);
+    if (!id) {
+      id = cached.idGenerator();
+      cached.classKeyToId.set(classKey, id);
+      cached.idToClassKey.set(id, classKey);
     }
-    return uid;
+    return id;
   }
 
-  async getNodesByUid(
+  async getNodesById(
     filePath: string,
-    uid: number,
+    id: number,
   ): Promise<DevTools.HeapSnapshotModel.HeapSnapshotModel.ItemsRange> {
     const snapshot = await this.getSnapshot(filePath);
     const filter =
       new DevTools.HeapSnapshotModel.HeapSnapshotModel.NodeFilter();
-    const className = await this.resolveClassKeyFromUid(filePath, uid);
+    const className = await this.resolveClassKeyFromId(filePath, id);
     if (!className) {
-      throw new Error(`Class with UID ${uid} not found in heap snapshot`);
+      throw new Error(`Class with ID ${id} not found in heap snapshot`);
     }
     const provider = snapshot.createNodesProviderForClass(className, filter);
 
@@ -159,12 +159,12 @@ export class HeapSnapshotManager {
     return cached;
   }
 
-  async resolveClassKeyFromUid(
+  async resolveClassKeyFromId(
     filePath: string,
-    uid: number,
+    id: number,
   ): Promise<string | undefined> {
     const cached = this.#getCachedSnapshot(filePath);
-    return cached.uidToClassKey.get(uid);
+    return cached.idToClassKey.get(id);
   }
 
   async #loadSnapshot(absolutePath: string): Promise<{

src/McpContext.ts

@@ -12,7 +12,7 @@ import {fileURLToPath, pathToFileURL} from 'node:url';
 import type {TargetUniverse} from './DevtoolsUtils.js';
 import {UniverseManager} from './DevtoolsUtils.js';
 import {HeapSnapshotManager} from './HeapSnapshotManager.js';
-import type {AggregatedInfoWithUid} from './HeapSnapshotManager.js';
+import type {AggregatedInfoWithId} from './HeapSnapshotManager.js';
 import {McpPage} from './McpPage.js';
 import {
   NetworkCollector,
@@ -804,7 +804,7 @@ export class McpContext implements Context {
 
   async getHeapSnapshotAggregates(
     filePath: string,
-  ): Promise<Record<string, AggregatedInfoWithUid>> {
+  ): Promise<Record<string, AggregatedInfoWithId>> {
     this.validatePath(filePath);
     return await this.#heapSnapshotManager.getAggregates(filePath);
   }
@@ -823,12 +823,12 @@ export class McpContext implements Context {
     return await this.#heapSnapshotManager.getStaticData(filePath);
   }
 
-  async getHeapSnapshotNodesByUid(
+  async getHeapSnapshotNodesById(
     filePath: string,
-    uid: number,
+    id: number,
   ): Promise<DevTools.HeapSnapshotModel.HeapSnapshotModel.ItemsRange> {
     this.validatePath(filePath);
-    return await this.#heapSnapshotManager.getNodesByUid(filePath, uid);
+    return await this.#heapSnapshotManager.getNodesById(filePath, id);
   }
 
   async getHeapSnapshotRetainers(