@alwaysmeticulous/cli 2.40.0 → 2.40.4

package/dist/commands/bootstrap/bootstrap.command.js

@@ -1,33 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.bootstrapCommand = void 0;
-const common_1 = require("@alwaysmeticulous/common");
-const chalk_1 = __importDefault(require("chalk"));
-const loglevel_1 = __importDefault(require("loglevel"));
-const command_builder_1 = require("../../command-utils/command-builder");
-const config_1 = require("../../config/config");
-const npm_set_script_utils_1 = require("../../utils/npm-set-script.utils");
-const handler = async () => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    logger.info(`Setting up ${chalk_1.default.green("meticulous.json")}...`);
-    const meticulousConfig = await (0, config_1.readConfig)();
-    const newConfig = {
-        ...meticulousConfig,
-        testCases: [...(meticulousConfig.testCases || [])],
-    };
-    await (0, config_1.saveConfig)(newConfig);
-    logger.info(`Setting up ${chalk_1.default.green("test:meticulous")} script...`);
-    await (0, npm_set_script_utils_1.npmSetScript)({
-        script: "test:meticulous",
-        command: "meticulous run-all-tests --headless --parallelize",
-    });
-};
-exports.bootstrapCommand = (0, command_builder_1.buildCommand)("bootstrap")
-    .details({
-    describe: "Bootstrap your project to use Meticulous",
-})
-    .options({})
-    .handler(handler);

package/dist/commands/create-test/create-test.command.d.ts

@@ -1,90 +0,0 @@
-/// <reference types="yargs" />
-export declare const createTestCommand: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
-    headless: {
-        default: boolean;
-        boolean: true;
-        description: "Start browser in headless mode";
-    };
-    skipPauses: {
-        description: string;
-        boolean: true;
-        default: true;
-    };
-    devTools: {
-        readonly boolean: true;
-        readonly description: "Open Chrome Dev Tools";
-        readonly default: false;
-    };
-    bypassCSP: {
-        readonly boolean: true;
-        readonly description: "Enables bypass CSP in the browser (danger: this could mean you tests hit your production backend)";
-        readonly default: false;
-    };
-    shiftTime: {
-        readonly boolean: true;
-        readonly description: "Shift time during simulation to be set as the recording time";
-        readonly default: true;
-    };
-    networkStubbing: {
-        readonly boolean: true;
-        readonly description: "Stub network requests during replay";
-        readonly default: true;
-    };
-    disableRemoteFonts: {
-        readonly boolean: true;
-        readonly description: "Pass the disable remote fonts flag into chromium";
-        readonly default: false;
-    };
-    noSandbox: {
-        readonly boolean: true;
-        readonly description: "Pass the no sandbox flag into chromium";
-        readonly default: false;
-    };
-    maxDurationMs: {
-        readonly number: true;
-        readonly description: "Maximum duration (in milliseconds) the simulation will run";
-    };
-    maxEventCount: {
-        readonly number: true;
-        readonly description: "Maximum number of events the simulation will run";
-    };
-    essentialFeaturesOnly: {
-        readonly boolean: true;
-        readonly description: "Disable any features that are non-essential for running tests/executing replays. This includes disabling recording a video of the replay, for playback in the web app. This flag is useful to reduce noise when debugging.";
-        readonly default: false;
-    };
-    apiToken: {
-        readonly string: true;
-    };
-    commitSha: {
-        readonly string: true;
-    };
-    width: {
-        number: true;
-    };
-    height: {
-        number: true;
-    };
-    uploadIntervalMs: {
-        number: true;
-        description: string;
-    };
-    incognito: {
-        boolean: true;
-        description: string;
-        default: boolean;
-    };
-    trace: {
-        boolean: true;
-        description: string;
-    };
-    moveBeforeClick: {
-        readonly boolean: true;
-        readonly description: "Simulate mouse movement before clicking";
-        readonly default: true;
-    };
-    cookiesFile: {
-        string: true;
-        description: string;
-    };
-}>>;

package/dist/commands/create-test/create-test.command.js

