@alwaysmeticulous/cli 2.39.0 → 2.40.4

package/dist/local-data/local-data.utils.js

@@ -1,92 +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.waitToAcquireLockOnDirectory = exports.fileExists = exports.getOrDownloadJsonFile = exports.sanitizeFilename = void 0;
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-const common_1 = require("@alwaysmeticulous/common");
-const loglevel_1 = __importDefault(require("loglevel"));
-const luxon_1 = require("luxon");
-const proper_lockfile_1 = require("proper-lockfile");
-const sanitizeFilename = (filename) => {
-    return filename.replace(/[^a-zA-Z0-9]/g, "_");
-};
-exports.sanitizeFilename = sanitizeFilename;
-/**
- * Returns the JSON.parse'd contents of the file at the given path. If the file
- * doesn't exist yet then it downloads the object, writes it to the file, and returns it.
- *
- * Handles concurrent processes trying to download to the same file at the same time.
- */
-const getOrDownloadJsonFile = async ({ filePath, downloadJson, dataDescription, }) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    await (0, promises_1.mkdir)((0, path_1.dirname)(filePath), { recursive: true });
-    // We create a lock file so that if multiple processes try downloading at the same
-    // time they don't interfere with each other. The second process to run will
-    // wait for the first process to complete, and then return straight away because
-    // it'll notice the file already exists.
-    const releaseLock = await waitToAcquireLockOnFile(filePath);
-    try {
-        const existingData = await (0, promises_1.readFile)(filePath)
-            .then((data) => JSON.parse(data.toString("utf-8")))
-            .catch(() => null);
-        if (existingData) {
-            logger.debug(`Reading ${dataDescription} from local copy in ${filePath}`);
-            return existingData;
-        }
-        const downloadedData = await downloadJson();
-        if (downloadedData) {
-            await (0, promises_1.writeFile)(filePath, JSON.stringify(downloadedData, null, 2));
-            logger.debug(`Wrote ${dataDescription} to ${filePath}`);
-        }
-        return downloadedData;
-    }
-    finally {
-        await releaseLock();
-    }
-};
-exports.getOrDownloadJsonFile = getOrDownloadJsonFile;
-const waitToAcquireLockOnFile = async (filePath) => {
-    // In many cases the file doesn't exist yet, and can't exist yet (need to download the data, and creating an
-    // empty file beforehand is risky if the process crashes, and a second process tries reading the empty file).
-    // However proper-lockfile requires us to pass a file or directory as the first arg. This path is just used
-    // to detect if the same process tries taking out multiple locks on the same file. It just needs to be calculated
-    // as something that's unique to the file, and gives the same path for a given file everytime. So we create our
-    // own lock-target directory for this purpose (directory not file since mkdir is guaranteed to be synchronous).
-    // The path needs to actually exist, since proper-lockfile resolves symlinks on it.
-    //
-    // Note: we don't delete the lock directory afterwards because doing so without creating race-conditions is tricky
-    const lockDirectory = `${filePath}.lock-target`;
-    await (0, promises_1.mkdir)(lockDirectory, { recursive: true });
-    const releaseLock = await (0, proper_lockfile_1.lock)(lockDirectory, {
-        retries: LOCK_RETRY_OPTIONS,
-        lockfilePath: `${filePath}.lock`,
-    });
-    return async () => {
-        await releaseLock();
-    };
-};
-const fileExists = (filePath) => (0, promises_1.access)(filePath)
-    .then(() => true)
-    .catch(() => false);
-exports.fileExists = fileExists;
-const waitToAcquireLockOnDirectory = (directoryPath) => {
-    return (0, proper_lockfile_1.lock)(directoryPath, {
-        retries: LOCK_RETRY_OPTIONS,
-        lockfilePath: (0, path_1.join)(directoryPath, "dir.lock"),
-    });
-};
-exports.waitToAcquireLockOnDirectory = waitToAcquireLockOnDirectory;
-const LOCK_RETRY_OPTIONS = {
-    // We want to keep on retrying till we get the maxRetryTime, so we set retries, which is a maximum, to a high value
-    retries: 1000,
-    factor: 1.05,
-    minTimeout: 500,
-    maxTimeout: 2000,
-    // Wait a maximum of 120s for the other process to finish downloading and/or extracting
-    maxRetryTime: luxon_1.Duration.fromObject({ minutes: 2 }).as("milliseconds"),
-    // Randomize so processes are less likely to clash on their retries
-    randomize: true,
-};

