@memlab/e2e 1.0.11 → 1.0.13

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/BaseSynthesizer.js

@@ -125,7 +125,7 @@ class BaseSynthesizer {
         return 1;
     }
     // get the URL of the target app
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/explicit-module-boundary-types
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     getBaseURL(_options = {}) {
         return 'https://www.facebook.com';
     }
@@ -134,7 +134,7 @@ class BaseSynthesizer {
         return url;
     }
     // get URL parameters
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/explicit-module-boundary-types
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     getURLParameters(_options = {}) {
         return '';
     }
@@ -335,6 +335,7 @@ class BaseSynthesizer {
             numOfWarmup: this.getActualNumberOfWarmup(),
             dataBuilder: null,
             isPageLoaded: (_a = scenario.isPageLoaded) !== null && _a !== void 0 ? _a : this.getPageLoadChecker(),
+            scenario,
         };
     }
     synthesisSimple(start, target, options = {}) {

package/dist/E2EInteractionManager.js

@@ -102,7 +102,10 @@ class E2EInteractionManager {
                 const url = `${baseURL}${subUrl}` + getURLParameter(tab, visitPlan);
                 logTabProgress(i, visitPlan);
                 yield maybeWaitForConsoleInput(i + 1);
-                const opArgs = { isPageLoaded: visitPlan.isPageLoaded };
+                const opArgs = {
+                    isPageLoaded: visitPlan.isPageLoaded,
+                    scenario: visitPlan.scenario,
+                };
                 yield applyAsyncWithRetry(this.getPageStatistics, this, [url, tab, opArgs], {
                     retry: runConfig.interactionFailRetry,
                 });
@@ -176,6 +179,7 @@ class E2EInteractionManager {
         });
     }
     getPageStatistics(url, tabInfo, opArgs = {}) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             if (core_1.config.verbose) {
                 core_1.info.lowLevel('url: ' + url);
@@ -197,6 +201,11 @@ class E2EInteractionManager {
             checkURL(this.page, url);
             // inject marker, which checks if the page is reloaded
             if (tabInfo.idx === 1) {
+                // call setup callback if the scenario has one
+                const setup = (_a = opArgs.scenario) === null || _a === void 0 ? void 0 : _a.setup;
+                if (setup) {
+                    yield setup(this.page);
+                }
                 yield injectPageReloadChecker(this.page);
             }
             else {

package/dist/lib/E2EUtils.js

@@ -121,7 +121,8 @@ function checkPageReload(page) {
         const flag = yield page.evaluate(() => window.__memlab_check_reload);
         if (flag !== 1) {
             core_1.utils.haltOrThrow('The page is reloaded. MemLab cannot analyze heap across page reloads. ' +
-                'Please remove window.reload() calls or disable any reload logic.');
+                'Please remove window.reload() calls, page.goto() calls, ' +
+                'or any reload logic.');
         }
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/e2e",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "license": "MIT",
   "description": "memlab browser E2E interaction libraries",
   "author": "Liang Gong <lgong@fb.com>",
@@ -17,7 +17,8 @@
   "types": "dist/index.d.ts",
   "files": [
     "dist",
-    "static"
+    "static",
+    "LICENSE"
   ],
   "dependencies": {
     "@memlab/core": "^1.1.10",

package/static/example/next.config.js

@@ -1,3 +1,8 @@
+/**
+ * (c) Meta Platforms, Inc. and affiliates. Confidential and proprietary.
+ *
+ * @oncall ws_labs
+ */
 // @nolint
 /** @type {import('next').NextConfig} */
 const nextConfig = {

package/static/example/scenarios/detached-dom.js

@@ -1,3 +1,8 @@
+/**
+ * (c) Meta Platforms, Inc. and affiliates. Confidential and proprietary.
+ *
+ * @oncall ws_labs
+ */
 // @nolint
 // memlab/packages/e2e/static/example/scenario/detached-dom.js
 /**

package/static/example/scenarios/oversized-object.js

@@ -1,3 +1,8 @@
+/**
+ * (c) Meta Platforms, Inc. and affiliates. Confidential and proprietary.
+ *
+ * @oncall ws_labs
+ */
 /* @nolint */
 
 function url() {