@memlab/core 1.1.6 → 1.1.10

package/dist/__tests__/parser/HeapParser.test.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 export {};
 //# sourceMappingURL=HeapParser.test.d.ts.map

package/dist/__tests__/parser/HeapParser.test.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -36,7 +36,7 @@ test('Capture inserted object', () => __awaiter(void 0, void 0, void 0, function
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const injected = new TestObject();
-    const heap = yield (0, NodeHeap_1.getNodeInnocentHeap)();
+    const heap = yield (0, NodeHeap_1.takeNodeMinimalHeap)();
     expect(heap.hasObjectWithClassName('TestObject')).toBe(true);
 }), timeout);
 test('Does not capture transcient object', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -49,6 +49,6 @@ test('Does not capture transcient object', () => __awaiter(void 0, void 0, void
     let injected = new TestObject();
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     injected = null;
-    const heap = yield (0, NodeHeap_1.getNodeInnocentHeap)();
+    const heap = yield (0, NodeHeap_1.takeNodeMinimalHeap)();
     expect(heap.hasObjectWithClassName('TestObject')).toBe(false);
 }), timeout);

package/dist/__tests__/parser/NodeHeap.test.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 export {};
 //# sourceMappingURL=NodeHeap.test.d.ts.map

package/dist/__tests__/parser/NodeHeap.test.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -30,7 +30,7 @@ const timeout = 5 * 60 * 1000;
 test('Capture current node heap snapshot', () => __awaiter(void 0, void 0, void 0, function* () {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const object = { 'memlab-test-heap-property': 'memlab-test-heap-value' };
-    const heap = yield (0, NodeHeap_1.getNodeInnocentHeap)();
+    const heap = yield (0, NodeHeap_1.takeNodeMinimalHeap)();
     expect(heap.hasObjectWithPropertyName('memlab-test-heap-property')).toBe(true);
 }), timeout);
 test('Nullified Object should not exist in heap', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -39,7 +39,7 @@ test('Nullified Object should not exist in heap', () => __awaiter(void 0, void 0
     };
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     object = null;
-    const heap = yield (0, NodeHeap_1.getNodeInnocentHeap)();
+    const heap = yield (0, NodeHeap_1.takeNodeMinimalHeap)();
     expect(heap.hasObjectWithPropertyName('memlab-test-heap-property')).toBe(false);
 }), timeout);
 test('Strongly referenced object should exist in heap', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -59,7 +59,7 @@ test('Strongly referenced object should exist in heap', () => __awaiter(void 0,
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const object = buildTest();
-    const heap = yield (0, NodeHeap_1.getNodeInnocentHeap)();
+    const heap = yield (0, NodeHeap_1.takeNodeMinimalHeap)();
     expect(heap.hasObjectWithClassName('TestClass1')).toBe(true);
     expect(heap.hasObjectWithClassName('TestClass2')).toBe(true);
 }), timeout);
@@ -80,7 +80,7 @@ test('Weakly referenced object should not exist in heap', () => __awaiter(void 0
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const object = buildTest();
-    const heap = yield (0, NodeHeap_1.getNodeInnocentHeap)();
+    const heap = yield (0, NodeHeap_1.takeNodeMinimalHeap)();
     expect(heap.hasObjectWithClassName('TestClass3')).toBe(true);
     expect(heap.hasObjectWithClassName('TestClass4')).toBe(false);
 }), timeout);
@@ -90,7 +90,7 @@ test('Check annotated objects', () => __awaiter(void 0, void 0, void 0, function
     (0, NodeHeap_1.tagObject)(o1, 'memlab-mark-1');
     (0, NodeHeap_1.tagObject)(o2, 'memlab-mark-2');
     o2 = null;
-    const heap = yield (0, NodeHeap_1.getNodeInnocentHeap)();
+    const heap = yield (0, NodeHeap_1.takeNodeMinimalHeap)();
     expect(heap.hasObjectWithTag('memlab-mark-1')).toBe(true);
     expect(heap.hasObjectWithTag('memlab-mark-2')).toBe(false);
 }), timeout);

package/dist/__tests__/parser/StringNode.test.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 export {};
 //# sourceMappingURL=StringNode.test.d.ts.map