package/dist/local-data/replay-assets.d.ts

@@ -1,3 +0,0 @@
-import { ReplayEventsDependencies } from "@alwaysmeticulous/common";
-export declare const loadReplayEventsDependencies: () => Promise<ReplayEventsDependencies>;
-export declare const fetchAsset: (path: string) => Promise<string>;

package/dist/local-data/replay-assets.js

@@ -1,94 +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.fetchAsset = exports.loadReplayEventsDependencies = void 0;
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-const common_1 = require("@alwaysmeticulous/common");
-const axios_1 = __importDefault(require("axios"));
-const loglevel_1 = __importDefault(require("loglevel"));
-const snippets_1 = require("../config/snippets");
-const ASSETS_FOLDER_NAME = "assets";
-const ASSET_METADATA_FILE_NAME = "assets.json";
-const loadReplayEventsDependencies = async () => {
-    const browserUserInteractions = await (0, exports.fetchAsset)("replay/v2/snippet-user-interactions.bundle.js");
-    const browserPlayback = await (0, exports.fetchAsset)("replay/v2/snippet-playback.bundle.js");
-    const browserUrlObserver = await (0, exports.fetchAsset)("replay/v2/snippet-url-observer.bundle.js");
-    const nodeBrowserContext = await (0, exports.fetchAsset)("replay/v2/node-browser-context.bundle.js");
-    const nodeNetworkStubbing = await (0, exports.fetchAsset)("replay/v2/node-network-stubbing.bundle.js");
-    const nodeUserInteractions = await (0, exports.fetchAsset)("replay/v2/node-user-interactions.bundle.js");
-    return {
-        browserUserInteractions: {
-            key: "browserUserInteractions",
-            location: browserUserInteractions,
-        },
-        browserPlayback: {
-            key: "browserPlayback",
-            location: browserPlayback,
-        },
-        browserUrlObserver: {
-            key: "browserUrlObserver",
-            location: browserUrlObserver,
-        },
-        nodeBrowserContext: {
-            key: "nodeBrowserContext",
-            location: nodeBrowserContext,
-        },
-        nodeNetworkStubbing: {
-            key: "nodeNetworkStubbing",
-            location: nodeNetworkStubbing,
-        },
-        nodeUserInteractions: {
-            key: "nodeUserInteractions",
-            location: nodeUserInteractions,
-        },
-    };
-};
-exports.loadReplayEventsDependencies = loadReplayEventsDependencies;
-const fetchAsset = async (path) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const fetchUrl = new URL(path, (0, snippets_1.getSnippetsBaseUrl)()).href;
-    const assetFileName = `${(0, path_1.basename)(new URL(fetchUrl).pathname, ".js")}.cjs`;
-    const assetMetadata = await loadAssetMetadata();
-    const etag = (await axios_1.default.head(fetchUrl)).headers["etag"] || "";
-    const entry = assetMetadata.assets.find((item) => item.fileName === assetFileName);
-    const filePath = (0, path_1.join)(await getOrCreateAssetsDir(), assetFileName);
-    if (entry && etag !== "" && etag === entry.etag) {
-        logger.debug(`${fetchUrl} already present`);
-        return filePath;
-    }
-    const contents = (await axios_1.default.get(fetchUrl)).data;
-    await (0, promises_1.writeFile)(filePath, contents);
-    if (entry) {
-        logger.debug(`${fetchUrl} updated`);
-        entry.etag = etag;
-    }
-    else {
-        logger.debug(`${fetchUrl} downloaded`);
-        assetMetadata.assets.push({ fileName: assetFileName, etag, fetchUrl });
-    }
-    await saveAssetMetadata(assetMetadata);
-    return filePath;
-};
-exports.fetchAsset = fetchAsset;
-const getOrCreateAssetsDir = async () => {
-    const assetsDir = (0, path_1.join)((0, common_1.getMeticulousLocalDataDir)(), ASSETS_FOLDER_NAME);
-    await (0, promises_1.mkdir)(assetsDir, { recursive: true });
-    return assetsDir;
-};
-const loadAssetMetadata = async () => {
-    const assetsFile = (0, path_1.join)(await getOrCreateAssetsDir(), ASSET_METADATA_FILE_NAME);
-    const existingMetadata = await (0, promises_1.readFile)(assetsFile)
-        .then((data) => JSON.parse(data.toString("utf-8")))
-        .catch(() => null);
-    if (existingMetadata) {
-        return existingMetadata;
-    }
-    return { assets: [] };
-};
-const saveAssetMetadata = async (assetMetadata) => {
-    const assetsFile = (0, path_1.join)(await getOrCreateAssetsDir(), ASSET_METADATA_FILE_NAME);
-    await (0, promises_1.writeFile)(assetsFile, JSON.stringify(assetMetadata, null, 2));
-};

