@memlab/api 1.0.10 → 1.0.12

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/API.js

@@ -250,7 +250,7 @@ function setupPage(page, options = {}) {
         if (config.emulateDevice) {
             yield page.emulate(config.emulateDevice);
         }
-        if (config.defaultUserAgent) {
+        if (config.defaultUserAgent && config.defaultUserAgent !== 'default') {
             yield page.setUserAgent(config.defaultUserAgent);
         }
         // set login session

package/dist/__tests__/API/E2EInjectLeaksWithSetup.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 ws_labs
+ */
+export {};
+//# sourceMappingURL=E2EInjectLeaksWithSetup.test.d.ts.map

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

@@ -0,0 +1,89 @@
+"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 ws_labs
+ */
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const index_1 = require("../../index");
+const E2ETestSettings_1 = require("./lib/E2ETestSettings");
+beforeEach(E2ETestSettings_1.testSetup);
+// This test uses scenario.setup callback
+// to set window.injectHookForLink4
+// which injects memory leaks.
+// The following test cases will check
+// if MemLab can detect the injected memory leaks.
+const setup = (page) => __awaiter(void 0, void 0, void 0, function* () {
+    page.evaluate(() => {
+        // @ts-ignore
+        window.injectHookForLink4 = () => {
+            class TestObject {
+            }
+            const arr = [];
+            for (let i = 0; i < 23; ++i) {
+                arr.push(document.createElement('div'));
+            }
+            // @ts-ignore
+            window.__injectedValue = arr;
+            // @ts-ignore
+            window._path_1 = { x: { y: document.createElement('div') } };
+            // @ts-ignore
+            window._path_2 = new Set([document.createElement('div')]);
+            // @ts-ignore
+            window._randomObject = [new TestObject()];
+        };
+    });
+});
+test('leak detector can find detached DOM elements', () => __awaiter(void 0, void 0, void 0, function* () {
+    const { leaks } = yield (0, index_1.run)({
+        scenario: Object.assign(Object.assign({}, E2ETestSettings_1.scenario), { setup }),
+    });
+    // detected all different leak trace cluster
+    expect(leaks.length >= 1).toBe(true);
+    // expect all traces are found
+    expect(leaks.some(leak => JSON.stringify(leak).includes('__injectedValue')));
+    expect(leaks.some(leak => JSON.stringify(leak).includes('_path_1')));
+    expect(leaks.some(leak => JSON.stringify(leak).includes('_path_2')));
+}), E2ETestSettings_1.testTimeout);
+test('self-defined leak detector can find TestObject', () => __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 === 'TestObject' && node.type === 'object';
+        },
+        setup,
+    };
+    const workDir = path_1.default.join(os_1.default.tmpdir(), 'memlab-api-test', `${process.pid}`);
+    fs_extra_1.default.mkdirsSync(workDir);
+    const result = yield (0, index_1.run)({
+        scenario: selfDefinedScenario,
+        workDir,
+    });
+    // detected all different leak trace cluster
+    expect(result.leaks.length).toBe(1);
+    // expect all traces are found
+    expect(result.leaks.some(leak => JSON.stringify(leak).includes('_randomObject')));
+    const reader = result.runResult;
+    expect(path_1.default.resolve(reader.getRootDirectory())).toBe(path_1.default.resolve(workDir));
+}), E2ETestSettings_1.testTimeout);

package/dist/__tests__/API/E2EReloadInSetup.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 ws_labs
+ */
+export {};
+//# sourceMappingURL=E2EReloadInSetup.test.d.ts.map

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

@@ -0,0 +1,39 @@
+"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 ws_labs
+ */
+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);
+// clear the page reload check in setup
+// to check that the page reload check should
+// be injected after the setup callback
+const setup = (page) => __awaiter(void 0, void 0, void 0, function* () {
+    yield page.evaluate(() => {
+        // @ts-ignore
+        delete window.__memlab_check_reload;
+    });
+});
+test('reload in setup is fine', () => __awaiter(void 0, void 0, void 0, function* () {
+    const { leaks } = yield (0, index_1.run)({
+        scenario: Object.assign(Object.assign({}, E2ETestSettings_1.scenario), { setup }),
+    });
+    // no memory leaks are detected
+    expect(leaks.length).toBe(0);
+}), E2ETestSettings_1.testTimeout);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/api",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "license": "MIT",
   "description": "memlab API",
   "author": "Liang Gong <lgong@fb.com>",
@@ -20,15 +20,16 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "LICENSE"
   ],
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@memlab/core": "^1.1.6",
-    "@memlab/e2e": "^1.0.7",
-    "@memlab/heap-analysis": "^1.0.5",
+    "@memlab/core": "^1.1.10",
+    "@memlab/e2e": "^1.0.9",
+    "@memlab/heap-analysis": "^1.0.7",
     "ansi": "^0.3.1",
     "babar": "^0.2.0",
     "chalk": "^4.0.0",