fix: handle asymmetric cause diff

vitest-dev · Oct 7, 2024 · 755cfb8 · 755cfb8
1 parent 898ce93
commit 755cfb8
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/packages/utils/src/diff/index.ts b/packages/utils/src/diff/index.ts
@@ -272,7 +272,6 @@ export function printDiffOrStringify(
   // if (isLineDiffable(expected, received)) {
   const clonedExpected = deepClone(expected, { forceWritable: true })
   const clonedReceived = deepClone(received, { forceWritable: true })
-  // TODO: strip `Error.cause` like asymmetric matcher
   const { replacedExpected, replacedActual } = replaceAsymmetricMatcher(clonedExpected, clonedReceived)
   const difference = diff(replacedExpected, replacedActual, options)
 
@@ -299,6 +298,19 @@ export function replaceAsymmetricMatcher(
     replacedActual: any
     replacedExpected: any
   } {
+  // handle asymmetric Error.cause diff
+  if (
+    actual instanceof Error
+    && expected instanceof Error
+    && typeof actual.cause !== 'undefined'
+    && typeof expected.cause === 'undefined'
+  ) {
+    delete actual.cause
+    return {
+      replacedActual: actual,
+      replacedExpected: expected,
+    }
+  }
   if (!isReplaceable(actual, expected)) {
     return { replacedActual: actual, replacedExpected: expected }
   }

diff --git a/test/core/test/__snapshots__/jest-expect.test.ts.snap b/test/core/test/__snapshots__/jest-expect.test.ts.snap
@@ -398,7 +398,6 @@ exports[`error equality 6`] = `
   Error {
 -   "message": "world",
 +   "message": "hello",
-+   "cause": "x",
   }",
   "expected": "[Error: world]",
   "message": "expected Error: hello { cause: 'x' } to deeply equal Error: world",

diff --git a/test/core/test/jest-expect.test.ts b/test/core/test/jest-expect.test.ts
@@ -1430,7 +1430,6 @@ it('error equality', () => {
 
   {
     // different cause (fail by other props)
-    // TODO: strip `cause` on actual side from diff
     const e1 = new Error('hello', { cause: 'x' })
     const e2 = new Error('world')
     snapshotError(() => expect(e1).toEqual(e2))
@@ -1453,6 +1452,12 @@ it('error equality', () => {
   // TODO: cyclic
 })
 
+it.skip('repro', () => {
+  const e1 = new Error('hello', { cause: 'x' })
+  const e2 = new Error('world')
+  expect(e1).toEqual(e2)
+})
+
 it('toHaveBeenNthCalledWith error', () => {
   const fn = vi.fn()
   fn('World')