@alwaysmeticulous/cli 2.45.2 → 2.46.0

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

@@ -1,21 +1,5 @@
 /// <reference types="yargs" />
-import { Replay, ScreenshotDiffOptions } from "@alwaysmeticulous/api";
-import { ReplayExecutionOptions, ReplayTarget } from "@alwaysmeticulous/sdk-bundles-api";
-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;
-    apiToken: string | null | undefined;
-    commitSha: string | null | undefined;
-    sessionId: string;
-    cookiesFile: string | null | undefined;
-    debugger: boolean;
-    baseReplayId: string | null | undefined;
-}
-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>;
+import { ReplayTarget } from "@alwaysmeticulous/sdk-bundles-api";
 export declare const getReplayTarget: ({ appUrl, simulationIdForAssets, }: {
     appUrl: string | null;
     simulationIdForAssets: string | null;

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

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replayCommand = exports.getReplayTarget = exports.rawReplayCommandHandler = void 0;
+exports.replayCommand = exports.getReplayTarget = void 0;
 const common_1 = require("@alwaysmeticulous/common");
 const replay_orchestrator_launcher_1 = require("@alwaysmeticulous/replay-orchestrator-launcher");
 const command_builder_1 = require("../../command-utils/command-builder");
 const common_options_1 = require("../../command-utils/common-options");
 const out_of_date_client_error_1 = require("../../utils/out-of-date-client-error");
 const replay_debugger_ui_1 = require("./utils/replay-debugger.ui");
-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, }) => {
+const replayCommandHandler = 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.");
     }
@@ -81,8 +81,7 @@ const rawReplayCommandHandler = async ({ apiToken, commitSha, sessionId, appUrl,
             getOnBeforeUserEventCallback.resolve(stepThroughDebuggerUI.onBeforeUserEvent);
             getOnClosePageCallback.resolve(stepThroughDebuggerUI.close);
         }
-        const { replay } = await replayExecution.finalResult;
-        return replay;
+        await replayExecution.finalResult;
     }
     catch (error) {
         if ((0, out_of_date_client_error_1.isOutOfDateClientError)(error)) {
@@ -93,7 +92,6 @@ const rawReplayCommandHandler = async ({ apiToken, commitSha, sessionId, appUrl,
         }
     }
 };
-exports.rawReplayCommandHandler = rawReplayCommandHandler;
 const getReplayTarget = ({ appUrl, simulationIdForAssets, }) => {
     if (simulationIdForAssets) {
         return { type: "snapshotted-assets", simulationIdForAssets };
@@ -149,5 +147,5 @@ exports.replayCommand = (0, command_builder_1.buildCommand)("simulate")
     ...common_options_1.SCREENSHOT_DIFF_OPTIONS,
 })
     .handler(async (options) => {
-    await (0, exports.rawReplayCommandHandler)(options);
+    await replayCommandHandler(options);
 });

package/dist/commands/run-all-tests/run-all-tests.command.d.ts

@@ -107,11 +107,6 @@ export declare const runAllTestsCommand: import("yargs").CommandModule<unknown,
         readonly description: "If set to a value greater than 0 then will re-run all replays the specified number of times and mark them as a flake if the screenshot generated on one of the retryed replays differs from that in the first replay.";
         readonly default: 0;
     };
