@alwaysmeticulous/cli 2.39.0 → 2.40.0

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

@@ -78,10 +78,6 @@ export declare const createTestCommand: import("yargs").CommandModule<unknown, i
         boolean: true;
         description: string;
     };
-    screenshotSelector: {
-        string: true;
-        description: string;
-    };
     moveBeforeClick: {
         readonly boolean: true;
         readonly description: "Simulate mouse movement before clicking";

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

@@ -59,7 +59,7 @@ apiToken, commitSha, devTools, bypassCSP,
 // Record options
 width, height, uploadIntervalMs, incognito, trace, 
 // Replay options
-headless, screenshotSelector, shiftTime, networkStubbing, moveBeforeClick, cookiesFile, disableRemoteFonts, noSandbox, skipPauses, }) => {
+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");
@@ -95,7 +95,6 @@ headless, screenshotSelector, shiftTime, networkStubbing, moveBeforeClick, cooki
         devTools,
         bypassCSP,
         screenshot: true,
-        screenshotSelector,
         shiftTime,
         disableRemoteFonts,
         noSandbox,
@@ -148,10 +147,6 @@ exports.createTestCommand = (0, command_builder_1.buildCommand)("create-test")
         description: "Enable verbose logging",
     },
     // Replay options
-    screenshotSelector: {
-        string: true,
-        description: "Query selector to screenshot a specific DOM element instead of the whole page",
-    },
     moveBeforeClick: common_options_1.OPTIONS.moveBeforeClick,
     cookiesFile: {
         string: true,

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

@@ -23,7 +23,6 @@ export interface RawReplayCommandHandlerOptions extends ScreenshotDiffOptions, O
     screenshot: boolean;
     appUrl: string | null | undefined;
     simulationIdForAssets: string | null | undefined;
-    screenshotSelector: string | null | undefined;
     maxDurationMs: number | null | undefined;
     maxEventCount: number | null | undefined;
     storyboard: boolean;
@@ -36,7 +35,7 @@ interface AdditionalReplayOptions {
     cookiesFile: string | null | undefined;
     debugger: boolean;
 }
-export declare const rawReplayCommandHandler: ({ apiToken, commitSha, sessionId, appUrl, simulationIdForAssets, headless, devTools, bypassCSP, screenshot, screenshotSelector, 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, 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;
@@ -134,10 +133,6 @@ export declare const replayCommand: import("yargs").CommandModule<unknown, impor
         description: string;
         default: boolean;
     };
-    screenshotSelector: {
-        string: true;
-        description: string;
-    };
     debugger: {
         boolean: true;
         description: string;

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

@@ -232,7 +232,7 @@ const serveOrGetAppUrl = async (client, 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, screenshotSelector, diffThreshold, diffPixelThreshold, shiftTime, networkStubbing, moveBeforeClick, cookiesFile, disableRemoteFonts, noSandbox, skipPauses, maxDurationMs, maxEventCount, storyboard, essentialFeaturesOnly, debugger: enableStepThroughDebugger, }) => {
+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,7 +254,6 @@ const rawReplayCommandHandler = async ({ apiToken, commitSha, sessionId, appUrl,
     const screenshottingOptions = screenshot
         ? {
             enabled: true,
-            screenshotSelector: screenshotSelector !== null && screenshotSelector !== void 0 ? screenshotSelector : null,
             diffOptions: { diffPixelThreshold, diffThreshold },
             storyboardOptions,
         }
@@ -317,10 +316,6 @@ exports.replayCommand = (0, command_builder_1.buildCommand)("simulate")
         description: "Take a screenshot at the end of simulation",
         default: true,
     },
-    screenshotSelector: {
-        string: true,
-        description: "Query selector to screenshot a specific DOM element instead of the whole page",
-    },
     debugger: {
         boolean: true,
         description: "Opens a step through debugger to advance through the replay event by event",

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

@@ -27,7 +27,6 @@ const handler = async ({ apiToken, commitSha: commitSha_, baseCommitSha, appUrl,
         : { enabled: false };
     const screenshottingOptions = {
         enabled: true,
-        screenshotSelector: null,
         diffOptions: { diffPixelThreshold, diffThreshold },
         storyboardOptions,
     };

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

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

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const get_screenshot_identifier_1 = require("../get-screenshot-identifier");
+describe("get-screenshot-identifier", () => {
+    it("can parse identifiers without version numbers", () => {
+        expect((0, get_screenshot_identifier_1.getScreenshotIdentifier)("final-state.png")).toEqual({
+            type: "end-state",
+        });
+        expect((0, get_screenshot_identifier_1.getScreenshotIdentifier)("screenshot-after-event-7.png")).toEqual({
+            type: "after-event",
+            eventNumber: 7,
+        });
+    });
+    it("can parse identifiers with version numbers", () => {
+        expect((0, get_screenshot_identifier_1.getScreenshotIdentifier)("final-state-v2.png")).toEqual({
+            type: "end-state",
+            logicVersion: 2,
+        });
+        expect((0, get_screenshot_identifier_1.getScreenshotIdentifier)("screenshot-after-event-7-v2.png")).toEqual({
+            type: "after-event",
+            eventNumber: 7,
+            logicVersion: 2,
+        });
+    });
+});

package/dist/commands/screenshot-diff/utils/get-screenshot-filename.js

@@ -5,11 +5,15 @@ exports.getScreenshotFilename = void 0;
 // in replay-node, and in https://github.com/alwaysmeticulous/meticulous-sdk/blob/395af4394dc51d9b51ba1136fc26b23fcbba5604/packages/replayer/src/screenshot.utils.ts#L42
 const getScreenshotFilename = (identifier) => {
     if (identifier.type === "end-state") {
-        return "final-state.png";
+        return identifier.logicVersion == null
+            ? "final-state.png"
+            : `final-state-v${identifier.logicVersion}.png`;
     }
     else if (identifier.type === "after-event") {
         const eventIndexStr = identifier.eventNumber.toString().padStart(5, "0");
-        return `screenshot-after-event-${eventIndexStr}.png`;
+        return identifier.logicVersion == null
+            ? `screenshot-after-event-${eventIndexStr}.png`
+            : `screenshot-after-event-${eventIndexStr}-v${identifier.logicVersion}.png`;
     }
     else {
         throw new Error("Unexpected screenshot identifier: " + JSON.stringify(identifier));

package/dist/commands/screenshot-diff/utils/get-screenshot-identifier.js

@@ -3,19 +3,34 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getScreenshotIdentifier = void 0;
 const path_1 = require("path");
 const getScreenshotIdentifier = (filename) => {
+    var _a;
     const name = (0, path_1.basename)(filename);
     if (name === "final-state.png") {
         return {
             type: "end-state",
         };
     }
+    if (name.startsWith("final-state-v")) {
+        const match = name.match(/^final-state-v(\d+)[.]png$/);
+        const logicVersionNumber = match ? parseInt(match[1], 10) : undefined;
+        if (match && logicVersionNumber != null && !isNaN(logicVersionNumber)) {
+            return {
+                type: "end-state",
+                logicVersion: logicVersionNumber,
+            };
+        }
+    }
     if (name.startsWith("screenshot-after-event")) {
-        const match = name.match(/^(?:.*)-(\d+)[.]png$/);
+        const match = (_a = name.match(/^(?:.*)-(\d+)-v(\d+)?[.]png$/)) !== null && _a !== void 0 ? _a : name.match(/^(?:.*)-(\d+)[.]png$/);
         const eventNumber = match ? parseInt(match[1], 10) : undefined;
+        const logicVersionNumber = match ? parseInt(match[2], 10) : undefined;
         if (match && eventNumber != null && !isNaN(eventNumber)) {
             return {
                 type: "after-event",
                 eventNumber,
+                ...(logicVersionNumber != null && !isNaN(logicVersionNumber)
+                    ? { logicVersion: logicVersionNumber }
+                    : {}),
             };
         }
     }

package/dist/config/config.js

@@ -22,10 +22,9 @@ const getConfigFilePath = async () => {
     return configFilePath;
 };
 const validateReplayOptions = (prevOptions) => {
-    const { appUrl, screenshotSelector, diffThreshold, diffPixelThreshold, moveBeforeClick, simulationIdForAssets, } = prevOptions;
+    const { appUrl, diffThreshold, diffPixelThreshold, moveBeforeClick, simulationIdForAssets, } = prevOptions;
     return {
         ...(appUrl != null ? { appUrl } : {}),
-        ...(screenshotSelector != null ? { screenshotSelector } : {}),
         ...(diffThreshold != null ? { diffThreshold } : {}),
         ...(diffPixelThreshold != null ? { diffPixelThreshold } : {}),
         ...(moveBeforeClick != null ? { moveBeforeClick } : {}),

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

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.testRunOutcomeFromDiffResults = exports.mergeResults = void 0;
-const utils_1 = require("@sentry/utils");
 const fast_json_stable_stringify_1 = __importDefault(require("fast-json-stable-stringify"));
 const has_notable_differences_1 = require("../commands/screenshot-diff/utils/has-notable-differences");
 const screenshot_diff_results_utils_1 = require("./screenshot-diff-results.utils");
@@ -86,22 +85,7 @@ identifier: _identifier,
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 baseReplayId: _baseReplayId, ...rest }) => rest;
 const hashScreenshotIdentifier = (identifier) => {
-    if (identifier.type === "end-state") {
-        return "end-state";
-    }
-    else if (identifier.type === "after-event") {
-        return `after-event-${identifier.eventNumber}`;
-    }
-    else {
-        unknownScreenshotIdentifierType(identifier);
-        // The identifier is probably from a newer version of the bundle script
-        // and we're on an old version of the CLI. Our best bet is to stringify it
-        // and use that as a hash.
-        return (0, fast_json_stable_stringify_1.default)(identifier);
-    }
-};
-const unknownScreenshotIdentifierType = (identifier) => {
-    utils_1.logger.error(`Unknown type of screenshot identifier: ${JSON.stringify(identifier)}`);
+    return (0, fast_json_stable_stringify_1.default)(identifier);
 };
 const testRunOutcomeFromDiffResults = (currentResult, newScreenshotDiffResults) => {
     // If a test run is already flakey, we don't want to overwrite that with a 'fail' result.

package/dist/parallel-tests/parallel-replay.handler.js

@@ -41,7 +41,7 @@ const applyTestCaseExecutionOptionOverrides = (executionOptionsFromCliFlags, ove
     };
 };
 const applyTestCaseScreenshottingOptionsOverrides = (screenshottingOptionsFromCliFlags, overridesFromTestCase) => {
-    var _a, _b, _c;
+    var _a, _b;
     // Options specified in the test case override those passed as CLI flags
     // (CLI flags set the defaults)
     const diffOptions = {
@@ -50,7 +50,6 @@ const applyTestCaseScreenshottingOptionsOverrides = (screenshottingOptionsFromCl
     };
     return {
         enabled: true,
-        screenshotSelector: (_c = overridesFromTestCase.screenshotSelector) !== null && _c !== void 0 ? _c : screenshottingOptionsFromCliFlags.screenshotSelector,
         diffOptions,
         storyboardOptions: screenshottingOptionsFromCliFlags.storyboardOptions,
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/cli",
-  "version": "2.39.0",
+  "version": "2.40.0",
   "description": "The Meticulous CLI",
   "license": "ISC",
   "main": "dist/index.js",
@@ -26,7 +26,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@alwaysmeticulous/common": "^2.39.0",
+    "@alwaysmeticulous/common": "^2.40.0",
     "@sentry/node": "^7.36.0",
     "@sentry/tracing": "^7.36.0",
     "adm-zip": "^0.5.9",
@@ -45,7 +45,7 @@
     "yargs": "^17.5.1"
   },
   "devDependencies": {
-    "@alwaysmeticulous/api": "^2.39.0",
+    "@alwaysmeticulous/api": "^2.40.0",
     "@types/express": "^4.17.14",
     "@types/proper-lockfile": "^4.1.2"
   },
@@ -95,5 +95,5 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   },
-  "gitHead": "b6488b15a8233fcd1380b1607ec254d5d3bc0378"
+  "gitHead": "46c8a774b634b1e43ca8e792a6ed573adba296ef"
 }