@memlab/e2e 1.0.21 → 1.0.23

package/dist/lib/E2EUtils.d.ts

@@ -7,7 +7,7 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { AnyOptions, AnyValue, E2EOperation, E2EStepInfo, IE2EScenarioVisitPlan, IScenario, Nullable, OperationArgs } from '@memlab/core';
+import { AnyOptions, AnyValue, E2EOperation, E2EStepInfo, IE2EScenarioVisitPlan, IScenario, Nullable, OperationArgs } from '@memlab/core';
 import type { CDPSession, Page } from 'puppeteer';
 declare type ExceptionHandler = (ex: Error) => void;
 declare function checkLastSnapshotChunk(chunk: string): void;

package/dist/lib/E2EUtils.js

@@ -21,15 +21,16 @@ 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 core_1 = require("@memlab/core");
+const fs_1 = __importDefault(require("fs"));
+const core_2 = require("@memlab/core");
 const BaseOperation_1 = __importDefault(require("./operations/BaseOperation"));
 const InteractionUtils_1 = __importDefault(require("./operations/InteractionUtils"));
-const core_2 = require("@memlab/core");
+const core_3 = require("@memlab/core");
 function checkLastSnapshotChunk(chunk) {
     const regex = /\}\s*$/;
     if (!regex.test(chunk)) {
-        core_1.utils.throwError(new Error('resolved `HeapProfiler.takeHeapSnapshot` before writing the last chunk'));
+        core_2.utils.throwError(new Error('resolved `HeapProfiler.takeHeapSnapshot` before writing the last chunk'));
     }
 }
 // get URL parameter for a specific step