package/dist/local-data/replays.d.ts

@@ -1,18 +0,0 @@
-import { ScreenshotIdentifier } from "@alwaysmeticulous/api";
-import { Replay } from "@alwaysmeticulous/common";
-import { AxiosInstance } from "axios";
-export declare const getOrFetchReplay: (client: AxiosInstance, replayId: string) => Promise<{
-    fileName: string;
-    data: Replay;
-}>;
-export declare const getOrFetchReplayArchive: (client: AxiosInstance, replayId: string) => Promise<{
-    fileName: string;
-}>;
-export interface IdentifiedScreenshotFile {
-    identifier: ScreenshotIdentifier;
-    fileName: string;
-}
-export declare const getScreenshotFiles: (screenshotsDirPath: string) => Promise<IdentifiedScreenshotFile[]>;
-export declare const getSnapshottedAssetsDir: (replayId: string) => string;
-export declare const getScreenshotsDir: (replayDir: string) => string;
-export declare const getReplayDir: (replayId: string) => string;

package/dist/local-data/replays.js

@@ -1,87 +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.getReplayDir = exports.getScreenshotsDir = exports.getSnapshottedAssetsDir = exports.getScreenshotFiles = exports.getOrFetchReplayArchive = exports.getOrFetchReplay = void 0;
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-const common_1 = require("@alwaysmeticulous/common");
-const adm_zip_1 = __importDefault(require("adm-zip"));
-const loglevel_1 = __importDefault(require("loglevel"));
-const download_1 = require("../api/download");
-const replay_api_1 = require("../api/replay.api");
-const get_screenshot_identifier_1 = require("../commands/screenshot-diff/utils/get-screenshot-identifier");
-const local_data_utils_1 = require("./local-data.utils");
-const getOrFetchReplay = async (client, replayId) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const replayFile = (0, path_1.join)((0, exports.getReplayDir)(replayId), `${replayId}.json`);
-    const replay = await (0, local_data_utils_1.getOrDownloadJsonFile)({
-        filePath: replayFile,
-        dataDescription: "replay",
-        downloadJson: () => (0, replay_api_1.getReplay)(client, replayId),
-    });
-    if (!replay) {
-        logger.error(`Error: Could not retrieve replay with id "${replayId}". Is the API token correct?`);
-        process.exit(1);
-    }
-    return { fileName: replayFile, data: replay };
-};
-exports.getOrFetchReplay = getOrFetchReplay;
-const getOrFetchReplayArchive = async (client, replayId) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const replayDir = (0, exports.getReplayDir)(replayId);
-    await (0, promises_1.mkdir)(replayDir, { recursive: true });
-    const releaseLock = await (0, local_data_utils_1.waitToAcquireLockOnDirectory)(replayDir);
-    try {
-        const replayArchiveFile = (0, path_1.join)(replayDir, `${replayId}.zip`);
-        const paramsFile = (0, path_1.join)(replayDir, "replayEventsParams.json");
-        // Check if "replayEventsParams.json" exists. If yes, we assume the replay
-        // zip archive has been downloaded and extracted.
-        if (await (0, local_data_utils_1.fileExists)(paramsFile)) {
-            logger.debug(`Replay archive already downloaded at ${replayDir}`);
-            return { fileName: replayDir };
-        }
-        const downloadUrlData = await (0, replay_api_1.getReplayDownloadUrl)(client, replayId);
-        if (!downloadUrlData) {
-            logger.error("Error: Could not retrieve replay archive URL. This may be an invalid replay");
-            await releaseLock();
-            process.exit(1);
-        }
-        await (0, download_1.downloadFile)(downloadUrlData.dowloadUrl, replayArchiveFile);
-        const zipFile = new adm_zip_1.default(replayArchiveFile);
-        zipFile.extractAllTo(replayDir, /*overwrite=*/ true);
-        await (0, promises_1.rm)(replayArchiveFile);
-        logger.debug(`Extracted replay archive in ${replayDir}`);
-        return { fileName: replayDir };
-    }
-    finally {
-        await releaseLock();
-    }
-};
-exports.getOrFetchReplayArchive = getOrFetchReplayArchive;
-const getScreenshotFiles = async (screenshotsDirPath) => {
-    const screenshotFiles = [];
-    const screenshotsDir = await (0, promises_1.opendir)(screenshotsDirPath);
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    for await (const dirEntry of screenshotsDir) {
-        if (!dirEntry.isFile() || !dirEntry.name.endsWith(".png")) {
-            continue;
-        }
-        const identifier = (0, get_screenshot_identifier_1.getScreenshotIdentifier)(dirEntry.name);
-        if (identifier == null) {
-            logger.error(`Ignoring screenshot file with unrecognized name pattern: ${dirEntry.name}`);
-            continue;
-        }
-        screenshotFiles.push({ identifier, fileName: dirEntry.name });
-    }
-    // Sort files alphabetically to help when reading results.
-    return screenshotFiles.sort((a, b) => a.fileName.localeCompare(b.fileName));
-};
-exports.getScreenshotFiles = getScreenshotFiles;
-const getSnapshottedAssetsDir = (replayId) => (0, path_1.join)((0, exports.getReplayDir)(replayId), "snapshotted-assets");
-exports.getSnapshottedAssetsDir = getSnapshottedAssetsDir;
-const getScreenshotsDir = (replayDir) => (0, path_1.join)(replayDir, "screenshots");
-exports.getScreenshotsDir = getScreenshotsDir;
-const getReplayDir = (replayId) => (0, path_1.join)((0, common_1.getMeticulousLocalDataDir)(), "replays", replayId);
-exports.getReplayDir = getReplayDir;

