@memlab/api 1.0.18 → 1.0.20

package/dist/API.d.ts

@@ -8,7 +8,7 @@
  * @oncall web_perf_infra
  */
 import type { ParsedArgs } from 'minimist';
-import type { AnyFunction, ISerializedInfo, IScenario } from '@memlab/core';
+import type { AnyFunction, ISerializedInfo, IScenario, Optional } from '@memlab/core';
 import { MemLabConfig } from '@memlab/core';
 import { TestPlanner } from '@memlab/e2e';
 import { BaseAnalysis } from '@memlab/heap-analysis';
@@ -45,6 +45,13 @@ export declare type RunOptions = {
      * specified working directory exists.
      */
     workDir?: string;
+    /**
+     * if this field is provided, it specifies the web worker as the target
+     * for heap analysis. For example `{webWorker: null}` means analyzing
+     * the heap of the first web worker found. `{webWorker: 'workerTitle'}`
+     * means analyzing the heap of the web worker with name: `'workerTitle'`.
+     */
+    webWorker?: Optional<string>;
 };
 /**
  * A data structure holding the result of the {@link run} API call.

package/dist/API.js

@@ -215,7 +215,7 @@ function warmup(options = {}) {
             core_1.info.beginSection('warmup');
             yield Promise.all(pages.map((page) => __awaiter(this, void 0, void 0, function* () {
                 yield setupPage(page, { cache: false });
-                const interactionManager = new e2e_1.E2EInteractionManager(page);
+                const interactionManager = new e2e_1.E2EInteractionManager(page, browser);
                 yield interactionManager.warmupInPage();
             }))).catch(err => {
                 core_1.info.error(err.message);
@@ -239,6 +239,16 @@ function getConfigFromRunOptions(options) {
     else {
         config = core_1.MemLabConfig.resetConfigWithTransientDir();
     }
+    if ('webWorker' in options) {
+        config.isAnalyzingMainThread = false;
+        const value = options.webWorker;
+        if (typeof value === 'string') {
+            config.targetWorkerTitle = value;
+        }
+    }
+    else {
+        config.isAnalyzingMainThread = true;
+    }
     config.isFullRun = !!options.snapshotForEachStep;
     return config;
 }
@@ -304,7 +314,7 @@ function testInBrowser(options = {}) {
             const browser = yield APIUtils_1.default.getBrowser();
             const pages = yield browser.pages();
             const page = pages.length > 0 ? pages[0] : yield browser.newPage();
-            interactionManager = new e2e_1.E2EInteractionManager(page);
+            interactionManager = new e2e_1.E2EInteractionManager(page, browser);
             if (options.evalInBrowserAfterInitLoad) {
                 interactionManager.setEvalFuncAfterInitLoad(options.evalInBrowserAfterInitLoad);
             }

package/dist/__tests__/API/E2EFindWebWorkerLeaks.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.
+ *
+ * @format
+ * @oncall web_perf_infra
+ */
+export {};
+//# sourceMappingURL=E2EFindWebWorkerLeaks.test.d.ts.map

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

@@ -0,0 +1,69 @@
+"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) {
+        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 });
+const index_1 = require("../../index");
+const E2ETestSettings_1 = require("./lib/E2ETestSettings");
+beforeEach(E2ETestSettings_1.testSetup);
+test('self-defined leak detector can find Web Worker TestObject (in initial load)', () => __awaiter(void 0, void 0, void 0, function* () {
+    const selfDefinedScenario = {
+        app: () => 'test-spa',
+        url: () => '',
+        leakFilter: (node) => {
+            return node.name === 'WorkerTestObject' && node.type === 'object';
+        },
+    };
+    const result = yield (0, index_1.run)({
+        scenario: selfDefinedScenario,
+        webWorker: null,
+    });
+    // detected all different leak trace cluster
+    expect(result.leaks.length).toBe(1);
+}), E2ETestSettings_1.testTimeout);
+test('self-defined leak detector can find Web Worker TestObject with specified worker name (in initial load)', () => __awaiter(void 0, void 0, void 0, function* () {
+    const selfDefinedScenario = {
+        app: () => 'test-spa',
+        url: () => '',
+        leakFilter: (node) => {
+            return node.name === 'WorkerTestObject' && node.type === 'object';
+        },
+    };
+    const result = yield (0, index_1.run)({
+        scenario: selfDefinedScenario,
+        webWorker: 'test-worker',
+    });
+    // detected all different leak trace cluster
+    expect(result.leaks.length).toBe(1);
+}), E2ETestSettings_1.testTimeout);
+test('self-defined leak detector can find Web Worker TestObject (during interaction)', () => __awaiter(void 0, void 0, void 0, function* () {
+    const selfDefinedScenario = {
+        app: () => 'test-spa',
+        url: () => '',
+        action: (page) => __awaiter(void 0, void 0, void 0, function* () { return yield page.click('[data-testid="link-4"]'); }),
+        leakFilter: (node) => {
+            return node.name === 'WorkerTestObject' && node.type === 'object';
+        },
+    };
+    const result = yield (0, index_1.run)({
+        scenario: selfDefinedScenario,
+        webWorker: null,
+    });
+    // detected all different leak trace cluster
+    expect(result.leaks.length).toBe(1);
+}), E2ETestSettings_1.testTimeout);

package/package.json

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