@memlab/api 1.0.0

package/README.md

@@ -0,0 +1,11 @@
+# `@memlab/api`
+
+> TODO: description
+
+## Usage
+
+```
+const api = require('@memlab/api');
+
+// TODO: DEMONSTRATE API
+```

package/dist/API.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import type { Page } from 'puppeteer';
+import type { ParsedArgs } from 'minimist';
+import type { AnyFunction, E2EStepInfo, IScenario, RunMetaInfo } from '@memlab/core';
+import { MemLabConfig } from '@memlab/core';
+import { TestPlanner } from '@memlab/e2e';
+import { BaseAnalysis } from '@memlab/heap-analysis';
+declare type APIOptions = {
+    testPlanner?: TestPlanner;
+    cache?: boolean;
+    config?: MemLabConfig;
+    evalInBrowserAfterInitLoad?: AnyFunction;
+};
+declare type RunOptions = {
+    scenario?: IScenario;
+    cookiesFile?: string;
+    evalInBrowserAfterInitLoad?: AnyFunction;
+    snapshotForEachStep?: boolean;
+};
+declare type RunResult = {
+    config: MemLabConfig;
+    tabsOrder: E2EStepInfo[];
+    metaInfo: RunMetaInfo;
+};
+export declare function run(options?: RunOptions): Promise<RunResult>;
+export declare function takeSnapshots(options?: RunOptions): Promise<RunResult>;
+export declare function analyze(runResult: RunResult, heapAnalyzer: BaseAnalysis, args?: ParsedArgs): Promise<void>;
+export declare function warmup(options?: APIOptions): Promise<void>;
+export declare function setupPage(page: Page, options?: APIOptions): Promise<void>;
+export declare function testInBrowser(options?: APIOptions): Promise<void>;
+export {};
+//# sourceMappingURL=API.d.ts.map

package/dist/API.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"API.d.ts","sourceRoot":"","sources":["../src/API.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,IAAI,EAAU,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,SAAS,EACT,WAAW,EAGZ,MAAM,cAAc,CAAC;AAEtB,OAAO,EAKL,YAAY,EACb,MAAM,cAAc,CAAC;AACtB,OAAO,EAEL,WAAW,EAGZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAGnD,aAAK,UAAU,GAAG;IAGhB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,0BAA0B,CAAC,EAAE,WAAW,CAAC;CAC1C,CAAC;AAEF,aAAK,UAAU,GAAG;IAChB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0BAA0B,CAAC,EAAE,WAAW,CAAC;IACzC,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF,aAAK,SAAS,GAAG;IACf,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,WAAW,EAAE,CAAC;IACzB,QAAQ,EAAE,WAAW,CAAC;CACvB,CAAC;AASF,wBAAsB,GAAG,CAAC,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,SAAS,CAAC,CActE;AAED,wBAAsB,aAAa,CACjC,OAAO,GAAE,UAAe,GACvB,OAAO,CAAC,SAAS,CAAC,CAapB;AAED,wBAAsB,OAAO,CAC3B,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,YAAY,EAC1B,IAAI,GAAE,UAAoB,GACzB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED,wBAAsB,MAAM,CAAC,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAuCpE;AAED,wBAAsB,SAAS,CAC7B,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,UAAe,GACvB,OAAO,CAAC,IAAI,CAAC,CAoBf;AAyBD,wBAAsB,aAAa,CAAC,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAkD3E"}

package/dist/API.js