package/dist/local-data/screenshot-diffs.d.ts

@@ -1,7 +0,0 @@
-import { PNG } from "pngjs";
-export declare const writeScreenshotDiff: (options: {
-    baseReplayId: string;
-    headReplayId: string;
-    screenshotFileName: string;
-    diff: PNG;
-}) => Promise<void>;

package/dist/local-data/screenshot-diffs.js

@@ -1,20 +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.writeScreenshotDiff = void 0;
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-const common_1 = require("@alwaysmeticulous/common");
-const loglevel_1 = __importDefault(require("loglevel"));
-const io_utils_1 = require("../image/io.utils");
-const writeScreenshotDiff = async ({ baseReplayId, headReplayId, screenshotFileName, diff, }) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const diffDir = (0, path_1.join)((0, common_1.getMeticulousLocalDataDir)(), "screenshot-diffs");
-    await (0, promises_1.mkdir)(diffDir, { recursive: true });
-    const diffFile = (0, path_1.join)(diffDir, `${baseReplayId}-vs-${headReplayId}-${screenshotFileName}.png`);
-    await (0, io_utils_1.writePng)(diff, diffFile);
-    logger.debug(`Screenshot diff written to ${diffFile}`);
-};
-exports.writeScreenshotDiff = writeScreenshotDiff;

