@memlab/api 1.0.0 → 1.0.3

package/dist/result-reader/BrowserInteractionResultReader.js

@@ -0,0 +1,136 @@
+"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 from a data directory where the data
+     * and generated files of a memlab run were stored
+     * @param workDir absolute path of the data directory
+     * @returns the ResultReader instance
+     *
+     * * **Examples**:
+     * ```javascript
+     * const {BrowserInteractionResultReader} = require('@memlab/api');
+     *
+     * const dataDir = '/tmp/memlab'; // where the last memlab run stores results
+     * const reader = BrowserInteractionResultReader.from(dataDir);
+     * reader.cleanup(); // clean up the results
+     * ```
+     */
+    static from(workDir = '') {
+        return new BrowserInteractionResultReader(workDir);
+    }
+    /**
+     * get all snapshot files generated from last memlab browser interaction
+     * @returns an array of snapshot file's absolute path
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   // get absolute paths of all snapshot files
+     *   const files = result.getSnapshotFiles();
+     * })();
+     * ```
+     */
+    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
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   // get the absolute path the directory holding all snapshot files
+     *   const files = result.getSnapshotFileDir();
+     * })();
+     * ```
+     */
+    getSnapshotFileDir() {
+        this.check();
+        return this.fileManager.getCurDataDir({ workDir: this.workDir });
+    }
+    /**
+     * browser interaction step sequence
+     * @returns an array of browser interaction step information
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   const steps = result.getInteractionSteps();
+     *   // print each browser interaction's name and JavaScript heap size (in bytes)
+     *   steps.forEach(step => console.log(step.name, step.JSHeapUsedSize))
+     * })();
+     * ```
+     */
+    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
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   const metaInfo = result.getRunMetaInfo();
+     *   // print all browser web console output
+     *   console.log(metaInfo.browserInfo._consoleMessages.join('\n'));
+     * })();
+     * ```
+     */
+    getRunMetaInfo() {
+        this.check();
+        const metaFile = this.fileManager.getRunMetaFile({
+            workDir: this.workDir,
+        });
+        return core_1.utils.loadRunMetaInfo(metaFile);
+    }
+}
+exports.default = BrowserInteractionResultReader;

package/package.json

@@ -1,13 +1,22 @@
 {
   "name": "@memlab/api",
-  "version": "1.0.0",
-  "description": "API of memlab",
-  "keywords": [
-    "api"
-  ],
+  "version": "1.0.3",
+  "license": "MIT",
+  "description": "memlab API",
   "author": "Liang Gong <lgong@fb.com>",
   "contributors": [],
-  "license": "MIT",
+  "keywords": [
+    "memlab",
+    "memory",
+    "leak",
+    "api",
+    "e2e",
+    "browser",
+    "heap",
+    "snapshot",
+    "analysis",
+    "plugin"
+  ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [

package/dist/API.d.ts.map

@@ -1 +0,0 @@
-{"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/__tests__/API/E2EBasicAnalysis.test.d.ts.map

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1 +0,0 @@
-{"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__/heap/E2EHeapParser.test.d.ts.map

@@ -1 +0,0 @@
-{"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/lib/HeapParserTestUtils.d.ts.map

@@ -1 +0,0 @@
-{"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/index.d.ts.map

@@ -1 +0,0 @@
-{"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/lib/APIUtils.d.ts.map

@@ -1 +0,0 @@
-{"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"}