@@ -0,0 +1,203 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testInBrowser = exports.setupPage = exports.warmup = exports.analyze = exports.takeSnapshots = exports.run = void 0;
+const core_1 = require("@memlab/core");
+const e2e_1 = require("@memlab/e2e");
+const APIUtils_1 = __importDefault(require("./lib/APIUtils"));
+function setConfigByRunOptions(config, options) {
+    config.isFullRun = !!options.snapshotForEachStep;
+}
+function run(options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = core_1.MemLabConfig.resetConfigWithTranscientDir();
+        setConfigByRunOptions(config, options);
+        config.externalCookiesFile = options.cookiesFile;
+        config.scenario = options.scenario;
+        const testPlanner = new e2e_1.TestPlanner({ config });
+        const { evalInBrowserAfterInitLoad } = options;
+        yield warmup({ testPlanner, config, evalInBrowserAfterInitLoad });
+        yield testInBrowser({ testPlanner, config, evalInBrowserAfterInitLoad });
+        return {
+            config,
+            tabsOrder: core_1.utils.loadTabsOrder(),
+            metaInfo: core_1.utils.loadRunMetaInfo(),
+        };
+    });
+}
+exports.run = run;
+function takeSnapshots(options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = core_1.MemLabConfig.resetConfigWithTranscientDir();
+        setConfigByRunOptions(config, options);
+        config.externalCookiesFile = options.cookiesFile;
+        config.scenario = options.scenario;
+        const testPlanner = new e2e_1.TestPlanner();
+        const { evalInBrowserAfterInitLoad } = options;
+        yield testInBrowser({ testPlanner, config, evalInBrowserAfterInitLoad });
+        return {
+            config,
+            tabsOrder: core_1.utils.loadTabsOrder(),
+            metaInfo: core_1.utils.loadRunMetaInfo(),
+        };
+    });
+}
+exports.takeSnapshots = takeSnapshots;
+function analyze(runResult, heapAnalyzer, args = { _: [] }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield heapAnalyzer.run({ args });
+    });
+}
+exports.analyze = analyze;
+function warmup(options = {}) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = (_a = options.config) !== null && _a !== void 0 ? _a : core_1.config;
+        if (config.verbose) {
+            core_1.info.lowLevel(`Xvfb: ${config.useXVFB}`);
+        }
+        const testPlanner = (_b = options.testPlanner) !== null && _b !== void 0 ? _b : e2e_1.defaultTestPlanner;
+        try {
+            if (config.skipWarmup) {
+                return;
+            }
+            const browser = yield APIUtils_1.default.getBrowser({ warmup: true });
+            const visitPlan = testPlanner.getVisitPlan();
+            config.setDevice(visitPlan.device);
+            const numOfWarmup = visitPlan.numOfWarmup || 3;
+            const promises = [];
+            for (let i = 0; i < numOfWarmup; ++i) {
+                promises.push(browser.newPage());
+            }
+            const pages = yield Promise.all(promises);
+            core_1.info.beginSection('warmup');
+            yield Promise.all(pages.map((page) => __awaiter(this, void 0, void 0, function* () {
+                yield setupPage(page, { cache: false });
+                const interactionManager = new e2e_1.E2EInteractionManager(page);
+                yield interactionManager.warmupInPage();
+            }))).catch(err => {
+                core_1.info.error(err.message);
+            });
+            core_1.info.endSection('warmup');
+            yield core_1.utils.closePuppeteer(browser, pages, { warmup: true });
+        }
+        catch (ex) {
+            const error = core_1.utils.getError(ex);
+            core_1.utils.checkUninstalledLibrary(error);
+            throw ex;
+        }
+    });
+}
+exports.warmup = warmup;
+function setupPage(page, options = {}) {
+    var _a, _b, _c;
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = (_a = options.config) !== null && _a !== void 0 ? _a : core_1.config;
+        const testPlanner = (_b = options.testPlanner) !== null && _b !== void 0 ? _b : e2e_1.defaultTestPlanner;
+        if (config.emulateDevice) {
+            yield page.emulate(config.emulateDevice);
+        }
+        if (config.defaultUserAgent) {
+            yield page.setUserAgent(config.defaultUserAgent);
+        }
+        // set login session
+        yield page.setCookie(...testPlanner.getCookies());
+        const cache = (_c = options.cache) !== null && _c !== void 0 ? _c : true;
+        yield page.setCacheEnabled(cache);
+        // automatically accept dialog
+        page.on('dialog', (dialog) => __awaiter(this, void 0, void 0, function* () {
+            yield dialog.accept();
+        }));
+    });
+}
+exports.setupPage = setupPage;
+function autoDismissDialog(page, options = {}) {
+    var _a;
+    const config = (_a = options.config) !== null && _a !== void 0 ? _a : core_1.config;
+    page.on('dialog', (dialog) => __awaiter(this, void 0, void 0, function* () {
+        if (config.verbose) {
+            core_1.info.lowLevel(`Browser dialog: ${dialog.message()}`);
+        }
+        yield dialog.dismiss();
+    }));
+}
+function initBrowserInfoInConfig(browser, options = {}) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = (_a = options.config) !== null && _a !== void 0 ? _a : core_1.config;
+        core_1.browserInfo.setPuppeteerConfig(config.puppeteerConfig);
+        const version = yield browser.version();
+        core_1.browserInfo.setBrowserVersion(version);
+        if (config.verbose) {
+            core_1.info.lowLevel(JSON.stringify(core_1.browserInfo, null, 2));
+        }
+    });
+}
+function testInBrowser(options = {}) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = (_a = options.config) !== null && _a !== void 0 ? _a : core_1.config;
+        if (config.verbose) {
+            core_1.info.lowLevel(`Xvfb: ${config.useXVFB}`);
+        }
+        const testPlanner = (_b = options.testPlanner) !== null && _b !== void 0 ? _b : e2e_1.defaultTestPlanner;
+        let interactionManager = null;
+        let xvfb = null;
+        try {
+            xvfb = e2e_1.Xvfb.startIfEnabled();
+            const browser = yield APIUtils_1.default.getBrowser();
+            const pages = yield browser.pages();
+            const page = pages.length > 0 ? pages[0] : yield browser.newPage();
+            interactionManager = new e2e_1.E2EInteractionManager(page);
+            if (options.evalInBrowserAfterInitLoad) {
+                interactionManager.setEvalFuncAfterInitLoad(options.evalInBrowserAfterInitLoad);
+            }
+            const visitPlan = testPlanner.getVisitPlan();
+            config.setDevice(visitPlan.device);
+            autoDismissDialog(page);
+            yield initBrowserInfoInConfig(browser);
+            core_1.browserInfo.monitorWebConsole(page);
+            yield setupPage(page, options);
+            yield interactionManager.visitAndGetSnapshots(options);
+            yield core_1.utils.closePuppeteer(browser, [page]);
+        }
+        catch (ex) {
+            const error = core_1.utils.getError(ex);
+            core_1.utils.checkUninstalledLibrary(error);
+            core_1.info.error(error.message);
+        }
+        finally {
+            if (interactionManager) {
+                interactionManager.clearCDPSession();
+            }
+            if (xvfb) {
+                xvfb.stop((err) => {
+                    if (err) {
+                        core_1.utils.haltOrThrow(err);
+                    }
+                });
+            }
+        }
+    });
+}
+exports.testInBrowser = testInBrowser;