package/dist/local-data/serve-assets-from-simulation.d.ts

@@ -1,5 +0,0 @@
-import { AxiosInstance } from "axios";
-export declare function serveAssetsFromSimulation(client: AxiosInstance, simulationId: string): Promise<{
-    url: string;
-    closeServer: () => void;
-}>;

package/dist/local-data/serve-assets-from-simulation.js

@@ -1,52 +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.serveAssetsFromSimulation = void 0;
-const fs_1 = require("fs");
-const common_1 = require("@alwaysmeticulous/common");
-const express_1 = __importDefault(require("express"));
-const find_free_port_1 = __importDefault(require("find-free-port"));
-const loglevel_1 = __importDefault(require("loglevel"));
-const replays_1 = require("./replays");
-// We must avoid ports blocked by Chrome: https://superuser.com/questions/188058/which-ports-are-considered-unsafe-by-chrome
-const STARTING_PORT = 9100;
-const ENDING_PORT = 10000;
-const MAX_RETRY_ATTEMPTS = 3;
-async function serveAssetsFromSimulation(client, simulationId) {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    await (0, replays_1.getOrFetchReplayArchive)(client, simulationId);
-    const snapshottedAssetsDir = (0, replays_1.getSnapshottedAssetsDir)(simulationId);
-    if (!(0, fs_1.existsSync)(snapshottedAssetsDir)) {
-        logger.error(`No snapshotted assets found for simulation '${simulationId}'.` +
-            " Please re-run without the --simulationIdForAssets flag." +
-            " You can optionally specify an --appUrl to run the simulation against.");
-        process.exit(1);
-    }
-    const app = (0, express_1.default)();
-    // eslint-disable-next-line import/no-named-as-default-member
-    app.use(express_1.default.static(snapshottedAssetsDir));
-    const serverStartupPromise = (0, common_1.defer)();
-    const { server, port } = await retryUntilFreePortFound((portToTry) => app.listen(portToTry, () => serverStartupPromise.resolve()));
-    return serverStartupPromise.promise.then(() => ({
-        url: `http://localhost:${port}`,
-        closeServer: server.close.bind(server),
-    }));
-}
-exports.serveAssetsFromSimulation = serveAssetsFromSimulation;
-// We retry a few times in case of race conditions (two servers trying to grab same port at same time)
-const retryUntilFreePortFound = async (startServer, attempt = 0) => {
-    // We randomize the port to try to minimize chance of race conditions
-    const [port] = await (0, find_free_port_1.default)(randomNumberBetween(STARTING_PORT, ENDING_PORT));
-    try {
-        return { server: startServer(port), port };
-    }
-    catch (err) {
-        if (attempt < MAX_RETRY_ATTEMPTS) {
-            return retryUntilFreePortFound(startServer, attempt + 1);
-        }
-        throw err;
-    }
-};
-const randomNumberBetween = (inclusiveStart, exclusiveEnd) => Math.floor(Math.random() * (exclusiveEnd - inclusiveStart) + inclusiveStart);

package/dist/local-data/sessions.d.ts

@@ -1,10 +0,0 @@
-import { SessionData } from "@alwaysmeticulous/api";
-import { AxiosInstance } from "axios";
-export declare const getOrFetchRecordedSession: (client: AxiosInstance, sessionId: string) => Promise<{
-    fileName: string;
-    data: any;
-}>;
-export declare const getOrFetchRecordedSessionData: (client: AxiosInstance, sessionId: string) => Promise<{
-    fileName: string;
-    data: SessionData;
-}>;

