@memlab/api 1.0.41 → 1.0.42

package/dist/API.js

@@ -21,14 +21,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.warmupAndTakeSnapshots = warmupAndTakeSnapshots;
-exports.run = run;
-exports.takeSnapshots = takeSnapshots;
-exports.findLeaks = findLeaks;
-exports.findLeaksBySnapshotFilePaths = findLeaksBySnapshotFilePaths;
-exports.analyze = analyze;
-exports.warmup = warmup;
-exports.testInBrowser = testInBrowser;
+exports.testInBrowser = exports.warmup = exports.analyze = exports.findLeaksBySnapshotFilePaths = 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"));
@@ -53,8 +46,8 @@ const APIStateManager_1 = __importDefault(require("./state/APIStateManager"));
  * })();
  * ```
  */
-function warmupAndTakeSnapshots() {
-    return __awaiter(this, arguments, void 0, function* (options = {}) {
+function warmupAndTakeSnapshots(options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
         const config = getConfigFromRunOptions(options);
         const state = APIStateManager_1.default.getAndUpdateState(config, options);
         const testPlanner = new e2e_1.TestPlanner({ config });
@@ -68,6 +61,7 @@ function warmupAndTakeSnapshots() {
         return ret;
     });
 }
+exports.warmupAndTakeSnapshots = warmupAndTakeSnapshots;
 /**
  * This API runs browser interaction and find memory leaks triggered in browser
  * This is equivalent to running `memlab run` in CLI.
@@ -89,8 +83,8 @@ function warmupAndTakeSnapshots() {
  * })();
  * ```
  */
