perf(db-*): add option to disable returning modified documents in db methods (#11393)

This PR adds a new `returning` option to various db adapter methods. Setting it to `false` where the return value is not used will lead to performance gains, as we don't have to do additional db calls to fetch the updated document and then sanitize it.

Author: AlessioGr

packages/db-mongodb/src/create.ts

@@ -1,5 +1,5 @@
 import type { CreateOptions } from 'mongoose'
-import type { Create, Document } from 'payload'
+import type { Create } from 'payload'
 
 import type { MongooseAdapter } from './index.js'
 
@@ -9,7 +9,7 @@ import { transform } from './utilities/transform.js'
 
 export const create: Create = async function create(
   this: MongooseAdapter,
-  { collection, data, req },
+  { collection, data, req, returning },
 ) {
   const Model = this.collections[collection]
   const options: CreateOptions = {
@@ -34,6 +34,9 @@ export const create: Create = async function create(
   } catch (error) {
     handleError({ collection, error, req })
   }
+  if (returning === false) {
+    return null
+  }
 
   doc = doc.toObject()
 

packages/db-mongodb/src/createGlobal.ts

@@ -8,7 +8,7 @@ import { transform } from './utilities/transform.js'
 
 export const createGlobal: CreateGlobal = async function createGlobal(
   this: MongooseAdapter,
-  { slug, data, req },
+  { slug, data, req, returning },
 ) {
   const Model = this.globals
 
@@ -25,6 +25,9 @@ export const createGlobal: CreateGlobal = async function createGlobal(
   }
 
   let [result] = (await Model.create([data], options)) as any
+  if (returning === false) {
+    return null
+  }
 
   result = result.toObject()
 

packages/db-mongodb/src/createGlobalVersion.ts

@@ -16,6 +16,7 @@ export const createGlobalVersion: CreateGlobalVersion = async function createGlo
     parent,
     publishedLocale,
     req,
+    returning,
     snapshot,
     updatedAt,
     versionData,
@@ -75,6 +76,10 @@ export const createGlobalVersion: CreateGlobalVersion = async function createGlo
     options,
   )
 
+  if (returning === false) {
+    return null
+  }
+
   doc = doc.toObject()
 
   transform({

packages/db-mongodb/src/createVersion.ts

@@ -16,6 +16,7 @@ export const createVersion: CreateVersion = async function createVersion(
     parent,
     publishedLocale,
     req,
+    returning,
     snapshot,
     updatedAt,
     versionData,
@@ -86,6 +87,10 @@ export const createVersion: CreateVersion = async function createVersion(
     options,
   )
 
+  if (returning === false) {
+    return null
+  }
+
   doc = doc.toObject()
 
   transform({

packages/db-mongodb/src/deleteOne.ts

@@ -1,4 +1,4 @@
-import type { QueryOptions } from 'mongoose'
+import type { MongooseUpdateQueryOptions } from 'mongoose'
 import type { DeleteOne } from 'payload'
 
 import type { MongooseAdapter } from './index.js'
@@ -10,10 +10,10 @@ import { transform } from './utilities/transform.js'
 
 export const deleteOne: DeleteOne = async function deleteOne(
   this: MongooseAdapter,
-  { collection, req, select, where },
+  { collection, req, returning, select, where },
 ) {
   const Model = this.collections[collection]
-  const options: QueryOptions = {
+  const options: MongooseUpdateQueryOptions = {
     projection: buildProjectionFromSelect({
       adapter: this,
       fields: this.payload.collections[collection].config.flattenedFields,
@@ -29,6 +29,11 @@ export const deleteOne: DeleteOne = async function deleteOne(
     where,
   })
 
+  if (returning === false) {
+    await Model.deleteOne(query, options)?.lean()
+    return null
+  }
+
   const doc = await Model.findOneAndDelete(query, options)?.lean()
 
   if (!doc) {

packages/db-mongodb/src/updateGlobal.ts

@@ -1,4 +1,4 @@
-import type { QueryOptions } from 'mongoose'
+import type { MongooseUpdateQueryOptions } from 'mongoose'
 import type { UpdateGlobal } from 'payload'
 
 import type { MongooseAdapter } from './index.js'
@@ -9,12 +9,12 @@ import { transform } from './utilities/transform.js'
 
 export const updateGlobal: UpdateGlobal = async function updateGlobal(
   this: MongooseAdapter,
-  { slug, data, options: optionsArgs = {}, req, select },
+  { slug, data, options: optionsArgs = {}, req, returning, select },
 ) {
   const Model = this.globals
   const fields = this.payload.config.globals.find((global) => global.slug === slug).fields
 
-  const options: QueryOptions = {
+  const options: MongooseUpdateQueryOptions = {
     ...optionsArgs,
     lean: true,
     new: true,
@@ -28,6 +28,11 @@ export const updateGlobal: UpdateGlobal = async function updateGlobal(
 
   transform({ adapter: this, data, fields, globalSlug: slug, operation: 'write' })
 
+  if (returning === false) {
+    await Model.updateOne({ globalType: slug }, data, options)
+    return null
+  }
+
   const result: any = await Model.findOneAndUpdate({ globalType: slug }, data, options)
 
   transform({ adapter: this, data: result, fields, globalSlug: slug, operation: 'read' })

packages/db-mongodb/src/updateGlobalVersion.ts

@@ -1,4 +1,4 @@
-import type { QueryOptions } from 'mongoose'
+import type { MongooseUpdateQueryOptions } from 'mongoose'
 
 import { buildVersionGlobalFields, type TypeWithID, type UpdateGlobalVersionArgs } from 'payload'
 
@@ -17,6 +17,7 @@ export async function updateGlobalVersion<T extends TypeWithID>(
     locale,
     options: optionsArgs = {},
     req,
+    returning,
     select,
     versionData,
     where,
@@ -28,7 +29,7 @@ export async function updateGlobalVersion<T extends TypeWithID>(
   const currentGlobal = this.payload.config.globals.find((global) => global.slug === globalSlug)
   const fields = buildVersionGlobalFields(this.payload.config, currentGlobal)
   const flattenedFields = buildVersionGlobalFields(this.payload.config, currentGlobal, true)
-  const options: QueryOptions = {
+  const options: MongooseUpdateQueryOptions = {
     ...optionsArgs,
     lean: true,
     new: true,
@@ -49,6 +50,11 @@ export async function updateGlobalVersion<T extends TypeWithID>(
 
   transform({ adapter: this, data: versionData, fields, operation: 'write' })
 
+  if (returning === false) {
+    await VersionModel.updateOne(query, versionData, options)
+    return null
+  }
+
   const doc = await VersionModel.findOneAndUpdate(query, versionData, options)
 
   if (!doc) {

packages/db-mongodb/src/updateOne.ts

@@ -1,4 +1,4 @@
-import type { QueryOptions } from 'mongoose'
+import type { MongooseUpdateQueryOptions } from 'mongoose'
 import type { UpdateOne } from 'payload'
 
 import type { MongooseAdapter } from './index.js'
@@ -11,12 +11,22 @@ import { transform } from './utilities/transform.js'
 
 export const updateOne: UpdateOne = async function updateOne(
   this: MongooseAdapter,
-  { id, collection, data, locale, options: optionsArgs = {}, req, select, where: whereArg },
+  {
+    id,
+    collection,
+    data,
+    locale,
+    options: optionsArgs = {},
+    req,
+    returning,
+    select,
+    where: whereArg,
+  },
 ) {
   const where = id ? { id: { equals: id } } : whereArg
   const Model = this.collections[collection]
   const fields = this.payload.collections[collection].config.fields
-  const options: QueryOptions = {
+  const options: MongooseUpdateQueryOptions = {
     ...optionsArgs,
     lean: true,
     new: true,
@@ -41,7 +51,12 @@ export const updateOne: UpdateOne = async function updateOne(
   transform({ adapter: this, data, fields, operation: 'write' })
 
   try {
-    result = await Model.findOneAndUpdate(query, data, options)
+    if (returning === false) {
+      await Model.updateOne(query, data, options)
+      return null
+    } else {
+      result = await Model.findOneAndUpdate(query, data, options)
+    }
   } catch (error) {
     handleError({ collection, error, req })
   }

packages/db-mongodb/src/updateVersion.ts

@@ -1,4 +1,4 @@
-import type { QueryOptions } from 'mongoose'
+import type { MongooseUpdateQueryOptions } from 'mongoose'
 
 import { buildVersionCollectionFields, type UpdateVersion } from 'payload'
 
@@ -11,7 +11,7 @@ import { transform } from './utilities/transform.js'
 
 export const updateVersion: UpdateVersion = async function updateVersion(
   this: MongooseAdapter,
-  { id, collection, locale, options: optionsArgs = {}, req, select, versionData, where },
+  { id, collection, locale, options: optionsArgs = {}, req, returning, select, versionData, where },
 ) {
   const VersionModel = this.versions[collection]
   const whereToUse = where || { id: { equals: id } }
@@ -26,7 +26,7 @@ export const updateVersion: UpdateVersion = async function updateVersion(
     true,
   )
 
-  const options: QueryOptions = {
+  const options: MongooseUpdateQueryOptions = {
     ...optionsArgs,
     lean: true,
     new: true,
@@ -47,6 +47,11 @@ export const updateVersion: UpdateVersion = async function updateVersion(
 
   transform({ adapter: this, data: versionData, fields, operation: 'write' })
 
+  if (returning === false) {
+    await VersionModel.updateOne(query, versionData, options)
+    return null
+  }
+
   const doc = await VersionModel.findOneAndUpdate(query, versionData, options)
 
   if (!doc) {

packages/db-mongodb/src/upsert.ts

@@ -4,7 +4,16 @@ import type { MongooseAdapter } from './index.js'
 
 export const upsert: Upsert = async function upsert(
   this: MongooseAdapter,
-  { collection, data, locale, req, select, where },
+  { collection, data, locale, req, returning, select, where },
 ) {
-  return this.updateOne({ collection, data, locale, options: { upsert: true }, req, select, where })
+  return this.updateOne({
+    collection,
+    data,
+    locale,
+    options: { upsert: true },
+    req,
+    returning,
+    select,
+    where,
+  })
 }