package/dist/local-data/sessions.js

@@ -1,41 +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.getOrFetchRecordedSessionData = exports.getOrFetchRecordedSession = void 0;
-const path_1 = require("path");
-const common_1 = require("@alwaysmeticulous/common");
-const loglevel_1 = __importDefault(require("loglevel"));
-const session_api_1 = require("../api/session.api");
-const local_data_utils_1 = require("./local-data.utils");
-const getOrFetchRecordedSession = async (client, sessionId) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const sessionFile = (0, path_1.join)((0, common_1.getMeticulousLocalDataDir)(), "sessions", `${(0, local_data_utils_1.sanitizeFilename)(sessionId)}.json`);
-    const session = await (0, local_data_utils_1.getOrDownloadJsonFile)({
-        filePath: sessionFile,
-        dataDescription: "session",
-        downloadJson: () => (0, session_api_1.getRecordedSession)(client, sessionId),
-    });
-    if (!session) {
-        logger.error("Error: Could not retrieve session. Is the API token correct?");
-        process.exit(1);
-    }
-    return { fileName: sessionFile, data: session };
-};
-exports.getOrFetchRecordedSession = getOrFetchRecordedSession;
-const getOrFetchRecordedSessionData = async (client, sessionId) => {
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    const sessionFile = (0, path_1.join)((0, common_1.getMeticulousLocalDataDir)(), "sessions", `${(0, local_data_utils_1.sanitizeFilename)(sessionId)}_data.json`);
-    const sessionData = await (0, local_data_utils_1.getOrDownloadJsonFile)({
-        filePath: sessionFile,
-        dataDescription: "session data",
-        downloadJson: () => (0, session_api_1.getRecordedSessionData)(client, sessionId),
-    });
-    if (!sessionData) {
-        logger.error("Error: Could not retrieve session data. This may be an invalid session");
-        process.exit(1);
-    }
-    return { fileName: sessionFile, data: sessionData };
-};
-exports.getOrFetchRecordedSessionData = getOrFetchRecordedSessionData;

package/dist/parallel-tests/__tests__/merge-test-results.spec.d.ts

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

package/dist/parallel-tests/__tests__/merge-test-results.spec.js

