@memlab/e2e 1.0.0

package/dist/lib/E2EUtils.js

@@ -0,0 +1,286 @@
+"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 core_1 = require("@memlab/core");
+const BaseOperation_1 = __importDefault(require("./operations/BaseOperation"));
+const InteractionUtils_1 = __importDefault(require("./operations/InteractionUtils"));
+const core_2 = 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'));
+    }
+}
+// get URL parameter for a specific step
+function getURLParameter(tab, visitPlan) {
+    var _a, _b;
+    const params = visitPlan.URLParameters;
+    const stepParams = (_b = (_a = tab.urlParams) === null || _a === void 0 ? void 0 : _a.map(({ name, value }) => [name, value].map(encodeURIComponent).join('=')).join('&')) !== null && _b !== void 0 ? _b : '';
+    let ret = params +
+        (params.length > 0 && stepParams.length > 0 ? '&' : '') +
+        stepParams;
+    if (ret.length > 0 && !ret.startsWith('?')) {
+        ret = '?' + ret;
+    }
+    return ret;
+}
+function compareURL(page, url) {
+    if (!core_1.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('');
+    }
+}
+function logTabProgress(i, visitPlan) {
+    const len = visitPlan.tabsOrder.length;
+    const tab = visitPlan.tabsOrder[i];
+    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);
+    }
+    core_1.info.topLevel(core_1.serializer.summarizeTabsOrder(visitPlan.tabsOrder, {
+        color: true,
+        progress: i,
+    }));
+    core_1.browserInfo.addMarker(`[memlab]: ${msg}`);
+}
+function serializeVisitPlan(visitPlan) {
+    fs_1.default.writeFileSync(core_1.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,
+        type: visitPlan.type,
+        interaction: core_1.config.targetTab,
+        browserInfo: core_1.browserInfo,
+    };
+    fs_1.default.writeFileSync(core_1.config.runMetaFile, JSON.stringify(runMeta), 'UTF-8');
+    // additional post processing of collected data
+    if (opt.final) {
+        core_1.config.runningMode.postProcessData(visitPlan);
+    }
+}
+function setPermissions(page, origin) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (origin === '' || origin == null) {
+            return;
+        }
+        const browser = page.browser();
+        const context = browser.defaultBrowserContext();
+        yield context.overridePermissions(origin, core_1.config.grantedPermissions);
+    });
+}
+// check if the URL is correct
+function checkURL(page, intendedURL) {
+    compareURL(page, intendedURL);
+}
+function injectPageReloadChecker(page) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield page.evaluate(() => {
+            // @ts-expect-error TODO: add Window shim type
+            window.__memlab_check_reload = 1;
+        });
+    });
+}
+function checkPageReload(page) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // @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. ' +
+                'Please remove window.reload() calls or disable any reload logic.');
+        }
+    });
+}
+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}:`);
+        }
+    });
+}
+function applyAsyncWithGuard(f, self, args, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+exceptionHandler = (_ex) => {
+    /*noop*/
+}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let ret;
+        try {
+            ret = yield f.apply(self, args);
+        }
+        catch (ex) {
+            exceptionHandler(core_1.utils.getError(ex));
+        }
+        return ret;
+    });
+}
+function applyAsyncWithRetry(f, self, args, options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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 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);
+                }
+                core_1.utils.haltOrThrow(core_1.utils.getError(ex), {
+                    printCallback: () => {
+                        core_1.info.warning('interaction fail');
+                    },
+                });
+            }
+            core_1.info.warning(`interaction fail, making ${retry} more attempt(s)...`);
+            if (!!options.delayBeforeRetry && options.delayBeforeRetry > 0) {
+                yield InteractionUtils_1.default.waitFor(options.delayBeforeRetry);
+            }
+            if (options.retry) {
+                options.retry--;
+            }
+            yield applyAsyncWithRetry(f, self, args, options);
+        });
+        yield applyAsyncWithGuard(f, self, args, exceptionHandler);
+    });
+}
+function clearConsole(page) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (core_1.config.clearConsole) {
+            yield page.evaluate(() => {
+                try {
+                    console.clear();
+                }
+                catch (_a) {
+                    // do nothing
+                }
+            });
+        }
+    });
+}
+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}`);
+        }
+        yield operation.do(page, opArgs);
+    });
+}
+function waitExtraForTab(tabInfo) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let delay = 0;
+        const mode = core_1.config.runningMode;
+        if (tabInfo.type === 'target') {
+            if (!mode.shouldExtraWaitForTarget(tabInfo)) {
+                return;
+            }
+            delay += core_1.config.extraWaitingForTarget;
+        }
+        else if (tabInfo.type === 'final') {
+            if (!mode.shouldExtraWaitForFinal(tabInfo)) {
+                return;
+            }
+            delay += core_1.config.extraWaitingForFinal;
+        }
+        // wait for extra time
+        if (delay > 0) {
+            core_1.info.overwrite(`wait extra ${delay / 1000}s for ${tabInfo.type} page...`);
+            yield InteractionUtils_1.default.waitFor(delay);
+        }
+    });
+}
+function getNavigationHistoryLength(page) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yield page.evaluate(() => {
+            let ret = -1;
+            try {
+                ret = history.length;
+            }
+            catch (e) {
+                // do nothing
+            }
+            return ret;
+        });
+    });
+}
+// const allocFile = path.join(config.curDataDir, 'Heap-alloc.json');
+// await startTrackingHeapAllocation(page, allocFile);
+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...');
+        const cdpSession = yield page.target().createCDPSession();
+        cdpSession.on('HeapProfiler.addHeapSnapshotChunk', data => {
+            fs_1.default.appendFileSync(file, data.chunk, 'UTF-8');
+        });
+        yield cdpSession.send('HeapProfiler.startTrackingHeapObjects', {
+            trackAllocations: true,
+        });
+        yield InteractionUtils_1.default.waitFor(30000);
+        return cdpSession;
+    });
+}
+function getScenarioAppName(scenario = null) {
+    if (!scenario || !scenario.app) {
+        return getScenarioDefaultAppName();
+    }
+    return scenario.app();
+}
+function getScenarioDefaultAppName() {
+    return 'default-app-for-scenario';
+}
+exports.default = (0, core_2.setInternalValue)({
+    applyAsyncWithGuard,
+    applyAsyncWithRetry,
+    checkLastSnapshotChunk,
+    checkPageReload,
+    checkURL,
+    clearConsole,
+    compareURL,
+    dispatchOperation,
+    getNavigationHistoryLength,
+    getScenarioAppName,
+    getURLParameter,
+    injectPageReloadChecker,
+    logMetaData,
+    logTabProgress,
+    maybeWaitForConsoleInput,
+    serializeVisitPlan,
+    setPermissions,
+    startTrackingHeapAllocation,
+    waitExtraForTab,
+}, __filename, core_2.constant.internalDir);

