fix(utils): deepMerge failing to correctly merge basic data types (#2872)

Kirk Lin · GitHub
1 parent a0fdceea
Showing 2 changed files with 52 additions and 26 deletions
src/utils/__test__/index.test.ts
src/utils/index.ts
@@ -4,6 +4,30 @@ import { describe, expect, test } from &#39;vitest&#39;;
 import { deepMerge } from '@/utils';
 describe('deepMerge function', () => {
+  test('should correctly merge basic data types', () => {
+    const source = { a: 1, b: 2, c: null };
+    const target = {
+      a: 2,
+      b: undefined,
+      c: 3,
+    };
+    const expected = {
+      a: 2,
+      b: 2,
+      c: 3,
+    };
+    expect(deepMerge(source, target)).toStrictEqual(expected);
+  });
+
+  test('should return the same date if only 1 is passed', () => {
+    const foo = new Date();
+    const merged = deepMerge(foo, null);
+    const merged2 = deepMerge(undefined, foo);
+    expect(merged).toStrictEqual(foo);
+    expect(merged2).toStrictEqual(foo);
+    expect(merged).toStrictEqual(merged2);
+  });
+
   test('should merge two objects recursively', () => {
     const source = {
       a: { b: { c: 1 }, d: [1, 2] },
@@ -15,6 +39,7 @@ describe(&#39;deepMerge function&#39;, () =&gt; {
           too: [1, 2, 3],
         },
       ],
+      r: { a: 1 },
     };
     const target = {
       a: { b: { d: [3] } },
@@ -30,6 +55,7 @@ describe(&#39;deepMerge function&#39;, () =&gt; {
           really: 'yes',
         },
       ],
+      r: { a: 2 },
     };
     const expected = {
       a: { b: { c: 1, d: [3] }, d: [1, 2] },
@@ -48,8 +74,9 @@ describe(&#39;deepMerge function&#39;, () =&gt; {
         },
       ],
       qu: 5,
+      r: { a: 2 },
     };
-    expect(deepMerge(source, target)).toEqual(expected);
+    expect(deepMerge(source, target)).toStrictEqual(expected);
   });
   test('should replace arrays by default', () => {
@@ -65,7 +92,7 @@ describe(&#39;deepMerge function&#39;, () =&gt; {
       a: { b: { d: [3] } },
       e: [3],
     };
-    expect(deepMerge(source, target)).toEqual(expected);
+    expect(deepMerge(source, target)).toStrictEqual(expected);
   });
   test("should union arrays using mergeArrays = 'union'", () => {
@@ -75,13 +102,13 @@ describe(&#39;deepMerge function&#39;, () =&gt; {
     };
     const target = {
       a: { b: { d: [2, 3] } },
-      e: [3],
+      e: [1, 3],
     };
     const expected = {
       a: { b: { d: [1, 2, 3] } },
       e: [1, 2, 3],
     };
-    expect(deepMerge(source, target, 'union')).toEqual(expected);
+    expect(deepMerge(source, target, 'union')).toStrictEqual(expected);
   });
   test("should intersect arrays using mergeArrays = 'intersection'", () => {
@@ -97,7 +124,7 @@ describe(&#39;deepMerge function&#39;, () =&gt; {
       a: { b: { d: [2] } },
       e: [],
     };
-    expect(deepMerge(source, target, 'intersection')).toEqual(expected);
+    expect(deepMerge(source, target, 'intersection')).toStrictEqual(expected);
   });
   test("should concatenate arrays using mergeArrays = 'concat'", () => {
@@ -113,6 +140,6 @@ describe(&#39;deepMerge function&#39;, () =&gt; {
       a: { b: { d: [1, 2, 2, 3] } },
       e: [1, 2, 3],
     };
-    expect(deepMerge(source, target, 'concat')).toEqual(expected);
+    expect(deepMerge(source, target, 'concat')).toStrictEqual(expected);
   });
 });
@@ -58,27 +58,26 @@ export function deepMerge&lt;T extends object | null | undefined, U extends object 
   if (!source) {
     return target as T & U;
   }
-  if (isArray(target) && isArray(source)) {
-    switch (mergeArrays) {
-      case 'union':
-        return unionWith(target, source, isEqual) as T & U;
-      case 'intersection':
-        return intersectionWith(target, source, isEqual) as T & U;
-      case 'concat':
-        return target.concat(source) as T & U;
-      case 'replace':
-        return source as T & U;
-      default:
-        throw new Error(`Unknown merge array strategy: ${mergeArrays}`);
-
+  return mergeWith({}, source, target, (sourceValue, targetValue) => {
+    if (isArray(targetValue) && isArray(sourceValue)) {
+      switch (mergeArrays) {
+        case 'union':
+          return unionWith(sourceValue, targetValue, isEqual);
+        case 'intersection':
+          return intersectionWith(sourceValue, targetValue, isEqual);
+        case 'concat':
+          return sourceValue.concat(targetValue);
+        case 'replace':
+          return targetValue;
+        default:
+          throw new Error(`Unknown merge array strategy: ${mergeArrays as string}`);
+      }
     }
-  }
-  if (isObject(target) && isObject(source)) {
-    return mergeWith({}, target, source, (targetValue, sourceValue) => {
-      return deepMerge(targetValue, sourceValue, mergeArrays);
-    }) as T & U;
-  }
-  return source as T & U;
+    if (isObject(targetValue) && isObject(sourceValue)) {
+      return deepMerge(sourceValue, targetValue, mergeArrays);
+    }
+    return undefined;
+  });
 }
 export function openWindow(