feat: make isMergeableObject configurable (#68)

* feat: make isMergeableObject configurable

* skip test

* lint

* document

* Update README.md

Signed-off-by: Aras Abbasi <[email protected]>

* Update README.md

Co-authored-by: Frazer Smith <[email protected]>
Signed-off-by: Aras Abbasi <[email protected]>

---------

Signed-off-by: Aras Abbasi <[email protected]>
Co-authored-by: Frazer Smith <[email protected]>

Author: Uzlopak

README.md

@@ -27,6 +27,7 @@ deepmerge(options)
 - `all` (`boolean`, optional) - makes deepmerge accept and merge any number of passed objects, default is false
 - `mergeArray` (`function`, optional) - provide a function, which returns a function to add custom array merging function
 - `cloneProtoObject` (`function`, optional) - provide a function, which must return a clone of the object with the prototype of the object
+- `isMergeableObject` (`function`, optional) - provide a function, which must return true if the object should be merged, default is `isMergeableObject` from this module
 
 ```js
 const deepmerge = require('@fastify/deepmerge')()
@@ -133,6 +134,27 @@ const result = deepmergeByReference({}, { stream: process.stdout })
 console.log(result) // { stream: <ref *1> WriteStream }
 ```
 
+#### isMergeableObject
+
+By default, `@fastify/deepmerge` merges all objects except native `Date` and `RegExp` objects. To exclude certain objects from being merged, you can provide a custom function to the `isMergeableObject` option.
+
+The default function is exported by this module as `isMergeableObject`.
+
+The following example shows how to extend the default function to exclude globally defined `FormData` objects from being identified as mergeable objects.
+
+```js
+const { isMergeableObject: defaultIsMergeableObject } = require('@fastify/deepmerge')
+
+
+function customIsMergeableObject (source) {
+  return defaultIsMergeableObject(source) && !(source instanceof FormData)
+}
+
+const deepmergeWithCustomMergeableObject = require('@fastify/deepmerge')({
+  isMergeableObject: customIsMergeableObject
+})
+```
+
 ## Benchmarks
 
 The benchmarks are available in the benchmark folder.

index.js

@@ -6,6 +6,12 @@
 
 const JSON_PROTO = Object.getPrototypeOf({})
 
+function defaultIsMergeableObjectFactory () {
+  return function defaultIsMergeableObject (value) {
+    return typeof value === 'object' && value !== null && !(value instanceof RegExp) && !(value instanceof Date)
+  }
+}
+
 function deepmergeConstructor (options) {
   function isNotPrototypeKey (value) {
     return (
@@ -73,18 +79,14 @@ function deepmergeConstructor (options) {
     ? options.cloneProtoObject
     : undefined
 
-  function isMergeableObject (value) {
-    return typeof value === 'object' && value !== null && !(value instanceof RegExp) && !(value instanceof Date)
-  }
+  const isMergeableObject = typeof options?.isMergeableObject === 'function'
+    ? options.isMergeableObject
+    : defaultIsMergeableObjectFactory()
 
   function isPrimitive (value) {
     return typeof value !== 'object' || value === null
   }
 
-  const isPrimitiveOrBuiltIn = typeof Buffer !== 'undefined'
-    ? (value) => typeof value !== 'object' || value === null || value instanceof RegExp || value instanceof Date || value instanceof Buffer
-    : (value) => typeof value !== 'object' || value === null || value instanceof RegExp || value instanceof Date
-
   const mergeArray = options && typeof options.mergeArray === 'function'
     ? options.mergeArray({ clone, deepmerge: _deepmerge, getKeys, isMergeableObject })
     : concatArrays
@@ -134,7 +136,7 @@ function deepmergeConstructor (options) {
 
     if (isPrimitive(source)) {
       return source
-    } else if (isPrimitiveOrBuiltIn(target)) {
+    } else if (!isMergeableObject(target)) {
       return clone(source)
     } else if (sourceIsArray && targetIsArray) {
       return mergeArray(target, source)
@@ -169,3 +171,7 @@ function deepmergeConstructor (options) {
 module.exports = deepmergeConstructor
 module.exports.default = deepmergeConstructor
 module.exports.deepmerge = deepmergeConstructor
+
+Object.defineProperty(module.exports, 'isMergeableObject', {
+  get: defaultIsMergeableObjectFactory
+})

test/is-mergeable-object.test.js

@@ -0,0 +1,68 @@
+'use strict'
+
+// based on https://github.com/TehShrike/deepmerge/tree/3c39fb376158fa3cfc75250cfc4414064a90f582/test
+// MIT License
+// Copyright (c) 2012 - 2022 James Halliday, Josh Duff, and other contributors of deepmerge
+
+const deepmerge = require('../index')
+const test = require('tape').test
+
+test('custom isMergeableObject', { skip: typeof FormData === 'undefined' }, function (t) {
+  function customIsMergeableObject (value) {
+    return (
+      typeof value === 'object' &&
+      value !== null &&
+      !(value instanceof RegExp) &&
+      !(value instanceof Date) &&
+      !(value instanceof FormData)
+    )
+  }
+
+  const merge = deepmerge({
+    isMergeableObject: customIsMergeableObject,
+  })
+  const destination = {
+    someArray: [1, 2],
+    someObject: new FormData()
+  }
+
+  const formdata = new FormData()
+  const source = {
+    someObject: formdata,
+  }
+
+  const actual = merge(destination, source)
+  const expected = {
+    someArray: [1, 2],
+    someObject: formdata
+  }
+
+  t.deepEqual(actual, expected)
+  t.end()
+})
+
+test('isMergeableObject is not mutable /1', function (t) {
+  t.plan(1)
+  try {
+    deepmerge.isMergeableObject = function (value) {
+      return false
+    }
+  } catch (e) {
+    t.pass('deepmerge.isMergeableObject is not mutable')
+  }
+
+  t.end()
+})
+
+test('isMergeableObject is not mutable /1', function (t) {
+  try {
+    Object.defineProperty(deepmerge, 'isMergeableObject', {
+      value: function (value) {
+        return false
+      }
+    })
+  } catch (e) {
+    t.pass('deepmerge.isMergeableObject is not mutable')
+  }
+  t.end()
+})

types/index.d.ts

@@ -73,6 +73,7 @@ type MergeArrayFn = (options: MergeArrayFnOptions) => (target: any[], source: an
 interface Options {
   cloneProtoObject?: CloneProtoObjectFn;
   mergeArray?: MergeArrayFn;
+  isMergeableObject?: (value: any) => boolean;
   symbols?: boolean;
   all?: boolean;
 }
@@ -83,6 +84,8 @@ declare namespace deepmerge {
   export { Options, DeepMergeFn, DeepMergeAllFn }
   export const deepmerge: DeepmergeConstructor
   export { deepmerge as default }
+
+  export const isMergeableObject: (value: any) => boolean
 }
 
 declare function deepmerge (options: Options & { all: true }): DeepMergeAllFn

types/index.test-d.ts

@@ -76,3 +76,11 @@ deepmerge({
     }
   }
 })
+deepmerge({
+  isMergeableObject: function (value) {
+    return true
+  }
+})
+
+expectType<(value: any) => boolean>(deepmerge.isMergeableObject)
+expectError(deepmerge.isMergeableObject = function () { return false })