package/dist/lib/SynthesisUtils.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
+ */
+import BackOperation from './operations/BackOperation';
+import RevertOperation from './operations/RevertOperation';
+declare const _default: {
+    backStep: {
+        name: string;
+        url: string;
+        interactions: BackOperation[];
+    };
+    revertStep: {
+        name: string;
+        url: string;
+        interactions: RevertOperation[];
+    };
+};
+export default _default;
+//# sourceMappingURL=SynthesisUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SynthesisUtils.d.ts","sourceRoot":"","sources":["../../src/lib/SynthesisUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,aAAa,MAAM,4BAA4B,CAAC;AACvD,OAAO,eAAe,MAAM,8BAA8B,CAAC;;;;;;;;;;;;;AAc3D,wBAGE"}

package/dist/lib/SynthesisUtils.js

@@ -0,0 +1,30 @@
+"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 BackOperation_1 = __importDefault(require("./operations/BackOperation"));
+const RevertOperation_1 = __importDefault(require("./operations/RevertOperation"));
+const backStep = {
+    name: 'back',
+    url: '',
+    interactions: [new BackOperation_1.default()],
+};
+const revertStep = {
+    name: 'revert',
+    url: '',
+    interactions: [new RevertOperation_1.default()],
+};
+exports.default = {
+    backStep,
+    revertStep,
+};

package/dist/lib/operations/BackOperation.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 BaseOperation from './BaseOperation';
+import type { Page } from 'puppeteer';
+export default class BackOperation extends BaseOperation {
+    kind: string;
+    constructor();
+    act(page: Page): Promise<void>;
+}
+//# sourceMappingURL=BackOperation.d.ts.map

