fix: tweak asymmetric error.cause diff

vitest-dev · Oct 8, 2024 · 1908bd6 · 1908bd6
1 parent 5de6d0a
commit 1908bd6
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 5 deletions.
diff --git a/packages/utils/src/diff/index.ts b/packages/utils/src/diff/index.ts
@@ -300,10 +300,8 @@ export function replaceAsymmetricMatcher(
   } {
   // handle asymmetric Error.cause diff
   if (
-    actual instanceof Error
-    && expected instanceof Error
-    && typeof actual.cause !== 'undefined'
-    && typeof expected.cause === 'undefined'
+    (actual instanceof Error && typeof actual.cause !== 'undefined')
+    && !(expected instanceof Error && typeof expected.cause !== 'undefined')
   ) {
     delete actual.cause
     return {

diff --git a/test/core/test/__snapshots__/jest-expect.test.ts.snap b/test/core/test/__snapshots__/jest-expect.test.ts.snap
@@ -428,6 +428,24 @@ exports[`error equality 7`] = `
 `;
 
 exports[`error equality 8`] = `
+{
+  "actual": "[Error: hello]",
+  "diff": "- Expected
++ Received
+
+- Object {
+-   "something": "else",
++ Error {
++   "message": "hello",
+  }",
+  "expected": "Object {
+  "something": "else",
+}",
+  "message": "expected Error: hello { cause: 'x' } to deeply equal { something: 'else' }",
+}
+`;
+
+exports[`error equality 9`] = `
 {
   "actual": "[AggregateError: outer]",
   "diff": "- Expected
@@ -449,7 +467,7 @@ exports[`error equality 8`] = `
 }
 `;
 
-exports[`error equality 9`] = `
+exports[`error equality 10`] = `
 {
   "actual": "undefined",
   "diff": undefined,

diff --git a/test/core/test/jest-expect.test.ts b/test/core/test/jest-expect.test.ts
@@ -1446,6 +1446,14 @@ it('error equality', () => {
     snapshotError(() => expect(e1).toEqual(e2))
   }
 
+  {
+    // different cause
+    const e1 = new Error('hello', { cause: 'x' })
+    const e2 = { something: 'else' }
+    expect(e1).toEqual(e2)
+    snapshotError(() => expect(e1).toEqual(e2))
+  }
+
   {
     // AggregateError (pass)
     const e1 = new AggregateError([new Error('inner')], 'outer', { cause: 'x' })