package/dist/__tests__/API/E2EBasicAnalysis.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export {};
+//# sourceMappingURL=E2EBasicAnalysis.test.d.ts.map

package/dist/__tests__/API/E2EBasicAnalysis.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"E2EBasicAnalysis.test.d.ts","sourceRoot":"","sources":["../../../src/__tests__/API/E2EBasicAnalysis.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/__tests__/API/E2EBasicAnalysis.test.js

@@ -0,0 +1,65 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+const index_1 = require("../../index");
+const heap_analysis_1 = require("@memlab/heap-analysis");
+const E2ETestSettings_1 = require("./lib/E2ETestSettings");
+beforeEach(E2ETestSettings_1.testSetup);
+function inject() {
+    // @ts-ignore
+    window.injectHookForLink3 = () => {
+        // @ts-ignore
+        window.__injectedValue3 = {};
+    };
+    // @ts-ignore
+    window.injectHookForLink4 = () => {
+        // @ts-ignore
+        window.__injectedValue4 = {};
+        const __injectedTimeoutValue1 = { v: 0 };
+        setTimeout(() => {
+            __injectedTimeoutValue1.v = 1;
+        }, 1);
+    };
+}
+test('E2E SPA test hooks work as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    yield (0, index_1.run)({ scenario: E2ETestSettings_1.scenario, evalInBrowserAfterInitLoad: inject });
+    const snapshot = yield heap_analysis_1.PluginUtils.loadHeapSnapshot(E2ETestSettings_1.defaultAnalysisArgs);
+    let foundInjectedValueForLink3 = false;
+    let foundInjectedValueForLink4 = false;
+    let foundInjectedTimeoutValue1 = false;
+    snapshot.edges.forEach(e => {
+        if (e.name_or_index === '__injectedValue3') {
+            foundInjectedValueForLink3 = true;
+        }
+        if (e.name_or_index === '__injectedValue4') {
+            foundInjectedValueForLink4 = true;
+        }
+        if (e.name_or_index === '__injectedTimeoutValue1') {
+            foundInjectedTimeoutValue1 = true;
+        }
+    });
+    // link-3 is not clicked, so injectHookForLink3 is not executed
+    expect(foundInjectedValueForLink3).toBe(false);
+    // link-4 is clicked, so injectHookForLink3 should be executed
+    expect(foundInjectedValueForLink4).toBe(true);
+    // __injectedValue is a local variable, which should not be retained
+    expect(foundInjectedTimeoutValue1).toBe(false);
+}), E2ETestSettings_1.testTimeout);

package/dist/__tests__/API/E2EDetachedDOMAnalysis.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export {};
+//# sourceMappingURL=E2EDetachedDOMAnalysis.test.d.ts.map

