@memlab/core 1.1.14 → 1.1.16

package/dist/index.d.ts

@@ -50,5 +50,9 @@ export * from './lib/PackageInfoLoader';
 /** @internal */
 export { default as SequentialClustering } from './trace-cluster/SequentialClustering';
 /** @internal */
+export { default as MultiIterationSeqClustering } from './trace-cluster/MultiIterationSeqClustering';
+/** @internal */
 export { default as TraceFinder } from './paths/TraceFinder';
+/** @internal */
+export * from './trace-cluster/ClusterUtils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -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.TraceFinder = 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;
+exports.TraceFinder = exports.MultiIterationSeqClustering = 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 */
@@ -101,5 +101,10 @@ __exportStar(require("./lib/PackageInfoLoader"), exports);
 var SequentialClustering_1 = require("./trace-cluster/SequentialClustering");
 Object.defineProperty(exports, "SequentialClustering", { enumerable: true, get: function () { return __importDefault(SequentialClustering_1).default; } });
 /** @internal */
+var MultiIterationSeqClustering_1 = require("./trace-cluster/MultiIterationSeqClustering");
+Object.defineProperty(exports, "MultiIterationSeqClustering", { enumerable: true, get: function () { return __importDefault(MultiIterationSeqClustering_1).default; } });
+/** @internal */
 var TraceFinder_1 = require("./paths/TraceFinder");
 Object.defineProperty(exports, "TraceFinder", { enumerable: true, get: function () { return __importDefault(TraceFinder_1).default; } });
+/** @internal */
+__exportStar(require("./trace-cluster/ClusterUtils"), exports);

package/dist/lib/Config.d.ts

