@memlab/core 1.1.12 → 1.1.16

package/README.md

@@ -3,5 +3,5 @@
 This is the memlab core library. It contains V8/Hermes heap snapshot parser, core algorithms, leak trace clustering, utilities, and config.
 
 ## Online Resources
-* [Official Website and Demo](https://facebookincubator.github.io/memlab)
-* [Documentation](https://facebookincubator.github.io/memlab/docs/intro)
+* [Official Website and Demo](https://facebook.github.io/memlab)
+* [Documentation](https://facebook.github.io/memlab/docs/intro)

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

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 export {};
 //# sourceMappingURL=HeapParser.test.d.ts.map

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

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -39,7 +39,7 @@ test('Capture inserted object', () => __awaiter(void 0, void 0, void 0, function
     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* () {
+test('Does not capture transient object', () => __awaiter(void 0, void 0, void 0, function* () {
     class TestObject {
         constructor() {
             this.arr1 = [1, 2, 3];

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

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 export {};
 //# sourceMappingURL=NodeHeap.test.d.ts.map

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

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 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/__tests__/parser/StringNode.test.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 export {};
 //# sourceMappingURL=StringNode.test.d.ts.map

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

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 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/__tests__/parser/traverse/HeapNodeTraverse.test.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { AnyValue } from '../../../lib/Types';
 declare global {

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

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 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/__tests__/utils/utils.test.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 export {};
 //# sourceMappingURL=utils.test.d.ts.map

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

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 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

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 /** @internal */
 export declare function registerPackage(): Promise<void>;
@@ -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

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 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.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/BaseOption.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { ParsedArgs } from 'minimist';
 import type { AnyRecord } from './Types';

package/dist/lib/BaseOption.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 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

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { ConsoleMessage, Dialog, LaunchOptions, Page } from 'puppeteer';
 import type { IBrowserInfo } from './Types';

package/dist/lib/BrowserInfo.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 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

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { LaunchOptions, Permission } from 'puppeteer';
 import type { AnyFunction, AnyValue, IClusterStrategy, IRunningMode, IScenario, Nullable, Optional, QuickExperiment, ILeakFilter, IPackageInfo } from './Types';
@@ -52,6 +52,7 @@ export declare class MemLabConfig {
     _isFullRun: boolean;
     _scenario: Optional<IScenario>;
     _isHeadfulBrowser: boolean;
+    _disableWebSecurity: boolean;
     _browser: string;
     snapshotHasDetachedness: boolean;
     specifiedEngine: boolean;
@@ -69,6 +70,7 @@ export declare class MemLabConfig {
     dataBaseDir: string;
     userDataDir: string;
     curDataDir: string;
+    webSourceDir: string;
     runMetaFile: string;
     snapshotSequenceFile: string;
     exploreResultFile: string;
@@ -186,15 +188,20 @@ 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;
     getAdditionalConfigInContinuousTest(_app: string, _interaction: string): string[];
     private static instance;
     static getInstance(): MemLabConfig;
-    static resetConfigWithTranscientDir(): MemLabConfig;
+    static resetConfigWithTransientDir(): MemLabConfig;
     private haltOrThrow;
     setTarget(app: string, tab: string): void;
     set scenario(scenario: Optional<IScenario>);
@@ -205,6 +212,8 @@ export declare class MemLabConfig {
     get browser(): string;
     set isHeadfulBrowser(isHeadful: boolean);
     get isHeadfulBrowser(): boolean;
+    set disableWebSecurity(disable: boolean);
+    get disableWebSecurity(): boolean;
     get browserBinaryPath(): string;
     set reportLeaksInTimers(shouldReport: boolean);
     get reportLeaksInTimers(): boolean;

package/dist/lib/Config.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -55,6 +55,7 @@ class MemLabConfig {
         this._timerNodes = ['Pending activities'];
         this._timerEdges = [];
         this._isHeadfulBrowser = false;
+        this._disableWebSecurity = false;
         this.targetApp = Constant_1.default.unset;
         this.targetTab = Constant_1.default.unset;
         this.analysisMode = Constant_1.default.unset;
@@ -115,6 +116,10 @@ class MemLabConfig {
         this.snapshotHasDetachedness = false;
         // by default running in regular mode
         this.runningMode = RunningModes_1.default.get('regular', this);
+        // 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 = [];
         // mute the console output, if enabled
@@ -136,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;
@@ -322,9 +334,9 @@ class MemLabConfig {
         }
         return MemLabConfig.instance;
     }
-    static resetConfigWithTranscientDir() {
+    static resetConfigWithTransientDir() {
         const config = MemLabConfig.getInstance();
-        FileManager_1.default.initDirs(config, { transcient: true });
+        FileManager_1.default.initDirs(config, { transient: true });
         return config;
     }
     haltOrThrow(msg, 
@@ -393,6 +405,27 @@ class MemLabConfig {
     get isHeadfulBrowser() {
         return this._isHeadfulBrowser;
     }
+    set disableWebSecurity(disable) {
+        this._disableWebSecurity = disable;
+        const args = this.puppeteerConfig.args;
+        const flag = '--disable-web-security';
+        const index = args.indexOf(flag);
+        if (disable) {
+            // add the flag
+            if (index < 0) {
+                args.push(flag);
+            }
+        }
+        else {
+            // remove the flag
+            if (index >= 0) {
+                args.splice(index, 1);
+            }
+        }
+    }
+    get disableWebSecurity() {
+        return this._disableWebSecurity;
+    }
     get browserBinaryPath() {
         return path_1.default.join(this.browserDir, this.browser);
     }

package/dist/lib/Console.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import { Chalk } from 'chalk';
 import type { MemLabConfig } from './Config';

package/dist/lib/Console.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 'use strict';
 var __importDefault = (this && this.__importDefault) || function (mod) {

package/dist/lib/Constant.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 declare const constants: {
     isFB: boolean;

package/dist/lib/Constant.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const InternalValueSetter_1 = require("./InternalValueSetter");

package/dist/lib/FileManager.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { MemLabConfig } from './Config';
 import type { AnyValue, Optional } from './Types';
@@ -13,13 +13,13 @@ import type { AnyValue, Optional } from './Types';
 export declare type FileOption = {
     workDir?: Optional<string>;
     clear?: boolean;
-    transcient?: boolean;
+    transient?: boolean;
 };
 /** @internal */
 export declare class FileManager {
     getDefaultWorkDir(): string;
     generateTmpHeapDir(): string;
-    private static transcientInstanceIdx;
+    private static transientInstanceIdx;
     getWorkDir(options?: FileOption): string;
     getChromeBinaryZipFile(): string;
     getChromeBinaryTimeStampFile(): string;
@@ -30,6 +30,8 @@ export declare class FileManager {
     getClusterSampleDataDir(): string;
     getUserDataDir(options: FileOption): string;
     getCurDataDir(options: FileOption): string;
+    getWebSourceDir(options?: FileOption): string;
+    getWebSourceMetaFile(options?: FileOption): string;
     getPersistDataDir(options: FileOption): string;
     getLoggerOutDir(options?: FileOption): string;
     getTraceClustersDir(options?: FileOption): string;

package/dist/lib/FileManager.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -52,9 +52,9 @@ class FileManager {
         if (options.workDir) {
             return path_1.default.resolve(options.workDir);
         }
-        // transcient options supercedes other the CLI options
-        if (options.transcient) {
-            const idx = ++FileManager.transcientInstanceIdx;
+        // transient options supercedes other the CLI options
+        if (options.transient) {
+            const idx = ++FileManager.transientInstanceIdx;
             const instanceId = `${process.pid}-${Date.now()}-${idx}`;
             const workDir = path_1.default.join(this.getTmpDir(), `memlab-${instanceId}`);
             return path_1.default.resolve(workDir);
@@ -92,6 +92,12 @@ class FileManager {
     getCurDataDir(options) {
         return path_1.default.join(this.getDataBaseDir(options), 'cur');
     }
+    getWebSourceDir(options = {}) {
+        return path_1.default.join(this.getCurDataDir(options), 'code');
+    }
+    getWebSourceMetaFile(options = {}) {
+        return path_1.default.join(this.getWebSourceDir(options), 'files.json');
+    }
     getPersistDataDir(options) {
         return path_1.default.join(this.getDataBaseDir(options), 'persist');
     }
@@ -205,6 +211,7 @@ class FileManager {
         if (!fs_extra_1.default.existsSync(curDataDir)) {
             return;
         }
+        this.emptyDirIfExists(this.getWebSourceDir(options));
         const dataSuffix = ['.heapsnapshot', '.json', '.png'];
         const files = fs_extra_1.default.readdirSync(curDataDir);
         for (const file of files) {
@@ -286,6 +293,7 @@ class FileManager {
         config.userDataDir = joinAndProcessDir(options, this.getUserDataDir(options));
         const outDir = joinAndProcessDir(options, this.getDataOutDir(options));
         config.curDataDir = joinAndProcessDir(options, this.getCurDataDir(options));
+        config.webSourceDir = joinAndProcessDir(options, this.getWebSourceDir(options));
         config.dataBuilderDataDir = joinAndProcessDir(options, config.dataBaseDir, 'dataBuilder');
         config.persistentDataDir = joinAndProcessDir(options, this.getPersistDataDir(options));
         config.consoleLogFile = path_1.default.join(config.curDataDir, 'console-log.txt');
@@ -320,5 +328,5 @@ class FileManager {
     }
 }
 exports.FileManager = FileManager;
-FileManager.transcientInstanceIdx = 0;
+FileManager.transientInstanceIdx = 0;
 exports.default = new FileManager();

package/dist/lib/HeapAnalyzer.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { E2EStepInfo, HeapNodeIdSet, IHeapNode, IHeapSnapshot, IMemoryAnalystOptions, IMemoryAnalystSnapshotDiff, LeakTracePathItem, Optional, IOveralLeakInfo, TraceCluster, ISerializedInfo } from './Types';
 import TraceFinder from '../paths/TraceFinder';

package/dist/lib/HeapAnalyzer.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 'use strict';
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

package/dist/lib/HeapParser.d.ts

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { IHeapSnapshot } from './Types';
 declare function getNodeIdsFromFile(file: string, _options?: {}): Promise<Set<number>>;

package/dist/lib/HeapParser.js

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 'use strict';
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

package/dist/lib/InternalValueSetter.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 /** @internal */
 export declare abstract class InternalValueSetter<T> {

package/dist/lib/InternalValueSetter.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/lib/NodeHeap.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { IHeapSnapshot } from './Types';
 /**

package/dist/lib/NodeHeap.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 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/PackageInfoLoader.js

@@ -20,7 +20,7 @@ exports.PackageInfoLoader = void 0;
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));

package/dist/lib/ProcessManager.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { Command, Optional } from './Types';
 declare type Options = {

package/dist/lib/ProcessManager.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/lib/Serializer.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import { E2EStepInfo, HeapNodeIdSet, IHeapEdge, IHeapNode, IHeapSnapshot, ISerializedInfo, LeakTracePathItem, Nullable } from './Types';
 declare type JSONifyArgs = {