@@ -1,165 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTestCommand = void 0;
-const common_1 = require("@alwaysmeticulous/common");
-const chalk_1 = __importDefault(require("chalk"));
-const inquirer_1 = require("inquirer");
-const loglevel_1 = __importDefault(require("loglevel"));
-const command_builder_1 = require("../../command-utils/command-builder");
-const common_options_1 = require("../../command-utils/common-options");
-const config_utils_1 = require("../../utils/config.utils");
-const record_command_1 = require("../record/record.command");
-const replay_command_1 = require("../replay/replay.command");
-const handleTestCreation = async (replay, sessionId) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const validationResponse = await (0, inquirer_1.prompt)([
-        {
-            type: "confirm",
-            name: "value",
-            message: "Does the end state screenshot match your expectation?",
-            default: true,
-        },
-    ]);
-    if (!validationResponse.value) {
-        return;
-    }
-    const createTestResponse = await (0, inquirer_1.prompt)([
-        {
-            type: "confirm",
-            name: "value",
-            message: `Would you like to save this as a test to ${chalk_1.default.green("meticulous.json")}?`,
-            default: true,
-        },
-    ]);
-    if (!createTestResponse.value) {
-        return;
-    }
-    const testNameResponse = await (0, inquirer_1.prompt)([
-        {
-            type: "input",
-            name: "name",
-            message: "Test name:",
-            default: `${sessionId} | ${replay.id}`,
-        },
-    ]);
-    await (0, config_utils_1.addTestCase)({
-        title: testNameResponse.name,
-        sessionId,
-    });
-    logger.info(chalk_1.default.bold.white(`Test saved to ${chalk_1.default.green("meticulous.json")}.`));
-};
-// The create-test handler combines recording a session and simulating it for
-// validation.
-const handler = async ({ 
-// Common options
-apiToken, commitSha, devTools, bypassCSP, 
-// Record options
-width, height, uploadIntervalMs, incognito, trace, 
-// Replay options
-headless, shiftTime, networkStubbing, moveBeforeClick, cookiesFile, disableRemoteFonts, noSandbox, skipPauses, }) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    logger.info("Creating a new Meticulous test");
-    logger.info("Step 1: record a new test");
-    let lastSessionId = "";
-    const onDetectedSession = (sessionId) => {
-        lastSessionId = sessionId;
-    };
-    // 1. Record
-    const recordOptions = {
-        apiToken,
-        commitSha,
-        devTools,
-        bypassCSP,
-        width,
-        height,
-        uploadIntervalMs,
-        incognito,
-        trace,
-        onDetectedSession,
-    };
-    await (0, record_command_1.recordCommandHandler)(recordOptions);
-    logger.debug(`lastSessionId = ${lastSessionId}`);
-    if (!lastSessionId) {
-        logger.error("No test was recorded!");
-        process.exit(1);
-    }
-    logger.info("Step 2: validating the new test...");
-    const replayOptions = {
-        apiToken,
-        commitSha,
-        sessionId: lastSessionId,
-        headless,
-        devTools,
-        bypassCSP,
-        screenshot: true,
-        shiftTime,
-        disableRemoteFonts,
-        noSandbox,
-        networkStubbing,
-        moveBeforeClick,
-        cookiesFile,
-        skipPauses,
-        // We replay against the original recorded URL
-        appUrl: null,
-        simulationIdForAssets: null,
-        // We don't try comparing to the original screenshot, so just set these to their defaults
-        diffThreshold: common_options_1.OPTIONS.diffThreshold.default,
-        diffPixelThreshold: common_options_1.OPTIONS.diffPixelThreshold.default,
-        // We don't expose these options
-        maxDurationMs: null,
-        maxEventCount: null,
-        storyboard: false,
-        essentialFeaturesOnly: false,
-        debugger: false,
-    };
-    const replay = await (0, replay_command_1.rawReplayCommandHandler)(replayOptions);
-    await handleTestCreation(replay, lastSessionId);
-};
-exports.createTestCommand = (0, command_builder_1.buildCommand)("create-test")
-    .details({
-    describe: "Create a new test",
-})
-    .options({
-    // Common options
-    apiToken: common_options_1.OPTIONS.apiToken,
-    commitSha: common_options_1.OPTIONS.commitSha,
-    // Record options
-    width: {
-        number: true,
-    },
-    height: {
-        number: true,
-    },
-    uploadIntervalMs: {
-        number: true,
-        description: "Meticulous recording upload interval (in milliseconds)",
-    },
-    incognito: {
-        boolean: true,
-        description: "Use an incognito browsing context",
-        default: true,
-    },
-    trace: {
-        boolean: true,
-        description: "Enable verbose logging",
-    },
-    // Replay options
-    moveBeforeClick: common_options_1.OPTIONS.moveBeforeClick,
-    cookiesFile: {
-        string: true,
-        description: "Path to cookies to inject before simulation",
-    },
-    ...common_options_1.COMMON_REPLAY_OPTIONS,
-    headless: {
-        ...common_options_1.COMMON_REPLAY_OPTIONS.headless,
-        default: true,
-    },
-    skipPauses: {
-        ...common_options_1.COMMON_REPLAY_OPTIONS.skipPauses,
-        description: "Fast forward through any pauses to replay as fast as possible when replaying for the first time to create the test.",
-    },
-})
-    .handler(handler);

