fix(utils): fix object diff with getter only property (#5466)

vitest-dev · Apr 2, 2024 · 366d97c · 366d97c
1 parent 91b06cc
commit 366d97c
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 2 deletions.
diff --git a/packages/utils/src/helpers.ts b/packages/utils/src/helpers.ts
@@ -111,7 +111,15 @@ export function clone<T>(
       if (!descriptor)
         continue
       const cloned = clone((val as any)[k], seen, options)
-      if ('get' in descriptor) {
+      if (options.forceWritable) {
+        Object.defineProperty(out, k, {
+          enumerable: descriptor.enumerable,
+          configurable: true,
+          writable: true,
+          value: cloned,
+        })
+      }
+      else if ('get' in descriptor) {
         Object.defineProperty(out, k, {
           ...descriptor,
           get() {
@@ -122,7 +130,6 @@ export function clone<T>(
       else {
         Object.defineProperty(out, k, {
           ...descriptor,
-          writable: options.forceWritable ? true : descriptor.writable,
           value: cloned,
         })
       }

diff --git a/test/core/test/diff.test.ts b/test/core/test/diff.test.ts
@@ -115,6 +115,34 @@ test('asymmetric matcher in nested', () => {
   `)
 })
 
+test('getter only property', () => {
+  setupColors(getDefaultColors())
+  const x = { normalProp: 1 }
+  const y = { normalProp: 2 }
+  Object.defineProperty(x, 'getOnlyProp', {
+    enumerable: true,
+    get: () => ({ a: 'b' }),
+  })
+  Object.defineProperty(y, 'getOnlyProp', {
+    enumerable: true,
+    get: () => ({ a: 'b' }),
+  })
+  expect(
+    getErrorDiff(x, y),
+  ).toMatchInlineSnapshot(`
+    "- Expected
+    + Received
+
+      Object {
+        "getOnlyProp": Object {
+          "a": "b",
+        },
+    -   "normalProp": 2,
+    +   "normalProp": 1,
+      }"
+  `)
+})
+
 function getErrorDiff(actual: unknown, expected: unknown) {
   try {
     expect(actual).toEqual(expected)