jest-image-snapshot 6.3.0 → 6.5.0

package/.nvmrc

@@ -0,0 +1 @@
+20

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [6.5.0](https://github.com/americanexpress/jest-image-snapshot/compare/v6.4.0...v6.5.0) (2025-05-12)
+
+
+### Features
+
+* work with TypedArray / Array / ArrayBuffer ([b419a4d](https://github.com/americanexpress/jest-image-snapshot/commit/b419a4dfbd6a34470f2833073f4f714d98a871c9))
+
+# [6.4.0](https://github.com/americanexpress/jest-image-snapshot/compare/v6.3.0...v6.4.0) (2023-12-11)
+
+
+### Features
+
+* add configurable maxBuffer option to runDiffImageToSnapshot ([#344](https://github.com/americanexpress/jest-image-snapshot/issues/344)) ([befad8b](https://github.com/americanexpress/jest-image-snapshot/commit/befad8ba6080be6b0a94d098334ea05258afab2e))
+
 # [6.3.0](https://github.com/americanexpress/jest-image-snapshot/compare/v6.2.0...v6.3.0) (2023-11-28)
 
 

package/CONTRIBUTING.md

@@ -29,13 +29,19 @@ This project adheres to the American Express [Code of Conduct](./CODE_OF_CONDUCT
 
    > replace `your-github-username` with your github username
 
-3. Install the dependencies by running
+3. Install and use the correct version of node (specified in `.nvmrc`)
+
+    ```bash
+    $ nvm use
+    ```
+
+4. Install the dependencies by running
 
     ```bash
     $ npm install
     ```
 
-4. You can now run any of these scripts from the root folder.
+5. You can now run any of these scripts from the root folder.
 
 #### Running tests
 
@@ -112,4 +118,4 @@ Please review our [Security Policy](./SECURITY.md). Please follow the instructio
 
 ### Git Commit Guidelines
 
-We follow [conventional commits](https://www.conventionalcommits.org/) for git commit message formatting. These rules make it easier to review commit logs and improve contextual understanding of code changes. This also allows us to auto-generate the CHANGELOG from commit messages.
+We follow [conventional commits](https://www.conventionalcommits.org/) for git commit message formatting. These rules make it easier to review commit logs and improve contextual understanding of code changes. This also allows us to auto-generate the CHANGELOG from commit messages.

package/README.md

@@ -124,6 +124,7 @@ See [the examples](./examples/README.md) for more detailed usage or read about a
 * `dumpDiffToConsole`: (default `false`) Will output base64 string of a diff image to console in case of failed tests (in addition to creating a diff image). This string can be copy-pasted to a browser address string to preview the diff for a failed test.
 * `dumpInlineDiffToConsole`: (default `false`) Will output the image to the terminal using iTerm's [Inline Images Protocol](https://iterm2.com/documentation-images.html). If the term is not compatible, it does the same thing as `dumpDiffToConsole`.
 * `allowSizeMismatch`: (default `false`) If set to true, the build will not fail when the screenshots to compare have different sizes.
+* `maxChildProcessBufferSizeInBytes`: (default `10 * 1024 * 1024`) Sets the max number of bytes for stdout/stderr when running `diff-snapshot` in a child process.
 * `runtimeHooksPath`: (default `undefined`) This needs to be set to a existing file, like `require.resolve('./runtimeHooksPath.cjs')`. This file can expose a few hooks:
   * `onBeforeWriteToDisc`: before saving any image to the disc, this function will be called (can be used to write EXIF data to images for instance)
     `onBeforeWriteToDisc: (arguments: { buffer: Buffer; destination: string; testPath: string; currentTestName: string }) => Buffer`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-image-snapshot",
-  "version": "6.3.0",
+  "version": "6.5.0",
   "description": "Jest matcher for image comparisons. Most commonly used for visual regression testing.",
   "main": "src/index.js",
   "engines": {
@@ -53,10 +53,11 @@
     "eslint-config-amex": "^7.0.0",
     "husky": "^4.2.1",
     "image-size": "^0.8.3",
-    "jest": "^29.0.0",
+    "jest": "^29.7.0",
     "jest-snapshot": "^29.0.0",
-    "lockfile-lint": "^4.0.0",
+    "lockfile-lint": "^4.14.0",
     "mock-spawn": "^0.2.6",
+    "rimraf": "^5.0.10",
     "semantic-release": "^17.0.4"
   },
   "dependencies": {
@@ -66,7 +67,6 @@
     "lodash": "^4.17.4",
     "pixelmatch": "^5.1.0",
     "pngjs": "^3.4.0",
-    "rimraf": "^2.6.2",
     "ssim.js": "^3.1.1"
   },
   "peerDependencies": {
@@ -106,5 +106,10 @@
       "@semantic-release/git",
       "@semantic-release/github"
     ]
+  },
+  "overrides": {
+    "eslint-config-amex": {
+      "eslint": "$eslint"
+    }
   }
 }

package/src/diff-snapshot.js

@@ -18,7 +18,6 @@ const path = require('path');
 const pixelmatch = require('pixelmatch');
 const ssim = require('ssim.js');
 const { PNG } = require('pngjs');
-const rimraf = require('rimraf');
 const glur = require('glur');
 const ImageComposer = require('./image-composer');
 
@@ -271,10 +270,10 @@ function diffImageToSnapshot(options) {
     result = { added: true };
   } else {
     const receivedSnapshotPath = path.join(receivedDir, `${snapshotIdentifier}${receivedPostfix}.png`);
-    rimraf.sync(receivedSnapshotPath);
+    fs.rmSync(receivedSnapshotPath, { recursive: true, force: true });
 
     const diffOutputPath = path.join(diffDir, `${snapshotIdentifier}-diff.png`);
-    rimraf.sync(diffOutputPath);
+    fs.rmSync(diffOutputPath, { recursive: true, force: true });
 
     const defaultDiffConfig = comparisonMethod !== 'ssim' ? defaultPixelmatchDiffConfig : defaultSSIMDiffConfig;
 
@@ -421,7 +420,7 @@ function runDiffImageToSnapshot(options) {
     {
       input: Buffer.from(serializedInput),
       stdio: ['pipe', 'inherit', 'inherit', 'pipe'],
-      maxBuffer: 10 * 1024 * 1024, // 10 MB
+      maxBuffer: options.maxChildProcessBufferSizeInBytes,
     }
   );
 

package/src/index.js

@@ -24,6 +24,14 @@ const timesCalled = new Map();
 
 const SNAPSHOTS_DIR = '__image_snapshots__';
 
+function toBuffer(data) {
+  if (data == null || Buffer.isBuffer(data)) {
+    return data;
+  }
+
+  return Buffer.from(data);
+}
+
 function updateSnapshotState(originalSnapshotState, partialSnapshotState) {
   if (global.UNSTABLE_SKIP_REPORTING) {
     return originalSnapshotState;
@@ -151,6 +159,10 @@ function configureToMatchImageSnapshot({
   dumpDiffToConsole: commonDumpDiffToConsole = false,
   dumpInlineDiffToConsole: commonDumpInlineDiffToConsole = false,
   allowSizeMismatch: commonAllowSizeMismatch = false,
+  // Default to 10 MB instead of node's default 1 MB
+  // See https://nodejs.org/api/child_process.html#child_processspawnsynccommand-args-options
+  maxChildProcessBufferSizeInBytes:
+    commonMaxChildProcessBufferSizeInBytes = 10 * 1024 * 1024, // 10 MB
   comparisonMethod: commonComparisonMethod = 'pixelmatch',
 } = {}) {
   return function toMatchImageSnapshot(received, {
@@ -173,6 +185,7 @@ function configureToMatchImageSnapshot({
     dumpDiffToConsole = commonDumpDiffToConsole,
     dumpInlineDiffToConsole = commonDumpInlineDiffToConsole,
     allowSizeMismatch = commonAllowSizeMismatch,
+    maxChildProcessBufferSizeInBytes = commonMaxChildProcessBufferSizeInBytes,
     comparisonMethod = commonComparisonMethod,
   } = {}) {
     const {
@@ -219,7 +232,7 @@ function configureToMatchImageSnapshot({
 
     const result =
       imageToSnapshot({
-        receivedImageBuffer: received,
+        receivedImageBuffer: toBuffer(received),
         snapshotsDir,
         storeReceivedOnFailure,
         receivedDir,
@@ -237,6 +250,7 @@ function configureToMatchImageSnapshot({
         updatePassedSnapshot,
         blur,
         allowSizeMismatch,
+        maxChildProcessBufferSizeInBytes,
         comparisonMethod,
         runtimeHooksPath,
       });