@memlab/e2e 1.0.0

package/dist/E2EInteractionManager.js

@@ -0,0 +1,347 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+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 fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const E2EUtils_1 = __importDefault(require("./lib/E2EUtils"));
+const core_1 = require("@memlab/core");
+const InteractionUtils_1 = __importDefault(require("./lib/operations/InteractionUtils"));
+const TestPlanner_1 = __importDefault(require("./lib/operations/TestPlanner"));
+const { logMetaData, setPermissions, logTabProgress, maybeWaitForConsoleInput, applyAsyncWithRetry, compareURL, waitExtraForTab, checkURL, injectPageReloadChecker, checkPageReload, dispatchOperation, clearConsole, getNavigationHistoryLength, checkLastSnapshotChunk, getURLParameter, } = E2EUtils_1.default;
+class E2EInteractionManager {
+    constructor(page) {
+        this.pageHistoryLength = [];
+        this.evalFuncAfterInitLoad = null;
+        this.page = page;
+    }
+    getCDPSession() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.cdpsession) {
+                this.cdpsession = yield this.page.target().createCDPSession();
+            }
+            return this.cdpsession;
+        });
+    }
+    clearCDPSession() {
+        this.cdpsession = null;
+    }
+    setEvalFuncAfterInitLoad(func) {
+        this.evalFuncAfterInitLoad = func;
+    }
+    initialLoad(page, url, opArgs = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (core_1.config.verbose) {
+                core_1.info.lowLevel(`loading: ${url}`);
+            }
+            core_1.info.overwrite('Connecting to web server...');
+            yield page.goto(url, {
+                timeout: core_1.config.initialPageLoadTimeout,
+                waitUntil: 'load',
+            });
+            // wait extra 10s in continuous test env for the initial page load
+            if (core_1.config.isContinuousTest) {
+                yield InteractionUtils_1.default.waitFor(10000);
+            }
+            if (this.evalFuncAfterInitLoad) {
+                yield page.evaluate(this.evalFuncAfterInitLoad);
+            }
+            yield InteractionUtils_1.default.waitUntilLoaded(page, opArgs);
+        });
+    }
+    beforeInteractions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (core_1.config.verbose) {
+                const browserVersion = yield this.page.browser().version();
+                core_1.info.lowLevel(`Browser version: ${browserVersion}`);
+                const nodeVersion = process.version;
+                core_1.info.lowLevel(`Node.js version: ${nodeVersion}`);
+            }
+        });
+    }
+    visitAndGetSnapshots(options = {}) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const visitPlan = options.testPlanner
+                ? options.testPlanner.getVisitPlan()
+                : TestPlanner_1.default.getVisitPlan();
+            const runConfig = (_a = options.config) !== null && _a !== void 0 ? _a : core_1.config;
+            // notify the running mode the current visit plan
+            runConfig.runningMode.beforeRunning(visitPlan);
+            logMetaData(visitPlan);
+            yield setPermissions(this.page, TestPlanner_1.default.getOrigin());
+            yield this.beforeInteractions();
+            const baseURL = core_1.utils.normalizeBaseUrl(visitPlan.baseURL);
+            yield this.startTrackingHeap();
+            for (let i = 0; i < visitPlan.tabsOrder.length; i++) {
+                core_1.info.beginSection(`step-${i}`);
+                if (runConfig.verbose) {
+                    core_1.info.lowLevel(new Date().toString());
+                }
+                const tab = visitPlan.tabsOrder[i];
+                const subUrl = tab.url.substr(tab.url.startsWith('/') ? 1 : 0);
+                const url = `${baseURL}${subUrl}` + getURLParameter(tab, visitPlan);
+                logTabProgress(i, visitPlan);
+                yield maybeWaitForConsoleInput(i + 1);
+                const opArgs = { isPageLoaded: visitPlan.isPageLoaded };
+                yield applyAsyncWithRetry(this.getPageStatistics, this, [url, tab, opArgs], {
+                    retry: runConfig.interactionFailRetry,
+                });
+                // dump browser console output in a readable file
+                core_1.browserInfo.dump();
+                core_1.info.nextLine();
+                core_1.info.endSection(`step-${i}`);
+            }
+            // show progress on console
+            core_1.info.topLevel(core_1.serializer.summarizeTabsOrder(visitPlan.tabsOrder, {
+                color: true,
+                progress: visitPlan.tabsOrder.length,
+            }) + '\n');
+            // serialize the meta data again (with more runtime and browser info)
+            logMetaData(visitPlan, { final: true });
+            // dump browser console output in a readable file
+            core_1.browserInfo.dump();
+        });
+    }
+    warmupInPage() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const visitPlan = TestPlanner_1.default.getVisitPlan();
+            const baseURL = visitPlan.baseURL;
+            const len = visitPlan.tabsOrder.length;
+            const visited = Object.create(null);
+            // randomize order
+            const tabs = core_1.utils.shuffleArray(Array.from(visitPlan.tabsOrder));
+            const multipler = core_1.config.warmupRepeat;
+            for (let i = 0; i < len * multipler; ++i) {
+                const tab = tabs[i % len];
+                visited[tab.name] |= 0;
+                if (++visited[tab.name] > multipler) {
+                    continue;
+                }
+                // print current progress
+                if (core_1.config.isContinuousTest || core_1.config.verbose) {
+                    let progress = `[${i + 1}/${len * multipler}]`;
+                    progress = `${progress}: warming up web server (${tab.name})...`;
+                    core_1.info.lowLevel(progress);
+                }
+                else {
+                    core_1.info.progress(i, len * multipler, { message: 'Warming up web server' });
+                }
+                // print url
+                const urlParams = getURLParameter(tab, visitPlan);
+                const url = `${baseURL}${tab.url}${urlParams}`;
+                if (core_1.config.verbose) {
+                    core_1.info.lowLevel(`url: ${url}`);
+                }
+                // warm up page
+                yield this.visitPage(url, {
+                    mute: true,
+                    isPageLoaded: visitPlan.isPageLoaded,
+                });
+                compareURL(this.page, url);
+            }
+        });
+    }
+    visitPage(url, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.page.goto(url, {
+                    timeout: core_1.config.warmupPageLoadTimeout,
+                    waitUntil: 'domcontentloaded',
+                });
+                yield InteractionUtils_1.default.waitUntilLoaded(this.page, options);
+            }
+            catch (ex) {
+                core_1.info.overwrite(core_1.utils.getError(ex).message);
+            }
+        });
+    }
+    getPageStatistics(url, tabInfo, opArgs = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (core_1.config.verbose) {
+                core_1.info.lowLevel('url: ' + url);
+            }
+            // visit the URL of the first step
+            if (tabInfo.idx === 1) {
+                yield applyAsyncWithRetry(this.initialLoad, this, [this.page, url, opArgs], {
+                    retry: core_1.config.initialLoadFailRetry,
+                    delayBeforeRetry: 3000,
+                });
+                // only use the interactions for steps other than the first step
+            }
+            else if (tabInfo.interactions) {
+                yield this.interactWithPage(this.page, tabInfo.interactions, opArgs);
+            }
+            if (tabInfo.type === 'final' || tabInfo.type === 'target') {
+                yield waitExtraForTab(tabInfo);
+            }
+            checkURL(this.page, url);
+            // inject marker, which checks if the page is reloaded
+            if (tabInfo.idx === 1) {
+                yield injectPageReloadChecker(this.page);
+            }
+            else {
+                yield checkPageReload(this.page);
+            }
+            yield this.fullGC(tabInfo);
+            // collect metrics
+            yield this.collectMetrics(tabInfo);
+            // take screenshot
+            const screenShotIdx = tabInfo.screenshot ? tabInfo.idx : 0;
+            if (core_1.config.runningMode.shouldTakeScreenShot(tabInfo) && screenShotIdx > 0) {
+                yield InteractionUtils_1.default.screenshot(this.page, screenShotIdx);
+            }
+            // take heap snapshot
+            const snapshotIdx = tabInfo.snapshot ? tabInfo.idx : 0;
+            if (core_1.config.runningMode.shouldTakeHeapSnapshot(tabInfo) && snapshotIdx > 0) {
+                const snapshotFile = path_1.default.join(core_1.config.curDataDir, `s${snapshotIdx}.heapsnapshot`);
+                yield this.saveHeapSnapshotToFile(snapshotFile);
+            }
+            if (tabInfo.postInteractions) {
+                yield this.interactWithPage(this.page, tabInfo.postInteractions, opArgs);
+            }
+        });
+    }
+    interactWithPage(page, operations, opArgs = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const args = Object.assign(Object.assign({}, opArgs), { pageHistoryLength: this.pageHistoryLength });
+            if (typeof operations === 'function') {
+                yield operations(page, args);
+                yield InteractionUtils_1.default.waitUntilLoaded(page, args);
+            }
+            else if (Array.isArray(operations)) {
+                for (const op of operations) {
+                    yield this.interactWithPage(page, op, args);
+                }
+            }
+            else if (operations.kind) {
+                yield dispatchOperation(page, operations, args);
+            }
+            else {
+                core_1.utils.throwError(new Error('unknown operation'));
+            }
+        });
+    }
+    startTrackingHeap() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (core_1.config.verbose) {
+                core_1.info.lowLevel('Start tracking JS heap');
+            }
+            const session = yield this.getCDPSession();
+            yield session.send('HeapProfiler.enable');
+        });
+    }
+    writeSnapshotFileFromCDPSession(file, session) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const writeStream = fs_1.default.createWriteStream(file, { encoding: 'UTF-8' });
+            let lastChunk = '';
+            const dataHandler = (data) => {
+                writeStream.write(data.chunk);
+                lastChunk = data.chunk;
+            };
+            const progressHander = (data) => {
+                const percent = ((100 * data.done) / data.total) | 0;
+                if (!core_1.config.isContinuousTest) {
+                    core_1.info.overwrite(`heap snapshot ${percent}% complete`);
+                }
+            };
+            session.on('HeapProfiler.addHeapSnapshotChunk', dataHandler);
+            session.on('HeapProfiler.reportHeapSnapshotProgress', progressHander);
+            // start taking heap snapshot
+            yield session.send('HeapProfiler.takeHeapSnapshot', {
+                reportProgress: true,
+                captureNumericValue: true,
+            });
+            checkLastSnapshotChunk(lastChunk);
+            session.removeListener('HeapProfiler.addHeapSnapshotChunk', dataHandler);
+            session.removeListener('HeapProfiler.reportHeapSnapshotProgress', progressHander);
+            writeStream.end();
+        });
+    }
+    saveHeapSnapshotToFile(file) {
+        return __awaiter(this, void 0, void 0, function* () {
+            core_1.info.beginSection('heap snapshot');
+            const start = Date.now();
+            const session = yield this.getCDPSession();
+            yield this.writeSnapshotFileFromCDPSession(file, session);
+            const spanMs = Date.now() - start;
+            if (core_1.config.verbose) {
+                core_1.info.lowLevel(`duration: ${core_1.utils.getReadableTime(spanMs)}`);
+            }
+            core_1.info.overwrite('snapshot saved to disk');
+            core_1.info.endSection('heap snapshot');
+        });
+    }
+    fullGC(tabInfo) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!core_1.config.runningMode.shouldGC(tabInfo)) {
+                return;
+            }
+            if (core_1.config.clearConsole) {
+                yield clearConsole(this.page);
+                core_1.info.overwrite('running a full GC (clear console)...');
+            }
+            else {
+                core_1.info.overwrite('running a full GC...');
+            }
+            // force GC 6 times to release feedback_cells
+            yield this.forceGC(6);
+        });
+    }
+    forceGC(repeat = 1) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const client = yield this.getCDPSession();
+            for (let i = 0; i < repeat; i++) {
+                yield client.send('HeapProfiler.collectGarbage');
+                // wait for a while and let GC do the job
+                yield InteractionUtils_1.default.waitFor(200);
+            }
+            yield InteractionUtils_1.default.waitFor(core_1.config.waitAfterGC);
+        });
+    }
+    collectMetrics(tabInfo) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            // collect navigation history info
+            const historyLength = yield getNavigationHistoryLength(this.page);
+            this.pageHistoryLength.push(historyLength);
+            if (!core_1.config.runningMode.shouldGetMetrics(tabInfo)) {
+                return;
+            }
+            yield this.forceGC();
+            // collect heap size
+            const builtInMetrics = yield this.page.metrics();
+            const size = core_1.utils.getReadableBytes(builtInMetrics.JSHeapUsedSize);
+            core_1.info.midLevel(`Heap size: ${size}`);
+            tabInfo.JSHeapUsedSize = (_a = builtInMetrics.JSHeapUsedSize) !== null && _a !== void 0 ? _a : 0;
+            // collect additional metrics
+            const metrics = yield core_1.config.runningMode.getAdditionalMetrics(this.page, tabInfo);
+            for (const key of Object.keys(metrics)) {
+                if (Object.prototype.hasOwnProperty.call(tabInfo, key)) {
+                    core_1.info.warning(`overwriting metrics: ${key}`);
+                }
+            }
+            tabInfo.metrics = metrics;
+        });
+    }
+}
+exports.default = E2EInteractionManager;

