@memlab/core 1.0.0

package/dist/logger/LeakClusterLogger.js

@@ -0,0 +1,228 @@
+"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 BrowserInfo_1 = __importDefault(require("../lib/BrowserInfo"));
+const Config_1 = __importDefault(require("../lib/Config"));
+const Console_1 = __importDefault(require("../lib/Console"));
+const Serializer_1 = __importDefault(require("../lib/Serializer"));
+const Utils_1 = __importDefault(require("../lib/Utils"));
+const TraceBucket_1 = __importDefault(require("../trace-cluster/TraceBucket"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const util_1 = require("util");
+const readdir = (0, util_1.promisify)(fs_1.default.readdir);
+const readFile = (0, util_1.promisify)(fs_1.default.readFile);
+class LeakClusterLogger {
+    constructor() {
+        this._fileIdx = 0;
+    }
+    _loadClustersData(dir) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const files = yield readdir(dir);
+            return Promise.all(files.map((file) => __awaiter(this, void 0, void 0, function* () {
+                const p = path_1.default.join(dir, file);
+                const content = yield readFile(p, 'UTF-8');
+                return JSON.parse(content);
+            })));
+        });
+    }
+    loadClusters(dir) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield this._loadClustersData(dir);
+            return data.map((info) => {
+                const meta = JSON.parse(info.meta_data);
+                const traceRecord = meta.trace_record;
+                return {
+                    id: info.cluster_id,
+                    path: TraceBucket_1.default.traceToPath(traceRecord),
+                    clusterMetaInfo: info,
+                };
+            });
+        });
+    }
+    dumpReadableCluster(options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const metaFile = options.metaFile;
+            if (!metaFile || !fs_1.default.existsSync(metaFile)) {
+                throw Utils_1.default.haltOrThrow(`File doesn't exist: ${metaFile}`);
+            }
+            const meta = yield this.loadClusterMeta(metaFile);
+            Console_1.default.topLevel(`\nApp: ${meta.app}, Interaction: ${meta.interaction}`);
+            Console_1.default.lowLevel(`Created on: ${new Date(meta.creation_time * 1000)}`);
+            Console_1.default.topLevel(`\nTest interactions: ${meta.interaction_summary}`);
+            Console_1.default.topLevel(`\nLeak trace:`);
+            Console_1.default.topLevel(meta.leak_trace_summary);
+        });
+    }
+    loadClusterMeta(file) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const content = yield readFile(file, 'UTF-8');
+            return JSON.parse(content);
+        });
+    }
+    logUnclassifiedClusters(clusters) {
+        const tabsOrder = Utils_1.default.loadTabsOrder();
+        const interactSummary = Serializer_1.default.summarizeTabsOrder(tabsOrder);
+        const interactionVector = tabsOrder.map(tab => tab.name);
+        for (const cluster of clusters) {
+            this._logSingleUnClassifiedCluster(tabsOrder, cluster, interactSummary, interactionVector);
+        }
+    }
+    logClusters(clusters, options = {}) {
+        this._saveClusterSummary(clusters);
+        if (Config_1.default.useExternalSnapshot) {
+            return;
+        }
+        const tabsOrder = Utils_1.default.loadTabsOrder();
+        const interactSummary = Serializer_1.default.summarizeTabsOrder(tabsOrder);
+        const interactionVector = tabsOrder.map(tab => tab.name);
+        for (const cluster of clusters) {
+            this._logCluster(tabsOrder, cluster, interactSummary, interactionVector);
+        }
+        // manage unique clusters
+        if (!options.clusterDiff) {
+            return;
+        }
+        this.logClusterDiff(options.clusterDiff);
+    }
+    logAllClusters(clusters) {
+        const file = Config_1.default.allClusterSummaryFile;
+        let content = '';
+        for (let i = 0; i < clusters.length; ++i) {
+            content += `--------- cluster ${i + 1} ---------\n\n`;
+            for (let j = 0; j < clusters[i].length; ++j) {
+                const cluster = clusters[i][j];
+                content += `cluster: ${cluster.id}\n\n`;
+                let traceSummary;
+                if (cluster.clusterMetaInfo) {
+                    traceSummary = cluster.clusterMetaInfo.leak_trace_summary;
+                }
+                else {
+                    const trace = new TraceBucket_1.default(cluster.path, cluster.snapshot);
+                    traceSummary = trace.getTraceSummary();
+                }
+                content += traceSummary + '\n\n';
+            }
+        }
+        fs_1.default.writeFileSync(file, content, 'UTF-8');
+    }
+    logClusterDiff(clusterDiff) {
+        const staleClusters = clusterDiff.staleClusters || [];
+        for (const cluster of staleClusters) {
+            this._logStaleCluster(cluster);
+        }
+        const clustersToAdd = clusterDiff.clustersToAdd || [];
+        for (const cluster of clustersToAdd) {
+            this._logClusterToAdd(cluster);
+        }
+        this.logAllClusters(clusterDiff.allClusters);
+    }
+    _logStaleCluster(cluster) {
+        const info = {
+            cluster_id: cluster.id,
+        };
+        const file = path_1.default.join(Config_1.default.staleUniqueClusterDir, `cluster-${cluster.id}.json`);
+        fs_1.default.writeFileSync(file, JSON.stringify(info, null, 2), 'UTF-8');
+    }
+    _logClusterToAdd(cluster) {
+        const tabsOrder = Utils_1.default.loadTabsOrder();
+        const interactSummary = Serializer_1.default.summarizeTabsOrder(tabsOrder);
+        const interactionVector = tabsOrder.map(tab => tab.name);
+        const nodeId = Utils_1.default.getLastNodeId(cluster.path);
+        const filepath = path_1.default.join(Config_1.default.newUniqueClusterDir, `@${nodeId}.json`);
+        this._logCluster(tabsOrder, cluster, interactSummary, interactionVector, {
+            filepath,
+        });
+    }
+    _saveClusterSummary(clusters) {
+        // log cluster summary to a readable file
+        fs_1.default.appendFileSync(Config_1.default.exploreResultFile, `\n------${clusters.length} clusters------\n`, 'UTF-8');
+        const opt = { color: !Config_1.default.isContinuousTest };
+        for (const cluster of clusters) {
+            const size = Utils_1.default.getReadableBytes(cluster.retainedSize);
+            const stat = `\n--Similar leaks in this run: ${cluster.count}--` +
+                `\n--Retained size of leaked objects: ${size}--\n`;
+            const { path, snapshot } = cluster;
+            if (snapshot) {
+                // print trace in terminal
+                let trace = Serializer_1.default.summarizePath(path, new Set(), snapshot, opt);
+                Console_1.default.topLevel(stat + trace);
+                // dump plain text train in files
+                trace = Serializer_1.default.summarizePath(path, new Set(), snapshot);
+                fs_1.default.appendFileSync(Config_1.default.exploreResultFile, stat + trace, 'UTF-8');
+            }
+        }
+    }
+    _logCluster(tabsOrder, cluster, interactSummary, interactionVector, options = {}) {
+        const file = options.filepath || this._getTraceFilePath(cluster);
+        const trace = new TraceBucket_1.default(cluster.path, cluster.snapshot);
+        const info = {
+            cluster_id: cluster.id || 0,
+            creation_time: Date.now(),
+            app: Config_1.default.targetApp,
+            interaction: Config_1.default.targetTab,
+            num_duplicates: cluster.count,
+            retained_size: cluster.retainedSize,
+            interaction_summary: interactSummary,
+            leak_trace_summary: trace.getTraceSummary(),
+            interaction_vector: interactionVector,
+            meta_data: JSON.stringify({
+                browser_info: BrowserInfo_1.default,
+                visit_plan: tabsOrder,
+                trace_record: TraceBucket_1.default.pathToTrace(cluster.path),
+            }),
+        };
+        fs_1.default.writeFileSync(file, JSON.stringify(info, null, 2), 'UTF-8');
+    }
+    _getTraceFilePath(cluster) {
+        const filename = `@${Utils_1.default.getLastNodeId(cluster.path)}.json`;
+        return path_1.default.join(Config_1.default.traceClusterOutDir, filename);
+    }
+    _logSingleUnClassifiedCluster(tabsOrder, cluster, interactSummary, interactionVector, options = {}) {
+        var _a;
+        const file = options.filepath || this._getUnclassifiedTraceFilePath(cluster);
+        const trace = new TraceBucket_1.default(cluster.path, cluster.snapshot);
+        const info = {
+            cluster_id: (_a = cluster.id) !== null && _a !== void 0 ? _a : 0,
+            creation_time: Date.now(),
+            app: Config_1.default.targetApp,
+            interaction: Config_1.default.targetTab,
+            num_duplicates: cluster.count,
+            retained_size: cluster.retainedSize,
+            interaction_summary: interactSummary,
+            leak_trace_summary: trace.getTraceSummary(),
+            interaction_vector: interactionVector,
+            meta_data: JSON.stringify({
+                browser_info: BrowserInfo_1.default,
+                visit_plan: tabsOrder,
+                trace_record: TraceBucket_1.default.pathToTrace(cluster.path),
+            }),
+        };
+        fs_1.default.writeFileSync(file, JSON.stringify(info, null, 2), 'UTF-8');
+    }
+    _getUnclassifiedTraceFilePath(cluster) {
+        const filename = `@${Utils_1.default.getLastNodeId(cluster.path)}.json`;
+        return path_1.default.join(Config_1.default.unclassifiedClusterDir, filename);
+    }
+}
+exports.default = new LeakClusterLogger();

