perf(db-mongodb): remove JSON.parse(JSON.stringify) copying of results (#11293)

Improves performance and optimizes memory usage for mongodb adapter by
cutting down copying of results via `JSON.parse(JSON.stringify())`.
Instead, `transform` does necessary transformations (`ObjectID` ->
`string,` `Date` -> `string`) without any copying

Author: r1tsuu

packages/db-mongodb/src/create.ts

@@ -5,7 +5,7 @@ import type { MongooseAdapter } from './index.js'
 
 import { getSession } from './utilities/getSession.js'
 import { handleError } from './utilities/handleError.js'
-import { sanitizeRelationshipIDs } from './utilities/sanitizeRelationshipIDs.js'
+import { transform } from './utilities/transform.js'
 
 export const create: Create = async function create(
   this: MongooseAdapter,
@@ -18,31 +18,31 @@ export const create: Create = async function create(
 
   let doc
 
-  const sanitizedData = sanitizeRelationshipIDs({
-    config: this.payload.config,
+  transform({
+    adapter: this,
     data,
     fields: this.payload.collections[collection].config.fields,
+    operation: 'write',
   })
 
   if (this.payload.collections[collection].customIDType) {
-    sanitizedData._id = sanitizedData.id
+    data._id = data.id
   }
 
   try {
-    ;[doc] = await Model.create([sanitizedData], options)
+    ;[doc] = await Model.create([data], options)
   } catch (error) {
     handleError({ collection, error, req })
   }
 
-  // doc.toJSON does not do stuff like converting ObjectIds to string, or date strings to date objects. That's why we use JSON.parse/stringify here
-  const result: Document = JSON.parse(JSON.stringify(doc))
-  const verificationToken = doc._verificationToken
+  doc = doc.toObject()
 
-  // custom id type reset
-  result.id = result._id
-  if (verificationToken) {
-    result._verificationToken = verificationToken
-  }
+  transform({
+    adapter: this,
+    data: doc,
+    fields: this.payload.collections[collection].config.fields,
+    operation: 'read',
+  })
 
-  return result
+  return doc
 }

packages/db-mongodb/src/createGlobal.ts

@@ -4,35 +4,36 @@ import type { CreateGlobal } from 'payload'
 import type { MongooseAdapter } from './index.js'
 
 import { getSession } from './utilities/getSession.js'
-import { sanitizeInternalFields } from './utilities/sanitizeInternalFields.js'
-import { sanitizeRelationshipIDs } from './utilities/sanitizeRelationshipIDs.js'
+import { transform } from './utilities/transform.js'
 
 export const createGlobal: CreateGlobal = async function createGlobal(
   this: MongooseAdapter,
   { slug, data, req },
 ) {
   const Model = this.globals
 
-  const global = sanitizeRelationshipIDs({
-    config: this.payload.config,
-    data: {
-      globalType: slug,
-      ...data,
-    },
+  transform({
+    adapter: this,
+    data,
     fields: this.payload.config.globals.find((globalConfig) => globalConfig.slug === slug).fields,
+    globalSlug: slug,
+    operation: 'write',
   })
 
   const options: CreateOptions = {
     session: await getSession(this, req),
   }
 
-  let [result] = (await Model.create([global], options)) as any
+  let [result] = (await Model.create([data], options)) as any
 
-  result = JSON.parse(JSON.stringify(result))
+  result = result.toObject()
 
-  // custom id type reset
-  result.id = result._id
-  result = sanitizeInternalFields(result)
+  transform({
+    adapter: this,
+    data: result,
+    fields: this.payload.config.globals.find((globalConfig) => globalConfig.slug === slug).fields,
+    operation: 'read',
+  })
 
   return result
 }

packages/db-mongodb/src/createGlobalVersion.ts

@@ -1,11 +1,11 @@
 import type { CreateOptions } from 'mongoose'
 
-import { buildVersionGlobalFields, type CreateGlobalVersion, type Document } from 'payload'
+import { buildVersionGlobalFields, type CreateGlobalVersion } from 'payload'
 
 import type { MongooseAdapter } from './index.js'
 
 import { getSession } from './utilities/getSession.js'
-import { sanitizeRelationshipIDs } from './utilities/sanitizeRelationshipIDs.js'
+import { transform } from './utilities/transform.js'
 
 export const createGlobalVersion: CreateGlobalVersion = async function createGlobalVersion(
   this: MongooseAdapter,
@@ -26,25 +26,30 @@ export const createGlobalVersion: CreateGlobalVersion = async function createGlo
     session: await getSession(this, req),
   }
 
-  const data = sanitizeRelationshipIDs({
-    config: this.payload.config,
-    data: {
-      autosave,
-      createdAt,
-      latest: true,
-      parent,
-      publishedLocale,
-      snapshot,
-      updatedAt,
-      version: versionData,
-    },
-    fields: buildVersionGlobalFields(
-      this.payload.config,
-      this.payload.config.globals.find((global) => global.slug === globalSlug),
-    ),
+  const data = {
+    autosave,
+    createdAt,
+    latest: true,
+    parent,
+    publishedLocale,
+    snapshot,
+    updatedAt,
+    version: versionData,
+  }
+
+  const fields = buildVersionGlobalFields(
+    this.payload.config,
+    this.payload.config.globals.find((global) => global.slug === globalSlug),
+  )
+
+  transform({
+    adapter: this,
+    data,
+    fields,
+    operation: 'write',
   })
 
-  const [doc] = await VersionModel.create([data], options, req)
+  let [doc] = await VersionModel.create([data], options, req)
 
   await VersionModel.updateMany(
     {
@@ -70,13 +75,14 @@ export const createGlobalVersion: CreateGlobalVersion = async function createGlo
     options,
   )
 
-  const result: Document = JSON.parse(JSON.stringify(doc))
-  const verificationToken = doc._verificationToken
+  doc = doc.toObject()
 
-  // custom id type reset
-  result.id = result._id
-  if (verificationToken) {
-    result._verificationToken = verificationToken
-  }
-  return result
+  transform({
+    adapter: this,
+    data: doc,
+    fields,
+    operation: 'read',
+  })
+
+  return doc
 }

packages/db-mongodb/src/createVersion.ts

@@ -1,12 +1,11 @@
 import type { CreateOptions } from 'mongoose'
 
-import { Types } from 'mongoose'
-import { buildVersionCollectionFields, type CreateVersion, type Document } from 'payload'
+import { buildVersionCollectionFields, type CreateVersion } from 'payload'
 
 import type { MongooseAdapter } from './index.js'
 
 import { getSession } from './utilities/getSession.js'
-import { sanitizeRelationshipIDs } from './utilities/sanitizeRelationshipIDs.js'
+import { transform } from './utilities/transform.js'
 
 export const createVersion: CreateVersion = async function createVersion(
   this: MongooseAdapter,
@@ -27,25 +26,30 @@ export const createVersion: CreateVersion = async function createVersion(
     session: await getSession(this, req),
   }
 
-  const data = sanitizeRelationshipIDs({
-    config: this.payload.config,
-    data: {
-      autosave,
-      createdAt,
-      latest: true,
-      parent,
-      publishedLocale,
-      snapshot,
-      updatedAt,
-      version: versionData,
-    },
-    fields: buildVersionCollectionFields(
-      this.payload.config,
-      this.payload.collections[collectionSlug].config,
-    ),
+  const data = {
+    autosave,
+    createdAt,
+    latest: true,
+    parent,
+    publishedLocale,
+    snapshot,
+    updatedAt,
+    version: versionData,
+  }
+
+  const fields = buildVersionCollectionFields(
+    this.payload.config,
+    this.payload.collections[collectionSlug].config,
+  )
+
+  transform({
+    adapter: this,
+    data,
+    fields,
+    operation: 'write',
   })
 
-  const [doc] = await VersionModel.create([data], options, req)
+  let [doc] = await VersionModel.create([data], options, req)
 
   const parentQuery = {
     $or: [
@@ -56,13 +60,6 @@ export const createVersion: CreateVersion = async function createVersion(
       },
     ],
   }
-  if (data.parent instanceof Types.ObjectId) {
-    parentQuery.$or.push({
-      parent: {
-        $eq: data.parent.toString(),
-      },
-    })
-  }
 
   await VersionModel.updateMany(
     {
@@ -89,13 +86,14 @@ export const createVersion: CreateVersion = async function createVersion(
     options,
   )
 
-  const result: Document = JSON.parse(JSON.stringify(doc))
-  const verificationToken = doc._verificationToken
+  doc = doc.toObject()
 
-  // custom id type reset
-  result.id = result._id
-  if (verificationToken) {
-    result._verificationToken = verificationToken
-  }
-  return result
+  transform({
+    adapter: this,
+    data: doc,
+    fields,
+    operation: 'read',
+  })
+
+  return doc
 }

packages/db-mongodb/src/deleteOne.ts

@@ -1,12 +1,12 @@
 import type { QueryOptions } from 'mongoose'
-import type { DeleteOne, Document } from 'payload'
+import type { DeleteOne } from 'payload'
 
 import type { MongooseAdapter } from './index.js'
 
 import { buildQuery } from './queries/buildQuery.js'
 import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
 import { getSession } from './utilities/getSession.js'
-import { sanitizeInternalFields } from './utilities/sanitizeInternalFields.js'
+import { transform } from './utilities/transform.js'
 
 export const deleteOne: DeleteOne = async function deleteOne(
   this: MongooseAdapter,
@@ -35,11 +35,12 @@ export const deleteOne: DeleteOne = async function deleteOne(
     return null
   }
 
-  let result: Document = JSON.parse(JSON.stringify(doc))
-
-  // custom id type reset
-  result.id = result._id
-  result = sanitizeInternalFields(result)
+  transform({
+    adapter: this,
+    data: doc,
+    fields: this.payload.collections[collection].config.fields,
+    operation: 'read',
+  })
 
-  return result
+  return doc
 }

packages/db-mongodb/src/find.ts

@@ -10,7 +10,7 @@ import { buildSortParam } from './queries/buildSortParam.js'
 import { buildJoinAggregation } from './utilities/buildJoinAggregation.js'
 import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
 import { getSession } from './utilities/getSession.js'
-import { sanitizeInternalFields } from './utilities/sanitizeInternalFields.js'
+import { transform } from './utilities/transform.js'
 
 export const find: Find = async function find(
   this: MongooseAdapter,
@@ -133,13 +133,12 @@ export const find: Find = async function find(
     result = await Model.paginate(query, paginationOptions)
   }
 
-  const docs = JSON.parse(JSON.stringify(result.docs))
+  transform({
+    adapter: this,
+    data: result.docs,
+    fields: this.payload.collections[collection].config.fields,
+    operation: 'read',
+  })
 
-  return {
-    ...result,
-    docs: docs.map((doc) => {
-      doc.id = doc._id
-      return sanitizeInternalFields(doc)
-    }),
-  }
+  return result
 }

packages/db-mongodb/src/findGlobal.ts

@@ -8,14 +8,15 @@ import type { MongooseAdapter } from './index.js'
 import { buildQuery } from './queries/buildQuery.js'
 import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
 import { getSession } from './utilities/getSession.js'
-import { sanitizeInternalFields } from './utilities/sanitizeInternalFields.js'
+import { transform } from './utilities/transform.js'
 
 export const findGlobal: FindGlobal = async function findGlobal(
   this: MongooseAdapter,
   { slug, locale, req, select, where },
 ) {
   const Model = this.globals
-  const fields = this.payload.globals.config.find((each) => each.slug === slug).flattenedFields
+  const globalConfig = this.payload.globals.config.find((each) => each.slug === slug)
+  const fields = globalConfig.flattenedFields
   const options: QueryOptions = {
     lean: true,
     select: buildProjectionFromSelect({
@@ -34,18 +35,18 @@ export const findGlobal: FindGlobal = async function findGlobal(
     where: combineQueries({ globalType: { equals: slug } }, where),
   })
 
-  let doc = (await Model.findOne(query, {}, options)) as any
+  const doc = (await Model.findOne(query, {}, options)) as any
 
   if (!doc) {
     return null
   }
-  if (doc._id) {
-    doc.id = doc._id
-    delete doc._id
-  }
 
-  doc = JSON.parse(JSON.stringify(doc))
-  doc = sanitizeInternalFields(doc)
+  transform({
+    adapter: this,
+    data: doc,
+    fields: globalConfig.fields,
+    operation: 'read',
+  })
 
   return doc
 }