@memlab/api 1.0.1 → 1.0.2

package/dist/API.d.ts

@@ -7,34 +7,96 @@
  * @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 type { AnyFunction, AnyValue, ISerializedInfo, IScenario } 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 = {
+import BrowserInteractionResultReader from './result-reader/BrowserInteractionResultReader';
+/**
+ * Options for configuring browser interaction run
+ */
+export declare type RunOptions = {
+    /** test scenario definition */
     scenario?: IScenario;
+    /** cookies file */
     cookiesFile?: string;
+    /** function to be evaluated in browser context after the web page initial load */
     evalInBrowserAfterInitLoad?: AnyFunction;
+    /**
+     * if true, take heap snapshot for each interaction step,
+     * by default this is false, which means memlab will decide
+     * which steps it will take heap snapshots
+     */
     snapshotForEachStep?: boolean;
 };
-declare type RunResult = {
-    config: MemLabConfig;
-    tabsOrder: E2EStepInfo[];
-    metaInfo: RunMetaInfo;
+/**
+ * @ignore
+ * Options for memlab inter-package API calls
+ */
+export declare type APIOptions = {
+    testPlanner?: TestPlanner;
+    cache?: boolean;
+    config?: MemLabConfig;
+    evalInBrowserAfterInitLoad?: AnyFunction;
 };
-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>;
+/**
+ * This API warms up web server, runs E2E interaction, and takes heap snapshots.
+ * This is equivalent to run `memlab warmup-and-snapshot` in CLI.
+ * This is also equivalent to call {@link warmup} and {@link takeSnapshots}.
+ *
+ * @param options configure browser interaction run
+ * @returns browser interaction results
+ */
+export declare function warmupAndTakeSnapshots(options?: RunOptions): Promise<BrowserInteractionResultReader>;
+/**
+ * This API runs browser interaction and find memory leaks triggered in browser
+ * This is equivalent to run `memlab run` in CLI.
+ * This is also equivalent to call {@link warmup}, {@link takeSnapshots},
+ * and {@link findLeaks}.
+ *
+ * @param options configure browser interaction run
+ * @returns an array of leak traces detected and clustered from the
+ * browser interaction
+ */
+export declare function run(options?: RunOptions): Promise<ISerializedInfo[]>;
+/**
+ * This API runs E2E interaction and takes heap snapshots.
+ * This is equivalent to run `memlab snapshot` in CLI.
+ *
+ * @param options configure browser interaction run
+ * @returns browser interaction results
+ */
+export declare function takeSnapshots(options?: RunOptions): Promise<BrowserInteractionResultReader>;
+/**
+ * This API finds memory leaks by analyzing heap snapshot(s)
+ * This is equivalent to `memlab find-leaks` in CLI.
+ *
+ * @param runResult return value of a browser interaction run
+ * @returns an array of leak traces detected and clustered from the
+ * browser interaction
+ */
+export declare function findLeaks(runResult: BrowserInteractionResultReader): Promise<ISerializedInfo[]>;
+/**
+ * This API analyzes heap snapshot(s) with a specified heap analysis.
+ * This is equivalent to `memlab analyze` in CLI.
+ *
+ * @param runResult return value of a browser interaction run
+ * @param heapAnalyzer instance of a heap analysis
+ * @param args other CLI arguments that needs to be passed to the heap analysis
+ * @returns
+ */
+export declare function analyze(runResult: BrowserInteractionResultReader, heapAnalyzer: BaseAnalysis, args?: ParsedArgs): Promise<AnyValue>;
+/**
+ * @ignore
+ * This warms up web server by sending web requests to the web sever.
+ * This is equivalent to run `memlab warmup` in CLI.
+ *
+ * @param options configure browser interaction run
+ */
 export declare function warmup(options?: APIOptions): Promise<void>;
-export declare function setupPage(page: Page, options?: APIOptions): Promise<void>;
+/**
+ * @ignore
+ */
 export declare function testInBrowser(options?: APIOptions): Promise<void>;
-export {};
 //# sourceMappingURL=API.d.ts.map

package/dist/API.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"API.d.ts","sourceRoot":"","sources":["../src/API.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EACV,WAAW,EACX,QAAQ,EACR,eAAe,EACf,SAAS,EAGV,MAAM,cAAc,CAAC;AAEtB,OAAO,EAML,YAAY,EAEb,MAAM,cAAc,CAAC;AACtB,OAAO,EAEL,WAAW,EAGZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAEnD,OAAO,8BAA8B,MAAM,gDAAgD,CAAC;AAE5F;;GAEG;AACH,oBAAY,UAAU,GAAG;IACvB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kFAAkF;IAClF,0BAA0B,CAAC,EAAE,WAAW,CAAC;IACzC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,oBAAY,UAAU,GAAG;IAGvB,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;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,GAAE,UAAe,GACvB,OAAO,CAAC,8BAA8B,CAAC,CAUzC;AAED;;;;;;;;;GASG;AACH,wBAAsB,GAAG,CACvB,OAAO,GAAE,UAAe,GACvB,OAAO,CAAC,eAAe,EAAE,CAAC,CAW5B;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,OAAO,GAAE,UAAe,GACvB,OAAO,CAAC,8BAA8B,CAAC,CASzC;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAC7B,SAAS,EAAE,8BAA8B,GACxC,OAAO,CAAC,eAAe,EAAE,CAAC,CAK5B;AAED;;;;;;;;GAQG;AACH,wBAAsB,OAAO,CAC3B,SAAS,EAAE,8BAA8B,EACzC,YAAY,EAAE,YAAY,EAC1B,IAAI,GAAE,UAAoB,GACzB,OAAO,CAAC,QAAQ,CAAC,CAInB;AAED;;;;;;GAMG;AACH,wBAAsB,MAAM,CAAC,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAuCpE;AAsDD;;GAEG;AACH,wBAAsB,aAAa,CAAC,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAkD3E"}

package/dist/API.js

@@ -21,13 +21,43 @@ 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;
+exports.testInBrowser = exports.warmup = exports.analyze = exports.findLeaks = exports.takeSnapshots = exports.run = exports.warmupAndTakeSnapshots = 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;
+const BrowserInteractionResultReader_1 = __importDefault(require("./result-reader/BrowserInteractionResultReader"));
+/**
+ * This API warms up web server, runs E2E interaction, and takes heap snapshots.
+ * This is equivalent to run `memlab warmup-and-snapshot` in CLI.
+ * This is also equivalent to call {@link warmup} and {@link takeSnapshots}.
+ *
+ * @param options configure browser interaction run
+ * @returns browser interaction results
+ */
+function warmupAndTakeSnapshots(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 BrowserInteractionResultReader_1.default.from(config.workDir);
+    });
 }