package/dist/__tests__/API/E2EDetachedDOMAnalysis.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"E2EDetachedDOMAnalysis.test.d.ts","sourceRoot":"","sources":["../../../src/__tests__/API/E2EDetachedDOMAnalysis.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/__tests__/API/E2EDetachedDOMAnalysis.test.js

@@ -0,0 +1,49 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+const path_1 = __importDefault(require("path"));
+const index_1 = require("../../index");
+const E2ETestSettings_1 = require("./lib/E2ETestSettings");
+beforeEach(E2ETestSettings_1.testSetup);
+function inject() {
+    // @ts-ignore
+    window.injectHookForLink4 = () => {
+        // @ts-ignore
+        window.__injectedValue = document.createElement('table');
+    };
+}
+test('Detached DOM analysis works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield (0, index_1.run)({ scenario: E2ETestSettings_1.scenario, evalInBrowserAfterInitLoad: inject });
+    // test analysis from auto loading
+    let analysis = new index_1.DetachedDOMElementAnalysis();
+    yield analysis.run();
+    let domElems = analysis.getDetachedElements();
+    expect(domElems.some(node => node.name === 'Detached HTMLTableElement')).toBe(true);
+    // test analysis from file
+    const snapshotFile = path_1.default.join(result.config.curDataDir, 's3.heapsnapshot');
+    analysis = new index_1.DetachedDOMElementAnalysis();
+    yield analysis.analyzeSnapshotFromFile(snapshotFile);
+    domElems = analysis.getDetachedElements();
+    expect(domElems.some(node => node.name === 'Detached HTMLTableElement')).toBe(true);
+}), E2ETestSettings_1.testTimeout);

package/dist/__tests__/API/E2EDuplicateObjectAnalysis.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export {};
+//# sourceMappingURL=E2EDuplicateObjectAnalysis.test.d.ts.map

package/dist/__tests__/API/E2EDuplicateObjectAnalysis.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"E2EDuplicateObjectAnalysis.test.d.ts","sourceRoot":"","sources":["../../../src/__tests__/API/E2EDuplicateObjectAnalysis.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/__tests__/API/E2EDuplicateObjectAnalysis.test.js

@@ -0,0 +1,54 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const index_1 = require("../../index");
+const E2ETestSettings_1 = require("./lib/E2ETestSettings");
+beforeEach(E2ETestSettings_1.testSetup);
+function inject() {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    window.injectHookForLink4 = () => {
+        const arr = [];
+        for (let i = 0; i < 12345; ++i) {
+            arr.push({ v: i % 1 });
+        }
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        window.__injectedValue = arr;
+    };
+}
+test('Duplicate object analysis works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield (0, index_1.run)({ scenario: E2ETestSettings_1.scenario, evalInBrowserAfterInitLoad: inject });
+    // test analysis from auto loading
+    let analysis = new index_1.ObjectShallowAnalysis();
+    yield analysis.run();
+    let dupcatedObjectInfo = analysis.getTopDuplicatedObjectInCount();
+    expect(dupcatedObjectInfo[0].n).toBe(12345);
+    // test analysis from file
+    const snapshotFile = path_1.default.join(result.config.curDataDir, 's3.heapsnapshot');
+    analysis = new index_1.ObjectShallowAnalysis();
+    yield analysis.analyzeSnapshotFromFile(snapshotFile);
+    dupcatedObjectInfo = analysis.getTopDuplicatedObjectInCount();
+    expect(dupcatedObjectInfo[0].n).toBe(12345);
+}), E2ETestSettings_1.testTimeout);

package/dist/__tests__/API/E2ERunMultipleSnapshots.example.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export {};
+//# sourceMappingURL=E2ERunMultipleSnapshots.example.d.ts.map