package/dist/commands/replay/utils/compute-diff.d.ts

@@ -1,13 +0,0 @@
-import { ScreenshotAssertionsEnabledOptions, ScreenshotDiffResult } from "@alwaysmeticulous/api";
-import { AxiosInstance } from "axios";
-import log from "loglevel";
-export interface ComputeAndSaveDiffOptions {
-    client: AxiosInstance;
-    baseTestRunId: string;
-    sessionId: string;
-    headReplayId: string;
-    tempDir: string;
-    screenshottingOptions: ScreenshotAssertionsEnabledOptions;
-    logger: log.Logger;
-}
-export declare const computeDiff: ({ client, baseTestRunId, sessionId, tempDir, headReplayId, screenshottingOptions, logger, }: ComputeAndSaveDiffOptions) => Promise<Record<string, ScreenshotDiffResult[]>>;

package/dist/commands/replay/utils/compute-diff.js

@@ -1,95 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.computeDiff = void 0;
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-const download_1 = require("../../../api/download");
-const test_run_api_1 = require("../../../api/test-run.api");
-const replays_1 = require("../../../local-data/replays");
-const screenshot_diff_command_1 = require("../../screenshot-diff/screenshot-diff.command");
-const get_screenshot_filename_1 = require("../../screenshot-diff/utils/get-screenshot-filename");
-const computeDiff = async ({ client, baseTestRunId, sessionId, tempDir, headReplayId, screenshottingOptions, logger, }) => {
-    var _a;
-    logger.info(`Diffing screenshots against replays of session ${sessionId} in test run ${baseTestRunId}`);
-    const baseScreenshotsDir = (0, path_1.join)((0, replays_1.getScreenshotsDir)(tempDir), "base-screenshots");
-    await (0, promises_1.mkdir)(baseScreenshotsDir, { recursive: true });
-    const baseScreenshots = await (0, test_run_api_1.getBaseScreenshots)({
-        client,
-        testRunId: baseTestRunId,
-        sessionId,
-    });
-    const screenshotIdentifiersByBaseReplayId = groupByBaseReplayId(baseScreenshots);
-    await downloadScreenshots(baseScreenshots, baseScreenshotsDir);
-    logger.debug(`Downloaded ${baseScreenshots.length} base screenshots to ${baseScreenshotsDir}}`);
-    const headReplayScreenshotsDir = (0, replays_1.getScreenshotsDir)(tempDir);
-    const headReplayScreenshots = await (0, replays_1.getScreenshotFiles)(headReplayScreenshotsDir);
-    const screenshotDiffResultsByBaseReplayId = {};
-    // Diff the screenshots for each base replay
-    for (const baseReplayId of screenshotIdentifiersByBaseReplayId.keys()) {
-        const baseScreenshotIdentifiers = (_a = screenshotIdentifiersByBaseReplayId.get(baseReplayId)) !== null && _a !== void 0 ? _a : [];
-        const baseReplayScreenshots = baseScreenshotIdentifiers.map((identifier) => ({
-            identifier,
-            fileName: (0, get_screenshot_filename_1.getScreenshotFilename)(identifier),
-        }));
-        const resultsForBaseReplay = await (0, screenshot_diff_command_1.diffScreenshots)({
-            baseReplayId,
-            headReplayId,
-            baseScreenshotsDir: baseScreenshotsDir,
-            headScreenshotsDir: headReplayScreenshotsDir,
-            headReplayScreenshots,
-            baseReplayScreenshots,
-            diffOptions: screenshottingOptions.diffOptions,
-        });
-        screenshotDiffResultsByBaseReplayId[baseReplayId] = resultsForBaseReplay;
-    }
-    (0, screenshot_diff_command_1.logDifferences)({
-        results: Object.values(screenshotDiffResultsByBaseReplayId).flat(),
-        diffOptions: screenshottingOptions.diffOptions,
-        logger,
-    });
-    // Delete base screenshots directory and all files inside it
-    // (we don't want to upload it to the backend)
-    await deleteScreenshotsDirectory(baseScreenshotsDir);
-    return screenshotDiffResultsByBaseReplayId;
-};
-exports.computeDiff = computeDiff;
-const deleteScreenshotsDirectory = async (directory) => {
-    const files = await (0, promises_1.opendir)(directory);
-    for await (const file of files) {
-        if (file.isFile()) {
-            await (0, promises_1.rm)((0, path_1.join)(directory, file.name));
-        }
-        else {
-            throw new Error(`Expected screenshots directory to only contain screenshot files, but it contained: ${file.name}`);
-        }
-    }
-    await (0, promises_1.rmdir)(directory);
-};
-const groupByBaseReplayId = (screenshots) => {
-    const screenshotIdentifiersByBaseReplayId = new Map();
-    screenshots.forEach(({ replayId, screenshotIdentifier }) => {
-        var _a;
-        const screenshotIdentifiers = (_a = screenshotIdentifiersByBaseReplayId.get(replayId)) !== null && _a !== void 0 ? _a : [];
-        screenshotIdentifiers.push(screenshotIdentifier);
-        screenshotIdentifiersByBaseReplayId.set(replayId, screenshotIdentifiers);
-    });
-    return screenshotIdentifiersByBaseReplayId;
-};
-const downloadScreenshots = async (screenshots, directory) => {
-    // Download in batches of 20
-    const screenshotBatches = chunk(screenshots, 20);
-    for (const screenshotBatch of screenshotBatches) {
-        const screenshotDownloads = screenshotBatch.map((screenshot) => {
-            const filePath = (0, path_1.join)(directory, (0, get_screenshot_filename_1.getScreenshotFilename)(screenshot.screenshotIdentifier));
-            return (0, download_1.downloadFile)(screenshot.screenshotUrl, filePath);
-        });
-        await Promise.all(screenshotDownloads);
-    }
-};
-const chunk = (array, size) => {
-    const chunkedArray = [];
-    for (let i = 0; i < array.length; i += size) {
-        chunkedArray.push(array.slice(i, i + size));
-    }
-    return chunkedArray;
-};