+exports.warmupAndTakeSnapshots = warmupAndTakeSnapshots;
+/**
+ * This API runs browser interaction and find memory leaks triggered in browser
+ * This is equivalent to run `memlab run` in CLI.
+ * This is also equivalent to call {@link warmup}, {@link takeSnapshots},
+ * and {@link findLeaks}.
+ *
+ * @param options configure browser interaction run
+ * @returns an array of leak traces detected and clustered from the
+ * browser interaction
+ */
 function run(options = {}) {
     return __awaiter(this, void 0, void 0, function* () {
         const config = core_1.MemLabConfig.resetConfigWithTranscientDir();
@@ -38,14 +68,18 @@ function run(options = {}) {
         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(),
-        };
+        const runResult = BrowserInteractionResultReader_1.default.from(config.workDir);
+        return yield findLeaks(runResult);
     });
 }
 exports.run = run;
+/**
+ * This API runs E2E interaction and takes heap snapshots.
+ * This is equivalent to run `memlab snapshot` in CLI.
+ *
+ * @param options configure browser interaction run
+ * @returns browser interaction results
+ */
 function takeSnapshots(options = {}) {
     return __awaiter(this, void 0, void 0, function* () {
         const config = core_1.MemLabConfig.resetConfigWithTranscientDir();
@@ -55,20 +89,51 @@ function takeSnapshots(options = {}) {
         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(),
-        };
+        return BrowserInteractionResultReader_1.default.from(config.workDir);
     });
 }
 exports.takeSnapshots = takeSnapshots;