@@ -1,104 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const merge_test_results_1 = require("../merge-test-results");
-const mock_test_results_1 = require("./mock-test-results");
-describe("mergeResults", () => {
-    it("keeps the result as a failure when all retried screenshots are 'identical'", () => {
-        const currentResult = (0, mock_test_results_1.testResult)("fail", [(0, mock_test_results_1.diff)(0), (0, mock_test_results_1.noDiff)(1)]);
-        const comparisonToHeadReplay = (0, mock_test_results_1.testResult)("pass", [(0, mock_test_results_1.noDiff)(0), (0, mock_test_results_1.noDiff)(1)]);
-        const mergedResult = (0, merge_test_results_1.mergeResults)({
-            currentResult,
-            comparisonToHeadReplay,
-        });
-        expect(mergedResult).toEqual((0, mock_test_results_1.testResult)("fail", [(0, mock_test_results_1.diff)(0), (0, mock_test_results_1.noDiff)(1)]));
-    });
-    it("doesn't ignore diffs to screenshots which originally passed", () => {
-        const currentResult = (0, mock_test_results_1.testResult)("pass", [(0, mock_test_results_1.noDiff)(0), (0, mock_test_results_1.noDiff)(1)]);
-        const comparisonToHeadReplay = (0, mock_test_results_1.testResult)("fail", [(0, mock_test_results_1.noDiff)(0), (0, mock_test_results_1.diff)(1)]);
-        const mergedResult = (0, merge_test_results_1.mergeResults)({
-            currentResult,
-            comparisonToHeadReplay,
-        });
-        expect(mergedResult).toEqual(
-        // All screenshots are either "no-diff" or "flake" thus the overall result is "flake"
-        (0, mock_test_results_1.testResult)("flake", [(0, mock_test_results_1.noDiff)(0), (0, mock_test_results_1.flake)(1, (0, mock_test_results_1.noDiff)(), [(0, mock_test_results_1.diff)()])]));
-    });
-    it("marks screenshots as flakes if the screenshot comparison originally failed, but the second retry gives a different screenshot again", () => {
-        const currentResult = (0, mock_test_results_1.testResult)("fail", [(0, mock_test_results_1.noDiff)(0), (0, mock_test_results_1.diff)(1), (0, mock_test_results_1.diff)(2)]);
-        const comparisonToHeadReplay = (0, mock_test_results_1.testResult)("fail", [
-            (0, mock_test_results_1.noDiff)(0),
-            (0, mock_test_results_1.diff)(1),
-            (0, mock_test_results_1.noDiff)(2),
-        ]);
-        const mergedResult = (0, merge_test_results_1.mergeResults)({
-            currentResult,
-            comparisonToHeadReplay,
-        });
-        expect(mergedResult).toEqual((0, mock_test_results_1.testResult)("fail", [(0, mock_test_results_1.noDiff)(0), (0, mock_test_results_1.flake)(1, (0, mock_test_results_1.diff)(), [(0, mock_test_results_1.diff)()]), (0, mock_test_results_1.diff)(2)]));
-    });
-    it("marks overall test as a flake if there are only flakey screenshots and no failed screenshots", () => {
-        const currentResult = (0, mock_test_results_1.testResult)("fail", [(0, mock_test_results_1.noDiff)(0), (0, mock_test_results_1.diff)(1), (0, mock_test_results_1.diff)(2)]);
-        const comparisonToHeadReplay = (0, mock_test_results_1.testResult)("fail", [
-            (0, mock_test_results_1.noDiff)(0),
-            (0, mock_test_results_1.diff)(1),
-            (0, mock_test_results_1.diff)(2),
-        ]);
-        const mergedResult = (0, merge_test_results_1.mergeResults)({
-            currentResult,
-            comparisonToHeadReplay,
-        });
-        expect(mergedResult).toEqual((0, mock_test_results_1.testResult)("flake", [
-            (0, mock_test_results_1.noDiff)(0),
-            (0, mock_test_results_1.flake)(1, (0, mock_test_results_1.diff)(), [(0, mock_test_results_1.diff)()]),
-            (0, mock_test_results_1.flake)(2, (0, mock_test_results_1.diff)(), [(0, mock_test_results_1.diff)()]),
-        ]));
-    });
-    it("adds to diffsToHeadScreenshotOnRetries for existing flakes", () => {
-        const currentResult = (0, mock_test_results_1.testResult)("fail", [
-            (0, mock_test_results_1.diff)(0),
-            (0, mock_test_results_1.flake)(1, (0, mock_test_results_1.diff)(), [(0, mock_test_results_1.missingHead)()]),
-            (0, mock_test_results_1.flake)(2, (0, mock_test_results_1.differentSize)(), [(0, mock_test_results_1.diff)()]),
-            (0, mock_test_results_1.flake)(3, (0, mock_test_results_1.missingBase)(), [(0, mock_test_results_1.diff)(), (0, mock_test_results_1.diff)()]),
-        ]);
-        const comparisonToHeadReplay = (0, mock_test_results_1.testResult)("fail", [
-            (0, mock_test_results_1.noDiff)(0),
-            (0, mock_test_results_1.diff)(1),
-            (0, mock_test_results_1.differentSize)(2),
-            (0, mock_test_results_1.missingHead)(3),
-        ]);
-        const mergedResult = (0, merge_test_results_1.mergeResults)({
-            currentResult,
-            comparisonToHeadReplay,
-        });
-        expect(mergedResult).toEqual((0, mock_test_results_1.testResult)("fail", [
-            (0, mock_test_results_1.diff)(0),
-            (0, mock_test_results_1.flake)(1, (0, mock_test_results_1.diff)(), [(0, mock_test_results_1.missingHead)(), (0, mock_test_results_1.diff)()]),
-            (0, mock_test_results_1.flake)(2, (0, mock_test_results_1.differentSize)(), [(0, mock_test_results_1.diff)(), (0, mock_test_results_1.differentSize)()]),
-            (0, mock_test_results_1.flake)(3, (0, mock_test_results_1.missingBase)(), [(0, mock_test_results_1.diff)(), (0, mock_test_results_1.diff)(), (0, mock_test_results_1.missingHead)()]),
-        ]));
-    });
-    it("keeps a missing-head as is, if there is no corresponding retry screenshot", () => {
-        const currentResult = (0, mock_test_results_1.testResult)("fail", [(0, mock_test_results_1.missingHead)(0)]);
-        const comparisonToHeadReplay = (0, mock_test_results_1.testResult)("pass", []);
-        const mergedResult = (0, merge_test_results_1.mergeResults)({
-            currentResult,
-            comparisonToHeadReplay,
-        });
-        expect(mergedResult).toEqual((0, mock_test_results_1.testResult)("fail", [(0, mock_test_results_1.missingHead)(0)]));
-    });
-    it("adds to diffsToHeadScreenshotOnRetries for a flakey missing-head, if there is no corresponding retry screenshot", () => {
-        const currentResult = (0, mock_test_results_1.testResult)("fail", [
-            (0, mock_test_results_1.flake)(0, (0, mock_test_results_1.missingHead)(), [(0, mock_test_results_1.missingBase)()]),
-            (0, mock_test_results_1.diff)(1),
-        ]);
-        const comparisonToHeadReplay = (0, mock_test_results_1.testResult)("pass", [(0, mock_test_results_1.noDiff)(1)]);
-        const mergedResult = (0, merge_test_results_1.mergeResults)({
-            currentResult,
-            comparisonToHeadReplay,
-        });
-        expect(mergedResult).toEqual((0, mock_test_results_1.testResult)("fail", [
-            (0, mock_test_results_1.flake)(0, (0, mock_test_results_1.missingHead)(), [(0, mock_test_results_1.missingBase)(), (0, mock_test_results_1.missingBaseAndHead)()]),
-            (0, mock_test_results_1.diff)(1),
-        ]));
-    });
-});