package/dist/commands/replay/utils/exit-early-if-skip-upload-env-var-set.d.ts

@@ -1 +0,0 @@
-export declare const exitEarlyIfSkipUploadEnvVarSet: (baseTestRunId: string | null | undefined) => void;

package/dist/commands/replay/utils/exit-early-if-skip-upload-env-var-set.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.exitEarlyIfSkipUploadEnvVarSet = void 0;
-const common_1 = require("@alwaysmeticulous/common");
-const loglevel_1 = __importDefault(require("loglevel"));
-const METICULOUS_SKIP_UPLOAD_ENV_VAR = "METICULOUS_SKIP_UPLOAD";
-// Uploading the zip can take a long time, so we expose a env variable to support skipping it
-// We don't expose this as a first-class CLI option because we don't want to pollute the list of CLI options
-const exitEarlyIfSkipUploadEnvVarSet = (baseTestRunId) => {
-    if (!shouldSkipUpload()) {
-        return;
-    }
-    if (baseTestRunId != null) {
-        throw new Error(`Cannot specify baseTestRunId and compare to base results when ${METICULOUS_SKIP_UPLOAD_ENV_VAR} is set to true`);
-    }
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    logger.info(`Skipping upload / exiting early since ${METICULOUS_SKIP_UPLOAD_ENV_VAR} is set to true`);
-    process.exit(0);
-};
-exports.exitEarlyIfSkipUploadEnvVarSet = exitEarlyIfSkipUploadEnvVarSet;
-const shouldSkipUpload = () => {
-    var _a;
-    return (((_a = process.env[METICULOUS_SKIP_UPLOAD_ENV_VAR]) !== null && _a !== void 0 ? _a : "").toLowerCase() === "true");
-};