+/**
+ * This API finds memory leaks by analyzing heap snapshot(s)
+ * This is equivalent to `memlab find-leaks` in CLI.
+ *
+ * @param runResult return value of a browser interaction run
+ * @returns an array of leak traces detected and clustered from the
+ * browser interaction
+ */
+function findLeaks(runResult) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const workDir = runResult.getRootDirectory();
+        core_1.fileManager.initDirs(core_1.config, { workDir });
+        core_1.config.chaseWeakMapEdge = false;
+        return yield core_1.analysis.checkLeak();
+    });
+}
+exports.findLeaks = findLeaks;
+/**
+ * This API analyzes heap snapshot(s) with a specified heap analysis.
+ * This is equivalent to `memlab analyze` in CLI.
+ *
+ * @param runResult return value of a browser interaction run
+ * @param heapAnalyzer instance of a heap analysis
+ * @param args other CLI arguments that needs to be passed to the heap analysis
+ * @returns
+ */
 function analyze(runResult, heapAnalyzer, args = { _: [] }) {
     return __awaiter(this, void 0, void 0, function* () {
-        yield heapAnalyzer.run({ args });
+        const workDir = runResult.getRootDirectory();
+        core_1.fileManager.initDirs(core_1.config, { workDir });
+        return yield heapAnalyzer.run({ args });
     });
 }
 exports.analyze = analyze;
+/**
+ * @ignore
+ * This warms up web server by sending web requests to the web sever.
+ * This is equivalent to run `memlab warmup` in CLI.
+ *
+ * @param options configure browser interaction run
+ */
 function warmup(options = {}) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
@@ -109,6 +174,9 @@ function warmup(options = {}) {
     });
 }
 exports.warmup = warmup;
+function setConfigByRunOptions(config, options) {
+    config.isFullRun = !!options.snapshotForEachStep;
+}
 function setupPage(page, options = {}) {
     var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
@@ -130,7 +198,6 @@ function setupPage(page, options = {}) {
         }));
     });
 }
-exports.setupPage = setupPage;
 function autoDismissDialog(page, options = {}) {
     var _a;
     const config = (_a = options.config) !== null && _a !== void 0 ? _a : core_1.config;
@@ -153,6 +220,9 @@ function initBrowserInfoInConfig(browser, options = {}) {
         }
     });
 }
+/**
+ * @ignore
+ */
 function testInBrowser(options = {}) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {

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

@@ -17,12 +17,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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);
@@ -34,14 +30,17 @@ function inject() {
     };
 }
 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 });
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
+        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');
+    const snapshotFile = result.getSnapshotFiles().pop();
     analysis = new index_1.DetachedDOMElementAnalysis();
     yield analysis.analyzeSnapshotFromFile(snapshotFile);
     domElems = analysis.getDetachedElements();

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

@@ -17,11 +17,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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);
@@ -39,14 +35,17 @@ function inject() {
     };
 }
 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 });
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
+        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');
+    const snapshotFile = result.getSnapshotFiles().pop();
     analysis = new index_1.ObjectShallowAnalysis();
     yield analysis.analyzeSnapshotFromFile(snapshotFile);
     dupcatedObjectInfo = analysis.getTopDuplicatedObjectInCount();

package/dist/__tests__/API/E2EFindLeaks.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=E2EFindLeaks.example.d.ts.map

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

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

