fix: attempt number is added to screenshot name, causing retries of failures to inappropriately succeed

src/commands.ts

@@ -125,6 +125,15 @@ Cypress.Commands.add(
               options.title || Cypress.currentTest.titlePath.join(" "),
             imagesPath,
             specPath: Cypress.spec.relative,
+            // Although cy.state is not on cypress.d.ts it is documented publicly at
+            // https://docs.cypress.io/guides/guides/test-retries#Can-I-access-the-current-attempt-counter-from-the-test
+            attempt: Cypress._.get(
+              (cy as unknown as { state: (state: string) => unknown }).state(
+                "runnable"
+              ),
+              "_currentRetry",
+              0
+            ),
           },
           { log: false }
         )

src/screenshotPath.utils.ts

@@ -13,10 +13,12 @@ export const generateScreenshotPath = ({
   titleFromOptions,
   imagesPath,
   specPath,
+  attempt,
 }: {
   titleFromOptions: string;
   imagesPath: string;
   specPath: string;
+  attempt: number;
 }) => {
   const parsePathPartVariables = (pathPart: string, i: number) => {
     if (pathPart === PATH_VARIABLES.specPath) {
@@ -39,7 +41,10 @@ export const generateScreenshotPath = ({
 
   if (typeof nameCacheCounter[screenshotPath] === "undefined") {
     nameCacheCounter[screenshotPath] = -1;
+  } else if (attempt > 0) {
+    nameCacheCounter[screenshotPath] -= 1;
   }
+
   return path.join(
     IMAGE_SNAPSHOT_PREFIX,
     `${screenshotPath} #${++nameCacheCounter[screenshotPath]}${

src/task.hook.test.ts

@@ -19,6 +19,7 @@ const fixturesPath = path.resolve(__dirname, "..", "__tests__", "fixtures");
 const oldImgFixture = "screenshot.png";
 const newImgFixture = "screenshot.actual.png";
 const newFileContent = "new file content";
+const attempt = 1;
 
 const generateConfig = async (cfg: Partial<CompareImagesCfg>) => ({
   updateImages: false,
@@ -48,6 +49,7 @@ describe("getScreenshotPathInfoTask", () => {
         titleFromOptions: "some-title-withśpęćiał人物",
         imagesPath: "nested/images/dir",
         specPath,
+        attempt,
       })
     ).toEqual({
       screenshotPath:
@@ -62,6 +64,7 @@ describe("getScreenshotPathInfoTask", () => {
         titleFromOptions: "some-title",
         imagesPath: "{spec_path}/images/dir",
         specPath,
+        attempt,
       })
     ).toEqual({
       screenshotPath:
@@ -76,6 +79,7 @@ describe("getScreenshotPathInfoTask", () => {
         titleFromOptions: "some-title",
         imagesPath: "/images/dir",
         specPath,
+        attempt,
       })
     ).toEqual({
       screenshotPath:
@@ -88,6 +92,7 @@ describe("getScreenshotPathInfoTask", () => {
         titleFromOptions: "some-title",
         imagesPath: "C:/images/dir",
         specPath,
+        attempt,
       })
     ).toEqual({
       screenshotPath:
@@ -104,6 +109,7 @@ describe("cleanupImagesTask", () => {
         titleFromOptions: "some-file",
         imagesPath: "images",
         specPath: "some/spec/path",
+        attempt,
       });
       return path.join(
         projectRoot,

src/task.hook.ts

@@ -39,6 +39,7 @@ export const getScreenshotPathInfoTask = (cfg: {
   titleFromOptions: string;
   imagesPath: string;
   specPath: string;
+  attempt: number;
 }) => {
   const screenshotPath = generateScreenshotPath(cfg);