package/dist/TestRunnerLoader.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import type { E2EScenarioSynthesizerConstructor } from '@memlab/core';
+declare class TestRunnerLoader {
+    load(): E2EScenarioSynthesizerConstructor[];
+}
+declare const _default: TestRunnerLoader;
+export default _default;
+//# sourceMappingURL=TestRunnerLoader.d.ts.map

package/dist/TestRunnerLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestRunnerLoader.d.ts","sourceRoot":"","sources":["../src/TestRunnerLoader.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EAAC,iCAAiC,EAAC,MAAM,cAAc,CAAC;AAIpE,cAAM,gBAAgB;IACpB,IAAI,IAAI,iCAAiC,EAAE;CAuB5C;;AAED,wBAAsC"}

package/dist/TestRunnerLoader.js

@@ -0,0 +1,41 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const core_1 = require("@memlab/core");
+const BaseSynthesizer_1 = __importDefault(require("./BaseSynthesizer"));
+class TestRunnerLoader {
+    load() {
+        const ret = [];
+        const dir = path_1.default.join(__dirname, 'plugins');
+        core_1.fileManager.iterateAllFiles(dir, (file) => {
+            if (!file.endsWith('Synthesizer.js')) {
+                return;
+            }
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const importedEntity = require(file);
+            if (!importedEntity.default) {
+                return;
+            }
+            const constructor = importedEntity.default;
+            if (typeof constructor !== 'function' ||
+                !(constructor.prototype instanceof BaseSynthesizer_1.default)) {
+                return;
+            }
+            ret.push(constructor);
+        });
+        return ret;
+    }
+}
+exports.default = new TestRunnerLoader();