package/dist/__tests__/API/E2EFindLeaks.example.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 });
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+const core_1 = require("@memlab/core");
+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"]'); }),
+};
+function inject() {
+    // @ts-ignore
+    window.injectHookForLink4 = () => {
+        const arr = [];
+        for (let i = 0; i < 23; ++i) {
+            arr.push(document.createElement('div'));
+        }
+        // @ts-ignore
+        window.__injectedValue = arr;
+        // @ts-ignore
+        window._path_1 = { x: { y: document.createElement('div') } };
+        // @ts-ignore
+        window._path_2 = new Set([document.createElement('div')]);
+    };
+}
+function test() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const leaks = yield (0, index_1.run)({ scenario, evalInBrowserAfterInitLoad: inject });
+        core_1.info.lowLevel(`${leaks.length}`);
+    });
+}
+test();

package/dist/__tests__/API/E2EFindMemoryLeaks.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=E2EFindMemoryLeaks.test.d.ts.map

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

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

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

@@ -0,0 +1,51 @@
+"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 E2ETestSettings_1 = require("./lib/E2ETestSettings");
+beforeEach(E2ETestSettings_1.testSetup);
+function injectDetachedDOMElements() {
+    // @ts-ignore
+    window.injectHookForLink4 = () => {
+        const arr = [];
+        for (let i = 0; i < 23; ++i) {
+            arr.push(document.createElement('div'));
+        }
+        // @ts-ignore
+        window.__injectedValue = arr;
+        // @ts-ignore
+        window._path_1 = { x: { y: document.createElement('div') } };
+        // @ts-ignore
+        window._path_2 = new Set([document.createElement('div')]);
+    };
+}
+test('leak detector can find detached DOM elements', () => __awaiter(void 0, void 0, void 0, function* () {
+    const leaks = yield (0, index_1.run)({
+        scenario: E2ETestSettings_1.scenario,
+        evalInBrowserAfterInitLoad: injectDetachedDOMElements,
+    });
+    // detected all different leak trace cluster
+    expect(leaks.length).toBe(3);
+    // expect all traces are found
+    expect(leaks.some(leak => JSON.stringify(leak).includes('__injectedValue')));
+    expect(leaks.some(leak => JSON.stringify(leak).includes('_path_1')));
+    expect(leaks.some(leak => JSON.stringify(leak).includes('_path_2')));
+}), E2ETestSettings_1.testTimeout);

package/dist/__tests__/API/E2EResultReader.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=E2EResultReader.test.d.ts.map

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

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

package/dist/__tests__/API/E2EResultReader.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 fs_1 = __importDefault(require("fs"));
+const BrowserInteractionResultReader_1 = __importDefault(require("../../result-reader/BrowserInteractionResultReader"));
+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;
+    };
+}
+function checkResultReader(result) {
+    const workDir = result.getRootDirectory();
+    expect(fs_1.default.existsSync(workDir)).toBe(true);
+    const snapshotDir = result.getSnapshotFileDir();
+    expect(fs_1.default.existsSync(snapshotDir)).toBe(true);
+    const snapshotFiles = result.getSnapshotFiles();
+    expect(snapshotFiles.length > 0).toBe(true);
+    const steps = result.getInteractionSteps();
+    expect(steps.length > 0).toBe(true);
+    expect(steps[0].name).toBe('page-load');
+    const runMeta = result.getRunMetaInfo();
+    expect(runMeta.app).toBe('test-spa');
+    result.cleanup();
+    expect(fs_1.default.existsSync(workDir)).toBe(false);
+    expect(() => result.getRootDirectory()).toThrowError();
+    expect(() => result.getSnapshotFileDir()).toThrowError();
+    expect(() => result.getSnapshotFiles()).toThrowError();
+}
+test('result data/file reader is working as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
+        scenario: E2ETestSettings_1.scenario,
+        evalInBrowserAfterInitLoad: inject,
+    });
+    checkResultReader(result);
+}), E2ETestSettings_1.testTimeout);
+test('ResultReader.from is working as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
+        scenario: E2ETestSettings_1.scenario,
+        evalInBrowserAfterInitLoad: inject,
+    });
+    checkResultReader(BrowserInteractionResultReader_1.default.from(result.getRootDirectory()));
+}), E2ETestSettings_1.testTimeout);

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

