storeReceivedOnFailure refuses to store received images in a CI environment

[GuilleDF]

I'm trying to make use of the storeReceivedOnFailure option, from the README:

storeReceivedOnFailure: (default: false) Store the received images separately from the composed diff images on failure. This can be useful when updating baseline images from CI.

But when I run it in my CI environment I get the following error:

New snapshot was not written. The update flag must be explicitly passed to write a new snapshot.
 + This is likely because this test is run in a continuous integration (CI) environment in which snapshots are not written by default.
  30 |     failureThresholdType: 'percent',
  31 |     failureThreshold: 0.01,
> 32 |     storeReceivedOnFailure: true,
     |                   ^
  33 |     customReceivedDir: '__snapshots__/__new__',
  34 |   });
  35 | };

I can't pass the update flag as suggested since I still want the test to fail, but I need the images to be written so I can use them in a separate job to update the baseline if needed.

I'm using version 6.1.0

[donaldpipowitch]

I see the same for new snapshots that don't exist yet. I haven't tested it with different snapshots so far, but I'd have expected that the new snapshots would also be saved in the CI within the "received directory", so that I can easily download them from there.

[plaa]

I encountered exactly the same problem when setting up CI to automatically create and after review commit the images. With CI=true environment variable, if the reference image exists, then jest-image-snapshot stores the received image, but if the file does not exist it doesn't store it. Would be great if it honored storeReceivedOnFailure also in this case.

As a workaround I made explicit logic so that if the reference image is missing if saves the image and fails the test:

      const snapshotFilename = `${customSnapshotsDir}/${snapshotId}.png`;
      if (fs.existsSync(snapshotFilename)) {
        expect(image).toMatchImageSnapshot({
          customSnapshotsDir,
          customSnapshotIdentifier: snapshotId,
          storeReceivedOnFailure: true,
          customReceivedPostfix: '',
          customDiffDir: diffOutputDir,
          customReceivedDir: diffOutputDir,
        });
      } else {
        // We want to write snapshot to diffOutputDir and fail the test in case it does not exist.
        // With CI=true Jest otherwise does not output the file.
        fs.mkdirSync(diffOutputDir, { recursive: true });
        fs.writeFileSync(`${diffOutputDir}/${snapshotId}.png`, image);
        fail(`Snapshot file not found: ${snapshotId}.png`);
      }