@memlab/api 1.0.16 → 1.0.18

package/dist/API.d.ts

@@ -71,7 +71,7 @@ export declare type APIOptions = {
 };
 /**
  * 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 equivalent to running `memlab warmup-and-snapshot` in CLI.
  * This is also equivalent to warm up and call {@link takeSnapshots}.
  *
  * @param options configure browser interaction run
@@ -91,7 +91,7 @@ export declare type APIOptions = {
 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 equivalent to running `memlab run` in CLI.
  * This is also equivalent to warm up, and call {@link takeSnapshots}
  * and {@link findLeaks}.
  *
@@ -113,7 +113,7 @@ export declare function warmupAndTakeSnapshots(options?: RunOptions): Promise<Br
 export declare function run(runOptions?: RunOptions): Promise<RunResult>;
 /**
  * This API runs E2E interaction and takes heap snapshots.
- * This is equivalent to run `memlab snapshot` in CLI.
+ * This is equivalent to running `memlab snapshot` in CLI.
  *
  * @param options configure browser interaction run
  * @returns a utility reading browser interaction results from disk
@@ -177,7 +177,7 @@ export declare function findLeaks(runResult: BrowserInteractionResultReader): Pr
 export declare function analyze(runResult: BrowserInteractionResultReader, heapAnalyzer: BaseAnalysis, args?: ParsedArgs): Promise<void>;
 /**
  * This warms up web server by sending web requests to the web sever.
- * This is equivalent to run `memlab warmup` in CLI.
+ * This is equivalent to running `memlab warmup` in CLI.
  * @internal
  *
  * @param options configure browser interaction run

package/dist/API.js

@@ -28,7 +28,7 @@ const APIUtils_1 = __importDefault(require("./lib/APIUtils"));
 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 equivalent to running `memlab warmup-and-snapshot` in CLI.
  * This is also equivalent to warm up and call {@link takeSnapshots}.
  *
  * @param options configure browser interaction run
@@ -60,7 +60,7 @@ function warmupAndTakeSnapshots(options = {}) {
 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 equivalent to running `memlab run` in CLI.
  * This is also equivalent to warm up, and call {@link takeSnapshots}
  * and {@link findLeaks}.
  *
@@ -96,7 +96,7 @@ function run(runOptions = {}) {
 exports.run = run;
 /**
  * This API runs E2E interaction and takes heap snapshots.
- * This is equivalent to run `memlab snapshot` in CLI.
+ * This is equivalent to running `memlab snapshot` in CLI.
  *
  * @param options configure browser interaction run
  * @returns a utility reading browser interaction results from disk
@@ -186,7 +186,7 @@ function analyze(runResult, heapAnalyzer, args = { _: [] }) {
 exports.analyze = analyze;
 /**
  * This warms up web server by sending web requests to the web sever.
- * This is equivalent to run `memlab warmup` in CLI.
+ * This is equivalent to running `memlab warmup` in CLI.
  * @internal
  *
  * @param options configure browser interaction run

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

@@ -17,8 +17,12 @@ 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 fs_1 = __importDefault(require("fs"));
 const index_1 = require("../../index");
 const E2ETestSettings_1 = require("./lib/E2ETestSettings");
 beforeEach(E2ETestSettings_1.testSetup);
@@ -42,7 +46,14 @@ test('Detached DOM analysis works as expected', () => __awaiter(void 0, void 0,
     // test analysis from file
     const snapshotFile = result.getSnapshotFiles().pop();
     analysis = new index_1.DetachedDOMElementAnalysis();
-    yield analysis.analyzeSnapshotFromFile(snapshotFile);
+    const ret = yield analysis.analyzeSnapshotFromFile(snapshotFile);
+    // expect the heap analysis output log file to exist and
+    // to contain the expected results
+    expect(fs_1.default.existsSync(ret.analysisOutputFile)).toBe(true);
+    expect(fs_1.default
+        .readFileSync(ret.analysisOutputFile, 'UTF-8')
+        .includes('Detached HTMLTableElement')).toBe(true);
+    // check if the query result API works as expected
     domElems = analysis.getDetachedElements();
     expect(domElems.some(node => node.name === 'Detached HTMLTableElement')).toBe(true);
 }), E2ETestSettings_1.testTimeout);

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

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

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

@@ -1,13 +1,4 @@
 "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.
- *
- * @format
- * @oncall web_perf_infra
- */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -17,7 +8,12 @@ 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 fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
 const index_1 = require("../../index");
 const E2ETestSettings_1 = require("./lib/E2ETestSettings");
 beforeEach(E2ETestSettings_1.testSetup);