@@ -17,22 +17,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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);
-});
+function test() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const result = yield (0, index_1.warmupAndTakeSnapshots)({
+            scenario,
+        });
+        const analysis = new index_1.StringAnalysis();
+        const snapshotFile = result.getSnapshotFiles().pop();
+        analysis.analyzeSnapshotFromFile(snapshotFile);
+    });
+}
+test();

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

@@ -17,12 +17,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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);
@@ -44,7 +40,7 @@ function inject() {
 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)({
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
         scenario: repeatScenario,
         evalInBrowserAfterInitLoad: inject,
         snapshotForEachStep: true,
@@ -54,19 +50,12 @@ test('Shape unbound analysis works as expected', () => __awaiter(void 0, void 0,
     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);
+    const snapshotDir = result.getSnapshotFileDir();
     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');
+    const snapshotFile = result.getSnapshotFiles().pop();
     analysis = new index_1.ShapeUnboundGrowthAnalysis();
-    let isThrow = false;
-    try {
-        yield analysis.analyzeSnapshotFromFile(snapshotFile);
-    }
-    catch (ex) {
-        isThrow = true;
-    }
-    expect(isThrow).toBe(true);
+    expect(() => __awaiter(void 0, void 0, void 0, function* () { return yield analysis.analyzeSnapshotFromFile(snapshotFile); })).rejects.toThrowError();
 }), E2ETestSettings_1.testTimeout);

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

@@ -17,12 +17,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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);
@@ -38,7 +34,10 @@ function inject() {
     };
 }
 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 });
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
+        scenario: E2ETestSettings_1.scenario,
+        evalInBrowserAfterInitLoad: inject,
+    });
     // test analysis from auto loading
     let analysis = new index_1.StringAnalysis();
     yield analysis.run();
@@ -46,21 +45,26 @@ test('String analysis works as expected', () => __awaiter(void 0, void 0, void 0
     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');
+    const snapshotFile = result.getSnapshotFiles().pop();
     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;
+    const snapshotDir = result.getSnapshotFileDir();
     analysis = new index_1.StringAnalysis();
-    let isThrow = false;
-    try {
-        yield analysis.analyzeSnapshotsInDirectory(snapshotDir);
-    }
-    catch (ex) {
-        isThrow = true;
-    }
-    expect(isThrow).toBe(true);
+    expect(() => __awaiter(void 0, void 0, void 0, function* () { return yield analysis.analyzeSnapshotsInDirectory(snapshotDir); })).rejects.toThrowError();
+}), E2ETestSettings_1.testTimeout);
+test('analyze function works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
+        scenario: E2ETestSettings_1.scenario,
+        evalInBrowserAfterInitLoad: inject,
+    });
+    // test analysis from auto loading
+    const analysis = new index_1.StringAnalysis();
+    yield (0, index_1.analyze)(result, analysis);
+    const dupStrings = analysis.getTopDuplicatedStringsInCount();
+    expect(dupStrings[0].n).toBe(10000);
+    expect(dupStrings[0].str).toBe('duplicated string value0');
 }), E2ETestSettings_1.testTimeout);

package/dist/index.d.ts

@@ -10,4 +10,5 @@
 export * from './API';
 export * from '@memlab/heap-analysis';
 export { config } from '@memlab/core';
+export { default as BrowserInteractionResultReader } from './result-reader/BrowserInteractionResultReader';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +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"}
+{"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;AACpC,OAAO,EAAC,OAAO,IAAI,8BAA8B,EAAC,MAAM,gDAAgD,CAAC"}

package/dist/index.js

@@ -22,9 +22,14 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 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);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.config = void 0;
+exports.BrowserInteractionResultReader = 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; } });
+var BrowserInteractionResultReader_1 = require("./result-reader/BrowserInteractionResultReader");
+Object.defineProperty(exports, "BrowserInteractionResultReader", { enumerable: true, get: function () { return __importDefault(BrowserInteractionResultReader_1).default; } });