package/dist/lib/operations/BackOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackOperation.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/BackOperation.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAGpC,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,aAAa;IACtD,IAAI,EAAE,MAAM,CAAC;;IAOP,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAGrC"}

package/dist/lib/operations/BackOperation.js

@@ -0,0 +1,37 @@
+"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 BaseOperation_1 = __importDefault(require("./BaseOperation"));
+const core_1 = require("@memlab/core");
+class BackOperation extends BaseOperation_1.default {
+    constructor() {
+        super();
+        this.kind = 'back';
+    }
+    act(page) {
+        return __awaiter(this, void 0, void 0, function* () {
+            page.goBack({ timeout: core_1.config.presenceCheckTimeout || 120000 });
+        });
+    }
+}
+exports.default = BackOperation;

package/dist/lib/operations/BackspaceOperation.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 BaseOperation from './BaseOperation';
+import type { Page } from 'puppeteer';
+declare class BackspaceOperation extends BaseOperation {
+    kind: string;
+    constructor();
+    act(page: Page): Promise<void>;
+}
+export default BackspaceOperation;
+//# sourceMappingURL=BackspaceOperation.d.ts.map

package/dist/lib/operations/BackspaceOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackspaceOperation.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/BackspaceOperation.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAEpC,cAAM,kBAAmB,SAAQ,aAAa;IAC5C,IAAI,EAAE,MAAM,CAAC;;IAOP,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAGrC;AAED,eAAe,kBAAkB,CAAC"}

package/dist/lib/operations/BackspaceOperation.js

@@ -0,0 +1,36 @@
+"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 BaseOperation_1 = __importDefault(require("./BaseOperation"));
+class BackspaceOperation extends BaseOperation_1.default {
+    constructor() {
+        super();
+        this.kind = 'backspace';
+    }
+    act(page) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield page.keyboard.press('Backspace');
+        });
+    }
+}
+exports.default = BackspaceOperation;

package/dist/lib/operations/BaseOperation.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { Page } from 'puppeteer';
+import type { E2EOperation, OperationArgs } from '@memlab/core';
+declare abstract class BaseOperation implements E2EOperation {
+    kind: string;
+    selector: string;
+    protected optional: boolean;
+    constructor();
+    protected log(msg: string): void;
+    do(page: Page, opArgs?: OperationArgs): Promise<void>;
+    act(_page: Page, _opArgs?: OperationArgs): Promise<void>;
+}
+export default BaseOperation;
+//# sourceMappingURL=BaseOperation.d.ts.map

package/dist/lib/operations/BaseOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseOperation.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/BaseOperation.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAC,YAAY,EAAE,aAAa,EAAC,MAAM,cAAc,CAAC;AAI9D,uBAAe,aAAc,YAAW,YAAY;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,QAAQ,UAAS;;IAO3B,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAQ1B,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBzD,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAKnE;AAED,eAAe,aAAa,CAAC"}

package/dist/lib/operations/BaseOperation.js

@@ -0,0 +1,67 @@
+"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 core_1 = require("@memlab/core");
+const InteractionUtils_1 = __importDefault(require("./InteractionUtils"));
+let opId = 1; // operation index used in debug mode
+class BaseOperation {
+    constructor() {
+        this.optional = false;
+        this.kind = 'abstract';
+        this.selector = '';
+    }
+    log(msg) {
+        if (core_1.config.verbose) {
+            core_1.info.lowLevel(msg);
+        }
+        else {
+            core_1.info.overwrite(msg);
+        }
+    }
+    do(page, opArgs = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (core_1.config.verbose && core_1.config.runningMode.shouldTakeScreenShot()) {
+                yield InteractionUtils_1.default.screenshot(page, `${++opId}-${this.kind}`);
+            }
+            if (this.selector !== '') {
+                yield InteractionUtils_1.default.waitForSelector(page, this.selector, 'exist', this.optional);
+            }
+            yield this.act(page, opArgs);
+            const isPageLoaded = opArgs.isPageLoaded;
+            yield InteractionUtils_1.default.waitUntilLoaded(page, {
+                isPageLoaded,
+                noWaitAfterPageLoad: true,
+            });
+            yield InteractionUtils_1.default.waitFor(core_1.config.waitAfterOperation);
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    act(_page, _opArgs = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const error = new Error('BaseOperation.act can not be called.');
+            error.stack;
+            throw error;
+        });
+    }
+}
+exports.default = BaseOperation;