package/dist/TypesThirdParty.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+declare module 'xvfb' {
+    interface XvfbParams {
+        silent: boolean;
+        xvfb_args: string[];
+        timeout: number;
+    }
+    export default class Xvfb {
+        constructor(params: XvfbParams);
+        start: (callback: (error: Error) => unknown | null) => void;
+        stop: (callback: (error: Error) => unknown | null) => void;
+        startSync: () => void;
+        stopSync: () => void;
+        display: () => string;
+    }
+}
+//# sourceMappingURL=TypesThirdParty.d.ts.map

package/dist/TypesThirdParty.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypesThirdParty.d.ts","sourceRoot":"","sources":["../src/TypesThirdParty.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,QAAQ,MAAM,CAAC;IACpB,UAAU,UAAU;QAClB,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,MAAM,EAAE,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KACjB;IACD,MAAM,CAAC,OAAO,OAAO,IAAI;oBACX,MAAM,EAAE,UAAU;QAC9B,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,GAAG,IAAI,KAAK,IAAI,CAAC;QAC5D,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,GAAG,IAAI,KAAK,IAAI,CAAC;QAC3D,SAAS,EAAE,MAAM,IAAI,CAAC;QACtB,QAAQ,EAAE,MAAM,IAAI,CAAC;QACrB,OAAO,EAAE,MAAM,MAAM,CAAC;KACvB;CACF"}