package/dist/result-reader/BaseResultReader.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { FileManager } from '@memlab/core';
+/**
+ * A utility entity to read all generated files from
+ * the directory holding the data and results from
+ * a memlab run
+ */
+export default class BaseResultReader {
+    /** @ignore */
+    protected workDir: string;
+    /** @ignore */
+    protected fileManager: FileManager;
+    /** @ignore */
+    private isValid;
+    /**
+     * build a result reader
+     * @param workDir absolute path of the directory where the data
+     * and generated files of the memlab run were stored
+     */
+    protected constructor(workDir?: string);
+    /** @ignore */
+    protected check(): void;
+    /**
+     * build a result reader
+     * @param workDir absolute path of the directory where the data
+     * and generated files of the memlab run were stored
+     * @returns the ResultReader instance
+     */
+    static from(workDir?: string): BaseResultReader;
+    /**
+     * get the directory where the data and generated files of
+     * the memlab run were stored
+     * @returns absolute path of the directory
+     */
+    getRootDirectory(): string;
+    /**
+     * clean up data/files generated from the memlab run
+     */
+    cleanup(): void;
+}
+//# sourceMappingURL=BaseResultReader.d.ts.map

package/dist/result-reader/BaseResultReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseResultReader.d.ts","sourceRoot":"","sources":["../../src/result-reader/BaseResultReader.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAQ,WAAW,EAAC,MAAM,cAAc,CAAC;AAGhD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,cAAc;IACd,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,cAAc;IACd,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC;IACnC,cAAc;IACd,OAAO,CAAC,OAAO,CAAU;IAEzB;;;;OAIG;IACH,SAAS,aAAa,OAAO,SAAK;IASlC,cAAc;IACd,SAAS,CAAC,KAAK,IAAI,IAAI;IAOvB;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,OAAO,SAAK,GAAG,gBAAgB;IAI3C;;;;OAIG;IACI,gBAAgB,IAAI,MAAM;IAKjC;;OAEG;IACI,OAAO,IAAI,IAAI;CAOvB"}

package/dist/result-reader/BaseResultReader.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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+/**
+ * A utility entity to read all generated files from
+ * the directory holding the data and results from
+ * a memlab run
+ */
+class BaseResultReader {
+    /**
+     * build a result reader
+     * @param workDir absolute path of the directory where the data
+     * and generated files of the memlab run were stored
+     */
+    constructor(workDir = '') {
+        this.fileManager = new core_1.FileManager();
+        if (workDir === '') {
+            workDir = this.fileManager.getWorkDir();
+        }
+        this.workDir = workDir;
+        this.check();
+    }
+    /** @ignore */
+    check() {
+        this.isValid = fs_extra_1.default.existsSync(this.workDir);
+        if (!this.isValid) {
+            core_1.utils.haltOrThrow(`invalid/removed data directory: ${this.workDir}`);
+        }
+    }
+    /**
+     * build a result reader
+     * @param workDir absolute path of the directory where the data
+     * and generated files of the memlab run were stored
+     * @returns the ResultReader instance
+     */
+    static from(workDir = '') {
+        return new BaseResultReader(workDir);
+    }
+    /**
+     * get the directory where the data and generated files of
+     * the memlab run were stored
+     * @returns absolute path of the directory
+     */
+    getRootDirectory() {
+        this.check();
+        return this.workDir;
+    }
+    /**
+     * clean up data/files generated from the memlab run
+     */
+    cleanup() {
+        if (!this.isValid) {
+            return;
+        }
+        fs_extra_1.default.removeSync(this.workDir);
+        this.isValid = false;
+    }
+}
+exports.default = BaseResultReader;

