feat!: 700% faster deepCopyObject, refactor deep merging and deep copying, type improvements (#7272)

**BREAKING:**
- The `deepMerge` exported from payload now handles more complex data and
is slower. The old, simple deepMerge is now exported as `deepMergeSimple`
- `combineMerge` is no longer exported. You can use
`deepMergeWithCombinedArrays` instead
- The behavior of the exported `deepCopyObject` and `isPlainObject` may
be different and more reliable, as the underlying algorithm has changed

Author: AlessioGr

packages/db-mongodb/package.json

@@ -34,7 +34,6 @@
   },
   "dependencies": {
     "bson-objectid": "2.0.4",
-    "deepmerge": "4.3.1",
     "http-status": "1.6.2",
     "mongoose": "6.12.3",
     "mongoose-paginate-v2": "1.7.22",

packages/db-mongodb/src/queries/parseParams.ts

@@ -1,8 +1,7 @@
 import type { FilterQuery } from 'mongoose'
 import type { Field, Operator, Payload, Where } from 'payload'
 
-import deepmerge from 'deepmerge'
-import { combineMerge } from 'payload'
+import { deepMergeWithCombinedArrays } from 'payload'
 import { validOperators } from 'payload/shared'
 
 import { buildAndOrConditions } from './buildAndOrConditions.js'
@@ -70,7 +69,7 @@ export async function parseParams({
                   [searchParam.path]: searchParam.value,
                 }
               } else if (typeof searchParam?.value === 'object') {
-                result = deepmerge(result, searchParam.value, { arrayMerge: combineMerge })
+                result = deepMergeWithCombinedArrays(result, searchParam.value)
               }
             }
           }

packages/payload/src/admin/RichText.ts

@@ -6,7 +6,7 @@ import type { SanitizedCollectionConfig, TypeWithID } from '../collections/confi
 import type { SanitizedConfig } from '../config/types.js'
 import type { Field, FieldAffectingData, RichTextField, Validate } from '../fields/config/types.js'
 import type { SanitizedGlobalConfig } from '../globals/config/types.js'
-import type { PayloadRequest, RequestContext } from '../types/index.js'
+import type { JsonObject, PayloadRequest, RequestContext } from '../types/index.js'
 import type { WithServerSidePropsComponentProps } from './elements/WithServerSideProps.js'
 
 export type RichTextFieldProps<Value extends object, AdapterProps, ExtraFieldProperties = {}> = {
@@ -82,7 +82,7 @@ export type BeforeChangeRichTextHookArgs<
   /**
    * The original data with locales (not modified by any hooks). Only available in `beforeChange` and `beforeDuplicate` field hooks.
    */
-  docWithLocales?: Record<string, unknown>
+  docWithLocales?: JsonObject
 
   duplicate?: boolean
 
@@ -98,7 +98,7 @@ export type BeforeChangeRichTextHookArgs<
   /**
    * The original siblingData with locales (not modified by any hooks).
    */
-  siblingDocWithLocales?: Record<string, unknown>
+  siblingDocWithLocales?: JsonObject
 
   skipValidation?: boolean
 }
@@ -216,7 +216,7 @@ type RichTextAdapterBase<
     populationPromises: Promise<void>[]
     req: PayloadRequest
     showHiddenFields: boolean
-    siblingDoc: Record<string, unknown>
+    siblingDoc: JsonObject
   }) => void
   hooks?: RichTextHooks
   i18n?: Partial<GenericLanguages>

packages/payload/src/auth/operations/resetPassword.ts

@@ -59,7 +59,7 @@ export const resetPasswordOperation = async (args: Arguments): Promise<Result> =
       collection: collectionConfig.slug,
       req,
       where: {
-        resetPasswordExpiration: { greater_than: new Date() },
+        resetPasswordExpiration: { greater_than: new Date().toISOString() },
         resetPasswordToken: { equals: data.token },
       },
     })

packages/payload/src/auth/strategies/local/incrementLoginAttempts.ts

@@ -1,5 +1,5 @@
 import type { SanitizedCollectionConfig, TypeWithID } from '../../../collections/config/types.js'
