feat: work with TypedArray / Array / ArrayBuffer

americanexpress · Feb 22, 2025 · 9dec991 · 9dec991
1 parent ff77394
commit 9dec991
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 2 deletions.
diff --git a/...c-js-to-match-image-snapshot-happy-path-should-work-with-typed-array-1-snap.png b/...c-js-to-match-image-snapshot-happy-path-should-work-with-typed-array-1-snap.png
diff --git a/__tests__/__snapshots__/index.spec.js.snap b/__tests__/__snapshots__/index.spec.js.snap
@@ -51,7 +51,37 @@ exports[`toMatchImageSnapshot passes diffImageToSnapshot everything it needs to
   "maxChildProcessBufferSizeInBytes": 10485760,
   "onlyDiff": false,
   "receivedDir": undefined,
-  "receivedImageBuffer": "pretendthisisanimagebuffer",
+  "receivedImageBuffer": {
+    "data": [
+      112,
+      114,
+      101,
+      116,
+      101,
+      110,
+      100,
+      116,
+      104,
+      105,
+      115,
+      105,
+      115,
+      97,
+      110,
+      105,
+      109,
+      97,
+      103,
+      101,
+      98,
+      117,
+      102,
+      102,
+      101,
+      114,
+    ],
+    "type": "Buffer",
+  },
   "receivedPostfix": undefined,
   "runtimeHooksPath": undefined,
   "snapshotIdentifier": "test-spec-js-test-1-snap",

diff --git a/__tests__/integration.spec.js b/__tests__/integration.spec.js
@@ -98,6 +98,11 @@ describe('toMatchImageSnapshot', () => {
 
       expect(diffExists(customSnapshotIdentifier)).toBe(false);
     });
+
+    it('should work with TypedArray', () => {
+      const imageTypedArray = new Uint8Array(imageData.buffer);
+      expect(() => expect(imageTypedArray).toMatchImageSnapshot()).not.toThrowError();
+    });
   });
 
   describe('updates', () => {

diff --git a/src/index.js b/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;
@@ -224,7 +232,7 @@ function configureToMatchImageSnapshot({
 
     const result =
       imageToSnapshot({
-        receivedImageBuffer: received,
+        receivedImageBuffer: toBuffer(received),
         snapshotsDir,
         storeReceivedOnFailure,
         receivedDir,