replace deepmerge with @fastify/deepmerge (#178)

* replace deepmerge with @fastify/deepmerge

* remove newline

* increase code coverage

* increase test coverage

Author: Uzlopak

package.json

@@ -66,6 +66,6 @@
     "tsd": "^0.22.0"
   },
   "dependencies": {
-    "deepmerge": "^4.2.2"
+    "@fastify/deepmerge": "^1.1.0"
   }
 }

src/ObjectSchema.js

@@ -1,5 +1,4 @@
 'use strict'
-const merge = require('deepmerge')
 const { BaseSchema } = require('./BaseSchema')
 const {
   omit,
@@ -9,7 +8,7 @@ const {
   patchIdsWithParentId,
   appendRequired,
   FluentSchemaError,
-  combineMerge,
+  combineDeepmerge,
 } = require('./utils')
 
 const initialState = {
@@ -322,7 +321,7 @@ const ObjectSchema = ({ schema = initialState, ...options } = {}) => {
         throw new FluentSchemaError("Schema isn't FluentSchema type")
       }
       const src = base._getState()
-      const extended = merge(src, schema, { arrayMerge: combineMerge })
+      const extended = combineDeepmerge(src, schema)
       const {
         valueOf,
         isFluentSchema,

src/utils.js

@@ -1,5 +1,5 @@
 'use strict'
-const merge = require('deepmerge')
+const deepmerge = require('@fastify/deepmerge')
 const isFluentSchema = obj => obj && obj.isFluentSchema
 
 const hasCombiningKeywords = attributes =>
@@ -40,23 +40,33 @@ const flat = array =>
     }
   }, {})
 
-const combineMerge = (target, source, options) => {
-  const destination = target.slice()
-
-  source.forEach((item, index) => {
-    const prop = target.find(attr => attr.name === item.name)
-    if (typeof destination[index] === 'undefined') {
-      destination[index] = options.cloneUnlessOtherwiseSpecified(item, options)
-    } else if (options.isMergeableObject(prop)) {
-      const propIndex = target.findIndex(prop => prop.name === item.name)
-      destination[propIndex] = merge(prop, item, options)
-    } else if (target.indexOf(item) === -1) {
-      destination.push(item)
-    }
-  })
-  return destination
+const combineArray = (options) => {
+
+  const {
+    clone,
+    isMergeableObject,
+    deepmerge,
+  } = options
+
+  return (target, source) => {
+    const result = target.slice()
+
+    source.forEach((item, index) => {
+      const prop = target.find(attr => attr.name === item.name)
+      if (typeof result[index] === 'undefined') {
+        result[index] = clone(item)
+      } else if (isMergeableObject(prop)) {
+        const propIndex = target.findIndex(prop => prop.name === item.name)
+        result[propIndex] = deepmerge(prop, item)
+      } else if (target.indexOf(item) === -1) {
+        result.push(item)
+      }
+    })
+    return result
+  }
 }
 
+const combineDeepmerge = deepmerge({ mergeArray: combineArray })
 const toArray = obj =>
   obj && Object.entries(obj).map(([key, value]) => ({ name: key, ...value }))
 
@@ -230,7 +240,7 @@ module.exports = {
   setRaw,
   setAttribute,
   setComposeType,
-  combineMerge,
+  combineDeepmerge,
   FORMATS,
   TYPES,
   FLUENT_SCHEMA,

src/utils.test.js

@@ -1,4 +1,4 @@
-const { setRaw } = require('./utils')
+const { setRaw, combineDeepmerge } = require('./utils')
 const { StringSchema } = require('./StringSchema')
 const { ObjectSchema } = require('./ObjectSchema')
 
@@ -31,3 +31,45 @@ describe('setRaw', () => {
     })
   })
 })
+
+describe('combineDeepmerge', () => {
+  it('should merge empty arrays', () => {
+    const result = combineDeepmerge([], []);
+    expect(result).toEqual([])
+  })
+
+  it('should merge array with primitive values', () => {
+    const result = combineDeepmerge([1], [2]);
+    expect(result).toEqual([1, 2])
+  })
+
+  it('should merge arrays with primitive values', () => {
+    const result = combineDeepmerge([], [1, 2]);
+    expect(result).toEqual([1, 2])
+  })
+
+  it('should merge arrays with primitive values', () => {
+    const result = combineDeepmerge([1, 2], [1, 2, 3]);
+    expect(result).toEqual([1, 2, 3])
+  })
+
+  it('should merge array with simple Schemas', () => {
+    const result = combineDeepmerge([{ type: 'string' }], [{ type: 'string' }]);
+    expect(result).toEqual([{ type: 'string' }])
+  })
+
+  it('should merge array with named Schemas', () => {
+    const result = combineDeepmerge([{ name: 'variant 1', type: 'string' }], [{  name: 'variant 2', type: 'string' }]);
+    expect(result).toEqual([{ name: 'variant 1', type: 'string' }, { name: 'variant 2', type: 'string' }])
+  })
+
+  it('should merge array with same named Schemas', () => {
+    const result = combineDeepmerge([{ name: 'variant 2', type: 'string' }], [{  name: 'variant 2', type: 'number' }]);
+    expect(result).toEqual([{ name: 'variant 2', type: 'number' }])
+  })
+
+  it('should merge array with same named Schemas', () => {
+    const result = combineDeepmerge([{ name: 'variant 2', type: 'string' }], [{  name: 'variant 2', type: 'number' }, { name: 'variant 1', type: 'string' }]);
+    expect(result).toEqual([{ name: 'variant 2', type: 'number' }, { name: 'variant 1', type: 'string' }])
+  })
+})