package/dist/__tests__/parser/StringNode.test.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -41,7 +41,7 @@ test('String heap object APIs work', () => __awaiter(void 0, void 0, void 0, fun
     injected.complexConcatString += 'value_';
     injected.complexConcatString += 123;
     injected.complexConcatString += '_suffix';
-    const heap = yield (0, NodeHeap_1.getNodeInnocentHeap)();
+    const heap = yield (0, NodeHeap_1.takeNodeMinimalHeap)();
     const testObject = heap.getAnyObjectWithClassName('TestObject');
     expect(testObject).not.toBe(null);
     // testObject.originalString === 'test'

package/dist/__tests__/parser/traverse/HeapNodeTraverse.test.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { AnyValue } from '../../../lib/Types';
 declare global {

package/dist/__tests__/parser/traverse/HeapNodeTraverse.test.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -74,7 +74,7 @@ test('Check getReference and getReferenceNode', () => __awaiter(void 0, void 0,
         });
         return detected;
     };
-    const heap = yield (0, NodeHeap_1.getNodeInnocentHeap)();
+    const heap = yield (0, NodeHeap_1.takeNodeMinimalHeap)();
     expect(checker(heap)).toBe(true);
 }), timeout);
 test('Check getReferrers and getReferrerNodes', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -135,6 +135,6 @@ test('Check getReferrers and getReferrerNodes', () => __awaiter(void 0, void 0,
         }
         return true;
     };
-    const heap = yield (0, NodeHeap_1.getNodeInnocentHeap)();
+    const heap = yield (0, NodeHeap_1.takeNodeMinimalHeap)();
     expect(checker(heap)).toBe(true);
 }), timeout);

package/dist/__tests__/utils/utils.test.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 export {};
 //# sourceMappingURL=utils.test.d.ts.map

package/dist/__tests__/utils/utils.test.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/index.d.ts

@@ -4,12 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 /** @internal */
 export declare function registerPackage(): Promise<void>;
 export * from './lib/Types';
+export * from './lib/NodeHeap';
 /** @internal */
 export { default as config } from './lib/Config';
 /** @internal */
@@ -46,5 +47,6 @@ export { default as NormalizedTrace } from './trace-cluster/TraceBucket';
 export { default as EvaluationMetric } from './trace-cluster/EvalutationMetric';
 /** @internal */
 export * from './lib/PackageInfoLoader';
-export * from './lib/NodeHeap';
+/** @internal */
+export { default as SequentialClustering } from './trace-cluster/SequentialClustering';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EvaluationMetric = exports.NormalizedTrace = exports.leakClusterLogger = exports.ProcessManager = exports.modes = exports.constant = exports.analysis = exports.browserInfo = exports.serializer = exports.fileManager = exports.utils = exports.BaseOption = exports.info = exports.config = exports.registerPackage = void 0;
+exports.SequentialClustering = exports.EvaluationMetric = exports.NormalizedTrace = exports.leakClusterLogger = exports.ProcessManager = exports.modes = exports.constant = exports.analysis = exports.browserInfo = exports.serializer = exports.fileManager = exports.utils = exports.BaseOption = exports.info = exports.config = exports.registerPackage = void 0;
 const path_1 = __importDefault(require("path"));
 const PackageInfoLoader_1 = require("./lib/PackageInfoLoader");
 /** @internal */
@@ -46,6 +46,7 @@ function registerPackage() {
 }
 exports.registerPackage = registerPackage;
 __exportStar(require("./lib/Types"), exports);
+__exportStar(require("./lib/NodeHeap"), exports);
 /** @internal */
 var Config_1 = require("./lib/Config");
 Object.defineProperty(exports, "config", { enumerable: true, get: function () { return __importDefault(Config_1).default; } });
@@ -96,4 +97,6 @@ var EvalutationMetric_1 = require("./trace-cluster/EvalutationMetric");
 Object.defineProperty(exports, "EvaluationMetric", { enumerable: true, get: function () { return __importDefault(EvalutationMetric_1).default; } });
 /** @internal */
 __exportStar(require("./lib/PackageInfoLoader"), exports);
-__exportStar(require("./lib/NodeHeap"), exports);
+/** @internal */
+var SequentialClustering_1 = require("./trace-cluster/SequentialClustering");
+Object.defineProperty(exports, "SequentialClustering", { enumerable: true, get: function () { return __importDefault(SequentialClustering_1).default; } });