package/dist/logger/LeakTraceDetailsLogger.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 { IHeapSnapshot, LeakTracePathItem } from '../lib/Types';
+declare class LeakTraceDetailsLogger {
+    _wrapPathJSONInLoader(jsonContent: string): string;
+    setTraceFileEmpty(filepath: string): void;
+    logTrace(leakedIdSet: Set<number>, snapshot: IHeapSnapshot, nodeIdsInSnapshots: Array<Set<number>>, trace: LeakTracePathItem, filepath: string): void;
+    logTraces(leakedIdSet: Set<number>, snapshot: IHeapSnapshot, nodeIdsInSnapshots: Array<Set<number>>, traces: LeakTracePathItem[], outDir: string): void;
+}
+declare const _default: LeakTraceDetailsLogger;
+export default _default;
+//# sourceMappingURL=LeakTraceDetailsLogger.d.ts.map

package/dist/logger/LeakTraceDetailsLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LeakTraceDetailsLogger.d.ts","sourceRoot":"","sources":["../../src/logger/LeakTraceDetailsLogger.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAOH,OAAO,EAAC,aAAa,EAAE,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAE9D,cAAM,sBAAsB;IAC1B,qBAAqB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAIlD,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAOzC,QAAQ,CACN,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,EACxB,QAAQ,EAAE,aAAa,EACvB,kBAAkB,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EACtC,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,MAAM,GACf,IAAI;IAUP,SAAS,CACP,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,EACxB,QAAQ,EAAE,aAAa,EACvB,kBAAkB,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EACtC,MAAM,EAAE,iBAAiB,EAAE,EAC3B,MAAM,EAAE,MAAM,GACb,IAAI;CAUR;;AAED,wBAA4C"}