package/dist/commands/screenshot-diff/screenshot-diff.command.d.ts

@@ -1,53 +0,0 @@
-/// <reference types="yargs" />
-import { ScreenshotDiffOptions, ScreenshotDiffResult } from "@alwaysmeticulous/api";
-import log from "loglevel";
-import { IdentifiedScreenshotFile } from "../../local-data/replays";
-export declare const diffScreenshots: ({ headReplayId, baseReplayId, baseScreenshotsDir, headScreenshotsDir, baseReplayScreenshots, headReplayScreenshots, diffOptions, }: {
-    baseReplayId: string;
-    headReplayId: string;
-    baseScreenshotsDir: string;
-    headScreenshotsDir: string;
-    baseReplayScreenshots: IdentifiedScreenshotFile[];
-    headReplayScreenshots: IdentifiedScreenshotFile[];
-    diffOptions: ScreenshotDiffOptions;
-}) => Promise<ScreenshotDiffResult[]>;
-export declare const logDifferences: ({ results, diffOptions, logger, }: {
-    results: ScreenshotDiffResult[];
-    diffOptions: ScreenshotDiffOptions;
-    logger: log.Logger;
-}) => void;
-export type ScreenshotDiffsSummary = HasDiffsScreenshotDiffsResult | NoDiffsScreenshotDiffsResult;
-export interface HasDiffsScreenshotDiffsResult {
-    hasDiffs: true;
-    summaryMessage: string;
-    baseReplayId: string;
-    headReplayId: string;
-}
-export interface NoDiffsScreenshotDiffsResult {
-    hasDiffs: false;
-}
-export declare const screenshotDiffCommand: import("yargs").CommandModule<unknown, import("yargs").InferredOptionTypes<{
-    apiToken: {
-        string: true;
-    };
-    baseSimulationId: {
-        string: true;
-        demandOption: true;
-        alias: string;
-    };
-    headSimulationId: {
-        string: true;
-        demandOption: true;
-        alias: string;
-    };
-    threshold: {
-        readonly number: true;
-        readonly description: "Acceptable maximum proportion of changed pixels, between 0 and 1. If this proportion is exceeded then the test will fail.";
-        readonly default: 0.01;
-    };
-    pixelThreshold: {
-        readonly number: true;
-        readonly description: "A number between 0 and 1. Color/brightness differences in individual pixels will be ignored if the difference is less than this threshold. A value of 1.0 would accept any difference in color, while a value of 0.0 would accept no difference in color.";
-        readonly default: 0.01;
-    };
-}>>;

package/dist/commands/screenshot-diff/screenshot-diff.command.js