package/dist/__tests__/API/E2ERunMultipleSnapshots.example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"E2ERunMultipleSnapshots.example.d.ts","sourceRoot":"","sources":["../../../src/__tests__/API/E2ERunMultipleSnapshots.example.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/__tests__/API/E2ERunMultipleSnapshots.example.js

@@ -0,0 +1,52 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../../index");
+const scenario = {
+    app: () => 'test-spa',
+    url: () => '',
+    action: (page) => __awaiter(void 0, void 0, void 0, function* () { return yield page.click('[data-testid="link-4"]'); }),
+    repeat: () => 4,
+};
+function inject() {
+    // @ts-ignore
+    window.injectHookForLink4 = () => {
+        class LeakObject {
+            constructor() {
+                this.value = `value: ${Math.random()}`;
+            }
+        }
+        // @ts-ignore
+        const leak = (window.__injectedValue = window.__injectedValue || []);
+        for (let i = 0; i < 10000; ++i) {
+            leak.push(new LeakObject());
+        }
+    };
+}
+const promise = (0, index_1.run)({
+    scenario,
+    evalInBrowserAfterInitLoad: inject,
+    snapshotForEachStep: true,
+});
+promise.then(() => {
+    // test analysis from auto loading
+    const analysis = new index_1.ShapeUnboundGrowthAnalysis();
+    analysis.run();
+});

package/dist/__tests__/API/E2ERunSingleSnapshot.example.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export {};
+//# sourceMappingURL=E2ERunSingleSnapshot.example.d.ts.map

package/dist/__tests__/API/E2ERunSingleSnapshot.example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"E2ERunSingleSnapshot.example.d.ts","sourceRoot":"","sources":["../../../src/__tests__/API/E2ERunSingleSnapshot.example.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/__tests__/API/E2ERunSingleSnapshot.example.js

@@ -0,0 +1,38 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const index_1 = require("../../index");
+const scenario = {
+    app: () => 'test-spa',
+    url: () => '',
+    action: (page) => __awaiter(void 0, void 0, void 0, function* () { return yield page.click('[data-testid="link-4"]'); }),
+};
+const promise = (0, index_1.run)({
+    scenario,
+});
+promise.then(result => {
+    const analysis = new index_1.StringAnalysis();
+    const snapshotFile = path_1.default.join(result.config.curDataDir, 's3.heapsnapshot');
+    analysis.analyzeSnapshotFromFile(snapshotFile);
+});

package/dist/__tests__/API/E2EShapeUnboundGrowthAnalysis.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export {};
+//# sourceMappingURL=E2EShapeUnboundGrowthAnalysis.test.d.ts.map

package/dist/__tests__/API/E2EShapeUnboundGrowthAnalysis.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"E2EShapeUnboundGrowthAnalysis.test.d.ts","sourceRoot":"","sources":["../../../src/__tests__/API/E2EShapeUnboundGrowthAnalysis.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/__tests__/API/E2EShapeUnboundGrowthAnalysis.test.js

@@ -0,0 +1,72 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+const path_1 = __importDefault(require("path"));
+const index_1 = require("../../index");
+const E2ETestSettings_1 = require("./lib/E2ETestSettings");
+beforeEach(E2ETestSettings_1.testSetup);
+function inject() {
+    // @ts-ignore
+    window.injectHookForLink4 = () => {
+        function LeakObject() {
+            // @ts-ignore
+            this.value = `value: ${Math.random()}`;
+        }
+        // @ts-ignore
+        const leak = (window.__injectedValue = window.__injectedValue || []);
+        for (let i = 0; i < 10000; ++i) {
+            // @ts-ignore
+            leak.push(new LeakObject());
+        }
+    };
+}
+test('Shape unbound analysis works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const repeatScenario = Object.assign({ repeat: () => 2 }, E2ETestSettings_1.scenario);
+    // test analysis from auto loading
+    const result = yield (0, index_1.run)({
+        scenario: repeatScenario,
+        evalInBrowserAfterInitLoad: inject,
+        snapshotForEachStep: true,
+    });
+    // test analysis from auto loading
+    let analysis = new index_1.ShapeUnboundGrowthAnalysis();
+    let shapeSummary = yield analysis.run();
+    expect(shapeSummary.reduce((acc, summary) => acc || summary.shape.includes('LeakObject'), false)).toBe(true);
+    // test analysis from file
+    const snapshotDir = path_1.default.join(result.config.curDataDir);
+    analysis = new index_1.ShapeUnboundGrowthAnalysis();
+    shapeSummary = yield analysis.analyzeSnapshotsInDirectory(snapshotDir);
+    expect(shapeSummary.some((summary) => summary.shape.includes('LeakObject'))).toBe(true);
+    // expect incorrect use of heap analysis to throw
+    const snapshotFile = path_1.default.join(result.config.curDataDir, 's3.heapsnapshot');
+    analysis = new index_1.ShapeUnboundGrowthAnalysis();
+    let isThrow = false;
+    try {
+        yield analysis.analyzeSnapshotFromFile(snapshotFile);
+    }
+    catch (ex) {
+        isThrow = true;
+    }
+    expect(isThrow).toBe(true);
+}), E2ETestSettings_1.testTimeout);

package/dist/__tests__/API/E2EStringAnalysis.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export {};
+//# sourceMappingURL=E2EStringAnalysis.test.d.ts.map

package/dist/__tests__/API/E2EStringAnalysis.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"E2EStringAnalysis.test.d.ts","sourceRoot":"","sources":["../../../src/__tests__/API/E2EStringAnalysis.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/dist/__tests__/API/E2EStringAnalysis.test.js

@@ -0,0 +1,66 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+const path_1 = __importDefault(require("path"));
+const index_1 = require("../../index");
+const E2ETestSettings_1 = require("./lib/E2ETestSettings");
+beforeEach(E2ETestSettings_1.testSetup);
+function inject() {
+    // @ts-ignore
+    window.injectHookForLink4 = () => {
+        const arr = [];
+        for (let i = 0; i < 10000; ++i) {
+            arr.push('duplicated string value' + (i % 1));
+        }
+        // @ts-ignore
+        window.__injectedValue = arr;
+    };
+}
+test('String analysis works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield (0, index_1.run)({ scenario: E2ETestSettings_1.scenario, evalInBrowserAfterInitLoad: inject });
+    // test analysis from auto loading
+    let analysis = new index_1.StringAnalysis();
+    yield analysis.run();
+    let dupStrings = analysis.getTopDuplicatedStringsInCount();
+    expect(dupStrings[0].n).toBe(10000);
+    expect(dupStrings[0].str).toBe('duplicated string value0');
+    // test analysis from file
+    const snapshotFile = path_1.default.join(result.config.curDataDir, 's3.heapsnapshot');
+    analysis = new index_1.StringAnalysis();
+    yield analysis.analyzeSnapshotFromFile(snapshotFile);
+    dupStrings = analysis.getTopDuplicatedStringsInCount();
+    expect(dupStrings[0].n).toBe(10000);
+    expect(dupStrings[0].str).toBe('duplicated string value0');
+    // expect incorrect use of heap analysis to throw
+    const snapshotDir = result.config.curDataDir;
+    analysis = new index_1.StringAnalysis();
+    let isThrow = false;
+    try {
+        yield analysis.analyzeSnapshotsInDirectory(snapshotDir);
+    }
+    catch (ex) {
+        isThrow = true;
+    }
+    expect(isThrow).toBe(true);
+}), E2ETestSettings_1.testTimeout);