@@ -46,17 +47,17 @@ function getURLParameter(tab, visitPlan) {
     return ret;
 }
 function compareURL(page, url) {
-    if (!core_1.config.verbose) {
+    if (!core_2.config.verbose) {
         return;
     }
     const actual = unescape(page.url());
     url = unescape(url);
-    if (!core_1.utils.isURLEqual(url, actual)) {
-        core_1.info.warning('URL changed:');
-        core_1.info.lowLevel(` Expected: ${url}`);
-        core_1.info.lowLevel('----');
-        core_1.info.lowLevel(` Actual:   ${actual}`);
-        core_1.info.lowLevel('');
+    if (!core_2.utils.isURLEqual(url, actual)) {
+        core_2.info.warning('URL changed:');
+        core_2.info.lowLevel(` Expected: ${url}`);
+        core_2.info.lowLevel('----');
+        core_2.info.lowLevel(` Actual:   ${actual}`);
+        core_2.info.lowLevel('');
     }
 }
 function logTabProgress(i, visitPlan) {
@@ -65,32 +66,32 @@ function logTabProgress(i, visitPlan) {
     const progress = `[${i + 1}/${len}]`;
     const tabType = tab.type ? `(${tab.type})` : '';
     const msg = `${progress} visiting ${tab.name} ${tabType}`;
-    if (core_1.config.verbose) {
-        core_1.info.topLevel(msg);
+    if (core_2.config.verbose) {
+        core_2.info.topLevel(msg);
     }
-    core_1.info.topLevel(core_1.serializer.summarizeTabsOrder(visitPlan.tabsOrder, {
+    core_2.info.topLevel(core_2.serializer.summarizeTabsOrder(visitPlan.tabsOrder, {
         color: true,
         progress: i,
     }));
-    core_1.browserInfo.addMarker(`[memlab]: ${msg}`);
+    core_2.browserInfo.addMarker(`[memlab]: ${msg}`);
 }
 function serializeVisitPlan(visitPlan) {
-    fs_1.default.writeFileSync(core_1.config.snapshotSequenceFile, JSON.stringify(visitPlan.tabsOrder, null, 2), 'UTF-8');
+    fs_1.default.writeFileSync(core_2.config.snapshotSequenceFile, JSON.stringify(visitPlan.tabsOrder, null, 2), 'UTF-8');
 }
 function logMetaData(visitPlan, opt = {}) {
     // save the visiting info to disk
     serializeVisitPlan(visitPlan);
     // save the run meta info to disk
     const runMeta = {
-        app: core_1.config.targetApp,
+        app: core_2.config.targetApp,
         type: visitPlan.type,
-        interaction: core_1.config.targetTab,
-        browserInfo: core_1.browserInfo,
+        interaction: core_2.config.targetTab,
+        browserInfo: core_2.browserInfo,
     };
-    fs_1.default.writeFileSync(core_1.config.runMetaFile, JSON.stringify(runMeta), 'UTF-8');
+    core_1.runInfoUtils.runMetaInfoManager.saveRunMetaInfo(runMeta);
     // additional post processing of collected data
     if (opt.final) {
-        core_1.config.runningMode.postProcessData(visitPlan);
+        core_2.config.runningMode.postProcessData(visitPlan);
     }
 }
 function setPermissions(page, origin) {
@@ -100,7 +101,7 @@ function setPermissions(page, origin) {
         }
         const browser = page.browser();
         const context = browser.defaultBrowserContext();
-        yield context.overridePermissions(origin, core_1.config.grantedPermissions);
+        yield context.overridePermissions(origin, core_2.config.grantedPermissions);
     });
 }
 // check if the URL is correct
@@ -120,7 +121,7 @@ function checkPageReload(page) {
         // @ts-expect-error TODO: add Window shim type
         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. ' +
+            core_2.utils.haltOrThrow('The page is reloaded. MemLab cannot analyze heap across page reloads. ' +
                 'Please remove window.reload() calls, page.goto() calls, ' +
                 'or any reload logic.');
         }
@@ -128,8 +129,8 @@ function checkPageReload(page) {
 }
 function maybeWaitForConsoleInput(stepId) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (core_1.config.isManualDebug) {
-            yield core_1.info.waitForConsole(`Press Enter (or Return) to continue step-${stepId}:`);
+        if (core_2.config.isManualDebug) {
+            yield core_2.info.waitForConsole(`Press Enter (or Return) to continue step-${stepId}:`);
         }
     });
 }
@@ -144,7 +145,7 @@ exceptionHandler = (_ex) => {
             ret = yield f.apply(self, args);
         }
         catch (ex) {
-            exceptionHandler(core_1.utils.getError(ex));
+            exceptionHandler(core_2.utils.getError(ex));
         }
         return ret;
     });
@@ -154,19 +155,19 @@ function applyAsyncWithRetry(f, self, args, options = {}) {
         options.retry = options.retry || 0;
         const retry = options.retry;
         const exceptionHandler = (ex) => __awaiter(this, void 0, void 0, function* () {
-            if (retry <= 0 || core_1.config.verbose) {
+            if (retry <= 0 || core_2.config.verbose) {
                 // if the browser UI is enabled, MemLab should wait for a while
                 // so we can have a chance to manually inspect the page
-                if (core_1.config.openDevtoolsConsole) {
-                    yield InteractionUtils_1.default.waitFor(core_1.config.delayBeforeExitUponException);
+                if (core_2.config.openDevtoolsConsole) {
+                    yield InteractionUtils_1.default.waitFor(core_2.config.delayBeforeExitUponException);
                 }
-                core_1.utils.haltOrThrow(core_1.utils.getError(ex), {
+                core_2.utils.haltOrThrow(core_2.utils.getError(ex), {
                     printCallback: () => {
-                        core_1.info.warning('interaction fail');
+                        core_2.info.warning('interaction fail');
                     },
                 });
             }
-            core_1.info.warning(`interaction fail, making ${retry} more attempt(s)...`);
+            core_2.info.warning(`interaction fail, making ${retry} more attempt(s)...`);
             if (!!options.delayBeforeRetry && options.delayBeforeRetry > 0) {
                 yield InteractionUtils_1.default.waitFor(options.delayBeforeRetry);
             }
@@ -180,7 +181,7 @@ function applyAsyncWithRetry(f, self, args, options = {}) {
 }
 function clearConsole(page) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (core_1.config.clearConsole) {
+        if (core_2.config.clearConsole) {
             yield page.evaluate(() => {
                 try {
                     console.clear();
@@ -195,7 +196,7 @@ function clearConsole(page) {
 function dispatchOperation(page, operation, opArgs) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!(operation instanceof BaseOperation_1.default)) {
-            throw core_1.utils.haltOrThrow(`unknown operation: ${operation}`);
+            throw core_2.utils.haltOrThrow(`unknown operation: ${operation}`);
         }
         yield operation.do(page, opArgs);
     });
@@ -203,22 +204,22 @@ function dispatchOperation(page, operation, opArgs) {
 function waitExtraForTab(tabInfo) {
     return __awaiter(this, void 0, void 0, function* () {
         let delay = 0;
-        const mode = core_1.config.runningMode;
+        const mode = core_2.config.runningMode;
         if (tabInfo.type === 'target') {
             if (!mode.shouldExtraWaitForTarget(tabInfo)) {
                 return;
             }
-            delay += core_1.config.extraWaitingForTarget;
+            delay += core_2.config.extraWaitingForTarget;
         }
         else if (tabInfo.type === 'final') {
             if (!mode.shouldExtraWaitForFinal(tabInfo)) {
                 return;
             }
-            delay += core_1.config.extraWaitingForFinal;
+            delay += core_2.config.extraWaitingForFinal;
         }
         // wait for extra time
         if (delay > 0) {
-            core_1.info.overwrite(`wait extra ${delay / 1000}s for ${tabInfo.type} page...`);
+            core_2.info.overwrite(`wait extra ${delay / 1000}s for ${tabInfo.type} page...`);
             yield InteractionUtils_1.default.waitFor(delay);
         }
     });
@@ -243,7 +244,7 @@ function startTrackingHeapAllocation(page, file) {
     return __awaiter(this, void 0, void 0, function* () {
         const heap = '';
         fs_1.default.writeFileSync(file, heap, 'UTF-8');
-        core_1.info.lowLevel('tracking heap allocation...');
+        core_2.info.lowLevel('tracking heap allocation...');
         const cdpSession = yield page.target().createCDPSession();
         cdpSession.on('HeapProfiler.addHeapSnapshotChunk', data => {
             fs_1.default.appendFileSync(file, data.chunk, 'UTF-8');
@@ -264,7 +265,7 @@ function getScenarioAppName(scenario = null) {
 function getScenarioDefaultAppName() {
     return 'default-app-for-scenario';
 }
-exports.default = (0, core_2.setInternalValue)({
+exports.default = (0, core_3.setInternalValue)({
     applyAsyncWithGuard,
     applyAsyncWithRetry,
     checkLastSnapshotChunk,
@@ -284,4 +285,4 @@ exports.default = (0, core_2.setInternalValue)({
     setPermissions,
     startTrackingHeapAllocation,
     waitExtraForTab,
-}, __filename, core_2.constant.internalDir);
+}, __filename, core_3.constant.internalDir);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/e2e",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "license": "MIT",
   "description": "memlab browser E2E interaction libraries",
   "author": "Liang Gong <lgong@fb.com>",