@@ -1,182 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.screenshotDiffCommand = exports.logDifferences = exports.diffScreenshots = void 0;
-const path_1 = require("path");
-const common_1 = require("@alwaysmeticulous/common");
-const fast_json_stable_stringify_1 = __importDefault(require("fast-json-stable-stringify"));
-const loglevel_1 = __importDefault(require("loglevel"));
-const client_1 = require("../../api/client");
-const command_builder_1 = require("../../command-utils/command-builder");
-const common_options_1 = require("../../command-utils/common-options");
-const diff_utils_1 = require("../../image/diff.utils");
-const io_utils_1 = require("../../image/io.utils");
-const replays_1 = require("../../local-data/replays");
-const screenshot_diffs_1 = require("../../local-data/screenshot-diffs");
-const has_notable_differences_1 = require("./utils/has-notable-differences");
-const diffScreenshots = async ({ headReplayId, baseReplayId, baseScreenshotsDir, headScreenshotsDir, baseReplayScreenshots, headReplayScreenshots, diffOptions, }) => {
-    const { diffThreshold, diffPixelThreshold } = diffOptions;
-    const headReplayScreenshotsByIdentifier = new Map(headReplayScreenshots.map((screenshot) => [
-        (0, fast_json_stable_stringify_1.default)(screenshot.identifier),
-        screenshot,
-    ]));
-    const baseReplayScreenshotsByIdentifier = new Map(baseReplayScreenshots.map((screenshot) => [
-        (0, fast_json_stable_stringify_1.default)(screenshot.identifier),
-        screenshot,
-    ]));
-    const missingHeadImages = new Set(baseReplayScreenshots.filter((file) => !headReplayScreenshotsByIdentifier.has((0, fast_json_stable_stringify_1.default)(file.identifier))));
-    const missingHeadImagesResults = Array.from(missingHeadImages).flatMap(({ identifier, fileName }) => {
-        return [
-            {
-                identifier,
-                outcome: "missing-head",
-                baseScreenshotFile: `screenshots/${fileName}`,
-            },
-        ];
-    });
-    const diffAgainstBase = async (headScreenshot) => {
-        const baseScreenshot = baseReplayScreenshotsByIdentifier.get((0, fast_json_stable_stringify_1.default)(headScreenshot.identifier));
-        if (baseScreenshot == null) {
-            return [
-                {
-                    identifier: headScreenshot.identifier,
-                    outcome: "missing-base",
-                    headScreenshotFile: `screenshots/${headScreenshot.fileName}`,
-                },
-            ];
-        }
-        const baseScreenshotFile = (0, path_1.join)(baseScreenshotsDir, baseScreenshot.fileName);
-        const headScreenshotFile = (0, path_1.join)(headScreenshotsDir, headScreenshot.fileName);
-        const baseScreenshotContents = await (0, io_utils_1.readPng)(baseScreenshotFile);
-        const headScreenshotContents = await (0, io_utils_1.readPng)(headScreenshotFile);
-        if (baseScreenshotContents.width !== headScreenshotContents.width ||
-            baseScreenshotContents.height !== headScreenshotContents.height) {
-            return [
-                {
-                    identifier: headScreenshot.identifier,
-                    outcome: "different-size",
-                    baseScreenshotFile: `screenshots/${baseScreenshot.fileName}`,
-                    headScreenshotFile: `screenshots/${headScreenshot.fileName}`,
-                    baseWidth: baseScreenshotContents.width,
-                    baseHeight: baseScreenshotContents.height,
-                    headWidth: headScreenshotContents.width,
-                    headHeight: headScreenshotContents.height,
-                },
-            ];
-        }
-        const comparisonResult = (0, diff_utils_1.compareImages)({
-            base: baseScreenshotContents,
-            head: headScreenshotContents,
-            pixelThreshold: diffPixelThreshold,
-        });
-        await (0, screenshot_diffs_1.writeScreenshotDiff)({
-            baseReplayId,
-            headReplayId,
-            screenshotFileName: headScreenshot.fileName,
-            diff: comparisonResult.diff,
-        });
-        return [
-            {
-                identifier: headScreenshot.identifier,
-                outcome: comparisonResult.mismatchFraction > diffThreshold
-                    ? "diff"
-                    : "no-diff",
-                baseScreenshotFile: `screenshots/${baseScreenshot.fileName}`,
-                headScreenshotFile: `screenshots/${headScreenshot.fileName}`,
-                width: baseScreenshotContents.width,
-                height: baseScreenshotContents.height,
-                mismatchPixels: comparisonResult.mismatchPixels,
-                mismatchFraction: comparisonResult.mismatchFraction,
-            },
-        ];
-    };
-    const headDiffResults = (await Promise.all(headReplayScreenshots.map(diffAgainstBase))).flat();
-    return [...missingHeadImagesResults, ...headDiffResults];
-};
-exports.diffScreenshots = diffScreenshots;
-const logDifferences = ({ results, diffOptions, logger, }) => {
-    const missingHeadImagesResults = results.flatMap((result) => result.outcome === "missing-head" ? [result] : []);
-    if (missingHeadImagesResults.length) {
-        const message = `Head replay is missing screenshots: ${missingHeadImagesResults
-            .map(({ baseScreenshotFile }) => (0, path_1.basename)(baseScreenshotFile))
-            .sort()} => FAIL!`;
-        logger.info(message);
-    }
-    const missingBaseImagesResults = results.flatMap((result) => result.outcome === "missing-base" ? [result] : []);
-    if (missingHeadImagesResults.length) {
-        const message = `Notice: Base replay is missing screenshots: ${missingBaseImagesResults
-            .map(({ headScreenshotFile }) => (0, path_1.basename)(headScreenshotFile))
-            .sort()}`;
-        logger.info(message);
-    }
-    results.forEach((result) => {
-        const { outcome } = result;
-        if (outcome === "different-size") {
-            const message = `Screenshots ${(0, path_1.basename)(result.headScreenshotFile)} have different sizes => FAIL!`;
-            logger.info(message);
-        }
-        if (outcome === "diff" || outcome === "no-diff") {
-            const mismatch = (result.mismatchFraction * 100).toFixed(3);
-            const threshold = (diffOptions.diffThreshold * 100).toFixed(3);
-            const message = `${mismatch}% pixel mismatch for screenshot ${(0, path_1.basename)(result.headScreenshotFile)} (threshold is ${threshold}%) => ${outcome === "no-diff" ? "PASS" : "FAIL!"}`;
-            logger.info(message);
-        }
-    });
-};
-exports.logDifferences = logDifferences;
-const handler = async ({ apiToken, baseSimulationId: baseReplayId, headSimulationId: headReplayId, threshold, pixelThreshold, }) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const client = (0, client_1.createClient)({ apiToken });
-    await (0, replays_1.getOrFetchReplay)(client, baseReplayId);
-    await (0, replays_1.getOrFetchReplayArchive)(client, baseReplayId);
-    await (0, replays_1.getOrFetchReplay)(client, headReplayId);
-    await (0, replays_1.getOrFetchReplayArchive)(client, headReplayId);
-    const baseScreenshotsDir = (0, replays_1.getScreenshotsDir)((0, replays_1.getReplayDir)(baseReplayId));
-    const headScreenshotsDir = (0, replays_1.getScreenshotsDir)((0, replays_1.getReplayDir)(headReplayId));
-    const diffOptions = {
-        diffThreshold: threshold,
-        diffPixelThreshold: pixelThreshold,
-    };
-    const baseReplayScreenshots = await (0, replays_1.getScreenshotFiles)(baseScreenshotsDir);
-    const headReplayScreenshots = await (0, replays_1.getScreenshotFiles)(headScreenshotsDir);
-    const results = await (0, exports.diffScreenshots)({
-        baseReplayId,
-        headReplayId,
-        baseScreenshotsDir,
-        headScreenshotsDir,
-        baseReplayScreenshots,
-        headReplayScreenshots,
-        diffOptions,
-    });
-    logger.debug(results);
-    (0, exports.logDifferences)({
-        results,
-        diffOptions,
-        logger,
-    });
-    if ((0, has_notable_differences_1.hasNotableDifferences)(results)) {
-        process.exit(1);
-    }
-};
-exports.screenshotDiffCommand = (0, command_builder_1.buildCommand)("screenshot-diff")
-    .details({ describe: "Diff two replay screenshots" })
-    .options({
-    apiToken: {
-        string: true,
-    },
-    baseSimulationId: {
-        string: true,
-        demandOption: true,
-        alias: "baseReplayId",
-    },
-    headSimulationId: {
-        string: true,
-        demandOption: true,
-        alias: "headReplayId",
-    },
-    threshold: common_options_1.SCREENSHOT_DIFF_OPTIONS.diffThreshold,
-    pixelThreshold: common_options_1.SCREENSHOT_DIFF_OPTIONS.diffPixelThreshold,
-})
-    .handler(handler);

package/dist/commands/screenshot-diff/utils/__tests__/get-screenshot-identifier.spec.d.ts

@@ -1 +0,0 @@
-export {};