@argos-ci/cypress 1.3.4 → 1.5.0

package/dist/support.d.ts

@@ -1,4 +1,14 @@
 import { ViewportOption } from "@argos-ci/browser";
+type ArgosScreenshotOptions = Partial<Cypress.Loggable & Cypress.Timeoutable & Cypress.ScreenshotOptions> & {
+    /**
+     * Viewports to take screenshots of.
+     */
+    viewports?: ViewportOption[];
+    /**
+     * Custom CSS evaluated during the screenshot process.
+     */
+    argosCSS?: string;
+};
 declare global {
     namespace Cypress {
         interface Chainable {
@@ -10,16 +20,7 @@ declare global {
              *    cy.argosScreenshot("my-screenshot")
              *    cy.get(".post").argosScreenshot()
              */
-            argosScreenshot: (name: string, options?: Partial<Loggable & Timeoutable & ScreenshotOptions> & {
-                /**
-                 * Viewports to take screenshots of.
-                 */
-                viewports?: ViewportOption[];
-                /**
-                 * Custom CSS evaluated during the screenshot process.
-                 */
-                argosCSS?: string;
-            }) => Chainable<null>;
+            argosScreenshot: (name: string, options?: ArgosScreenshotOptions) => Chainable<null>;
         }
     }
 }

package/dist/support.mjs

@@ -1,21 +1,35 @@
 import 'cypress-wait-until';
-import { resolveViewport } from '@argos-ci/browser';
-import { getGlobalFilePath } from '@argos-ci/browser/cypress.cjs';
+import { resolveViewport, getGlobalScript } from '@argos-ci/browser';
 import { getScreenshotName, getMetadataPath } from '@argos-ci/util/browser';
 
-var version = "1.3.3";
+var version = "1.4.0";
 
 function injectArgos() {
     cy.window({
         log: false
     }).then((window)=>{
         if (typeof window.__ARGOS__ !== "undefined") return;
-        const fileName = getGlobalFilePath();
-        return cy.readFile(fileName).then((source)=>{
-            window.eval(source);
-        });
+        window.eval(getGlobalScript());
     });
 }
+function setup(options) {
+    const { argosCSS } = options;
+    const fullPage = !options.capture || options.capture === "fullPage";
+    cy.window({
+        log: false
+    }).then((window)=>window.__ARGOS__.setup({
+            fullPage,
+            argosCSS
+        }));
+    return ()=>{
+        cy.window({
+            log: false
+        }).then((window)=>window.__ARGOS__.teardown({
+                fullPage,
+                argosCSS
+            }));
+    };
+}
 Cypress.Commands.add("argosScreenshot", {
     prevSubject: [
         "optional",
@@ -23,7 +37,8 @@ Cypress.Commands.add("argosScreenshot", {
         "window",
         "document"
     ]
-}, (subject, name, { viewports, argosCSS, ...options } = {})=>{
+}, (subject, name, options = {})=>{
+    const { viewports, argosCSS, ...cypressOptions } = options;
     if (!name) {
         throw new Error("The `name` argument is required.");
     }
@@ -33,13 +48,7 @@ Cypress.Commands.add("argosScreenshot", {
         message: name
     });
     injectArgos();
-    const fullPage = !options.capture || options.capture === "fullPage";
-    cy.window({
-        log: false
-    }).then((window)=>window.__ARGOS__.setup({
-            fullPage,
-            argosCSS
-        }));
+    const teardown = setup(options);
     function stabilizeAndScreenshot(name) {
         cy.waitUntil(()=>cy.window({
                 log: false
@@ -52,7 +61,7 @@ Cypress.Commands.add("argosScreenshot", {
             onAfterScreenshot: (_$el, props)=>{
                 ref.props = props;
             },
-            ...options
+            ...cypressOptions
         });
         cy.window({
             log: false
@@ -69,7 +78,10 @@ Cypress.Commands.add("argosScreenshot", {
                 mediaType,
                 test: {
                     title: Cypress.currentTest.title,
-                    titlePath: Cypress.currentTest.titlePath
+                    titlePath: Cypress.currentTest.titlePath,
+                    retry: Cypress.currentRetry,
+                    // @ts-ignore
+                    retries: cy.state("runnable")._retries
                 },
                 browser: {
                     name: Cypress.browser.name,
@@ -100,11 +112,5 @@ Cypress.Commands.add("argosScreenshot", {
     } else {
         stabilizeAndScreenshot(name);
     }
-    // Teardown Argos
-    cy.window({
-        log: false
-    }).then((window)=>window.__ARGOS__.teardown({
-            fullPage,
-            argosCSS
-        }));
+    teardown();
 });

package/dist/task.cjs

@@ -1,9 +1,24 @@
 'use strict';
 
 var core = require('@argos-ci/core');
+var node_path = require('node:path');
+var promises = require('node:fs/promises');
 
 /// <reference types="cypress" />
 function registerArgosTask(on, config, options) {
+    on("after:screenshot", async (details)=>{
+        // Get the base filename without extension
+        const baseName = node_path.basename(details.path, node_path.extname(details.path));
+        // Remove attempt from the filename
+        const newBaseName = baseName.replace(/ \(attempt \d+\)/, "");
+        // Construct a new path with the original file extension
+        const newPath = node_path.join(node_path.dirname(details.path), newBaseName + node_path.extname(details.path));
+        // Rename the file
+        await promises.rename(details.path, newPath);
+        return {
+            path: newPath
+        };
+    });
     on("after:run", async ()=>{
         const { screenshotsFolder } = config;
         if (!screenshotsFolder) return;

package/dist/task.mjs

@@ -1,7 +1,22 @@
 import { upload } from '@argos-ci/core';
+import { basename, extname, join, dirname } from 'node:path';
+import { rename } from 'node:fs/promises';
 
 /// <reference types="cypress" />
 function registerArgosTask(on, config, options) {
+    on("after:screenshot", async (details)=>{
+        // Get the base filename without extension
+        const baseName = basename(details.path, extname(details.path));
+        // Remove attempt from the filename
+        const newBaseName = baseName.replace(/ \(attempt \d+\)/, "");
+        // Construct a new path with the original file extension
+        const newPath = join(dirname(details.path), newBaseName + extname(details.path));
+        // Rename the file
+        await rename(details.path, newPath);
+        return {
+            path: newPath
+        };
+    });
     on("after:run", async ()=>{
         const { screenshotsFolder } = config;
         if (!screenshotsFolder) return;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/cypress",
   "description": "Visual testing solution to avoid visual regression. Cypress commands and utilities for Argos visual testing.",
-  "version": "1.3.4",
+  "version": "1.5.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -42,8 +42,8 @@
     "node": ">=16.0.0"
   },
   "dependencies": {
-    "@argos-ci/browser": "1.3.0",
-    "@argos-ci/core": "1.5.1",
+    "@argos-ci/browser": "1.4.1",
+    "@argos-ci/core": "1.5.2",
     "@argos-ci/util": "1.2.0",
     "cypress-wait-until": "^1.7.2"
   },
@@ -51,7 +51,7 @@
     "cypress": "^12.0.0 || ^13.0.0"
   },
   "devDependencies": {
-    "@argos-ci/cli": "1.0.8",
+    "@argos-ci/cli": "1.0.9",
     "@argos-ci/cypress": "workspace:.",
     "@types/node": "^16.0.0",
     "cypress": "^13.3.0",
@@ -64,5 +64,5 @@
     "test": "pnpm exec cypress run",
     "e2e": "UPLOAD_TO_ARGOS=true pnpm run test"
   },
-  "gitHead": "174a9847d8a547d4fa4acb7602ea3687dc9bde8e"
+  "gitHead": "47e813466b9224cb428eb44ee4d4d450f737763e"
 }