@@ -34,20 +30,51 @@ function inject() {
         window.__injectedValue = arr;
     };
 }
-test('Duplicate object analysis works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
-    const result = yield (0, index_1.warmupAndTakeSnapshots)({
-        scenario: E2ETestSettings_1.scenario,
-        evalInBrowserAfterInitLoad: inject,
+function gatherSnapshots() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const result = yield (0, index_1.warmupAndTakeSnapshots)({
+            scenario: E2ETestSettings_1.scenario,
+            evalInBrowserAfterInitLoad: inject,
+        });
+        return result;
+    });
+}
+function testAnalysisFromAutoLoading() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // test analysis from auto loading
+        const analysis = new index_1.ObjectShallowAnalysis();
+        yield analysis.run();
+        const dupcatedObjectInfo = analysis.getTopDuplicatedObjectInCount();
+        expect(dupcatedObjectInfo[0].n).toBe(12345);
+    });
+}
+function testAnalysisFromFileDir(result) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // test analysis from file
+        const snapshotFile = result.getSnapshotFiles().pop();
+        const analysis = new index_1.ObjectShallowAnalysis();
+        yield analysis.analyzeSnapshotFromFile(snapshotFile);
+        const dupcatedObjectInfo = analysis.getTopDuplicatedObjectInCount();
+        expect(dupcatedObjectInfo[0].n).toBe(12345);
+    });
+}
+function testAnalysisWithSpecifiedWorkDir(result) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const snapshotFile = result.getSnapshotFiles().pop();
+        const analysis = new index_1.ObjectShallowAnalysis();
+        const workDir = `/tmp/memlab-test/${(0, E2ETestSettings_1.getUniqueID)()}`;
+        const ret = yield analysis.analyzeSnapshotFromFile(snapshotFile, { workDir });
+        // expect the heap analysis output log file to exist and
+        expect(fs_1.default.existsSync(ret.analysisOutputFile)).toBe(true);
+        // output file is inside the working directory
+        expect(path_1.default.resolve(ret.analysisOutputFile).includes(path_1.default.resolve(workDir))).toBe(true);
+        const dupcatedObjectInfo = analysis.getTopDuplicatedObjectInCount();
+        expect(dupcatedObjectInfo[0].n).toBe(12345);
     });
-    // 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 = result.getSnapshotFiles().pop();
-    analysis = new index_1.ObjectShallowAnalysis();
-    yield analysis.analyzeSnapshotFromFile(snapshotFile);
-    dupcatedObjectInfo = analysis.getTopDuplicatedObjectInCount();
-    expect(dupcatedObjectInfo[0].n).toBe(12345);
+}
+test('Duplicate object analysis works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield gatherSnapshots();
+    yield testAnalysisFromAutoLoading();
+    yield testAnalysisFromFileDir(result);
+    yield testAnalysisWithSpecifiedWorkDir(result);
 }), E2ETestSettings_1.testTimeout);

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

@@ -17,8 +17,12 @@ 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 fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
 const index_1 = require("../../index");
 const E2ETestSettings_1 = require("./lib/E2ETestSettings");
 beforeEach(E2ETestSettings_1.testSetup);
@@ -37,27 +41,74 @@ 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.warmupAndTakeSnapshots)({
-        scenario: repeatScenario,
-        evalInBrowserAfterInitLoad: inject,
-        snapshotForEachStep: true,
+function gatherSnapshots() {
+    return __awaiter(this, 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.warmupAndTakeSnapshots)({
+            scenario: repeatScenario,
+            evalInBrowserAfterInitLoad: inject,
+            snapshotForEachStep: true,
+        });
+        return result;
+    });
+}
+function testAnalysisFromAutoLoading() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // test analysis from auto loading
+        const analysis = new index_1.ShapeUnboundGrowthAnalysis();
+        yield analysis.run();
+        const shapeSummary = analysis.getShapesWithUnboundGrowth();
+        expect(shapeSummary.reduce((acc, summary) => acc || summary.shape.includes('LeakObject'), false)).toBe(true);
+    });
+}
+function testAnalysisFromFileDir(result) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // test analysis from file
+        const snapshotDir = result.getSnapshotFileDir();
+        const analysis = new index_1.ShapeUnboundGrowthAnalysis();
+        const ret = yield analysis.analyzeSnapshotsInDirectory(snapshotDir);
+        // expect the heap analysis output log file to exist and
+        // to contain the expected results
+        expect(fs_1.default.existsSync(ret.analysisOutputFile)).toBe(true);
+        expect(fs_1.default.readFileSync(ret.analysisOutputFile, 'UTF-8').includes('LeakObject')).toBe(true);
+        // expect the query API works
+        const shapeSummary = analysis.getShapesWithUnboundGrowth();
+        expect(shapeSummary.some((summary) => summary.shape.includes('LeakObject'))).toBe(true);
     });