-function run() {
-    return __awaiter(this, arguments, void 0, function* (options = {}) {
+function run(options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
         const config = getConfigFromRunOptions(options);
         const state = APIStateManager_1.default.getAndUpdateState(config, options);
         const testPlanner = new e2e_1.TestPlanner({ config });
@@ -105,6 +99,7 @@ function run() {
         return { leaks, runResult };
     });
 }
+exports.run = run;
 /**
  * This API runs E2E interaction and takes heap snapshots.
  * This is equivalent to running `memlab snapshot` in CLI.
@@ -123,8 +118,8 @@ function run() {
  * })();
  * ```
  */
-function takeSnapshots() {
-    return __awaiter(this, arguments, void 0, function* (options = {}) {
+function takeSnapshots(options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
         const config = getConfigFromRunOptions(options);
         const state = APIStateManager_1.default.getAndUpdateState(config, options);
         const testPlanner = new e2e_1.TestPlanner();
@@ -135,6 +130,7 @@ function takeSnapshots() {
         return ret;
     });
 }
+exports.takeSnapshots = takeSnapshots;
 /**
  * This API finds memory leaks by analyzing heap snapshot(s).
  * This is equivalent to `memlab find-leaks` in CLI.
@@ -157,8 +153,8 @@ function takeSnapshots() {
  * })();
  * ```
  */
-function findLeaks(runResult_1) {
-    return __awaiter(this, arguments, void 0, function* (runResult, options = {}) {
+function findLeaks(runResult, options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
         const state = APIStateManager_1.default.getAndUpdateState(core_1.config, options);
         const workDir = runResult.getRootDirectory();
         core_1.fileManager.initDirs(core_1.config, { workDir });
@@ -168,6 +164,7 @@ function findLeaks(runResult_1) {
         return ret;
     });
 }
+exports.findLeaks = findLeaks;
 /**
  * This API finds memory leaks by analyzing specified heap snapshots.
  * This is equivalent to `memlab find-leaks` with
@@ -183,8 +180,8 @@ function findLeaks(runResult_1) {
  * mode (see {@link ConsoleMode})
  * @returns leak traces detected and clustered from the browser interaction
  */
-function findLeaksBySnapshotFilePaths(baselineSnapshot_1, targetSnapshot_1, finalSnapshot_1) {
-    return __awaiter(this, arguments, void 0, function* (baselineSnapshot, targetSnapshot, finalSnapshot, options = {}) {
+function findLeaksBySnapshotFilePaths(baselineSnapshot, targetSnapshot, finalSnapshot, options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
         const state = APIStateManager_1.default.getAndUpdateState(core_1.config, options);
         core_1.config.useExternalSnapshot = true;
         core_1.config.externalSnapshotFilePaths = [
@@ -199,6 +196,7 @@ function findLeaksBySnapshotFilePaths(baselineSnapshot_1, targetSnapshot_1, fina
         return ret;
     });
 }
+exports.findLeaksBySnapshotFilePaths = findLeaksBySnapshotFilePaths;
 /**
  * This API analyzes heap snapshot(s) with a specified heap analysis.
  * This is equivalent to `memlab analyze` in CLI.
@@ -223,13 +221,14 @@ function findLeaksBySnapshotFilePaths(baselineSnapshot_1, targetSnapshot_1, fina
  * })();
  * ```
  */
-function analyze(runResult_1, heapAnalyzer_1) {
-    return __awaiter(this, arguments, void 0, function* (runResult, heapAnalyzer, args = { _: [] }) {
+function analyze(runResult, heapAnalyzer, args = { _: [] }) {
+    return __awaiter(this, void 0, void 0, function* () {
         const workDir = runResult.getRootDirectory();
         core_1.fileManager.initDirs(core_1.config, { workDir });
         return yield heapAnalyzer.run({ args });
     });
 }
+exports.analyze = analyze;
 /**
  * This warms up web server by sending web requests to the web sever.
  * This is equivalent to running `memlab warmup` in CLI.
@@ -237,9 +236,9 @@ function analyze(runResult_1, heapAnalyzer_1) {
  *
  * @param options configure browser interaction run
  */
-function warmup() {
-    return __awaiter(this, arguments, void 0, function* (options = {}) {
-        var _a, _b;
+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}`);
@@ -276,6 +275,7 @@ function warmup() {
         }
     });
 }
+exports.warmup = warmup;
 function getConfigFromRunOptions(options) {
     let config = core_1.MemLabConfig.getInstance();
     if (options.workDir) {
@@ -297,9 +297,9 @@ function getConfigFromRunOptions(options) {
     config.isFullRun = !!options.snapshotForEachStep;
     return config;
 }
-function setupPage(page_1) {
-    return __awaiter(this, arguments, void 0, function* (page, options = {}) {
-        var _a, _b, _c;
+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) {
@@ -321,9 +321,9 @@ function setupPage(page_1) {
         }));
     });
 }
-function initBrowserInfoInConfig(browser_1) {
-    return __awaiter(this, arguments, void 0, function* (browser, options = {}) {
-        var _a;
+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.recordPuppeteerConfig(config.puppeteerConfig);
         const version = yield browser.version();
@@ -337,9 +337,9 @@ function initBrowserInfoInConfig(browser_1) {
  * Browser interaction API used by MemLab API and MemLab CLI
  * @internal
  */
-function testInBrowser() {
-    return __awaiter(this, arguments, void 0, function* (options = {}) {
-        var _a, _b;
+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}`);
@@ -393,3 +393,4 @@ function testInBrowser() {
         }
     });
 }
+exports.testInBrowser = testInBrowser;

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

@@ -1 +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,OAAO,CAAC,IAAI,CAAC;CAE1C,CAAC;AAEF,eAAO,MAAM,SAAS,QAAO,IAK5B,CAAC;AAGF,wBAAgB,WAAW,IAAI,MAAM,CAEpC"}
+{"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;AAGF,wBAAgB,WAAW,IAAI,MAAM,CAEpC"}

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

@@ -18,8 +18,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testSetup = exports.scenario = exports.defaultAnalysisArgs = exports.testTimeout = void 0;
-exports.getUniqueID = getUniqueID;
+exports.getUniqueID = exports.testSetup = exports.scenario = exports.defaultAnalysisArgs = exports.testTimeout = void 0;
 const core_1 = require("@memlab/core");
 exports.testTimeout = 5 * 60 * 1000;
 exports.defaultAnalysisArgs = { args: { _: [] } };
@@ -39,3 +38,4 @@ let uindex = 1;
 function getUniqueID() {
     return `${process.pid}-${Date.now()}-${uindex++}`;
 }
+exports.getUniqueID = getUniqueID;

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

@@ -21,7 +21,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isExpectedSnapshot = isExpectedSnapshot;
+exports.isExpectedSnapshot = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const core_1 = require("@memlab/core");
@@ -34,6 +34,7 @@ function isExpectedSnapshot(leakInjector, checkSnapshotCb) {
         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)) {

package/dist/index.js

@@ -35,8 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.config = exports.takeNodeMinimalHeap = exports.getNodeInnocentHeap = exports.dumpNodeHeapSnapshot = exports.SnapshotResultReader = exports.BrowserInteractionResultReader = void 0;
-exports.registerPackage = registerPackage;
+exports.config = exports.takeNodeMinimalHeap = exports.getNodeInnocentHeap = exports.dumpNodeHeapSnapshot = exports.SnapshotResultReader = exports.BrowserInteractionResultReader = exports.registerPackage = void 0;
 const path_1 = __importDefault(require("path"));
 const core_1 = require("@memlab/core");
 /** @internal */
@@ -45,6 +44,7 @@ function registerPackage() {
         return core_1.PackageInfoLoader.registerPackage(path_1.default.join(__dirname, '..'));
     });
 }
+exports.registerPackage = registerPackage;
 __exportStar(require("./API"), exports);
 __exportStar(require("@memlab/heap-analysis"), exports);
 __exportStar(require("./state/ConsoleModeManager"), exports);

package/dist/lib/APIUtils.js

@@ -24,9 +24,9 @@ const puppeteer = core_1.constant.isFRL
     : core_1.constant.isFB
         ? require('puppeteer-core')
         : require('puppeteer');
-function getBrowser() {
-    return __awaiter(this, arguments, void 0, function* (options = {}) {
-        var _a;
+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;
         core_1.utils.tryToMutePuppeteerWarning();

package/dist/state/ConsoleModeManager.js

@@ -33,7 +33,7 @@ var ConsoleMode;
      * verbose mode, there could be terminal output overwrite and animation
      */
     ConsoleMode["VERBOSE"] = "VERBOSE";
-})(ConsoleMode || (exports.ConsoleMode = ConsoleMode = {}));
+})(ConsoleMode = exports.ConsoleMode || (exports.ConsoleMode = {}));
 /**
  * Manage, save, and restore the current state of the Console modes.
  * @internal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/api",
-  "version": "1.0.41",
+  "version": "1.0.42",
   "license": "MIT",
   "description": "memlab API",
   "author": "Liang Gong <lgong@meta.com>",
@@ -27,9 +27,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@memlab/core": "^1.1.42",
-    "@memlab/e2e": "^1.0.42",
-    "@memlab/heap-analysis": "^1.0.39",
+    "@memlab/core": "^1.1.43",
+    "@memlab/e2e": "^1.0.43",
+    "@memlab/heap-analysis": "^1.0.40",
     "ansi": "^0.3.1",
     "babar": "^0.2.0",
     "chalk": "^4.0.0",