jest-image-snapshot 6.3.0 → 6.4.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [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/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.4.0",
   "description": "Jest matcher for image comparisons. Most commonly used for visual regression testing.",
   "main": "src/index.js",
   "engines": {

package/src/diff-snapshot.js

@@ -421,7 +421,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

@@ -151,6 +151,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 +177,7 @@ function configureToMatchImageSnapshot({
     dumpDiffToConsole = commonDumpDiffToConsole,
     dumpInlineDiffToConsole = commonDumpInlineDiffToConsole,
     allowSizeMismatch = commonAllowSizeMismatch,
+    maxChildProcessBufferSizeInBytes = commonMaxChildProcessBufferSizeInBytes,
     comparisonMethod = commonComparisonMethod,
   } = {}) {
     const {
@@ -237,6 +242,7 @@ function configureToMatchImageSnapshot({
         updatePassedSnapshot,
         blur,
         allowSizeMismatch,
+        maxChildProcessBufferSizeInBytes,
         comparisonMethod,
         runtimeHooksPath,
       });