jest-image-snapshot 6.0.0 → 6.1.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [6.1.1](https://github.com/americanexpress/jest-image-snapshot/compare/v6.1.0...v6.1.1) (2023-07-25)
+
+
+### Bug Fixes
+
+* only updatePassedSnapshot if updateSnapshot is also true ([#327](https://github.com/americanexpress/jest-image-snapshot/issues/327)) ([b9d9c3f](https://github.com/americanexpress/jest-image-snapshot/commit/b9d9c3f16ab0e10a3e1320d03efb52e81675d2aa)), closes [#320](https://github.com/americanexpress/jest-image-snapshot/issues/320) [#322](https://github.com/americanexpress/jest-image-snapshot/issues/322) [#324](https://github.com/americanexpress/jest-image-snapshot/issues/324)
+
+# [6.1.0](https://github.com/americanexpress/jest-image-snapshot/compare/v6.0.0...v6.1.0) (2022-12-02)
+
+
+### Features
+
+* add onlyDiff in options ([#317](https://github.com/americanexpress/jest-image-snapshot/issues/317)) ([4bad752](https://github.com/americanexpress/jest-image-snapshot/commit/4bad752571bb567861ddfa2cc9073f33c4239352))
+
 # [6.0.0](https://github.com/americanexpress/jest-image-snapshot/compare/v5.2.0...v6.0.0) (2022-11-03)
 
 

package/README.md

@@ -113,6 +113,7 @@ See [the examples](./examples/README.md) for more detailed usage or read about a
 * `customReceivedDir`: A custom absolute path of a directory to keep this received image in
 * `customSnapshotIdentifier`: A custom name to give this snapshot. If not provided one is computed automatically. When a function is provided it is called with an object containing `testPath`, `currentTestName`, `counter` and `defaultIdentifier` as its first argument. The function must return an identifier to use for the snapshot. If a path is given, the path will be created inside the snapshot/diff directories.
 * `diffDirection`: (default: `horizontal`) (options `horizontal` or `vertical`) Changes diff image layout direction
+* `onlyDiff`: (default: `false`) Either only include the difference between the baseline and the received image in the diff image, or include the 3 images (following the direction set by `diffDirection`).
 * `noColors`: Removes coloring from console output, useful if storing the results in a file
 * `failureThreshold`: (default `0`) Sets the threshold that would trigger a test failure based on the `failureThresholdType` selected. This is different to the `customDiffConfig.threshold` above, that is the per pixel failure threshold, this is the failure threshold for the entire comparison.
 * `failureThresholdType`: (default `pixel`) (options `percent` or `pixel`) Sets the type of threshold that would trigger a failure.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-image-snapshot",
-  "version": "6.0.0",
+  "version": "6.1.1",
   "description": "Jest matcher for image comparisons. Most commonly used for visual regression testing.",
   "main": "src/index.js",
   "engines": {
@@ -64,7 +64,6 @@
     "get-stdin": "^5.0.1",
     "glur": "^1.1.2",
     "lodash": "^4.17.4",
-    "mkdirp": "^0.5.1",
     "pixelmatch": "^5.1.0",
     "pngjs": "^3.4.0",
     "rimraf": "^2.6.2",
@@ -73,6 +72,11 @@
   "peerDependencies": {
     "jest": ">=20 <=29"
   },
+  "peerDependenciesMeta": {
+    "jest": {
+      "optional": true
+    }
+  },
   "husky": {
     "hooks": {
       "pre-commit": "npm test",

package/src/diff-snapshot.js

@@ -15,7 +15,6 @@
 const childProcess = require('child_process');
 const fs = require('fs');
 const path = require('path');
-const mkdirp = require('mkdirp');
 const pixelmatch = require('pixelmatch');
 const ssim = require('ssim.js');
 const { PNG } = require('pngjs');
@@ -148,9 +147,8 @@ const alignImagesToSameSize = (firstImage, secondImage) => {
 
 const isFailure = ({ pass, updateSnapshot }) => !pass && !updateSnapshot;
 
-const shouldUpdate = ({ pass, updateSnapshot, updatePassedSnapshot }) => (
-  (!pass && updateSnapshot) || (pass && updatePassedSnapshot)
-);
+const shouldUpdate = ({ pass, updateSnapshot, updatePassedSnapshot }) =>
+  updateSnapshot && (!pass || (pass && updatePassedSnapshot));
 
 const shouldFail = ({
   totalPixels,
@@ -184,6 +182,24 @@ const shouldFail = ({
   };
 };
 
+function composeDiff(options) {
+  const {
+    diffDirection, baselineImage, diffImage, receivedImage, imageWidth, imageHeight, onlyDiff,
+  } = options;
+  const composer = new ImageComposer({
+    direction: diffDirection,
+  });
+
+  if (onlyDiff) {
+    composer.addImage(diffImage, imageWidth, imageHeight);
+  } else {
+    composer.addImage(baselineImage, imageWidth, imageHeight);
+    composer.addImage(diffImage, imageWidth, imageHeight);
+    composer.addImage(receivedImage, imageWidth, imageHeight);
+  }
+  return composer;
+}
+
 function diffImageToSnapshot(options) {
   const {
     receivedImageBuffer,
@@ -193,6 +209,7 @@ function diffImageToSnapshot(options) {
     receivedDir = path.join(options.snapshotsDir, '__received_output__'),
     diffDir = path.join(options.snapshotsDir, '__diff_output__'),
     diffDirection,
+    onlyDiff = false,
     updateSnapshot = false,
     updatePassedSnapshot = false,
     customDiffConfig = {},
@@ -207,7 +224,7 @@ function diffImageToSnapshot(options) {
   let result = {};
   const baselineSnapshotPath = path.join(snapshotsDir, `${snapshotIdentifier}.png`);
   if (!fs.existsSync(baselineSnapshotPath)) {
-    mkdirp.sync(path.dirname(baselineSnapshotPath));
+    fs.mkdirSync(path.dirname(baselineSnapshotPath), { recursive: true });
     fs.writeFileSync(baselineSnapshotPath, receivedImageBuffer);
     result = { added: true };
   } else {
@@ -275,20 +292,16 @@ function diffImageToSnapshot(options) {
 
     if (isFailure({ pass, updateSnapshot })) {
       if (storeReceivedOnFailure) {
-        mkdirp.sync(path.dirname(receivedSnapshotPath));
+        fs.mkdirSync(path.dirname(receivedSnapshotPath), { recursive: true });
         fs.writeFileSync(receivedSnapshotPath, receivedImageBuffer);
         result = { receivedSnapshotPath };
       }
 
-      mkdirp.sync(path.dirname(diffOutputPath));
-      const composer = new ImageComposer({
-        direction: diffDirection,
+      fs.mkdirSync(path.dirname(diffOutputPath), { recursive: true });
+      const composer = composeDiff({
+        diffDirection, baselineImage, diffImage, receivedImage, imageWidth, imageHeight, onlyDiff,
       });
 
-      composer.addImage(baselineImage, imageWidth, imageHeight);
-      composer.addImage(diffImage, imageWidth, imageHeight);
-      composer.addImage(receivedImage, imageWidth, imageHeight);
-
       const composerParams = composer.getParams();
 
       const compositeResultImage = new PNG({
@@ -319,7 +332,7 @@ function diffImageToSnapshot(options) {
         imgSrcString: `data:image/png;base64,${pngBuffer.toString('base64')}`,
       };
     } else if (shouldUpdate({ pass, updateSnapshot, updatePassedSnapshot })) {
-      mkdirp.sync(path.dirname(baselineSnapshotPath));
+      fs.mkdirSync(path.dirname(baselineSnapshotPath), { recursive: true });
       fs.writeFileSync(baselineSnapshotPath, receivedImageBuffer);
       result = { updated: true };
     } else {
@@ -335,6 +348,7 @@ function diffImageToSnapshot(options) {
   return result;
 }
 
+
 function runDiffImageToSnapshot(options) {
   options.receivedImageBuffer = options.receivedImageBuffer.toString('base64');
 

package/src/index.js

@@ -138,6 +138,7 @@ function configureToMatchImageSnapshot({
   storeReceivedOnFailure: commonStoreReceivedOnFailure = false,
   customReceivedDir: commonCustomReceivedDir,
   customDiffDir: commonCustomDiffDir,
+  onlyDiff: commonOnlyDiff = false,
   diffDirection: commonDiffDirection = 'horizontal',
   noColors: commonNoColors,
   failureThreshold: commonFailureThreshold = 0,
@@ -156,6 +157,7 @@ function configureToMatchImageSnapshot({
     storeReceivedOnFailure = commonStoreReceivedOnFailure,
     customReceivedDir = commonCustomReceivedDir,
     customDiffDir = commonCustomDiffDir,
+    onlyDiff = commonOnlyDiff,
     diffDirection = commonDiffDirection,
     customDiffConfig = {},
     noColors = commonNoColors,
@@ -218,6 +220,7 @@ function configureToMatchImageSnapshot({
         receivedDir,
         diffDir,
         diffDirection,
+        onlyDiff,
         snapshotIdentifier,
         updateSnapshot: snapshotState._updateSnapshot === 'all',
         customDiffConfig: Object.assign({}, commonCustomDiffConfig, customDiffConfig),