package/dist/lib/operations/CachePageContent.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { Page } from 'puppeteer';
+import type { AnyValue } from '@memlab/core';
+import BaseOperation from './BaseOperation';
+declare type PageFunction = (page: Page) => Promise<AnyValue>;
+declare class CachePageContent extends BaseOperation {
+    kind: string;
+    private pageFunction;
+    private varName;
+    constructor(pageFunction: PageFunction, varName: string);
+    act(page: Page): Promise<void>;
+}
+export default CachePageContent;
+//# sourceMappingURL=CachePageContent.d.ts.map

package/dist/lib/operations/CachePageContent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CachePageContent.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/CachePageContent.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,cAAc,CAAC;AAG3C,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAE5C,aAAK,YAAY,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AAKtD,cAAM,gBAAiB,SAAQ,aAAa;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,OAAO,CAAS;gBAEZ,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM;IAOjD,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAWrC;AAED,eAAe,gBAAgB,CAAC"}

package/dist/lib/operations/CachePageContent.js

@@ -0,0 +1,46 @@
+"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 core_1 = require("@memlab/core");
+const BaseOperation_1 = __importDefault(require("./BaseOperation"));
+// Takes a pageFunction and variable name,
+// calls the pageFunction with the argument 'page',
+// and saves the result to the utils.memCache object with varName as the key
+class CachePageContent extends BaseOperation_1.default {
+    constructor(pageFunction, varName) {
+        super();
+        this.kind = 'cache-page-content';
+        this.pageFunction = pageFunction;
+        this.varName = varName;
+    }
+    act(page) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const varValue = yield this.pageFunction(page);
+            if (varValue == null) {
+                core_1.utils.haltOrThrow(`CachePageContent: Provided pageFunction returned ${varValue}`);
+            }
+            core_1.utils.memCache[this.varName] = varValue;
+        });
+    }
+}
+exports.default = CachePageContent;

package/dist/lib/operations/ClickOperation.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { Page } from 'puppeteer';
+import type { AnyOptions, Optional } from '@memlab/core';
+import BaseOperation from './BaseOperation';
+declare type PageFunction = (page: Page) => Promise<void>;
+declare type IfPageFunction = (page: Page) => Promise<boolean>;
+declare class ClickOperation extends BaseOperation {
+    kind: string;
+    selector: string;
+    delay: Optional<number>;
+    waitFor: Optional<string | PageFunction>;
+    clickCount: Optional<number>;
+    indexInMatches: Optional<number>;
+    if: Optional<string | IfPageFunction>;
+    constructor(selector: string, args?: AnyOptions & {
+        delay?: number;
+        waitFor?: string | PageFunction;
+        clickCount?: number;
+        indexInMatches?: number;
+        if?: string | IfPageFunction;
+    });
+    _shouldClick(page: Page): Promise<boolean>;
+    private useContains;
+    private clickElement;
+    act(page: Page): Promise<void>;
+}
+export default ClickOperation;
+//# sourceMappingURL=ClickOperation.d.ts.map

package/dist/lib/operations/ClickOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClickOperation.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/ClickOperation.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAC,UAAU,EAAE,QAAQ,EAAC,MAAM,cAAc,CAAC;AAGvD,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAG5C,aAAK,YAAY,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAClD,aAAK,cAAc,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAEvD,cAAM,cAAe,SAAQ,aAAa;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACxB,OAAO,EAAE,QAAQ,CAAC,MAAM,GAAG,YAAY,CAAC,CAAC;IACzC,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7B,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjC,EAAE,EAAE,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAC,CAAC;gBAGpC,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,UAAU,GAAG;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,EAAE,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;KACzB;IAgBF,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBhD,OAAO,CAAC,WAAW;YAKL,YAAY;IAgCpB,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CA0CrC;AAED,eAAe,cAAc,CAAC"}