package/dist/parallel-tests/__tests__/mock-test-results.d.ts

@@ -1,17 +0,0 @@
-import { ScreenshotDiffResult, ScreenshotIdentifier, TestCase } from "@alwaysmeticulous/api";
-import { DetailedTestCaseResult } from "../../config/config.types";
-export declare const id: (eventNumber?: number) => ScreenshotIdentifier;
-export declare const testResult: (result: "pass" | "fail" | "flake", screenshotDiffResults: ScreenshotDiffResult[], testCase?: TestCase) => DetailedTestCaseResult;
-export declare const diff: (eventNumber?: number) => ScreenshotDiffResult;
-export declare const noDiff: (eventNumber?: number) => ScreenshotDiffResult;
-export declare const flake: (eventNumber: number, diffToBaseScreenshot: ScreenshotDiffResult, diffsToHeadScreenshotOnRetries: Array<ScreenshotDiffResult | {
-    identifier: ScreenshotIdentifier;
-    outcome: "missing-base-and-head";
-}>) => ScreenshotDiffResult;
-export declare const missingBase: (eventNumber?: number) => ScreenshotDiffResult;
-export declare const missingHead: (eventNumber?: number) => ScreenshotDiffResult;
-export declare const missingBaseAndHead: (eventNumber?: number) => {
-    readonly identifier: ScreenshotIdentifier;
-    readonly outcome: "missing-base-and-head";
-};
-export declare const differentSize: (eventNumber?: number) => ScreenshotDiffResult;