-import type { Payload } from '../../../index.js'
+import type { JsonObject, Payload } from '../../../index.js'
 import type { PayloadRequest } from '../../../types/index.js'
 
 type Args = {
@@ -39,13 +39,13 @@ export const incrementLoginAttempts = async ({
     return
   }
 
-  const data: Record<string, unknown> = {
+  const data: JsonObject = {
     loginAttempts: Number(doc.loginAttempts) + 1,
   }
 
   // Lock the account if at max attempts and not already locked
   if (typeof doc.loginAttempts === 'number' && doc.loginAttempts + 1 >= maxLoginAttempts) {
-    const lockUntil = new Date(Date.now() + lockTime)
+    const lockUntil = new Date(Date.now() + lockTime).toISOString()
     data.lockUntil = lockUntil
   }
 

packages/payload/src/auth/strategies/local/register.ts

@@ -1,13 +1,13 @@
 import type { SanitizedCollectionConfig } from '../../../collections/config/types.js'
-import type { Payload } from '../../../index.js'
+import type { JsonObject, Payload } from '../../../index.js'
 import type { PayloadRequest } from '../../../types/index.js'
 
 import { ValidationError } from '../../../errors/index.js'
 import { generatePasswordSaltHash } from './generatePasswordSaltHash.js'
 
 type Args = {
   collection: SanitizedCollectionConfig
-  doc: Record<string, unknown>
+  doc: JsonObject
   password: string
   payload: Payload
   req: PayloadRequest

packages/payload/src/collections/config/defaults.ts

@@ -1,8 +1,9 @@
-import type { LoginWithUsernameOptions } from '../../auth/types.js'
+import type { IncomingAuthType, LoginWithUsernameOptions } from '../../auth/types.js'
+import type { CollectionConfig } from './types.js'
 
 import defaultAccess from '../../auth/defaultAccess.js'
 
-export const defaults = {
+export const defaults: Partial<CollectionConfig> = {
   access: {
     create: defaultAccess,
     delete: defaultAccess,
@@ -49,7 +50,7 @@ export const defaults = {
   versions: false,
 }
 
-export const authDefaults = {
+export const authDefaults: IncomingAuthType = {
   cookies: {
     sameSite: 'Lax',
     secure: false,

packages/payload/src/collections/config/sanitize.ts

@@ -1,5 +1,3 @@
-import merge from 'deepmerge'
-
 import type { Config, SanitizedConfig } from '../../config/types.js'
 import type { CollectionConfig, SanitizedCollectionConfig } from './types.js'
 
@@ -9,8 +7,8 @@ import { sanitizeFields } from '../../fields/config/sanitize.js'
 import { fieldAffectsData } from '../../fields/config/types.js'
 import mergeBaseFields from '../../fields/mergeBaseFields.js'
 import { getBaseUploadFields } from '../../uploads/getBaseFields.js'
+import { deepMergeWithReactComponents } from '../../utilities/deepMerge.js'
 import { formatLabels } from '../../utilities/formatLabels.js'
-import { isPlainObject } from '../../utilities/isPlainObject.js'
 import baseVersionFields from '../../versions/baseFields.js'
 import { versionDefaults } from '../../versions/defaults.js'
 import { authDefaults, defaults, loginWithUsernameDefaults } from './defaults.js'
@@ -29,9 +27,7 @@ export const sanitizeCollection = async (
   // Make copy of collection config
   // /////////////////////////////////
 
-  const sanitized: CollectionConfig = merge(defaults, collection, {
-    isMergeableObject: isPlainObject,
-  })
+  const sanitized: CollectionConfig = deepMergeWithReactComponents(defaults, collection)
 
   // /////////////////////////////////
   // Sanitize fields
@@ -141,9 +137,10 @@ export const sanitizeCollection = async (
     // sanitize fields for reserved names
     sanitizeAuthFields(sanitized.fields, sanitized)
 
-    sanitized.auth = merge(authDefaults, typeof sanitized.auth === 'object' ? sanitized.auth : {}, {
-      isMergeableObject: isPlainObject,
-    })
+    sanitized.auth = deepMergeWithReactComponents(
+      authDefaults,
+      typeof sanitized.auth === 'object' ? sanitized.auth : {},
+    )
 
     if (!sanitized.auth.disableLocalStrategy && sanitized.auth.verify === true) {
       sanitized.auth.verify = {}
@@ -157,12 +154,12 @@ export const sanitizeCollection = async (
     }
 
     sanitized.auth.loginWithUsername = sanitized.auth.loginWithUsername
-      ? merge(
-          loginWithUsernameDefaults,
-          typeof sanitized.auth.loginWithUsername === 'boolean'
+      ? {
+          ...loginWithUsernameDefaults,
+          ...(typeof sanitized.auth.loginWithUsername === 'boolean'
             ? {}
-            : sanitized.auth.loginWithUsername,
-        )
+            : sanitized.auth.loginWithUsername),
+        }
       : false
 
     sanitized.fields = mergeBaseFields(sanitized.fields, getBaseAuthFields(sanitized.auth))

packages/payload/src/collections/config/types.ts

@@ -28,7 +28,12 @@ import type {
 } from '../../config/types.js'
 import type { DBIdentifierName } from '../../database/types.js'
 import type { Field } from '../../fields/config/types.js'
-import type { CollectionSlug, TypedAuthOperations, TypedCollection } from '../../index.js'
+import type {
+  CollectionSlug,
+  JsonObject,
+  TypedAuthOperations,
+  TypedCollection,
+} from '../../index.js'
 import type { PayloadRequest, RequestContext } from '../../types/index.js'
 import type { SanitizedUploadConfig, UploadConfig } from '../../uploads/types.js'
 import type {
@@ -41,7 +46,7 @@ export type DataFromCollectionSlug<TSlug extends CollectionSlug> = TypedCollecti
 export type AuthOperationsFromCollectionSlug<TSlug extends CollectionSlug> =
   TypedAuthOperations[TSlug]
 
-export type RequiredDataFromCollection<TData extends Record<string, any>> = MarkOptional<
+export type RequiredDataFromCollection<TData extends JsonObject> = MarkOptional<
   TData,
   'createdAt' | 'id' | 'sizes' | 'updatedAt'
 >

packages/payload/src/collections/dataloader.ts

@@ -2,7 +2,7 @@ import type { BatchLoadFn } from 'dataloader'
 
 import DataLoader from 'dataloader'
 
-import type { PayloadRequest } from '../types/index.js'
+import type { JsonValue, PayloadRequest } from '../types/index.js'
 import type { TypeWithID } from './config/types.js'
 
 import { isValidID } from '../utilities/isValidID.js'
@@ -119,7 +119,7 @@ const batchAndLoadDocs =
         showHiddenFields: Boolean(showHiddenFields),
         where: {
           id: {
-            in: ids,
+            in: ids as JsonValue,
           },
         },
       })