package/dist/result-reader/BrowserInteractionResultReader.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 { E2EStepInfo, RunMetaInfo } from '@memlab/core';
+import BaseResultReader from './BaseResultReader';
+/**
+ * A utility entity to read all generated files from
+ * the directory holding the data and results from the
+ * last browser interaction run
+ */
+export default class BrowserInteractionResultReader extends BaseResultReader {
+    /**
+     * build a result reader
+     * @param workDir absolute path of the directory where the data
+     * and generated files of the browser interaction run were stored
+     * @returns the ResultReader instance
+     */
+    static from(workDir?: string): BrowserInteractionResultReader;
+    /**
+     * get all snapshot files
+     * @returns an array of snapshot file's absolute path
+     */
+    getSnapshotFiles(): string[];
+    /**
+     * get the directory holding all snapshot files
+     * @returns the absolute path of the directory
+     */
+    getSnapshotFileDir(): string;
+    /**
+     * browser interaction step sequence
+     * @returns an array of browser interaction step info
+     */
+    getInteractionSteps(): E2EStepInfo[];
+    /**
+     * general meta data of the browser interaction run
+     * @returns meta data about the entire browser interaction
+     */
+    getRunMetaInfo(): RunMetaInfo;
+}
+//# sourceMappingURL=BrowserInteractionResultReader.d.ts.map

package/dist/result-reader/BrowserInteractionResultReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserInteractionResultReader.d.ts","sourceRoot":"","sources":["../../src/result-reader/BrowserInteractionResultReader.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,WAAW,EAAE,WAAW,EAAC,MAAM,cAAc,CAAC;AAK3D,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAElD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,8BAA+B,SAAQ,gBAAgB;IAC1E;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,OAAO,SAAK,GAAG,8BAA8B;IAIzD;;;OAGG;IACI,gBAAgB,IAAI,MAAM,EAAE;IASnC;;;OAGG;IACI,kBAAkB,IAAI,MAAM;IAKnC;;;OAGG;IACI,mBAAmB,IAAI,WAAW,EAAE;IAQ3C;;;OAGG;IACI,cAAc,IAAI,WAAW;CAOrC"}

package/dist/result-reader/BrowserInteractionResultReader.js

@@ -0,0 +1,77 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const BaseResultReader_1 = __importDefault(require("./BaseResultReader"));
+/**
+ * A utility entity to read all generated files from
+ * the directory holding the data and results from the
+ * last browser interaction run
+ */
+class BrowserInteractionResultReader extends BaseResultReader_1.default {
+    /**
+     * build a result reader
+     * @param workDir absolute path of the directory where the data
+     * and generated files of the browser interaction run were stored
+     * @returns the ResultReader instance
+     */
+    static from(workDir = '') {
+        return new BrowserInteractionResultReader(workDir);
+    }
+    /**
+     * get all snapshot files
+     * @returns an array of snapshot file's absolute path
+     */
+    getSnapshotFiles() {
+        this.check();
+        const dataDir = this.fileManager.getCurDataDir({ workDir: this.workDir });
+        return fs_extra_1.default
+            .readdirSync(dataDir)
+            .filter(file => file.endsWith('heapsnapshot'))
+            .map(file => path_1.default.join(dataDir, file));
+    }
+    /**
+     * get the directory holding all snapshot files
+     * @returns the absolute path of the directory
+     */
+    getSnapshotFileDir() {
+        this.check();
+        return this.fileManager.getCurDataDir({ workDir: this.workDir });
+    }
+    /**
+     * browser interaction step sequence
+     * @returns an array of browser interaction step info
+     */
+    getInteractionSteps() {
+        this.check();
+        const metaFile = this.fileManager.getSnapshotSequenceMetaFile({
+            workDir: this.workDir,
+        });
+        return core_1.utils.loadTabsOrder(metaFile);
+    }
+    /**
+     * general meta data of the browser interaction run
+     * @returns meta data about the entire browser interaction
+     */
+    getRunMetaInfo() {
+        this.check();
+        const metaFile = this.fileManager.getRunMetaFile({
+            workDir: this.workDir,
+        });
+        return core_1.utils.loadRunMetaInfo(metaFile);
+    }
+}
+exports.default = BrowserInteractionResultReader;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/api",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "MIT",
   "description": "memlab API",
   "author": "Liang Gong <lgong@fb.com>",