fix(matcher-utils): correct diff for expect asymmetric matchers

jestjs · Jan 28, 2022 · 7652055 · 7652055
1 parent 056e5ef
commit 7652055
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 7 deletions.
diff --git a/packages/jest-matcher-utils/src/__tests__/__snapshots__/index.test.ts.snap b/packages/jest-matcher-utils/src/__tests__/__snapshots__/index.test.ts.snap
@@ -88,6 +88,25 @@ exports[`ensureNumbers() with options promise resolves isNot true expected 1`] =
 Expected has value: <g>null</>
 `;
 
+exports[`printDiffOrStringify expected asymmetric matchers should be diffable 1`] = `
+<g>- Expected  - 2</>
+<r>+ Received  + 2</>
+
+<g>- ObjectContaining {</>
+<r>+ Object {</>
+<d>    "array": Array [</>
+<d>      Object {</>
+<d>        "3": "three",</>
+<d>        "four": "4",</>
+<d>        "one": 1,</>
+<g>-       "two": 2,</>
+<r>+       "two": 1,</>
+<d>      },</>
+<d>    ],</>
+<d>    "foo": "bar",</>
+<d>  }</>
+`;
+
 exports[`stringify() toJSON errors when comparing two objects 1`] = `
 <d>expect(</><r>received</><d>).</>toEqual<d>(</><g>expected</><d>) // deep equality</>
 

diff --git a/packages/jest-matcher-utils/src/__tests__/index.test.ts b/packages/jest-matcher-utils/src/__tests__/index.test.ts
@@ -342,3 +342,37 @@ describe('matcherHint', () => {
     expect(received).toMatch(substringPositive);
   });
 });
+
+describe('printDiffOrStringify', () => {
+  test('expected asymmetric matchers should be diffable', () => {
+    jest.dontMock('jest-diff');
+    jest.resetModules();
+    const {printDiffOrStringify} = require('../');
+
+    const expected = expect.objectContaining({
+      array: [
+        {
+          3: 'three',
+          four: '4',
+          one: 1,
+          two: 2,
+        },
+      ],
+      foo: 'bar',
+    });
+    const received = {
+      array: [
+        {
+          3: 'three',
+          four: '4',
+          one: 1,
+          two: 1,
+        },
+      ],
+      foo: 'bar',
+    };
+    expect(
+      printDiffOrStringify(expected, received, 'Expected', 'Received', false),
+    ).toMatchSnapshot();
+  });
+});
diff --git a/packages/jest-matcher-utils/src/index.ts b/packages/jest-matcher-utils/src/index.ts
@@ -293,13 +293,6 @@ const isLineDiffable = (expected: unknown, received: unknown): boolean => {
     return false;
   }
 
-  if (
-    expectedType === 'object' &&
-    typeof (expected as any).asymmetricMatch === 'function'
-  ) {
-    return false;
-  }
-
   if (
     receivedType === 'object' &&
     typeof (received as any).asymmetricMatch === 'function'