package/dist/__tests__/API/lib/E2ETestSettings.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import type { Page } from 'puppeteer';
+export declare const testTimeout: number;
+export declare const defaultAnalysisArgs: {
+    args: {
+        _: never[];
+    };
+};
+export declare const scenario: {
+    app: () => string;
+    url: () => string;
+    action: (page: Page) => Promise<void>;
+};
+export declare const testSetup: () => void;
+//# sourceMappingURL=E2ETestSettings.d.ts.map

package/dist/__tests__/API/lib/E2ETestSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"E2ETestSettings.d.ts","sourceRoot":"","sources":["../../../../src/__tests__/API/lib/E2ETestSettings.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAGpC,eAAO,MAAM,WAAW,QAAgB,CAAC;AAEzC,eAAO,MAAM,mBAAmB;;;;CAAkB,CAAC;AAEnD,eAAO,MAAM,QAAQ;eACV,MAAM;eACN,MAAM;mBACM,IAAI,KAAG,QAAQ,IAAI,CAAC;CAE1C,CAAC;AAEF,eAAO,MAAM,SAAS,QAAO,IAK5B,CAAC"}

package/dist/__tests__/API/lib/E2ETestSettings.js

@@ -0,0 +1,36 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testSetup = exports.scenario = exports.defaultAnalysisArgs = exports.testTimeout = void 0;
+const core_1 = require("@memlab/core");
+exports.testTimeout = 5 * 60 * 1000;
+exports.defaultAnalysisArgs = { args: { _: [] } };
+exports.scenario = {
+    app: () => 'test-spa',
+    url: () => '',
+    action: (page) => __awaiter(void 0, void 0, void 0, function* () { return yield page.click('[data-testid="link-4"]'); }),
+};
+const testSetup = () => {
+    core_1.config.isTest = true;
+    core_1.config.useXVFB = false;
+    core_1.config.skipExtraOps = true;
+    core_1.config.errorHandling = core_1.ErrorHandling.Throw;
+};
+exports.testSetup = testSetup;

package/dist/__tests__/heap/E2EHeapParser.test.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import type { AnyValue } from '@memlab/core';
+declare global {
+    interface Window {
+        injected: AnyValue;
+    }
+}
+//# sourceMappingURL=E2EHeapParser.test.d.ts.map