@@ -188,9 +188,13 @@ export declare class MemLabConfig {
     mlClusteringLinkageMaxDistance: number;
     mlMaxDF: number;
     isSequentialClustering: boolean;
+    isMultiIterationSeqClustering: boolean;
     seqClusteringSplitCount: number;
+    multiIterSeqClusteringIteration: number;
+    multiIterSeqClusteringSampleSize: number;
     seqClusteringIsRandomChunks: boolean;
     instrumentJS: boolean;
+    interceptScript: boolean;
     constructor(options?: ConfigOption);
     private initInternalConfigs;
     private init;

package/dist/lib/Config.js

@@ -116,7 +116,9 @@ class MemLabConfig {
         this.snapshotHasDetachedness = false;
         // by default running in regular mode
         this.runningMode = RunningModes_1.default.get('regular', this);
-        // intercept and rewrite JavaScript Code in browser
+        // intercept and log JavaScript Code in browser
+        this.interceptScript = false;
+        // rewrite JavaScript Code in browser
         this.instrumentJS = false;
         // external heap snapshot paths, if enabled
         this.externalSnapshotFilePaths = [];
@@ -139,8 +141,15 @@ class MemLabConfig {
         this.mlMaxDF = 1;
         // if true, evaluating results with sequential clustering
         this.isSequentialClustering = false;
+        // if true, evaluating results with sequential
+        // clustering with multiple iterations
+        this.isMultiIterationSeqClustering = false;
         // split the sample leak traces into 4 smaller ones by default.
         this.seqClusteringSplitCount = 4;
+        // the number of iterations for multi-iteration sequential clustering
+        this.multiIterSeqClusteringIteration = 1;
+        // the number of trace samples to retain from each cluster
+        this.multiIterSeqClusteringSampleSize = Infinity;
         // if true, split dataset into trunks
         // with random order for sequential clustering
         this.seqClusteringIsRandomChunks = false;

package/dist/lib/Serializer.js

@@ -274,7 +274,7 @@ function JSONifyCode(node, args, options) {
 }
 function JSONifyContext(node, args, options) {
     const info = Object.create(null);
-    const key = 'variables in scope (used by nested closures)';
+    const key = 'variables in defining scope (used by nested closures)';
     const closure_vars = (info[key] = Object.create(null));
     iterateSelectedEdges(node, (edge) => {
         const key = filterJSONPropName(edge.name_or_index);

package/dist/lib/Utils.js

@@ -540,7 +540,10 @@ function getScenarioName(scenario) {
     if (!scenario.name) {
         return Constant_1.default.namePrefixForScenarioFromFile;
     }
-    return Constant_1.default.namePrefixForScenarioFromFile + '-' + scenario.name();
+    if (Constant_1.default.namePrefixForScenarioFromFile.length > 0) {
+        return Constant_1.default.namePrefixForScenarioFromFile + '-' + scenario.name();
+    }
+    return scenario.name();
 }
 function handleSnapshotError(e) {
     haltOrThrow(e, {
@@ -821,8 +824,11 @@ function extractHTMLElementNodeInfo(node) {
     return `${node.name} ${extractFiberNodeInfo(reactFiberEdge.toNode)}`;
 }
 function hasOnlyWeakReferrers(node) {
-    const referrer = node.findAnyReferrer((edge) => edge.type !== 'weak' && edge.type !== 'shortcut');
-    return !!referrer;
+    const referrer = node.findAnyReferrer(
+    // shortcut references are added by JS engine
+    // GC won't consider shortcut as a retaining edge
+    (edge) => edge.type !== 'weak' && edge.type !== 'shortcut');
+    return referrer == null;
 }
 function getRunMetaFilePath() {
     return Config_1.default.useExternalSnapshot

package/dist/trace-cluster/ClusterUtils.d.ts

@@ -7,8 +7,22 @@
  * @format
  * @oncall web_perf_infra
  */
+import type { LeakTrace } from '../lib/Types';
 declare const _default: {
-    isSimilarTrace: (t1: import("..").LeakTrace, t2: import("..").LeakTrace) => boolean;
+    isSimilarTrace: (t1: LeakTrace, t2: LeakTrace) => boolean;
 };
 export default _default;
+/**
+ * const elements = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+ * randomChunks(elements, 3) -> [[4, 8, 3], [9, 5, 1], [2, 6, 7, 10]]
+ * @internal
+ */
+export declare const randomChunks: <T>(items: T[], n: number) => T[][];
+/**
+ * chunks(elements, 3) -> [[1, 2, 3], [4, 5, 6], [7, 8, 9, 10]]
+ * @internal
+ */
+export declare const chunks: <T>(items: T[], n: number) => T[][];
+/** @internal*/
+export declare const lastNodeFromTrace: (trace: LeakTrace) => import("../lib/Types").LeakTraceElement;
 //# sourceMappingURL=ClusterUtils.d.ts.map

package/dist/trace-cluster/ClusterUtils.js

@@ -12,6 +12,48 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.lastNodeFromTrace = exports.chunks = exports.randomChunks = void 0;
 const ClusterUtilsHelper_1 = __importDefault(require("./ClusterUtilsHelper"));
 const ClusteringHeuristics_1 = __importDefault(require("./ClusteringHeuristics"));
 exports.default = ClusterUtilsHelper_1.default.initialize(ClusteringHeuristics_1.default);
+/**
+ * const elements = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+ * randomChunks(elements, 3) -> [[4, 8, 3], [9, 5, 1], [2, 6, 7, 10]]
+ * @internal
+ */
+const randomChunks = (items, n) => {
+    const array = [...items];
+    const size = Math.floor(array.length / n);
+    const chunks = [];
+    for (let i = 0; i < n - 1; i++) {
+        const chunk = [];
+        for (let j = 0; j < size; j++) {
+            const idx = Math.floor(Math.random() * array.length);
+            chunk[j] = array[idx];
+            array.splice(idx, 1);
+        }
+        chunks.push(chunk);
+    }
+    chunks.push(array);
+    return chunks;
+};
+exports.randomChunks = randomChunks;
+/**
+ * chunks(elements, 3) -> [[1, 2, 3], [4, 5, 6], [7, 8, 9, 10]]
+ * @internal
+ */
+const chunks = (items, n) => {
+    const array = [...items];
+    const size = Math.floor(array.length / n);
+    const chunks = [];
+    for (let i = 0; i < n - 1; i++) {
+        const chunk = array.splice(0, size);
+        chunks.push(chunk);
+    }
+    chunks.push(array);
+    return chunks;
+};
+exports.chunks = chunks;
+/** @internal*/
+const lastNodeFromTrace = (trace) => trace[trace.length - 1];
+exports.lastNodeFromTrace = lastNodeFromTrace;

package/dist/trace-cluster/MultiIterationSeqClustering.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall web_perf_infra
+ */
+import type { LeakTrace } from '../lib/Types';
+declare type ClusterOption = {
+    numberOfIteration?: number;
+    numberOfTraceToRetainInCluster?: number;
+};
+export default class MultiIterationSeqClustering {
+    private traceSimilarity;
+    constructor();
+    cluster(newLeakTraces: LeakTrace[], options?: ClusterOption): LeakTrace[][];
+}
+export {};
+//# sourceMappingURL=MultiIterationSeqClustering.d.ts.map

package/dist/trace-cluster/MultiIterationSeqClustering.js

@@ -0,0 +1,112 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @oncall web_perf_infra
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ClusterUtils_1 = require("./ClusterUtils");
+const TraceSimilarityStrategy_1 = __importDefault(require("./strategies/TraceSimilarityStrategy"));
+const MLTraceSimilarityStrategy_1 = __importDefault(require("./strategies/MLTraceSimilarityStrategy"));
+const Config_1 = __importDefault(require("../lib/Config"));
+const Utils_1 = __importDefault(require("../lib/Utils"));
+const Console_1 = __importDefault(require("../lib/Console"));
+class MultiIterationSeqClustering {
+    constructor() {
+        this.traceSimilarity = Config_1.default.isMLClustering
+            ? new MLTraceSimilarityStrategy_1.default()
+            : new TraceSimilarityStrategy_1.default();
+    }
+    cluster(newLeakTraces, options = {}) {
+        const maxNumOfSampleTraceInCluster = positiveIntOrDefaultValue(options.numberOfTraceToRetainInCluster, Infinity);
+        const numIteration = positiveIntOrDefaultValue(options.numberOfIteration, 1);
+        if (Config_1.default.verbose) {
+            Console_1.default.lowLevel(`maxNumOfSampleTraceInCluster: ${maxNumOfSampleTraceInCluster}`);
+            Console_1.default.lowLevel(`numIteration: ${numIteration}`);
+        }
+        // build trace and id mapping
+        const traceId2RepTraceId = new Map();
+        const traceId2Trace = new Map();
+        for (const trace of newLeakTraces) {
+            traceId2Trace.set(traceId(trace), trace);
+        }
+        // split all traces into several batches
+        const splitFn = Config_1.default.seqClusteringIsRandomChunks ? ClusterUtils_1.randomChunks : ClusterUtils_1.chunks;
+        const traceGroups = splitFn(newLeakTraces, numIteration);
+        let clusteredTraceSamples = [];
+        for (let iter = 0; iter < numIteration; ++iter) {
+            Console_1.default.overwrite(`Iteration: ${iter + 1}`);
+            // mix the current traces to cluster with all clustered trace samples
+            const curTraceGroup = traceGroups[iter].concat(clusteredTraceSamples);
+            // cluster the trace group
+            const { allClusters: clusters } = this.traceSimilarity.diffTraces(curTraceGroup, []);
+            // assign trace id to representative trace id
+            updateTraceId2RepTraceIdMap(clusters, traceId2RepTraceId);
+            // sample each group
+            for (let i = 0; i < clusters.length; ++i) {
+                clusters[i] = clusters[i].slice(0, maxNumOfSampleTraceInCluster);
+            }
+            // update samples
+            clusteredTraceSamples = clusters.reduce((acc, cluster) => acc.concat(cluster), []);
+        }
+        // rebuild full clusters based on the mappings
+        const repTraceId2Cluster = new Map();
+        for (const id of traceId2RepTraceId.keys()) {
+            const repTraceId = traceId2RepTraceId.get(id);
+            if (!repTraceId2Cluster.has(repTraceId)) {
+                repTraceId2Cluster.set(repTraceId, []);
+            }
+            const cluster = repTraceId2Cluster.get(repTraceId);
+            if (cluster.length === 0) {
+                const repTrace = traceId2Trace.get(repTraceId);
+                cluster.push(repTrace);
+            }
+            if (id !== repTraceId) {
+                const trace = traceId2Trace.get(id);
+                cluster.push(trace);
+            }
+        }
+        return Array.from(repTraceId2Cluster.values());
+    }
+}
+exports.default = MultiIterationSeqClustering;
+function traceId(trace) {
+    const lastNode = (0, ClusterUtils_1.lastNodeFromTrace)(trace);
+    if (lastNode.id == null) {
+        throw Utils_1.default.haltOrThrow('last node id missing');
+    }
+    return lastNode.id;
+}
+function updateTraceId2RepTraceIdMap(clusters, traceId2RepTraceId) {
+    for (const cluster of clusters) {
+        const repTrace = cluster[0];
+        for (const trace of cluster) {
+            traceId2RepTraceId.set(traceId(trace), traceId(repTrace));
+        }
+    }
+    // update trace id to representative trace id closure
+    for (const id of traceId2RepTraceId.keys()) {
+        const queue = [];
+        let cur = id;
+        let repTraceId = traceId2RepTraceId.get(cur);
+        while (repTraceId !== cur) {
+            queue.push(cur);
+            cur = repTraceId;
+            repTraceId = traceId2RepTraceId.get(cur);
+        }
+        for (const idInQueue of queue) {
+            traceId2RepTraceId.set(idInQueue, repTraceId);
+        }
+    }
+    return traceId2RepTraceId;
+}
+function positiveIntOrDefaultValue(v, d) {
+    return typeof v !== 'number' || v <= 0 ? d : v;
+}

package/dist/trace-cluster/TraceBucket.js

@@ -21,6 +21,7 @@ const TraceElement_1 = require("./TraceElement");
 const TraceSimilarityStrategy_1 = __importDefault(require("./strategies/TraceSimilarityStrategy"));
 const TraceAsClusterStrategy_1 = __importDefault(require("./strategies/TraceAsClusterStrategy"));
 const MLTraceSimilarityStrategy_1 = __importDefault(require("./strategies/MLTraceSimilarityStrategy"));
+const ClusterUtils_1 = require("./ClusterUtils");
 // sync up with html/intern/js/webspeed/memlab/lib/LeakCluster.js
 class NormalizedTrace {
     constructor(p = null, snapshot = null) {
@@ -166,10 +167,9 @@ class NormalizedTrace {
         return NormalizedTrace.clusteredLeakTracesToRecord(allClusters);
     }
     static clusteredLeakTracesToRecord(allClusters) {
-        const lastNodeFromTrace = (trace) => trace[trace.length - 1];
         const labaledLeakTraces = allClusters.reduce((acc, bucket) => {
-            const lastNodeFromFirstTrace = lastNodeFromTrace(bucket[0]);
-            bucket.map(lastNodeFromTrace).forEach(lastNodeInTrace => {
+            const lastNodeFromFirstTrace = (0, ClusterUtils_1.lastNodeFromTrace)(bucket[0]);
+            bucket.map(ClusterUtils_1.lastNodeFromTrace).forEach(lastNodeInTrace => {
                 if (lastNodeInTrace.id == null || lastNodeFromFirstTrace.id == null) {
                     throw new Error('node id not found in last node of the leak trace');
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/core",
-  "version": "1.1.14",
+  "version": "1.1.16",
   "license": "MIT",
   "description": "memlab core libraries",
   "author": "Liang Gong <lgong@fb.com>",