package/dist/logger/LeakTraceDetailsLogger.js

@@ -0,0 +1,50 @@
+"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 Config_1 = __importDefault(require("../lib/Config"));
+const Serializer_1 = __importDefault(require("../lib/Serializer"));
+const Utils_1 = __importDefault(require("../lib/Utils"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+class LeakTraceDetailsLogger {
+    _wrapPathJSONInLoader(jsonContent) {
+        return `window.gcPath = ${jsonContent};`;
+    }
+    setTraceFileEmpty(filepath) {
+        const content = this._wrapPathJSONInLoader('');
+        fs_1.default.writeFile(filepath, content, 'UTF-8', () => {
+            // noop
+        });
+    }
+    logTrace(leakedIdSet, snapshot, nodeIdsInSnapshots, trace, filepath) {
+        const options = { leakedIdSet, nodeIdsInSnapshots };
+        const gcTrace = Serializer_1.default.JSONifyPath(trace, snapshot, options);
+        const traceJSON = JSON.stringify(gcTrace, null, 2);
+        const content = this._wrapPathJSONInLoader(traceJSON);
+        fs_1.default.writeFile(filepath, content, 'UTF-8', () => {
+            // noop
+        });
+    }
+    logTraces(leakedIdSet, snapshot, nodeIdsInSnapshots, traces, outDir) {
+        if (!Config_1.default.isContinuousTest) {
+            return;
+        }
+        for (const trace of traces) {
+            const nodeId = Utils_1.default.getLastNodeId(trace);
+            const file = path_1.default.join(outDir, `@${nodeId}.json`);
+            this.logTrace(leakedIdSet, snapshot, nodeIdsInSnapshots, trace, file);
+        }
+    }
+}
+exports.default = new LeakTraceDetailsLogger();

package/dist/modes/BaseMode.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 { E2EStepInfo, Config, IE2EScenarioVisitPlan, Optional } from '../lib/Types';
+import type { Page } from 'puppeteer';
+declare class BaseMode {
+    protected config: Config;
+    protected visitPlan: Optional<IE2EScenarioVisitPlan>;
+    setConfig(config: Config): void;
+    beforeRunning(visitPlan: IE2EScenarioVisitPlan): void;
+    shouldGC(_tabInfo?: E2EStepInfo): boolean;
+    shouldScroll(_tabInfo?: E2EStepInfo): boolean;
+    shouldGetMetrics(_tabInfo?: E2EStepInfo): boolean;
+    shouldUseConciseConsole(_tabInfo?: E2EStepInfo): boolean;
+    shouldTakeScreenShot(_tabInfo?: E2EStepInfo): boolean;
+    shouldTakeHeapSnapshot(_tabInfo?: E2EStepInfo): boolean;
+    shouldExtraWaitForTarget(_tabInfo?: E2EStepInfo): boolean;
+    shouldExtraWaitForFinal(_tabInfo?: E2EStepInfo): boolean;
+    shouldRunExtraTargetOperations(_tabInfo?: E2EStepInfo): boolean;
+    getAdditionalMetrics(_page: Page, _tabInfo?: E2EStepInfo): Promise<E2EStepInfo['metrics']>;
+    postProcessData(_visitPlan: IE2EScenarioVisitPlan): void;
+}
+export default BaseMode;
+//# sourceMappingURL=BaseMode.d.ts.map

package/dist/modes/BaseMode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseMode.d.ts","sourceRoot":"","sources":["../../src/modes/BaseMode.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACV,WAAW,EACX,MAAM,EACN,qBAAqB,EACrB,QAAQ,EACT,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAIpC,cAAM,QAAQ;IACZ,SAAS,CAAC,MAAM,EAAE,MAAM,CAAiB;IACzC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IACrD,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI/B,aAAa,CAAC,SAAS,EAAE,qBAAqB,GAAG,IAAI;IAKrD,QAAQ,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,OAAO;IAKzC,YAAY,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,OAAO;IAK7C,gBAAgB,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,OAAO;IAKjD,uBAAuB,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,OAAO;IAKxD,oBAAoB,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,OAAO;IAKrD,sBAAsB,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,OAAO;IAKvD,wBAAwB,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,OAAO;IAQzD,uBAAuB,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,OAAO;IAQxD,8BAA8B,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,OAAO;IAOzD,oBAAoB,CAExB,KAAK,EAAE,IAAI,EAEX,QAAQ,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAKlC,eAAe,CAAC,UAAU,EAAE,qBAAqB,GAAG,IAAI;CAGzD;AAED,eAAe,QAAQ,CAAC"}

package/dist/modes/BaseMode.js

@@ -0,0 +1,95 @@
+"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 Config_1 = __importDefault(require("../lib/Config"));
+// the regular mode for conventional MemLab runs
+class BaseMode {
+    constructor() {
+        this.config = Config_1.default;
+    }
+    setConfig(config) {
+        this.config = config;
+    }
+    beforeRunning(visitPlan) {
+        this.visitPlan = visitPlan;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldGC(_tabInfo) {
+        return !this.config.skipGC;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldScroll(_tabInfo) {
+        return !this.config.skipScroll;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldGetMetrics(_tabInfo) {
+        return true;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldUseConciseConsole(_tabInfo) {
+        return false;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldTakeScreenShot(_tabInfo) {
+        return !this.config.skipScreenshot;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldTakeHeapSnapshot(_tabInfo) {
+        return !this.config.skipSnapshot;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldExtraWaitForTarget(_tabInfo) {
+        if (this.visitPlan && this.visitPlan.type === 'repeat') {
+            return false;
+        }
+        return !this.config.skipExtraOps;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldExtraWaitForFinal(_tabInfo) {
+        if (this.visitPlan && this.visitPlan.type === 'repeat') {
+            return false;
+        }
+        return !this.config.skipExtraOps;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldRunExtraTargetOperations(_tabInfo) {
+        if (this.visitPlan && this.visitPlan.type === 'repeat') {
+            return false;
+        }
+        return !this.config.skipExtraOps;
+    }
+    getAdditionalMetrics(
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _page, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _tabInfo) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {};
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    postProcessData(_visitPlan) {
+        // for overriding
+    }
+}
+exports.default = BaseMode;

package/dist/modes/InteractionTestMode.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 BaseMode from './BaseMode';
+declare class InteractionTestMode extends BaseMode {
+    shouldGC(): boolean;
+    shouldScroll(): boolean;
+    shouldGetMetrics(): boolean;
+    shouldUseConciseConsole(): boolean;
+    shouldTakeScreenShot(): boolean;
+    shouldTakeHeapSnapshot(): boolean;
+    shouldExtraWaitForTarget(): boolean;
+    shouldExtraWaitForFinal(): boolean;
+    shouldRunExtraTargetOperations(): boolean;
+}
+export default InteractionTestMode;
+//# sourceMappingURL=InteractionTestMode.d.ts.map

package/dist/modes/InteractionTestMode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InteractionTestMode.d.ts","sourceRoot":"","sources":["../../src/modes/InteractionTestMode.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,QAAQ,MAAM,YAAY,CAAC;AAGlC,cAAM,mBAAoB,SAAQ,QAAQ;IACxC,QAAQ,IAAI,OAAO;IAInB,YAAY,IAAI,OAAO;IAIvB,gBAAgB,IAAI,OAAO;IAI3B,uBAAuB,IAAI,OAAO;IAIlC,oBAAoB,IAAI,OAAO;IAI/B,sBAAsB,IAAI,OAAO;IAIjC,wBAAwB,IAAI,OAAO;IAInC,uBAAuB,IAAI,OAAO;IAIlC,8BAA8B,IAAI,OAAO;CAG1C;AAED,eAAe,mBAAmB,CAAC"}

package/dist/modes/InteractionTestMode.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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseMode_1 = __importDefault(require("./BaseMode"));
+// mode for running quick interaction test
+class InteractionTestMode extends BaseMode_1.default {
+    shouldGC() {
+        return false;
+    }
+    shouldScroll() {
+        return false;
+    }
+    shouldGetMetrics() {
+        return false;
+    }
+    shouldUseConciseConsole() {
+        return true;
+    }
+    shouldTakeScreenShot() {
+        return false;
+    }
+    shouldTakeHeapSnapshot() {
+        return false;
+    }
+    shouldExtraWaitForTarget() {
+        return false;
+    }
+    shouldExtraWaitForFinal() {
+        return false;
+    }
+    shouldRunExtraTargetOperations() {
+        return false;
+    }
+}
+exports.default = InteractionTestMode;

package/dist/modes/MeasureMode.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 BaseMode from './BaseMode';
+import type { Page } from 'puppeteer';
+import type { E2EStepInfo, IE2EScenarioVisitPlan } from '../lib/Types';
+declare class MeasureMode extends BaseMode {
+    shouldTakeScreenShot(): boolean;
+    shouldTakeHeapSnapshot(): boolean;
+    shouldExtraWaitForTarget(): boolean;
+    shouldExtraWaitForFinal(): boolean;
+    shouldRunExtraTargetOperations(): boolean;
+    getAdditionalMetrics(page: Page): Promise<E2EStepInfo['metrics']>;
+    postProcessData(visitPlan: IE2EScenarioVisitPlan): void;
+}
+export default MeasureMode;
+//# sourceMappingURL=MeasureMode.d.ts.map

package/dist/modes/MeasureMode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MeasureMode.d.ts","sourceRoot":"","sources":["../../src/modes/MeasureMode.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,QAAQ,MAAM,YAAY,CAAC;AAIlC,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAC,WAAW,EAAE,qBAAqB,EAAC,MAAM,cAAc,CAAC;AAGrE,cAAM,WAAY,SAAQ,QAAQ;IAChC,oBAAoB,IAAI,OAAO;IAI/B,sBAAsB,IAAI,OAAO;IAIjC,wBAAwB,IAAI,OAAO;IAInC,uBAAuB,IAAI,OAAO;IAIlC,8BAA8B,IAAI,OAAO;IAInC,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAQvE,eAAe,CAAC,SAAS,EAAE,qBAAqB,GAAG,IAAI;CAMxD;AAED,eAAe,WAAW,CAAC"}

package/dist/modes/MeasureMode.js

@@ -0,0 +1,58 @@
+"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 BaseMode_1 = __importDefault(require("./BaseMode"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+// mode for running quick measurement or experiments
+class MeasureMode extends BaseMode_1.default {
+    shouldTakeScreenShot() {
+        return false;
+    }
+    shouldTakeHeapSnapshot() {
+        return false;
+    }
+    shouldExtraWaitForTarget() {
+        return false;
+    }
+    shouldExtraWaitForFinal() {
+        return false;
+    }
+    shouldRunExtraTargetOperations() {
+        return false;
+    }
+    getAdditionalMetrics(page) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // number of DOM elements on the page
+            const numDOMElements = yield page.evaluate(() => document.getElementsByTagName('*').length);
+            return { numDOMElements };
+        });
+    }
+    postProcessData(visitPlan) {
+        const filename = `metrics-${Date.now()}-${process.pid}.json`;
+        const filepath = path_1.default.join(this.config.metricsOutDir, filename);
+        const content = JSON.stringify(visitPlan.tabsOrder, null, 2);
+        fs_1.default.writeFileSync(filepath, content, 'UTF-8');
+    }
+}
+exports.default = MeasureMode;

package/dist/modes/RunningModes.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 { Config, IRunningMode } from '../lib/Types';
+declare const _default: {
+    get(name: string, config?: Config): IRunningMode;
+};
+export default _default;
+//# sourceMappingURL=RunningModes.d.ts.map

package/dist/modes/RunningModes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RunningModes.d.ts","sourceRoot":"","sources":["../../src/modes/RunningModes.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,MAAM,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;;cAQ3C,MAAM,WAAW,MAAM,GAAG,YAAY;;AADlD,wBAqBE"}

package/dist/modes/RunningModes.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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Utils_1 = __importDefault(require("../lib/Utils"));
+const BaseMode_1 = __importDefault(require("./BaseMode"));
+const InteractionTestMode_1 = __importDefault(require("./InteractionTestMode"));
+const MeasureMode_1 = __importDefault(require("./MeasureMode"));
+exports.default = {
+    get(name, config) {
+        let ret;
+        switch (name) {
+            case 'regular':
+                ret = new BaseMode_1.default();
+                break;
+            case 'interaction-test':
+                ret = new InteractionTestMode_1.default();
+                break;
+            case 'measure':
+                ret = new MeasureMode_1.default();
+                break;
+            default:
+                throw Utils_1.default.haltOrThrow(`unknown running mode: ${name}`);
+        }
+        if (config) {
+            ret.setConfig(config);
+        }
+        return ret;
+    },
+};