package/dist/__tests__/heap/E2EHeapParser.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"E2EHeapParser.test.d.ts","sourceRoot":"","sources":["../../../src/__tests__/heap/E2EHeapParser.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,QAAQ,EAA2B,MAAM,cAAc,CAAC;AAOrE,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,QAAQ,EAAE,QAAQ,CAAC;KACpB;CACF"}

package/dist/__tests__/heap/E2EHeapParser.test.js

@@ -0,0 +1,57 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const HeapParserTestUtils_1 = require("./lib/HeapParserTestUtils");
+beforeEach(() => {
+    core_1.config.isTest = true;
+});
+const timeout = 5 * 60 * 1000;
+test('Capture numeric value from heap in browser', () => __awaiter(void 0, void 0, void 0, function* () {
+    const leakInjector = () => {
+        class TestObject {
+            constructor() {
+                this.numProp = 0.1;
+            }
+        }
+        window.injected = new TestObject();
+    };
+    const checker = (snapshot) => {
+        let detected = false;
+        snapshot.nodes.forEach((node) => {
+            if (node.name !== 'TestObject' || node.type !== 'object') {
+                return;
+            }
+            const refs = node.references;
+            for (const ref of refs) {
+                if (ref.name_or_index === 'numProp') {
+                    const node = ref.toNode;
+                    if (node.type === 'number' &&
+                        core_1.utils.getNumberNodeValue(node) === 0.1) {
+                        detected = true;
+                    }
+                    break;
+                }
+            }
+        });
+        return detected;
+    };
+    yield (0, HeapParserTestUtils_1.isExpectedSnapshot)(leakInjector, checker);
+}), timeout);

package/dist/__tests__/heap/lib/HeapParserTestUtils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import type { IHeapSnapshot } from '@memlab/core';
+export declare function isExpectedSnapshot(leakInjector: () => void, checkSnapshotCb: (snapshot: IHeapSnapshot) => boolean): Promise<void>;
+//# sourceMappingURL=HeapParserTestUtils.d.ts.map

package/dist/__tests__/heap/lib/HeapParserTestUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HeapParserTestUtils.d.ts","sourceRoot":"","sources":["../../../../src/__tests__/heap/lib/HeapParserTestUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAUhD,wBAAsB,kBAAkB,CACtC,YAAY,EAAE,MAAM,IAAI,EACxB,eAAe,EAAE,CAAC,QAAQ,EAAE,aAAa,KAAK,OAAO,GACpD,OAAO,CAAC,IAAI,CAAC,CAGf"}

package/dist/__tests__/heap/lib/HeapParserTestUtils.js

@@ -0,0 +1,99 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isExpectedSnapshot = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const core_1 = require("@memlab/core");
+const puppeteer = core_1.config.isFB
+    ? require('puppeteer-core')
+    : require('puppeteer');
+function isExpectedSnapshot(leakInjector, checkSnapshotCb) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const snapshot = yield getHeapSnapshot(leakInjector);
+        expect(checkSnapshotCb(snapshot)).toBe(true);
+    });
+}
+exports.isExpectedSnapshot = isExpectedSnapshot;
+function getHeapDirPrefix() {
+    const dir = path_1.default.join(core_1.config.dataBaseDir, 'gen-files');
+    if (!fs_1.default.existsSync(dir)) {
+        fs_1.default.mkdirSync(dir);
+    }
+    return dir;
+}
+function saveSnapshotToFile(page, file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        core_1.info.lowLevel(`saving heap snapshot to file ${file}`);
+        let heap = '';
+        const devtoolsProtocolClient = yield page.target().createCDPSession();
+        devtoolsProtocolClient.on('HeapProfiler.addHeapSnapshotChunk', data => {
+            heap += data.chunk;
+        });
+        yield devtoolsProtocolClient.send('HeapProfiler.takeHeapSnapshot', {
+            reportProgress: false,
+            captureNumericValue: true,
+        });
+        return new Promise((resolve, reject) => {
+            fs_1.default.writeFile(file, heap, 'UTF-8', err => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+    });
+}
+const TEST_URL = 'about:blank';
+function dumpHeap(snapshotFile, leakInjector) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const browser = yield puppeteer.launch(core_1.config.puppeteerConfig);
+        const page = yield browser.newPage();
+        // set page size
+        yield page.setViewport({
+            width: 1680,
+            height: 1050,
+            deviceScaleFactor: 1,
+        });
+        // visit page
+        yield page.goto(TEST_URL);
+        // insert a memory leak object
+        yield page.evaluate(leakInjector);
+        // take a heap snapshot
+        yield saveSnapshotToFile(page, snapshotFile);
+        yield browser.close();
+    });
+}
+let fileId = 0;
+function getHeapSnapshot(leakInjector) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const snapshotFile = path_1.default.join(getHeapDirPrefix(), `snapshot-${Date.now()}-${fileId++}.json`);
+        yield dumpHeap(snapshotFile, leakInjector);
+        // parse the heap
+        const opt = { buildNodeIdIndex: true };
+        const snapshot = yield core_1.utils.getSnapshotFromFile(snapshotFile, opt);
+        return snapshot;
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export * from './API';
+export * from '@memlab/heap-analysis';
+export { config } from '@memlab/core';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,cAAc,OAAO,CAAC;AACtB,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAC,MAAM,EAAC,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,30 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
+__exportStar(require("./API"), exports);
+__exportStar(require("@memlab/heap-analysis"), exports);
+var core_1 = require("@memlab/core");
+Object.defineProperty(exports, "config", { enumerable: true, get: function () { return core_1.config; } });

