@alwaysmeticulous/cli 2.40.0 → 2.41.0

package/dist/api/test-run.api.d.ts

@@ -1,35 +1,7 @@
-import { TestRunConfigData } from "@alwaysmeticulous/api";
+import { TestCaseResult } from "@alwaysmeticulous/api";
 import { AxiosInstance } from "axios";
-import { TestCaseResult } from "../config/config.types";
-import { ScreenshotLocator, TestRun, TestRunStatus } from "./types";
-export declare const getTestRun: (options: {
-    client: AxiosInstance;
-    testRunId: string;
-}) => Promise<TestRun | null>;
-export declare const createTestRun: (options: {
-    client: AxiosInstance;
-    commitSha: string;
-    meticulousSha: string;
-    configData: TestRunConfigData;
-}) => Promise<TestRun>;
-export declare const putTestRunResults: (options: {
-    client: AxiosInstance;
-    testRunId: string;
-    status: TestRunStatus;
-    resultData: {
-        [key: string]: any;
-    };
-}) => Promise<TestRun>;
-export declare const getTestRunUrl: (testRun: TestRun) => string;
-export interface GetLatestTestRunResultsOptions {
+export interface GetCachedTestRunResultsOptions {
     client: AxiosInstance;
     commitSha: string;
 }
-export declare const getCachedTestRunResults: ({ client, commitSha, }: GetLatestTestRunResultsOptions) => Promise<TestCaseResult[]>;
-export declare const getLatestTestRunId: (opts: GetLatestTestRunResultsOptions) => Promise<string | null>;
-export interface GetBaseScreenshotLocatorsOptions {
-    client: AxiosInstance;
-    testRunId: string;
-    sessionId: string;
-}
-export declare const getBaseScreenshots: ({ client, testRunId, sessionId, }: GetBaseScreenshotLocatorsOptions) => Promise<ScreenshotLocator[]>;
+export declare const getCachedTestRunResults: ({ client, commitSha, }: GetCachedTestRunResultsOptions) => Promise<TestCaseResult[]>;

package/dist/api/test-run.api.js

@@ -1,73 +1,12 @@
 "use strict";
-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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBaseScreenshots = exports.getLatestTestRunId = exports.getCachedTestRunResults = exports.getTestRunUrl = exports.putTestRunResults = exports.createTestRun = exports.getTestRun = void 0;
+exports.getCachedTestRunResults = void 0;
+const client_1 = require("@alwaysmeticulous/client");
 const common_1 = require("@alwaysmeticulous/common");
-const axios_1 = __importStar(require("axios"));
 const loglevel_1 = __importDefault(require("loglevel"));
-const getTestRun = async ({ client, testRunId }) => {
-    const { data } = await client.get(`test-runs/${testRunId}`).catch((error) => {
-        var _a;
-        if (axios_1.default.isAxiosError(error)) {
-            if (((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
-                return { data: null };
-            }
-        }
-        throw error;
-    });
-    return data;
-};
-exports.getTestRun = getTestRun;
-const createTestRun = async ({ client, commitSha, meticulousSha, configData, }) => {
-    const { data } = await client.post("test-runs", {
-        commitSha,
-        meticulousSha,
-        configData,
-    });
-    return data;
-};
-exports.createTestRun = createTestRun;
-const putTestRunResults = async ({ client, testRunId, status, resultData }) => {
-    const { data } = await client.put(`test-runs/${testRunId}/results`, {
-        status,
-        resultData,
-    });
-    return data;
-};
-exports.putTestRunResults = putTestRunResults;
-const getTestRunUrl = (testRun) => {
-    const { project } = testRun;
-    const organizationName = encodeURIComponent(project.organization.name);
-    const projectName = encodeURIComponent(project.name);
-    const testRunUrl = `https://app.meticulous.ai/projects/${organizationName}/${projectName}/test-runs/${testRun.id}`;
-    return testRunUrl;
-};
-exports.getTestRunUrl = getTestRunUrl;
 const getCachedTestRunResults = async ({ client, commitSha, }) => {
     var _a, _b, _c;
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
@@ -75,40 +14,8 @@ const getCachedTestRunResults = async ({ client, commitSha, }) => {
         logger.warn("Test run cache not supported: no commit hash");
         return [];
     }
-    const results = (_c = (_b = (_a = (await getLatestTestRunResults({ client, commitSha }))) === null || _a === void 0 ? void 0 : _a.resultData) === null || _b === void 0 ? void 0 : _b.results) !== null && _c !== void 0 ? _c : [];
+    const results = (_c = (_b = (_a = (await (0, client_1.getLatestTestRunResults)({ client, commitSha }))) === null || _a === void 0 ? void 0 : _a.resultData) === null || _b === void 0 ? void 0 : _b.results) !== null && _c !== void 0 ? _c : [];
     // Only return passing tests
     return results.filter(({ result }) => result === "pass");
 };
 exports.getCachedTestRunResults = getCachedTestRunResults;
-const getLatestTestRunResults = async ({ client, commitSha, }) => {
-    var _a;
-    const { data } = await client
-        .get(`test-runs/cache?commitSha=${encodeURIComponent(commitSha)}`)
-        .catch((error) => {
-        var _a;
-        if (error instanceof axios_1.AxiosError && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
-            return { data: null };
-        }
-        throw error;
-    });
-    return (_a = data) !== null && _a !== void 0 ? _a : null;
-};
-const getLatestTestRunId = async (opts) => {
-    var _a, _b;
-    return (_b = (_a = (await getLatestTestRunResults(opts))) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : null;
-};
-exports.getLatestTestRunId = getLatestTestRunId;
-const getBaseScreenshots = async ({ client, testRunId, sessionId, }) => {
-    var _a;
-    const { data } = await client
-        .get(`test-runs/${encodeURIComponent(testRunId)}/base-screenshots?sessionId=${encodeURIComponent(sessionId)}`)
-        .catch((error) => {
-        var _a;
-        if (error instanceof axios_1.AxiosError && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
-            return { data: null };
-        }
-        throw error;
-    });
-    return (_a = data) !== null && _a !== void 0 ? _a : [];
-};
-exports.getBaseScreenshots = getBaseScreenshots;

package/dist/commands/download-replay/download-replay.command.js

@@ -4,17 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.downloadReplayCommand = void 0;
+const client_1 = require("@alwaysmeticulous/client");
 const common_1 = require("@alwaysmeticulous/common");
+const downloading_helpers_1 = require("@alwaysmeticulous/downloading-helpers");
 const loglevel_1 = __importDefault(require("loglevel"));
-const client_1 = require("../../api/client");
 const command_builder_1 = require("../../command-utils/command-builder");
-const replays_1 = require("../../local-data/replays");
 const handler = async ({ apiToken, replayId, }) => {
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     const client = (0, client_1.createClient)({ apiToken });
-    const { fileName: replayMetadataFileName } = await (0, replays_1.getOrFetchReplay)(client, replayId);
+    const { fileName: replayMetadataFileName } = await (0, downloading_helpers_1.getOrFetchReplay)(client, replayId);
     logger.info(`Downloaded replay metadata to: ${replayMetadataFileName}`);
-    const { fileName: replayFolderFilePath } = await (0, replays_1.getOrFetchReplayArchive)(client, replayId);
+    const { fileName: replayFolderFilePath } = await (0, downloading_helpers_1.getOrFetchReplayArchive)(client, replayId);
     logger.info(`Downloaded replay data to: ${replayFolderFilePath}`);
 };
 exports.downloadReplayCommand = (0, command_builder_1.buildCommand)("download-simulation")

package/dist/commands/download-session/download-session.command.js

@@ -4,17 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.downloadSessionCommand = void 0;
+const client_1 = require("@alwaysmeticulous/client");
 const common_1 = require("@alwaysmeticulous/common");
+const downloading_helpers_1 = require("@alwaysmeticulous/downloading-helpers");
 const loglevel_1 = __importDefault(require("loglevel"));
-const client_1 = require("../../api/client");
 const command_builder_1 = require("../../command-utils/command-builder");
-const sessions_1 = require("../../local-data/sessions");
 const handler = async ({ apiToken, sessionId, }) => {
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     const client = (0, client_1.createClient)({ apiToken });
-    const { fileName: sessionMetadataFileName } = await (0, sessions_1.getOrFetchRecordedSession)(client, sessionId);
+    const { fileName: sessionMetadataFileName } = await (0, downloading_helpers_1.getOrFetchRecordedSession)(client, sessionId);
     logger.info(`Downloaded session metadata to: ${sessionMetadataFileName}`);
-    const { fileName: sessionFileName } = await (0, sessions_1.getOrFetchRecordedSessionData)(client, sessionId);
+    const { fileName: sessionFileName } = await (0, downloading_helpers_1.getOrFetchRecordedSessionData)(client, sessionId);
     logger.info(`Downloaded session data to: ${sessionFileName}`);
 };
 exports.downloadSessionCommand = (0, command_builder_1.buildCommand)("download-session")

package/dist/commands/record/record.command.js

@@ -5,14 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.recordCommand = exports.recordCommandHandler = void 0;
 const path_1 = require("path");
+const client_1 = require("@alwaysmeticulous/client");
 const common_1 = require("@alwaysmeticulous/common");
+const downloading_helpers_1 = require("@alwaysmeticulous/downloading-helpers");
 const loglevel_1 = __importDefault(require("loglevel"));
-const client_1 = require("../../api/client");
-const project_api_1 = require("../../api/project.api");
-const session_api_1 = require("../../api/session.api");
 const command_builder_1 = require("../../command-utils/command-builder");
-const replay_assets_1 = require("../../local-data/replay-assets");
-const commit_sha_utils_1 = require("../../utils/commit-sha.utils");
 const recordCommandHandler = async ({ apiToken, commitSha: commitSha_, devTools, bypassCSP, width, height, uploadIntervalMs, incognito, trace, onDetectedSession: onDetectedSession_, }) => {
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     const debugLogger = trace ? await common_1.DebugLogger.create() : null;
@@ -30,7 +27,7 @@ const recordCommandHandler = async ({ apiToken, commitSha: commitSha_, devTools,
     logger.info("Preparing recording...");
     // 1. Fetch the recording token
     const client = (0, client_1.createClient)({ apiToken });
-    const project = await (0, project_api_1.getProject)(client);
+    const project = await (0, client_1.getProject)(client);
     if (!project) {
         logger.error("Could not retrieve project data. Is the API token correct?");
         debugLogger === null || debugLogger === void 0 ? void 0 : debugLogger.log("Could not retrieve project data. Is the API token correct?");
@@ -44,11 +41,11 @@ const recordCommandHandler = async ({ apiToken, commitSha: commitSha_, devTools,
     }
     logger.debug(`Recording token: ${recordingToken}`);
     // 2. Guess commit SHA1
-    const commitSha = (await (0, commit_sha_utils_1.getCommitSha)(commitSha_)) || "unknown";
+    const commitSha = (await (0, common_1.getCommitSha)(commitSha_)) || "unknown";
     logger.debug(`Commit: ${commitSha}`);
     // 3. Load recording snippets
-    const recordingSnippet = await (0, replay_assets_1.fetchAsset)("v1/stagingMeticulousSnippet.js");
-    const earlyNetworkRecorderSnippet = await (0, replay_assets_1.fetchAsset)("record/v1/network-recorder.bundle.js");
+    const recordingSnippet = await (0, downloading_helpers_1.fetchAsset)("v1/stagingMeticulousSnippet.js");
+    const earlyNetworkRecorderSnippet = await (0, downloading_helpers_1.fetchAsset)("record/v1/network-recorder.bundle.js");
     // 4. Load recording package
     let recordSession;
     try {
@@ -64,13 +61,13 @@ const recordCommandHandler = async ({ apiToken, commitSha: commitSha_, devTools,
     }
     const cookieDir = (0, path_1.join)((0, common_1.getMeticulousLocalDataDir)(), "cookies");
     // Report recording start
-    const recordingCommandId = await (0, session_api_1.getRecordingCommandId)(client);
+    const recordingCommandId = await (0, client_1.getRecordingCommandId)(client);
     // 5. Start recording
     const onDetectedSession = (sessionId) => {
         if (onDetectedSession_) {
             onDetectedSession_(sessionId);
         }
-        (0, session_api_1.postSessionIdNotification)(client, sessionId, recordingCommandId).catch((error) => {
+        (0, client_1.postSessionIdNotification)(client, sessionId, recordingCommandId).catch((error) => {
             logger.error(`Warning: error while notifying session recording ${sessionId}`);
             logger.error(error);
             debugLogger === null || debugLogger === void 0 ? void 0 : debugLogger.log(`Warning: error while notifying session recording ${sessionId}`);

package/dist/commands/replay/replay.command.d.ts

@@ -1,41 +1,28 @@
 /// <reference types="yargs" />
-import { ScreenshotDiffResult } from "@alwaysmeticulous/api";
-import { GeneratedBy, Replay, ReplayEventsDependencies, ReplayExecutionOptions, ReplayTarget } from "@alwaysmeticulous/common";
-import { ScreenshotAssertionsOptions, ScreenshotDiffOptions } from "../../command-utils/common-types";
-export interface ReplayOptions extends AdditionalReplayOptions {
-    replayTarget: ReplayTarget;
-    executionOptions: ReplayExecutionOptions;
-    screenshottingOptions: ScreenshotAssertionsOptions;
-    generatedBy: GeneratedBy;
-    testRunId: string | null;
-    replayEventsDependencies: ReplayEventsDependencies;
-    suppressScreenshotDiffLogging: boolean;
-}
-export interface ReplayResult {
+import { Replay, ScreenshotDiffOptions, ScreenshotDiffResult } from "@alwaysmeticulous/api";
+import { ReplayExecutionOptions, ReplayTarget } from "@alwaysmeticulous/sdk-bundles-api";
+export interface ReplayAndStoreResultsResult {
     replay: Replay;
     /**
      * Empty if screenshottingOptions.enabled was false.
      */
     screenshotDiffResultsByBaseReplayId: Record<string, ScreenshotDiffResult[]>;
 }
-export declare const replayCommandHandler: ({ replayTarget, executionOptions, screenshottingOptions, apiToken, sessionId, commitSha: commitSha_, baseTestRunId, cookiesFile, generatedBy, testRunId, replayEventsDependencies, debugger: enableStepThroughDebugger, suppressScreenshotDiffLogging, }: ReplayOptions) => Promise<ReplayResult>;
-export interface RawReplayCommandHandlerOptions extends ScreenshotDiffOptions, Omit<ReplayExecutionOptions, "maxDurationMs" | "maxEventCount">, Omit<AdditionalReplayOptions, "baseTestRunId"> {
+export interface RawReplayCommandHandlerOptions extends ScreenshotDiffOptions, Omit<ReplayExecutionOptions, "maxDurationMs" | "maxEventCount"> {
     screenshot: boolean;
     appUrl: string | null | undefined;
     simulationIdForAssets: string | null | undefined;
     maxDurationMs: number | null | undefined;
     maxEventCount: number | null | undefined;
     storyboard: boolean;
-}
-interface AdditionalReplayOptions {
     apiToken: string | null | undefined;
     commitSha: string | null | undefined;
     sessionId: string;
-    baseTestRunId: string | null | undefined;
     cookiesFile: string | null | undefined;
     debugger: boolean;
+    baseReplayId: string | null | undefined;
 }
-export declare const rawReplayCommandHandler: ({ apiToken, commitSha, sessionId, appUrl, simulationIdForAssets, headless, devTools, bypassCSP, screenshot, diffThreshold, diffPixelThreshold, shiftTime, networkStubbing, moveBeforeClick, cookiesFile, disableRemoteFonts, noSandbox, skipPauses, maxDurationMs, maxEventCount, storyboard, essentialFeaturesOnly, debugger: enableStepThroughDebugger, }: RawReplayCommandHandlerOptions) => Promise<Replay>;
+export declare const rawReplayCommandHandler: ({ apiToken, commitSha, sessionId, appUrl, simulationIdForAssets, headless, devTools, bypassCSP, screenshot, baseReplayId, diffThreshold, diffPixelThreshold, shiftTime, networkStubbing, moveBeforeClick, cookiesFile, disableRemoteFonts, noSandbox, skipPauses, maxDurationMs, maxEventCount, storyboard, essentialFeaturesOnly, debugger: enableStepThroughDebugger, }: RawReplayCommandHandlerOptions) => Promise<Replay>;
 export declare const getReplayTarget: ({ appUrl, simulationIdForAssets, }: {
     appUrl: string | null;
     simulationIdForAssets: string | null;
@@ -147,5 +134,9 @@ export declare const replayCommand: import("yargs").CommandModule<unknown, impor
         string: true;
         description: string;
     };
+    baseReplayId: {
+        string: true;
+        description: string;
+        alias: string;
+    };
 }>>;
-export {};

package/dist/commands/replay/replay.command.js

@@ -1,238 +1,13 @@
 "use strict";
-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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replayCommand = exports.getReplayTarget = exports.rawReplayCommandHandler = exports.replayCommandHandler = void 0;
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-const common_1 = require("@alwaysmeticulous/common");
-const Sentry = __importStar(require("@sentry/node"));
-const loglevel_1 = __importDefault(require("loglevel"));
-const luxon_1 = require("luxon");
-const client_1 = require("../../api/client");
-const replay_api_1 = require("../../api/replay.api");
-const upload_1 = require("../../api/upload");
-const archive_1 = require("../../archive/archive");
+exports.replayCommand = exports.getReplayTarget = exports.rawReplayCommandHandler = void 0;
+const replay_orchestrator_1 = require("@alwaysmeticulous/replay-orchestrator");
 const command_builder_1 = require("../../command-utils/command-builder");
 const common_options_1 = require("../../command-utils/common-options");
-const local_data_utils_1 = require("../../local-data/local-data.utils");
-const replay_assets_1 = require("../../local-data/replay-assets");
-const serve_assets_from_simulation_1 = require("../../local-data/serve-assets-from-simulation");
-const sessions_1 = require("../../local-data/sessions");
-const commit_sha_utils_1 = require("../../utils/commit-sha.utils");
-const version_utils_1 = require("../../utils/version.utils");
-const compute_diff_1 = require("./utils/compute-diff");
-const exit_early_if_skip_upload_env_var_set_1 = require("./utils/exit-early-if-skip-upload-env-var-set");
-const replayCommandHandler = async ({ replayTarget, executionOptions, screenshottingOptions, apiToken, sessionId, commitSha: commitSha_, baseTestRunId, cookiesFile, generatedBy, testRunId, replayEventsDependencies, debugger: enableStepThroughDebugger, suppressScreenshotDiffLogging, }) => {
-    var _a;
-    if (executionOptions.headless === true &&
-        enableStepThroughDebugger === true) {
-        throw new Error("Cannot run with both --debugger flag and --headless flag at the same time.");
-    }
-    const rootTransaction = (_a = Sentry.getCurrentHub().getScope()) === null || _a === void 0 ? void 0 : _a.getTransaction();
-    const handlerSpanContext = {
-        name: "replay.command_handler",
-        description: "Handle the replay command",
-        op: "replay.command_handler",
-    };
-    let transaction;
-    if (rootTransaction) {
-        transaction = rootTransaction.startChild(handlerSpanContext);
-    }
-    else {
-        transaction = Sentry.startTransaction(handlerSpanContext);
-    }
-    Sentry.getCurrentHub().configureScope((scope) => scope.setSpan(transaction));
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const client = (0, client_1.createClient)({ apiToken });
-    // 1. Check session files
-    const fetchSessions = transaction.startChild({ op: "fetchingSessions" });
-    const { data: session } = await (0, sessions_1.getOrFetchRecordedSession)(client, sessionId);
-    const { data: sessionData } = await (0, sessions_1.getOrFetchRecordedSessionData)(client, sessionId);
-    fetchSessions.finish();
-    // 2. Guess commit SHA1
-    const commitSha = (await (0, commit_sha_utils_1.getCommitSha)(commitSha_)) || "unknown";
-    logger.debug(`Commit: ${commitSha}`);
-    const meticulousSha = await (0, version_utils_1.getMeticulousVersion)();
-    // 3. If simulationIdForAssets specified then download assets & spin up local server
-    const serveOrGetAppUrlSpan = transaction.startChild({
-        op: "serveOrGetAppUrl",
-    });
-    const { appUrl, closeServer } = await serveOrGetAppUrl(client, replayTarget);
-    serveOrGetAppUrlSpan.finish();
-    // 4. Load replay package
-    let replayEvents;
-    try {
-        logger.debug("Loading replayer package...");
-        const replayer = await require("@alwaysmeticulous/replayer");
-        replayEvents = replayer.replayEvents;
-    }
-    catch (error) {
-        logger.error("Error: could not import @alwaysmeticulous/replayer");
-        logger.error(error);
-        process.exit(1);
-    }
-    // Report replay start
-    logger.debug("Reporting replay started...");
-    const replayCommandId = await (0, replay_api_1.getReplayCommandId)(client, sessionId);
-    // 5. Create replay directory
-    logger.debug("Creating directory to store replay output...");
-    await (0, promises_1.mkdir)((0, path_1.join)((0, common_1.getMeticulousLocalDataDir)(), "replays"), {
-        recursive: true,
-    });
-    const tempDirName = (0, local_data_utils_1.sanitizeFilename)(`${new Date().toISOString()}-`);
-    const tempDir = await (0, promises_1.mkdtemp)((0, path_1.join)((0, common_1.getMeticulousLocalDataDir)(), "replays", tempDirName));
-    // 6. Create and save replay parameters
-    logger.debug("Snapshotting replay parameters...");
-    const replayEventsParams = {
-        appUrl: appUrl !== null && appUrl !== void 0 ? appUrl : null,
-        replayExecutionOptions: executionOptions,
-        browser: null,
-        outputDir: tempDir,
-        session,
-        recordingId: "manual-replay",
-        meticulousSha: "meticulousSha",
-        generatedBy,
-        testRunId,
-        dependencies: replayEventsDependencies,
-        enableStepThroughDebugger,
-        screenshottingOptions,
-        cookiesFile: cookiesFile !== null && cookiesFile !== void 0 ? cookiesFile : null,
-    };
-    await (0, promises_1.writeFile)((0, path_1.join)(tempDir, "replayEventsParams.json"), JSON.stringify(replayEventsParams));
-    // 7. Perform replay
-    logger.debug("Beggining replay...");
-    const startTime = luxon_1.DateTime.utc();
-    await replayEvents({
-        ...replayEventsParams,
-        sessionData,
-        parentPerformanceSpan: transaction.startChild({ op: "replayEvents" }),
-    });
-    closeServer === null || closeServer === void 0 ? void 0 : closeServer();
-    const endTime = luxon_1.DateTime.utc();
-    logger.info(`Simulation time: ${endTime.diff(startTime).as("seconds")} seconds`);
-    (0, exit_early_if_skip_upload_env_var_set_1.exitEarlyIfSkipUploadEnvVarSet)(baseTestRunId);
-    logger.info("Sending simulation results to Meticulous");
-    // 8. Create a Zip archive containing the replay files
-    const createReplayArchiveSpan = transaction.startChild({
-        op: "createArchiveAndUpload",
-    });
-    const archivePath = await (0, archive_1.createReplayArchive)(tempDir);
-    createReplayArchiveSpan.finish();
-    try {
-        // 9. Get upload URL
-        const getReplayPushUrlSpan = transaction.startChild({
-            op: "getReplayPushUrl",
-        });
-        const replay = await (0, replay_api_1.createReplay)({
-            client,
-            commitSha,
-            sessionId,
-            meticulousSha,
-            version: "v2",
-            metadata: { generatedBy },
-        });
-        const uploadUrlData = await (0, replay_api_1.getReplayPushUrl)(client, replay.id);
-        if (!uploadUrlData) {
-            logger.error("Error: Could not get a push URL from the Meticulous API");
-            process.exit(1);
-        }
-        const uploadUrl = uploadUrlData.pushUrl;
-        getReplayPushUrlSpan.finish();
-        // 10. Send archive to S3
-        const uploadArchiveSpan = transaction.startChild({ op: "uploadArchive" });
-        try {
-            await (0, upload_1.uploadArchive)(uploadUrl, archivePath);
-        }
-        catch (error) {
-            await (0, replay_api_1.putReplayPushedStatus)(client, replay.id, "failure", replayCommandId).catch(logger.error);
-            logger.error(error);
-            process.exit(1);
-        }
-        uploadArchiveSpan.finish();
-        // 11. Report successful upload to Meticulous
-        const updatedProjectBuild = await (0, replay_api_1.putReplayPushedStatus)(client, replay.id, "success", replayCommandId);
-        logger.info("Simulation artifacts successfully sent to Meticulous");
-        logger.debug(updatedProjectBuild);
-        const replayUrl = (0, replay_api_1.getReplayUrl)(replay);
-        logger.info("=======");
-        logger.info(`View simulation at: ${replayUrl}`);
-        logger.info("=======");
-        // 12. Diff against base replay screenshot if one is provided
-        const computeDiffSpan = transaction.startChild({
-            op: "computeDiff",
-        });
-        const computeDiffsLogger = loglevel_1.default.getLogger(`METICULOUS_LOGGER_NAME/compute-diffs`);
-        if (suppressScreenshotDiffLogging) {
-            computeDiffsLogger.setLevel("ERROR", false);
-        }
-        else {
-            computeDiffsLogger.setLevel(logger.getLevel(), false);
-        }
-        const screenshotDiffResultsByBaseReplayId = screenshottingOptions.enabled && baseTestRunId
-            ? await (0, compute_diff_1.computeDiff)({
-                client,
-                baseTestRunId,
-                sessionId,
-                headReplayId: replay.id,
-                tempDir,
-                screenshottingOptions,
-                logger: computeDiffsLogger,
-            })
-            : {};
-        computeDiffSpan.finish();
-        return { replay, screenshotDiffResultsByBaseReplayId };
+const rawReplayCommandHandler = async ({ apiToken, commitSha, sessionId, appUrl, simulationIdForAssets, headless, devTools, bypassCSP, screenshot, baseReplayId, diffThreshold, diffPixelThreshold, shiftTime, networkStubbing, moveBeforeClick, cookiesFile, disableRemoteFonts, noSandbox, skipPauses, maxDurationMs, maxEventCount, storyboard, essentialFeaturesOnly, debugger: enableStepThroughDebugger, }) => {
+    if (!screenshot && storyboard) {
+        throw new Error("Cannot take storyboard screenshots without taking end state screenshots. Please set '--screenshot' to true, or '--storyboard' to false.");
     }
-    finally {
-        await (0, archive_1.deleteArchive)(archivePath);
-        transaction.finish();
-    }
-};
-exports.replayCommandHandler = replayCommandHandler;
-const serveOrGetAppUrl = async (client, replayTarget) => {
-    if (replayTarget.type === "snapshotted-assets") {
-        const server = await (0, serve_assets_from_simulation_1.serveAssetsFromSimulation)(client, replayTarget.simulationIdForAssets);
-        return {
-            appUrl: server.url,
-            closeServer: server.closeServer,
-        };
-    }
-    if (replayTarget.type === "url") {
-        return { appUrl: replayTarget.appUrl };
-    }
-    if (replayTarget.type === "original-recorded-url") {
-        return {};
-    }
-    return unknownReplayTargetType(replayTarget);
-};
-const unknownReplayTargetType = (replayTarget) => {
-    throw new Error(`Unknown type of replay target: ${JSON.stringify(replayTarget)}`);
-};
-const rawReplayCommandHandler = async ({ apiToken, commitSha, sessionId, appUrl, simulationIdForAssets, headless, devTools, bypassCSP, screenshot, diffThreshold, diffPixelThreshold, shiftTime, networkStubbing, moveBeforeClick, cookiesFile, disableRemoteFonts, noSandbox, skipPauses, maxDurationMs, maxEventCount, storyboard, essentialFeaturesOnly, debugger: enableStepThroughDebugger, }) => {
     const executionOptions = {
         headless,
         devTools,
@@ -254,12 +29,19 @@ const rawReplayCommandHandler = async ({ apiToken, commitSha, sessionId, appUrl,
     const screenshottingOptions = screenshot
         ? {
             enabled: true,
-            diffOptions: { diffPixelThreshold, diffThreshold },
             storyboardOptions,
+            compareTo: baseReplayId != null
+                ? {
+                    type: "specific-replay",
+                    replayId: baseReplayId,
+                    diffOptions: { diffThreshold, diffPixelThreshold },
+                }
+                : {
+                    type: "do-not-compare",
+                },
         }
         : { enabled: false };
-    const replayEventsDependencies = await (0, replay_assets_1.loadReplayEventsDependencies)();
-    const { replay } = await (0, exports.replayCommandHandler)({
+    const { replay } = await (0, replay_orchestrator_1.replayAndStoreResults)({
         replayTarget: (0, exports.getReplayTarget)({
             appUrl: appUrl !== null && appUrl !== void 0 ? appUrl : null,
             simulationIdForAssets: simulationIdForAssets !== null && simulationIdForAssets !== void 0 ? simulationIdForAssets : null,
@@ -271,9 +53,7 @@ const rawReplayCommandHandler = async ({ apiToken, commitSha, sessionId, appUrl,
         cookiesFile,
         sessionId,
         generatedBy: generatedByOption,
-        baseTestRunId: null,
         testRunId: null,
-        replayEventsDependencies,
         debugger: enableStepThroughDebugger,
         suppressScreenshotDiffLogging: false,
     });
@@ -326,6 +106,11 @@ exports.replayCommand = (0, command_builder_1.buildCommand)("simulate")
         string: true,
         description: "Path to cookies to inject before simulation",
     },
+    baseReplayId: {
+        string: true,
+        description: "Base simulation id to diff the screenshots against",
+        alias: "baseSimulationId",
+    },
     ...common_options_1.COMMON_REPLAY_OPTIONS,
     ...common_options_1.SCREENSHOT_DIFF_OPTIONS,
 })

package/dist/commands/run-all-tests/run-all-tests.command.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runAllTestsCommand = void 0;
-const client_1 = require("../../api/client");
+const client_1 = require("@alwaysmeticulous/client");
+const common_1 = require("@alwaysmeticulous/common");
+const replay_orchestrator_1 = require("@alwaysmeticulous/replay-orchestrator");
 const test_run_api_1 = require("../../api/test-run.api");
 const command_builder_1 = require("../../command-utils/command-builder");
 const common_options_1 = require("../../command-utils/common-options");
-const run_all_tests_1 = require("../../parallel-tests/run-all-tests");
-const commit_sha_utils_1 = require("../../utils/commit-sha.utils");
 const handler = async ({ apiToken, commitSha: commitSha_, baseCommitSha, appUrl, headless, devTools, bypassCSP, diffThreshold, diffPixelThreshold, shiftTime, networkStubbing, githubSummary, parallelize, parallelTasks: parrelelTasks_, maxRetriesOnFailure, rerunTestsNTimes, useCache, testsFile, disableRemoteFonts, noSandbox, skipPauses, moveBeforeClick, maxDurationMs, maxEventCount, storyboard, essentialFeaturesOnly, baseTestRunId, }) => {
     const executionOptions = {
         headless,
@@ -31,12 +31,12 @@ const handler = async ({ apiToken, commitSha: commitSha_, baseCommitSha, appUrl,
         storyboardOptions,
     };
     const parrelelTasks = parallelize ? parrelelTasks_ : 1;
-    const commitSha = (await (0, commit_sha_utils_1.getCommitSha)(commitSha_)) || "unknown";
+    const commitSha = (await (0, common_1.getCommitSha)(commitSha_)) || "unknown";
     const client = (0, client_1.createClient)({ apiToken });
     const cachedTestRunResults = useCache
         ? await (0, test_run_api_1.getCachedTestRunResults)({ client, commitSha })
         : [];
-    const { testRun } = await (0, run_all_tests_1.runAllTests)({
+    const { testRun } = await (0, replay_orchestrator_1.executeTestRun)({
         testsFile: testsFile !== null && testsFile !== void 0 ? testsFile : null,
         executionOptions,
         screenshottingOptions,

package/dist/commands/show-project/show-project.command.js

@@ -4,15 +4,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.showProjectCommand = void 0;
+const client_1 = require("@alwaysmeticulous/client");
 const common_1 = require("@alwaysmeticulous/common");
 const loglevel_1 = __importDefault(require("loglevel"));
-const client_1 = require("../../api/client");
-const project_api_1 = require("../../api/project.api");
 const command_builder_1 = require("../../command-utils/command-builder");
 const handler = async ({ apiToken }) => {
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     const client = (0, client_1.createClient)({ apiToken });
-    const project = await (0, project_api_1.getProject)(client);
+    const project = await (0, client_1.getProject)(client);
     if (!project) {
         logger.error("Could not retrieve project data. Is the API token correct?");
         process.exit(1);