package/dist/TypesThirdParty.js

@@ -0,0 +1,10 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export { default as defaultTestPlanner } from './lib/operations/TestPlanner';
+export * from './lib/operations/TestPlanner';
+export { default as Xvfb } from './lib/operations/XVirtualFrameBuffer';
+export { default as E2EInteractionManager } from './E2EInteractionManager';
+export { default as BaseSynthesizer } from './BaseSynthesizer';
+export { default as E2EUtils } from './lib/E2EUtils';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,8BAA8B,CAAC;AAC3E,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EAAC,OAAO,IAAI,IAAI,EAAC,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAC,OAAO,IAAI,qBAAqB,EAAC,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAC,OAAO,IAAI,QAAQ,EAAC,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,40 @@
+"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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.E2EUtils = exports.BaseSynthesizer = exports.E2EInteractionManager = exports.Xvfb = exports.defaultTestPlanner = void 0;
+var TestPlanner_1 = require("./lib/operations/TestPlanner");
+Object.defineProperty(exports, "defaultTestPlanner", { enumerable: true, get: function () { return __importDefault(TestPlanner_1).default; } });
+__exportStar(require("./lib/operations/TestPlanner"), exports);
+var XVirtualFrameBuffer_1 = require("./lib/operations/XVirtualFrameBuffer");
+Object.defineProperty(exports, "Xvfb", { enumerable: true, get: function () { return __importDefault(XVirtualFrameBuffer_1).default; } });
+var E2EInteractionManager_1 = require("./E2EInteractionManager");
+Object.defineProperty(exports, "E2EInteractionManager", { enumerable: true, get: function () { return __importDefault(E2EInteractionManager_1).default; } });
+var BaseSynthesizer_1 = require("./BaseSynthesizer");
+Object.defineProperty(exports, "BaseSynthesizer", { enumerable: true, get: function () { return __importDefault(BaseSynthesizer_1).default; } });
+var E2EUtils_1 = require("./lib/E2EUtils");
+Object.defineProperty(exports, "E2EUtils", { enumerable: true, get: function () { return __importDefault(E2EUtils_1).default; } });