package/dist/lib/APIUtils.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import type { Browser } from 'puppeteer';
+import type { MemLabConfig } from '@memlab/core';
+declare function getBrowser(options?: {
+    config?: MemLabConfig;
+    warmup?: boolean;
+}): Promise<Browser>;
+declare const _default: {
+    getBrowser: typeof getBrowser;
+};
+export default _default;
+//# sourceMappingURL=APIUtils.d.ts.map

package/dist/lib/APIUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"APIUtils.d.ts","sourceRoot":"","sources":["../../src/lib/APIUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAU/C,iBAAe,UAAU,CACvB,OAAO,GAAE;IAAC,MAAM,CAAC,EAAE,YAAY,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAM,GACtD,OAAO,CAAC,OAAO,CAAC,CAmBlB;;;;AAED,wBAEE"}

package/dist/lib/APIUtils.js

@@ -0,0 +1,50 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const puppeteer = core_1.constant.isFRL
+    ? {}
+    : core_1.constant.isFB
+        ? require('puppeteer-core')
+        : require('puppeteer');
+function getBrowser(options = {}) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const runConfig = (_a = options.config) !== null && _a !== void 0 ? _a : core_1.config;
+        let browser;
+        if (runConfig.isLocalPuppeteer && !options.warmup) {
+            try {
+                browser = yield puppeteer.connect(Object.assign({ browserURL: `http://localhost:${runConfig.localBrowserPort}` }, runConfig.puppeteerConfig));
+            }
+            catch (e) {
+                throw core_1.utils.haltOrThrow(core_1.utils.getError(e), {
+                    primaryMessageToPrint: 'Failed to connect to local browser. Ensure that the local-puppeteer script is running.',
+                });
+            }
+        }
+        else {
+            browser = yield puppeteer.launch(runConfig.puppeteerConfig);
+        }
+        return browser;
+    });
+}
+exports.default = {
+    getBrowser,
+};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@memlab/api",
+  "version": "1.0.0",
+  "description": "API of memlab",
+  "keywords": [
+    "api"
+  ],
+  "author": "Liang Gong <lgong@fb.com>",
+  "contributors": [],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@memlab/core": "^1.0.0",
+    "@memlab/e2e": "^1.0.0",
+    "@memlab/heap-analysis": "^1.0.0",
+    "ansi": "^0.3.1",
+    "babar": "^0.2.0",
+    "chalk": "^4.0.0",
+    "fs-extra": "^4.0.2",
+    "minimist": "^1.2.0",
+    "puppeteer": "^13.5.1",
+    "string-width": "^4.2.0",
+    "util.promisify": "^1.1.1",
+    "xvfb": "^0.4.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^9.0.3",
+    "@types/jest": "^27.4.1",
+    "@types/minimist": "^1.2.2",
+    "@types/node": "^12.16.3",
+    "@types/puppeteer": "^5.4.4",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.6.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/facebookincubator/memlab.git",
+    "directory": "packages/api"
+  },
+  "scripts": {
+    "build-pkg": "tsc",
+    "test-pkg": "jest .",
+    "clean-pkg": "rm -rf ./dist && rm -rf ./node_modules && rm -f ./tsconfig.tsbuildinfo"
+  },
+  "bugs": {
+    "url": "https://github.com/facebookincubator/memlab/issues"
+  },
+  "homepage": "https://github.com/facebookincubator/memlab#readme"
+}