package/dist/lib/BaseOption.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { ParsedArgs } from 'minimist';
 import type { AnyRecord } from './Types';

package/dist/lib/BaseOption.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/lib/BrowserInfo.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { ConsoleMessage, Dialog, LaunchOptions, Page } from 'puppeteer';
 import type { IBrowserInfo } from './Types';

package/dist/lib/BrowserInfo.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/lib/Config.d.ts

@@ -4,11 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { LaunchOptions, Permission } from 'puppeteer';
 import type { AnyFunction, AnyValue, IClusterStrategy, IRunningMode, IScenario, Nullable, Optional, QuickExperiment, ILeakFilter, IPackageInfo } from './Types';
+import { IHeapConfig } from '..';
 interface BrowserLaunchArgumentOptions {
     headless?: boolean;
     userDataDir?: string;
@@ -95,6 +96,7 @@ export declare class MemLabConfig {
     dataBuilderDataDir: string;
     unclassifiedClusterDir: string;
     externalCookiesFile: Optional<string>;
+    heapConfig: Optional<IHeapConfig>;
     puppeteerConfig: LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions;
     openDevtoolsConsole: boolean;
     emulateDevice: Nullable<Device>;
@@ -182,6 +184,10 @@ export declare class MemLabConfig {
     packageInfo: IPackageInfo[];
     isMLClustering: boolean;
     mlClusteringLinkageMaxDistance: number;
+    mlMaxDF: number;
+    isSequentialClustering: boolean;
+    seqClusteringSplitCount: number;
+    seqClusteringIsRandomChunks: boolean;
     constructor(options?: ConfigOption);
     private initInternalConfigs;
     private init;
@@ -200,7 +206,7 @@ export declare class MemLabConfig {
     set isHeadfulBrowser(isHeadful: boolean);
     get isHeadfulBrowser(): boolean;
     get browserBinaryPath(): string;
-    set reportLeaksInTimers(flag: boolean);
+    set reportLeaksInTimers(shouldReport: boolean);
     get reportLeaksInTimers(): boolean;
     setDevice(deviceName: string, options?: {
         manualOverride?: boolean;

package/dist/lib/Config.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -50,7 +50,7 @@ class MemLabConfig {
     initInternalConfigs() {
         // DO NOT SET PARAMETER HERE
         this._isFullRun = false;
-        this._reportLeaksInTimers = false;
+        this._reportLeaksInTimers = true;
         this._deviceManualOverridden = false;
         this._timerNodes = ['Pending activities'];
         this._timerEdges = [];
@@ -58,13 +58,15 @@ class MemLabConfig {
         this.targetApp = Constant_1.default.unset;
         this.targetTab = Constant_1.default.unset;
         this.analysisMode = Constant_1.default.unset;
-        this.focusFiberNodeId = 1;
+        this.focusFiberNodeId = -1;
         this.isFB = Constant_1.default.isFB;
         // assuming the Evn doesn't support Xvfb before checking
         this.machineSupportsXVFB = false;
         // by default we want to use Xvfb if the Env supports it
         this.useXVFB = true;
         this.specifiedEngine = false;
+        // set by the heap-analysis package if HeapConfig is used
+        this.heapConfig = null;
         // set puppeteer configuration
         this.puppeteerConfig = {
             headless: !this._isHeadfulBrowser,
@@ -126,7 +128,19 @@ class MemLabConfig {
         this.includeObjectInfoInTraceReturnChain = false;
         // by default halt the program when utils.haltOrThrow is calleds
         this.errorHandling = ErrorHandling.Halt;
+        // by default use clustering based on heurastics
+        this.isMLClustering = false;
+        // linkage max distance for caclulating distances among clusters
         this.mlClusteringLinkageMaxDistance = 0.7;
+        // TF/IDF maximum document frequency
+        this.mlMaxDF = 1;
+        // if true, evaluating results with sequential clustering
+        this.isSequentialClustering = false;
+        // split the sample leak traces into 4 smaller ones by default.
+        this.seqClusteringSplitCount = 4;
+        // if true, split dataset into trunks
+        // with random order for sequential clustering
+        this.seqClusteringIsRandomChunks = false;
     }
     // initialize configurable parameters
     init(options = {}) {
@@ -171,9 +185,9 @@ class MemLabConfig {
         // the # of retries when initial load fails
         this.initialLoadFailRetry = 2;
         // timeout for checking the presence of non-optional click target
-        this.presenceCheckTimeout = 120000;
+        this.presenceCheckTimeout = 2 * 60 * 1000;
         // default waiting time before exit when exception occurs during page interaction
-        this.delayBeforeExitUponException = 120 * 1000;
+        this.delayBeforeExitUponException = 2 * 60 * 1000;
         // Chrome window width
         this.windowWidth = windowWidth;
         // Chrome window height
@@ -299,7 +313,7 @@ class MemLabConfig {
     static getInstance() {
         if (!MemLabConfig.instance) {
             const config = new MemLabConfig();
-            // do not consider objects kept alive by timers as leaks
+            // consider objects kept alive by timers as leaks
             config.reportLeaksInTimers = true;
             // assign configuration to console manager
             Console_1.default.setConfig(config);
@@ -382,11 +396,8 @@ class MemLabConfig {
     get browserBinaryPath() {
         return path_1.default.join(this.browserDir, this.browser);
     }
-    set reportLeaksInTimers(flag) {
-        if (typeof flag !== 'boolean') {
-            return;
-        }
-        if (flag) {
+    set reportLeaksInTimers(shouldReport) {
+        if (shouldReport) {
             this.removeFromSet(this.nodeNameBlockList, this._timerNodes);
             this.removeFromSet(this.edgeNameBlockList, this._timerEdges);
         }
@@ -394,7 +405,7 @@ class MemLabConfig {
             this.addToSet(this.nodeNameBlockList, this._timerNodes);
             this.addToSet(this.edgeNameBlockList, this._timerEdges);
         }
-        this._reportLeaksInTimers = flag;
+        this._reportLeaksInTimers = shouldReport;
     }
     get reportLeaksInTimers() {
         return this._reportLeaksInTimers;

package/dist/lib/Console.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import { Chalk } from 'chalk';
 import type { MemLabConfig } from './Config';

package/dist/lib/Console.js

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 'use strict';
 var __importDefault = (this && this.__importDefault) || function (mod) {

package/dist/lib/Constant.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 declare const constants: {
     isFB: boolean;

package/dist/lib/Constant.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const InternalValueSetter_1 = require("./InternalValueSetter");

package/dist/lib/FileManager.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { MemLabConfig } from './Config';
 import type { AnyValue, Optional } from './Types';

package/dist/lib/FileManager.js

@@ -5,8 +5,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -41,8 +41,10 @@ class FileManager {
         return path_1.default.join(this.getTmpDir(), 'memlab');
     }
     generateTmpHeapDir() {
-        const dirPath = path_1.default.join(this.getTmpDir(), Utils_1.default.getUniqueID());
-        fs_extra_1.default.mkdirSync(dirPath);
+        const dirPath = path_1.default.join(this.getTmpDir(), 'memlab-' + Utils_1.default.getUniqueID());
+        if (!fs_extra_1.default.existsSync(dirPath)) {
+            fs_extra_1.default.mkdirSync(dirPath);
+        }
         return dirPath;
     }
     getWorkDir(options = {}) {

package/dist/lib/HeapAnalyzer.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 import type { E2EStepInfo, HeapNodeIdSet, IHeapNode, IHeapSnapshot, IMemoryAnalystOptions, IMemoryAnalystSnapshotDiff, LeakTracePathItem, Optional, IOveralLeakInfo, TraceCluster, ISerializedInfo } from './Types';
 import TraceFinder from '../paths/TraceFinder';
@@ -41,6 +41,14 @@ declare class MemoryAnalyst {
     searchLeakedTraces(leakedNodeIds: HeapNodeIdSet, snapshot: IHeapSnapshot): Promise<{
         paths: LeakTracePathItem[];
     }>;
+    /**
+     * Given a set of heap object ids, cluster them based on the similarity
+     * of their retainer traces and return a
+     * @param leakedNodeIds
+     * @param snapshot
+     * @returns
+     */
+    clusterHeapObjects(objectIds: HeapNodeIdSet, snapshot: IHeapSnapshot): TraceCluster[];
     serializeClusterUpdate(clusters: TraceCluster[], options?: {
         reclusterOnly?: boolean;
     }): Promise<void>;

package/dist/lib/HeapAnalyzer.js

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
  * @format
+ * @oncall ws_labs
  */
 'use strict';
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -250,9 +250,17 @@ class MemoryAnalyst {
             let snapshotLeakedHeapNodeIdSet = new Set();
             let nodeIdsInSnapshots = [];
             let snapshot;
+            // if specified a heap file
             if (options.file) {
                 const opt = { buildNodeIdIndex: true, verbose: true };
                 snapshot = yield Utils_1.default.getSnapshotFromFile(options.file, opt);
+                // if running in interactive heap analysis mode
+            }
+            else if (Config_1.default.heapConfig &&
+                Config_1.default.heapConfig.isCliInteractiveMode &&
+                Config_1.default.heapConfig.currentHeap) {
+                snapshot = Config_1.default.heapConfig.currentHeap;
+                // otherwise diff heap snapshots
             }
             else {
                 Utils_1.default.checkSnapshots();
@@ -368,14 +376,17 @@ class MemoryAnalyst {
     // initialize the path finder
     preparePathFinder(snapshot) {
         const finder = new TraceFinder_1.default();
-        // shortest path for all nodes
-        finder.annotateShortestPaths(snapshot);
-        // dominator and retained size
-        finder.calculateAllNodesRetainedSizes(snapshot);
-        // mark detached Fiber nodes
-        Utils_1.default.markAllDetachedFiberNode(snapshot);
-        // mark alternate Fiber nodes
-        Utils_1.default.markAlternateFiberNode(snapshot);
+        if (!snapshot.isProcessed) {
+            // shortest path for all nodes
+            finder.annotateShortestPaths(snapshot);
+            // dominator and retained size
+            finder.calculateAllNodesRetainedSizes(snapshot);
+            // mark detached Fiber nodes
+            Utils_1.default.markAllDetachedFiberNode(snapshot);
+            // mark alternate Fiber nodes
+            Utils_1.default.markAlternateFiberNode(snapshot);
+            snapshot.isProcessed = true;
+        }
         return finder;
     }
     // summarize the page interaction and dump to the leak text summary file
@@ -636,6 +647,7 @@ class MemoryAnalyst {
                     ? new MLTraceSimilarityStrategy_1.default()
                     : undefined,
             });
+            Console_1.default.midLevel(`MemLab found ${clusters.length} leak(s)`);
             yield this.serializeClusterUpdate(clusters);
             if (Config_1.default.logUnclassifiedClusters) {
                 // cluster traces from the current run
@@ -647,6 +659,36 @@ class MemoryAnalyst {
             };
         });
     }
+    /**
+     * Given a set of heap object ids, cluster them based on the similarity
+     * of their retainer traces and return a
+     * @param leakedNodeIds
+     * @param snapshot
+     * @returns
+     */
+    clusterHeapObjects(objectIds, snapshot) {
+        const finder = this.preparePathFinder(snapshot);
+        const paths = [];
+        let i = 0;
+        // analysis for each node
+        Utils_1.default.applyToNodes(objectIds, snapshot, node => {
+            if (++i % 11 === 0) {
+                Console_1.default.overwrite(`progress: ${i} / ${objectIds.size} @${node.id}`);
+            }
+            // BFS search for path from the leaked node to GC roots
+            const p = finder.getPathToGCRoots(snapshot, node);
+            if (p) {
+                paths.push(p);
+            }
+        }, { reverse: true });
+        // cluster traces from the current run
+        const clusters = TraceBucket_1.default.clusterPaths(paths, snapshot, this.aggregateDominatorMetrics, {
+            strategy: Config_1.default.isMLClustering
+                ? new MLTraceSimilarityStrategy_1.default()
+                : undefined,
+        });
+        return clusters;
+    }
     serializeClusterUpdate(clusters, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             // load existing clusters

package/dist/lib/HeapParser.d.ts

@@ -4,9 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @emails oncall+ws_labs
- * @lightSyntaxTransform
  * @format
+ * @lightSyntaxTransform
+ * @oncall ws_labs
  */
 import type { IHeapSnapshot } from './Types';
 declare function getNodeIdsFromFile(file: string, _options?: {}): Promise<Set<number>>;