@memlab/api 2.0.3 → 2.0.5

package/dist/API.js

@@ -127,7 +127,7 @@ function takeSnapshots() {
     return __awaiter(this, arguments, void 0, function* (options = {}) {
         const config = getConfigFromRunOptions(options);
         const state = APIStateManager_1.default.getAndUpdateState(config, options);
-        const testPlanner = new e2e_1.TestPlanner();
+        const testPlanner = new e2e_1.TestPlanner({ config });
         const { evalInBrowserAfterInitLoad } = options;
         yield testInBrowser({ testPlanner, config, evalInBrowserAfterInitLoad });
         const ret = BrowserInteractionResultReader_1.default.from(config.workDir);
@@ -287,9 +287,9 @@ function getConfigFromRunOptions(options) {
     if ('webWorker' in options) {
         config.isAnalyzingMainThread = false;
         const value = options.webWorker;
-        if (typeof value === 'string') {
-            config.targetWorkerTitle = value;
-        }
+        // config is a singleton shared by all API calls in the process, so the
+        // title has to be cleared when this run targets any web worker
+        config.targetWorkerTitle = typeof value === 'string' ? value : null;
     }
     else {
         config.isAnalyzingMainThread = true;

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

@@ -27,6 +27,9 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
 const index_1 = require("../../index");
 const E2ETestSettings_1 = require("./lib/E2ETestSettings");
 beforeEach(E2ETestSettings_1.testSetup);
+function hasPathEdgeWithName(leak, edgeName) {
+    return Object.keys(leak).some(key => key.includes(`--${edgeName} (`));
+}
 function injectDetachedDOMElements() {
     // @ts-ignore
     window.injectHookForLink4 = () => {
@@ -74,8 +77,11 @@ test('self-defined retainer trace filter work as expected (part 1)', () => __awa
         app: () => 'test-spa',
         url: () => '',
         action: (page) => __awaiter(void 0, void 0, void 0, function* () { return yield page.click('[data-testid="link-4"]'); }),
-        retainerReferenceFilter: (edge) => {
-            return edge.name_or_index !== '_path_1';
+        retainerReferenceFilter: (edge, _snapshot, isReferenceUsedByDefault) => {
+            if (edge.name_or_index === '_path_1') {
+                return false;
+            }
+            return isReferenceUsedByDefault;
         },
     };
     const workDir = path_1.default.join(os_1.default.tmpdir(), 'memlab-api-test', (0, E2ETestSettings_1.getUniqueID)());
@@ -85,12 +91,12 @@ test('self-defined retainer trace filter work as expected (part 1)', () => __awa
         evalInBrowserAfterInitLoad: injectDetachedDOMElements,
         workDir,
     });
-    // detected all different leak trace cluster
-    expect(result.leaks.length).toBe(1);
-    // expect the none of the traces to include _path_1
-    expect(result.leaks.every(leak => !JSON.stringify(leak).includes('_path_1')));
-    // expect some of the traces to include _path_2
-    expect(result.leaks.some(leak => JSON.stringify(leak).includes('_path_2')));
+    // detected leak trace clusters
+    expect(result.leaks.length).toBeGreaterThanOrEqual(1);
+    // expect none of the retainer trace paths to go through _path_1
+    expect(result.leaks.every(leak => !hasPathEdgeWithName(leak, '_path_1'))).toBe(true);
+    // expect some of the retainer trace paths to go through _path_2
+    expect(result.leaks.some(leak => hasPathEdgeWithName(leak, '_path_2'))).toBe(true);
     const reader = result.runResult;
     expect(path_1.default.resolve(reader.getRootDirectory())).toBe(path_1.default.resolve(workDir));
 }), E2ETestSettings_1.testTimeout);
@@ -99,8 +105,11 @@ test('self-defined retainer trace filter work as expected (part 2)', () => __awa
         app: () => 'test-spa',
         url: () => '',
         action: (page) => __awaiter(void 0, void 0, void 0, function* () { return yield page.click('[data-testid="link-4"]'); }),
-        retainerReferenceFilter: (edge) => {
-            return edge.name_or_index !== '_path_2';
+        retainerReferenceFilter: (edge, _snapshot, isReferenceUsedByDefault) => {
+            if (edge.name_or_index === '_path_2') {
+                return false;
+            }
+            return isReferenceUsedByDefault;
         },
     };
     const workDir = path_1.default.join(os_1.default.tmpdir(), 'memlab-api-test', (0, E2ETestSettings_1.getUniqueID)());
@@ -110,12 +119,12 @@ test('self-defined retainer trace filter work as expected (part 2)', () => __awa
         evalInBrowserAfterInitLoad: injectDetachedDOMElements,
         workDir,
     });
-    // detected all different leak trace cluster
-    expect(result.leaks.length).toBe(1);
-    // expect the none of the traces to include _path_2
-    expect(result.leaks.every(leak => !JSON.stringify(leak).includes('_path_2')));
-    // expect some of the traces to include _path_1
-    expect(result.leaks.some(leak => JSON.stringify(leak).includes('_path_1')));
+    // detected leak trace clusters
+    expect(result.leaks.length).toBeGreaterThanOrEqual(1);
+    // expect none of the retainer trace paths to go through _path_2
+    expect(result.leaks.every(leak => !hasPathEdgeWithName(leak, '_path_2'))).toBe(true);
+    // expect some of the retainer trace paths to go through _path_1
+    expect(result.leaks.some(leak => hasPathEdgeWithName(leak, '_path_1'))).toBe(true);
     const reader = result.runResult;
     expect(path_1.default.resolve(reader.getRootDirectory())).toBe(path_1.default.resolve(workDir));
 }), E2ETestSettings_1.testTimeout);

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

@@ -53,9 +53,9 @@ function checkResultReader(result) {
     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();
+    expect(() => result.getRootDirectory()).toThrow();
+    expect(() => result.getSnapshotFileDir()).toThrow();
+    expect(() => result.getSnapshotFiles()).toThrow();
 }
 test('result data/file reader is working as expected', () => __awaiter(void 0, void 0, void 0, function* () {
     const result = yield (0, index_1.warmupAndTakeSnapshots)({

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

@@ -84,7 +84,7 @@ function testIncorrectUseage(result) {
         // 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();
+        expect(() => __awaiter(this, void 0, void 0, function* () { return yield analysis.analyzeSnapshotFromFile(snapshotFile); })).rejects.toThrow();
     });
 }
 function testAnalysisWithSpecifiedWorkDir(result) {

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

@@ -54,7 +54,7 @@ test('String analysis works as expected', () => __awaiter(void 0, void 0, void 0
     // expect incorrect use of heap analysis to throw
     const snapshotDir = result.getSnapshotFileDir();
     analysis = new index_1.StringAnalysis();
-    expect(() => __awaiter(void 0, void 0, void 0, function* () { return yield analysis.analyzeSnapshotsInDirectory(snapshotDir); })).rejects.toThrowError();
+    expect(() => __awaiter(void 0, void 0, void 0, function* () { return yield analysis.analyzeSnapshotsInDirectory(snapshotDir); })).rejects.toThrow();
 }), E2ETestSettings_1.testTimeout);
 test('analyze function works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
     const result = yield (0, index_1.warmupAndTakeSnapshots)({

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

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

@@ -23,6 +23,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isExpectedSnapshot = isExpectedSnapshot;
 const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const core_1 = require("@memlab/core");
 const puppeteer = core_1.config.isFB
@@ -69,21 +70,27 @@ const TEST_URL = 'about:blank';
 function dumpHeap(snapshotFile, leakInjector) {
     return __awaiter(this, void 0, void 0, function* () {
         core_1.utils.tryToMutePuppeteerWarning();
-        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();
+        const userDataDir = fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), 'memlab-heap-test-'));
+        try {
+            const browser = yield puppeteer.launch(Object.assign(Object.assign({}, core_1.config.puppeteerConfig), { userDataDir }));
+            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();
+        }
+        finally {
+            fs_1.default.rmSync(userDataDir, { recursive: true, force: true });
+        }
     });
 }
 let fileId = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/api",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "license": "MIT",
   "description": "memlab API",
   "author": "Liang Gong <lgong@meta.com>",
@@ -27,16 +27,16 @@
     "access": "public"
   },
   "dependencies": {
-    "@memlab/core": "^2.0.3",
-    "@memlab/e2e": "^2.0.3",
-    "@memlab/heap-analysis": "^2.0.3",
+    "@memlab/core": "^2.0.5",
+    "@memlab/e2e": "^2.0.5",
+    "@memlab/heap-analysis": "^2.0.5",
     "ansi": "^0.3.1",
     "babar": "^0.2.0",
     "chalk": "^4.0.0",
     "fs-extra": "^4.0.2",
     "minimist": "^1.2.8",
-    "puppeteer": "^24.2.0",
-    "puppeteer-core": "^24.2.0",
+    "puppeteer": "24.31.0",
+    "puppeteer-core": "24.31.0",
     "string-width": "^4.2.0",
     "util.promisify": "^1.1.1",
     "xvfb": "^0.4.0"