package/dist/lib/E2EUtils.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import type { 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;
+declare function getURLParameter(tab: E2EStepInfo, visitPlan: IE2EScenarioVisitPlan): string;
+declare function compareURL(page: Page, url: string): void;
+declare function logTabProgress(i: number, visitPlan: IE2EScenarioVisitPlan): void;
+declare function serializeVisitPlan(visitPlan: IE2EScenarioVisitPlan): void;
+declare function logMetaData(visitPlan: IE2EScenarioVisitPlan, opt?: AnyOptions & {
+    final?: boolean;
+}): void;
+declare function setPermissions(page: Page, origin: Nullable<string>): Promise<void>;
+declare function checkURL(page: Page, intendedURL: string): void;
+declare function injectPageReloadChecker(page: Page): Promise<void>;
+declare function checkPageReload(page: Page): Promise<void>;
+declare function maybeWaitForConsoleInput(stepId: number): Promise<void>;
+declare function applyAsyncWithGuard(f: (...args: AnyValue[]) => Promise<AnyValue>, self: AnyValue, args: AnyValue[], exceptionHandler?: ExceptionHandler): Promise<AnyValue>;
+declare function applyAsyncWithRetry(f: (...args: AnyValue[]) => Promise<AnyValue>, self: AnyValue, args: AnyValue[], options?: AnyOptions & {
+    retry?: number;
+    delayBeforeRetry?: number;
+}): Promise<void>;
+declare function clearConsole(page: Page): Promise<void>;
+declare function dispatchOperation(page: Page, operation: E2EOperation, opArgs: OperationArgs): Promise<void>;
+declare function waitExtraForTab(tabInfo: E2EStepInfo): Promise<void>;
+declare function getNavigationHistoryLength(page: Page): Promise<number>;
+declare function startTrackingHeapAllocation(page: Page, file: string): Promise<CDPSession>;
+declare function getScenarioAppName(scenario?: Nullable<IScenario>): string;
+declare const _default: {
+    applyAsyncWithGuard: typeof applyAsyncWithGuard;
+    applyAsyncWithRetry: typeof applyAsyncWithRetry;
+    checkLastSnapshotChunk: typeof checkLastSnapshotChunk;
+    checkPageReload: typeof checkPageReload;
+    checkURL: typeof checkURL;
+    clearConsole: typeof clearConsole;
+    compareURL: typeof compareURL;
+    dispatchOperation: typeof dispatchOperation;
+    getNavigationHistoryLength: typeof getNavigationHistoryLength;
+    getScenarioAppName: typeof getScenarioAppName;
+    getURLParameter: typeof getURLParameter;
+    injectPageReloadChecker: typeof injectPageReloadChecker;
+    logMetaData: typeof logMetaData;
+    logTabProgress: typeof logTabProgress;
+    maybeWaitForConsoleInput: typeof maybeWaitForConsoleInput;
+    serializeVisitPlan: typeof serializeVisitPlan;
+    setPermissions: typeof setPermissions;
+    startTrackingHeapAllocation: typeof startTrackingHeapAllocation;
+    waitExtraForTab: typeof waitExtraForTab;
+};
+export default _default;
+//# sourceMappingURL=E2EUtils.d.ts.map

package/dist/lib/E2EUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"E2EUtils.d.ts","sourceRoot":"","sources":["../../src/lib/E2EUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,qBAAqB,EACrB,SAAS,EACT,QAAQ,EACR,aAAa,EACd,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,WAAW,CAAC;AAQhD,aAAK,gBAAgB,GAAG,CAAC,EAAE,EAAE,KAAK,KAAK,IAAI,CAAC;AAE5C,iBAAS,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CASnD;AAGD,iBAAS,eAAe,CACtB,GAAG,EAAE,WAAW,EAChB,SAAS,EAAE,qBAAqB,GAC/B,MAAM,CAcR;AAED,iBAAS,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAajD;AAED,iBAAS,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,qBAAqB,GAAG,IAAI,CAgBzE;AAED,iBAAS,kBAAkB,CAAC,SAAS,EAAE,qBAAqB,GAAG,IAAI,CAMlE;AAED,iBAAS,WAAW,CAClB,SAAS,EAAE,qBAAqB,EAChC,GAAG,GAAE,UAAU,GAAG;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAM,GACvC,IAAI,CAeN;AAED,iBAAe,cAAc,CAC3B,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GACvB,OAAO,CAAC,IAAI,CAAC,CAOf;AAGD,iBAAS,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAEvD;AAED,iBAAe,uBAAuB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAKhE;AAED,iBAAe,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CASxD;AAED,iBAAe,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMrE;AAED,iBAAe,mBAAmB,CAChC,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,KAAK,OAAO,CAAC,QAAQ,CAAC,EAC7C,IAAI,EAAE,QAAQ,EACd,IAAI,EAAE,QAAQ,EAAE,EAEhB,gBAAgB,GAAE,gBAEjB,GACA,OAAO,CAAC,QAAQ,CAAC,CAQnB;AAED,iBAAe,mBAAmB,CAChC,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,KAAK,OAAO,CAAC,QAAQ,CAAC,EAC7C,IAAI,EAAE,QAAQ,EACd,IAAI,EAAE,QAAQ,EAAE,EAChB,OAAO,GAAE,UAAU,GAAG;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAAM,GACrE,OAAO,CAAC,IAAI,CAAC,CA4Bf;AAED,iBAAe,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAUrD;AAED,iBAAe,iBAAiB,CAC9B,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,YAAY,EACvB,MAAM,EAAE,aAAa,GACpB,OAAO,CAAC,IAAI,CAAC,CAKf;AAED,iBAAe,eAAe,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAoBlE;AAED,iBAAe,0BAA0B,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAUrE;AAID,iBAAe,2BAA2B,CACxC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,UAAU,CAAC,CAarB;AAED,iBAAS,kBAAkB,CAAC,QAAQ,GAAE,QAAQ,CAAC,SAAS,CAAQ,GAAG,MAAM,CAKxE;;;;;;;;;;;;;;;;;;;;;;AAMD,wBAwBE"}