-    readonly useCache: {
-        readonly boolean: true;
-        readonly description: "Use result cache";
-        readonly default: false;
-    };
     readonly testsFile: {
         readonly string: true;
         readonly description: string;

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

@@ -1,14 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runAllTestsCommand = void 0;
-const client_1 = require("@alwaysmeticulous/client");
 const common_1 = require("@alwaysmeticulous/common");
 const replay_orchestrator_launcher_1 = require("@alwaysmeticulous/replay-orchestrator-launcher");
-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 out_of_date_client_error_1 = require("../../utils/out-of-date-client-error");
-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 handler = async ({ apiToken, commitSha: commitSha_, baseCommitSha, appUrl, headless, devTools, bypassCSP, diffThreshold, diffPixelThreshold, shiftTime, networkStubbing, githubSummary, parallelize, parallelTasks: parrelelTasks_, maxRetriesOnFailure, rerunTestsNTimes, testsFile, disableRemoteFonts, noSandbox, skipPauses, moveBeforeClick, maxDurationMs, maxEventCount, storyboard, essentialFeaturesOnly, baseTestRunId, }) => {
     const executionOptions = {
         headless,
         devTools,
@@ -33,10 +31,6 @@ const handler = async ({ apiToken, commitSha: commitSha_, baseCommitSha, appUrl,
     };
     const parrelelTasks = parallelize ? parrelelTasks_ : 1;
     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 })
-        : [];
     try {
         const { testRun } = await (0, replay_orchestrator_launcher_1.executeTestRun)({
             testsFile: testsFile !== null && testsFile !== void 0 ? testsFile : null,
@@ -50,7 +44,6 @@ const handler = async ({ apiToken, commitSha: commitSha_, baseCommitSha, appUrl,
             parallelTasks: parrelelTasks !== null && parrelelTasks !== void 0 ? parrelelTasks : null,
             maxRetriesOnFailure,
             rerunTestsNTimes,
-            cachedTestRunResults,
             githubSummary,
             maxSemanticVersionSupported: 1,
         });
@@ -110,11 +103,6 @@ exports.runAllTestsCommand = (0, command_builder_1.buildCommand)("run-all-tests"
         description: "If set to a value greater than 0 then will re-run all replays the specified number of times and mark them as a flake if the screenshot generated on one of the retryed replays differs from that in the first replay.",
         default: 0,
     },
-    useCache: {
-        boolean: true,
-        description: "Use result cache",
-        default: false,
-    },
     testsFile: {
         string: true,
         description: "The path to the meticulous.json file containing the list of tests you want to run." +

package/dist/utils/sentry.utils.js

@@ -38,13 +38,17 @@ exports.setOptions = setOptions;
 const wrapHandler = function wrapHandler_(handler) {
     return async (args) => {
         await handler(args)
-            .then(() => {
+            .then(async () => {
             var _a;
             const transaction = (_a = Sentry.getCurrentHub().getScope()) === null || _a === void 0 ? void 0 : _a.getTransaction();
             if (transaction !== undefined) {
                 transaction.setStatus("ok");
                 transaction.finish();
             }
+            await Sentry.flush(sentry_1.SENTRY_FLUSH_TIMEOUT.toMillis());
+            // This is required: otherwise the process will hang for a while,
+            // presumably waiting on some setTimeout to trigger
+            process.exit(0);
         })
             .catch(async (error) => {
             var _a;
@@ -54,6 +58,7 @@ const wrapHandler = function wrapHandler_(handler) {
                 transaction.setStatus("unknown_error");
                 transaction.finish();
             }
+            await Sentry.flush(sentry_1.SENTRY_FLUSH_TIMEOUT.toMillis());
             // Don't display the help text which can obscure the error
             process.exit(1);
         });
@@ -67,5 +72,4 @@ const reportHandlerError = async (error) => {
     logger.info("");
     logger.info("Tip: run `meticulous <command> --help` for help on a particular command, or `meticulous --help` for a list of the available commands.");
     Sentry.captureException(error);
-    await Sentry.flush(sentry_1.SENTRY_FLUSH_TIMEOUT.toMillis());
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/cli",
-  "version": "2.45.2",
+  "version": "2.46.0",
   "description": "The Meticulous CLI",
   "license": "ISC",
   "main": "dist/index.js",
@@ -27,17 +27,16 @@
     "depcheck": "depcheck --ignore-patterns=dist"
   },
   "dependencies": {
-    "@alwaysmeticulous/api": "^2.44.1",
-    "@alwaysmeticulous/client": "^2.44.1",
-    "@alwaysmeticulous/common": "^2.44.1",
-    "@alwaysmeticulous/downloading-helpers": "^2.44.1",
-    "@alwaysmeticulous/record": "^2.44.1",
-    "@alwaysmeticulous/replay-debugger-ui": "^2.45.2",
-    "@alwaysmeticulous/replay-orchestrator-launcher": "^2.45.0",
-    "@alwaysmeticulous/sdk-bundles-api": "^2.45.0",
+    "@alwaysmeticulous/api": "^2.46.0",
+    "@alwaysmeticulous/client": "^2.46.0",
+    "@alwaysmeticulous/common": "^2.46.0",
+    "@alwaysmeticulous/downloading-helpers": "^2.46.0",
+    "@alwaysmeticulous/record": "^2.46.0",
+    "@alwaysmeticulous/replay-debugger-ui": "^2.46.0",
+    "@alwaysmeticulous/replay-orchestrator-launcher": "^2.46.0",
+    "@alwaysmeticulous/sdk-bundles-api": "^2.46.0",
     "@alwaysmeticulous/sentry": "^2.40.0",
     "@sentry/node": "^7.36.0",
-    "axios": "^1.2.6",
     "loglevel": "^1.8.0",
     "puppeteer": "19.7.5",
     "yargs": "^17.5.1"
@@ -79,5 +78,5 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   },
-  "gitHead": "3093e2cc8552f2821bac908b98a5be7316bc98b2"
+  "gitHead": "c03e5e034eb89d79d16f0eee09f95fa58341e038"
 }

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

@@ -1,7 +0,0 @@
-import { TestCaseResult } from "@alwaysmeticulous/api";
-import { AxiosInstance } from "axios";
-export interface GetCachedTestRunResultsOptions {
-    client: AxiosInstance;
-    commitSha: string;
-}
-export declare const getCachedTestRunResults: ({ client, commitSha, }: GetCachedTestRunResultsOptions) => Promise<TestCaseResult[]>;

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

@@ -1,21 +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.getCachedTestRunResults = void 0;
-const client_1 = require("@alwaysmeticulous/client");
-const common_1 = require("@alwaysmeticulous/common");
-const loglevel_1 = __importDefault(require("loglevel"));
-const getCachedTestRunResults = async ({ client, commitSha, }) => {
-    var _a, _b, _c;
-    const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
-    if (!commitSha || commitSha === "unknown") {
-        logger.warn("Test run cache not supported: no commit hash");
-        return [];
-    }
-    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;