-    // test analysis from auto loading
-    let analysis = new index_1.ShapeUnboundGrowthAnalysis();
-    yield analysis.run();
-    let shapeSummary = analysis.getShapesWithUnboundGrowth();
-    expect(shapeSummary.reduce((acc, summary) => acc || summary.shape.includes('LeakObject'), false)).toBe(true);
-    // test analysis from file
-    const snapshotDir = result.getSnapshotFileDir();
-    analysis = new index_1.ShapeUnboundGrowthAnalysis();
-    yield analysis.analyzeSnapshotsInDirectory(snapshotDir);
-    shapeSummary = analysis.getShapesWithUnboundGrowth();
-    expect(shapeSummary.some((summary) => summary.shape.includes('LeakObject'))).toBe(true);
-    // expect incorrect use of heap analysis to throw
-    const snapshotFile = result.getSnapshotFiles().pop();
-    analysis = new index_1.ShapeUnboundGrowthAnalysis();
-    expect(() => __awaiter(void 0, void 0, void 0, function* () { return yield analysis.analyzeSnapshotFromFile(snapshotFile); })).rejects.toThrowError();
+}
+function testIncorrectUseage(result) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // expect incorrect use of heap analysis to throw
+        const snapshotFile = result.getSnapshotFiles().pop();
+        const analysis = new index_1.ShapeUnboundGrowthAnalysis();
+        expect(() => __awaiter(this, void 0, void 0, function* () { return yield analysis.analyzeSnapshotFromFile(snapshotFile); })).rejects.toThrowError();
+    });
+}
+function testAnalysisWithSpecifiedWorkDir(result) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // test analysis from file
+        const snapshotDir = result.getSnapshotFileDir();
+        const analysis = new index_1.ShapeUnboundGrowthAnalysis();
+        const workDir = `/tmp/memlab-test/${(0, E2ETestSettings_1.getUniqueID)()}`;
+        const ret = yield analysis.analyzeSnapshotsInDirectory(snapshotDir, {
+            workDir,
+        });
+        // expect the heap analysis output log file to exist and
+        expect(fs_1.default.existsSync(ret.analysisOutputFile)).toBe(true);
+        // output file is inside the working directory
+        expect(path_1.default.resolve(ret.analysisOutputFile).includes(path_1.default.resolve(workDir))).toBe(true);
+        // output file contains the expected result
+        expect(fs_1.default.readFileSync(ret.analysisOutputFile, 'UTF-8').includes('LeakObject')).toBe(true);
+        // expect the query API works
+        const shapeSummary = analysis.getShapesWithUnboundGrowth();
+        expect(shapeSummary.some((summary) => summary.shape.includes('LeakObject'))).toBe(true);
+    });
+}
+test('Shape unbound analysis works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield gatherSnapshots();
+    yield testAnalysisFromAutoLoading();
+    yield testAnalysisFromFileDir(result);
+    yield testIncorrectUseage(result);
+    yield testAnalysisWithSpecifiedWorkDir(result);
 }), E2ETestSettings_1.testTimeout);

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

@@ -20,4 +20,5 @@ export declare const scenario: {
     action: (page: Page) => Promise<void>;
 };
 export declare const testSetup: () => void;
+export declare function getUniqueID(): string;
 //# sourceMappingURL=E2ETestSettings.d.ts.map

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

@@ -18,7 +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 = exports.testSetup = exports.scenario = exports.defaultAnalysisArgs = exports.testTimeout = void 0;
 const core_1 = require("@memlab/core");
 exports.testTimeout = 5 * 60 * 1000;
 exports.defaultAnalysisArgs = { args: { _: [] } };
@@ -34,3 +34,8 @@ const testSetup = () => {
     core_1.config.errorHandling = core_1.ErrorHandling.Throw;
 };
 exports.testSetup = testSetup;
+let uindex = 1;
+function getUniqueID() {
+    return `${process.pid}-${Date.now()}-${uindex++}`;
+}
+exports.getUniqueID = getUniqueID;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/api",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "license": "MIT",
   "description": "memlab API",
   "author": "Liang Gong <lgong@fb.com>",
@@ -58,7 +58,7 @@
   "scripts": {
     "build-pkg": "tsc",
     "test-pkg": "jest .",
-    "publish-patch": "npm version patch --force && npm publish",
+    "publish-patch": "npm publish",
     "clean-pkg": "rm -rf ./dist && rm -rf ./node_modules && rm -f ./tsconfig.tsbuildinfo"
   },
   "bugs": {