@argos-ci/cypress 4.0.5 → 5.0.1

package/dist/support.js

@@ -11,7 +11,10 @@ import {
 } from "@argos-ci/util/browser";
 
 // package.json
-var version = "4.0.4";
+var version = "5.0.0";
+
+// src/shared.ts
+var NAME_PREFIX = "argos/";
 
 // src/support.ts
 function injectArgos() {
@@ -90,7 +93,7 @@ Cypress.Commands.add(
       waitForReadiness(options);
       const afterEach = beforeEach(options);
       const ref = {};
-      cy.wrap(subject).screenshot(name2, {
+      cy.wrap(subject).screenshot(`${NAME_PREFIX}${name2}`, {
         blackout: ['[data-visual-test="blackout"]'].concat(
           options.blackout || []
         ),

package/dist/task.cjs

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/task.ts
@@ -25,34 +35,72 @@ __export(task_exports, {
 module.exports = __toCommonJS(task_exports);
 var import_core = require("@argos-ci/core");
 var import_node_path = require("path");
+
+// src/shared.ts
+var NAME_PREFIX = "argos/";
+
+// src/task.ts
 var import_promises = require("fs/promises");
 function checkIsCypressFailedResult(results) {
   return "status" in results && results.status === "failed";
 }
+var screenshotsDirectoryPromise = void 0;
+async function getScreenshotsDirectory() {
+  const { createTemporaryDirectory } = await import("@argos-ci/util");
+  if (!screenshotsDirectoryPromise) {
+    screenshotsDirectoryPromise = createTemporaryDirectory();
+  }
+  return screenshotsDirectoryPromise;
+}
+async function createDirectory(directory) {
+  const { createDirectory: createDirectory2 } = await import("@argos-ci/util");
+  await createDirectory2(directory);
+}
 function registerArgosTask(on, config, options) {
   on("after:screenshot", async (details) => {
-    const baseName = (0, import_node_path.basename)(details.path, (0, import_node_path.extname)(details.path));
-    const newBaseName = baseName.replace(/ \(attempt \d+\)/, "");
-    const newPath = (0, import_node_path.join)(
-      (0, import_node_path.dirname)(details.path),
-      newBaseName + (0, import_node_path.extname)(details.path)
+    const { uploadToArgos = true } = options || {};
+    if (!uploadToArgos) {
+      return { path: details.path };
+    }
+    const argosScreenshotsDir = await getScreenshotsDirectory();
+    if (details.name?.startsWith(NAME_PREFIX)) {
+      const newPath2 = (0, import_node_path.join)(
+        argosScreenshotsDir,
+        details.name.slice(NAME_PREFIX.length) + (0, import_node_path.extname)(details.path)
+      );
+      await createDirectory((0, import_node_path.dirname)(newPath2));
+      await (0, import_promises.rename)(details.path, newPath2);
+      return { path: newPath2 };
+    }
+    const { screenshotsFolder } = config;
+    if (!screenshotsFolder) {
+      throw new Error(
+        "Cypress screenshotsFolder is not defined. Please set it in your cypress.config.js"
+      );
+    }
+    if (!details.path.startsWith(screenshotsFolder)) {
+      throw new Error(
+        `Cypress screenshot path ${details.path} does not start with the configured screenshotsFolder ${screenshotsFolder}. Please check your cypress.config.js.`
+      );
+    }
+    const relativePath = details.path.slice(
+      screenshotsFolder.length + (screenshotsFolder.endsWith("/") ? 0 : 1)
     );
+    const newPath = (0, import_node_path.join)(argosScreenshotsDir, relativePath);
+    await createDirectory((0, import_node_path.dirname)(newPath));
     await (0, import_promises.rename)(details.path, newPath);
-    return { path: newPath };
+    return { path: (0, import_node_path.join)(argosScreenshotsDir, relativePath) };
   });
   on("after:run", async (results) => {
-    const { screenshotsFolder } = config;
-    if (!screenshotsFolder) {
-      return;
-    }
     const { uploadToArgos = true } = options || {};
     if (!uploadToArgos) {
       return;
     }
+    const argosScreenshotsDir = await getScreenshotsDirectory();
     const res = await (0, import_core.upload)({
       ...options,
       files: ["**/*.png"],
-      root: screenshotsFolder,
+      root: argosScreenshotsDir,
       metadata: {
         testReport: checkIsCypressFailedResult(results) ? { status: "failed" } : {
           status: "passed",

package/dist/task.js

@@ -1,34 +1,72 @@
 // src/task.ts
 import { upload } from "@argos-ci/core";
-import { basename, extname, join, dirname } from "node:path";
+import { extname, join, dirname } from "node:path";
+
+// src/shared.ts
+var NAME_PREFIX = "argos/";
+
+// src/task.ts
 import { rename } from "node:fs/promises";
 function checkIsCypressFailedResult(results) {
   return "status" in results && results.status === "failed";
 }
+var screenshotsDirectoryPromise = void 0;
+async function getScreenshotsDirectory() {
+  const { createTemporaryDirectory } = await import("@argos-ci/util");
+  if (!screenshotsDirectoryPromise) {
+    screenshotsDirectoryPromise = createTemporaryDirectory();
+  }
+  return screenshotsDirectoryPromise;
+}
+async function createDirectory(directory) {
+  const { createDirectory: createDirectory2 } = await import("@argos-ci/util");
+  await createDirectory2(directory);
+}
 function registerArgosTask(on, config, options) {
   on("after:screenshot", async (details) => {
-    const baseName = basename(details.path, extname(details.path));
-    const newBaseName = baseName.replace(/ \(attempt \d+\)/, "");
-    const newPath = join(
-      dirname(details.path),
-      newBaseName + extname(details.path)
+    const { uploadToArgos = true } = options || {};
+    if (!uploadToArgos) {
+      return { path: details.path };
+    }
+    const argosScreenshotsDir = await getScreenshotsDirectory();
+    if (details.name?.startsWith(NAME_PREFIX)) {
+      const newPath2 = join(
+        argosScreenshotsDir,
+        details.name.slice(NAME_PREFIX.length) + extname(details.path)
+      );
+      await createDirectory(dirname(newPath2));
+      await rename(details.path, newPath2);
+      return { path: newPath2 };
+    }
+    const { screenshotsFolder } = config;
+    if (!screenshotsFolder) {
+      throw new Error(
+        "Cypress screenshotsFolder is not defined. Please set it in your cypress.config.js"
+      );
+    }
+    if (!details.path.startsWith(screenshotsFolder)) {
+      throw new Error(
+        `Cypress screenshot path ${details.path} does not start with the configured screenshotsFolder ${screenshotsFolder}. Please check your cypress.config.js.`
+      );
+    }
+    const relativePath = details.path.slice(
+      screenshotsFolder.length + (screenshotsFolder.endsWith("/") ? 0 : 1)
     );
+    const newPath = join(argosScreenshotsDir, relativePath);
+    await createDirectory(dirname(newPath));
     await rename(details.path, newPath);
-    return { path: newPath };
+    return { path: join(argosScreenshotsDir, relativePath) };
   });
   on("after:run", async (results) => {
-    const { screenshotsFolder } = config;
-    if (!screenshotsFolder) {
-      return;
-    }
     const { uploadToArgos = true } = options || {};
     if (!uploadToArgos) {
       return;
     }
+    const argosScreenshotsDir = await getScreenshotsDirectory();
     const res = await upload({
       ...options,
       files: ["**/*.png"],
-      root: screenshotsFolder,
+      root: argosScreenshotsDir,
       metadata: {
         testReport: checkIsCypressFailedResult(results) ? { status: "failed" } : {
           status: "passed",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/cypress",
   "description": "Cypress SDK for visual testing with Argos.",
-  "version": "4.0.5",
+  "version": "5.0.1",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -46,8 +46,8 @@
   },
   "dependencies": {
     "@argos-ci/browser": "4.1.2",
-    "@argos-ci/core": "3.2.0",
-    "@argos-ci/util": "2.3.1",
+    "@argos-ci/core": "3.2.1",
+    "@argos-ci/util": "2.3.2",
     "cypress-wait-until": "^3.0.2"
   },
   "peerDependencies": {
@@ -67,5 +67,5 @@
     "check-format": "prettier --check --ignore-unknown --ignore-path=../../.gitignore --ignore-path=../../.prettierignore .",
     "lint": "eslint ."
   },
-  "gitHead": "ce03297aa28db2101dba3f495b8a02025d845981"
+  "gitHead": "1504eec02534235dc749f470150c37fc3beac1c0"
 }