5ded64eaaf
This PR adds **atomic** `$push` **support for array fields**. It makes it possible to safely append new items to arrays, which is especially useful when running tasks in parallel (like job queues) where multiple processes might update the same record at the same time. By handling pushes atomically, we avoid race conditions and keep data consistent - especially on postgres, where the current implementation would nuke the entire array table before re-inserting every single array item. The feature works for both localized and unlocalized arrays, and supports pushing either single or multiple items at once. This PR is a requirement for reliably running parallel tasks in the job queue - see https://github.com/payloadcms/payload/pull/13452. Alongside documenting `$push`, this PR also adds documentation for `$inc`. ## Changes to updatedAt behavior https://github.com/payloadcms/payload/pull/13335 allows us to override the updatedAt property instead of the db always setting it to the current date. However, we are not able to skip updating the updatedAt property completely. This means, usage of $push results in 2 postgres db calls: 1. set updatedAt in main row 2. append array row in arrays table This PR changes the behavior to only automatically set updatedAt if it's undefined. If you explicitly set it to `null`, this now allows you to skip the db adapter automatically setting updatedAt. => This allows us to use $push in just one single db call ## Usage Examples ### Pushing a single item to an array ```ts const post = (await payload.db.updateOne({ data: { array: { $push: { text: 'some text 2', id: new mongoose.Types.ObjectId().toHexString(), }, }, }, collection: 'posts', id: post.id, })) ``` ### Pushing a single item to a localized array ```ts const post = (await payload.db.updateOne({ data: { arrayLocalized: { $push: { en: { text: 'some text 2', id: new mongoose.Types.ObjectId().toHexString(), }, es: { text: 'some text 2 es', id: new mongoose.Types.ObjectId().toHexString(), }, }, }, }, collection: 'posts', id: post.id, })) ``` ### Pushing multiple items to an array ```ts const post = (await payload.db.updateOne({ data: { array: { $push: [ { text: 'some text 2', id: new mongoose.Types.ObjectId().toHexString(), }, { text: 'some text 3', id: new mongoose.Types.ObjectId().toHexString(), }, ], }, }, collection: 'posts', id: post.id, })) ``` ### Pushing multiple items to a localized array ```ts const post = (await payload.db.updateOne({ data: { arrayLocalized: { $push: { en: { text: 'some text 2', id: new mongoose.Types.ObjectId().toHexString(), }, es: [ { text: 'some text 2 es', id: new mongoose.Types.ObjectId().toHexString(), }, { text: 'some text 3 es', id: new mongoose.Types.ObjectId().toHexString(), }, ], }, }, }, collection: 'posts', id: post.id, })) ``` --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1211110462564647
95 lines
2.4 KiB
TypeScript
95 lines
2.4 KiB
TypeScript
import type { MongooseUpdateQueryOptions, UpdateQuery } from 'mongoose'
|
|
import type { UpdateOne } from 'payload'
|
|
|
|
import type { MongooseAdapter } from './index.js'
|
|
|
|
import { buildQuery } from './queries/buildQuery.js'
|
|
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
|
|
import { getCollection } from './utilities/getEntity.js'
|
|
import { getSession } from './utilities/getSession.js'
|
|
import { handleError } from './utilities/handleError.js'
|
|
import { transform } from './utilities/transform.js'
|
|
|
|
export const updateOne: UpdateOne = async function updateOne(
|
|
this: MongooseAdapter,
|
|
{
|
|
id,
|
|
collection: collectionSlug,
|
|
data,
|
|
locale,
|
|
options: optionsArgs = {},
|
|
req,
|
|
returning,
|
|
select,
|
|
where: whereArg = {},
|
|
},
|
|
) {
|
|
const { collectionConfig, Model } = getCollection({ adapter: this, collectionSlug })
|
|
const where = id ? { id: { equals: id } } : whereArg
|
|
const fields = collectionConfig.fields
|
|
|
|
const options: MongooseUpdateQueryOptions = {
|
|
...optionsArgs,
|
|
lean: true,
|
|
new: true,
|
|
projection: buildProjectionFromSelect({
|
|
adapter: this,
|
|
fields: collectionConfig.flattenedFields,
|
|
select,
|
|
}),
|
|
session: await getSession(this, req),
|
|
// Timestamps are manually added by the write transform
|
|
timestamps: false,
|
|
}
|
|
|
|
const query = await buildQuery({
|
|
adapter: this,
|
|
collectionSlug,
|
|
fields: collectionConfig.flattenedFields,
|
|
locale,
|
|
where,
|
|
})
|
|
|
|
let result
|
|
|
|
let updateData: UpdateQuery<any> = data
|
|
|
|
const $inc: Record<string, number> = {}
|
|
const $push: Record<string, { $each: any[] } | any> = {}
|
|
|
|
transform({ $inc, $push, adapter: this, data, fields, operation: 'write' })
|
|
|
|
const updateOps: UpdateQuery<any> = {}
|
|
|
|
if (Object.keys($inc).length) {
|
|
updateOps.$inc = $inc
|
|
}
|
|
if (Object.keys($push).length) {
|
|
updateOps.$push = $push
|
|
}
|
|
if (Object.keys(updateOps).length) {
|
|
updateOps.$set = updateData
|
|
updateData = updateOps
|
|
}
|
|
|
|
try {
|
|
if (returning === false) {
|
|
await Model.updateOne(query, updateData, options)
|
|
transform({ adapter: this, data, fields, operation: 'read' })
|
|
return null
|
|
} else {
|
|
result = await Model.findOneAndUpdate(query, updateData, options)
|
|
}
|
|
} catch (error) {
|
|
handleError({ collection: collectionSlug, error, req })
|
|
}
|
|
|
|
if (!result) {
|
|
return null
|
|
}
|
|
|
|
transform({ adapter: this, data: result, fields, operation: 'read' })
|
|
|
|
return result
|
|
}
|