feat(db-*): support atomic array $push db updates

packages/db-mongodb/src/updateOne.ts

@@ -52,11 +52,24 @@ export const updateOne: UpdateOne = async function updateOne(
 
   let result
 
-  const $inc: Record<string, number> = {}
   let updateData: UpdateQuery<any> = data
-  transform({ $inc, adapter: this, data, fields, operation: 'write' })
+
+  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) {
-    updateData = { $inc, $set: updateData }
+    updateOps.$inc = $inc
+  }
+  if (Object.keys($push).length) {
+    updateOps.$push = $push
+  }
+  if (Object.keys(updateOps).length) {
+    updateOps.$set = updateData
+    updateData = updateOps
   }
 
   try {

packages/db-mongodb/src/utilities/transform.ts

@@ -209,6 +209,7 @@ const sanitizeDate = ({
 
 type Args = {
   $inc?: Record<string, number>
+  $push?: Record<string, { $each: any[] } | any>
   /** instance of the adapter */
   adapter: MongooseAdapter
   /** data to transform, can be an array of documents or a single document */
@@ -398,6 +399,7 @@ const stripFields = ({
 
 export const transform = ({
   $inc,
+  $push,
   adapter,
   data,
   fields,
@@ -412,7 +414,16 @@ export const transform = ({
 
   if (Array.isArray(data)) {
     for (const item of data) {
-      transform({ $inc, adapter, data: item, fields, globalSlug, operation, validateRelationships })
+      transform({
+        $inc,
+        $push,
+        adapter,
+        data: item,
+        fields,
+        globalSlug,
+        operation,
+        validateRelationships,
+      })
     }
     return
   }
@@ -470,6 +481,39 @@ export const transform = ({
       }
     }
 
+    if (
+      $push &&
+      field.type === 'array' &&
+      operation === 'write' &&
+      field.name in ref &&
+      ref[field.name]
+    ) {
+      const value = ref[field.name]
+      if (value && typeof value === 'object' && '$push' in value) {
+        const push = value.$push
+
+        if (config.localization && fieldShouldBeLocalized({ field, parentIsLocalized })) {
+          if (typeof push === 'object' && push !== null) {
+            Object.entries(push).forEach(([localeKey, localeData]) => {
+              if (Array.isArray(localeData)) {
+                $push[`${parentPath}${field.name}.${localeKey}`] = { $each: localeData }
+              } else if (typeof localeData === 'object') {
+                $push[`${parentPath}${field.name}.${localeKey}`] = localeData
+              }
+            })
+          }
+        } else {
+          if (Array.isArray(push)) {
+            $push[`${parentPath}${field.name}`] = { $each: push }
+          } else if (typeof push === 'object') {
+            $push[`${parentPath}${field.name}`] = push
+          }
+        }
+
+        delete ref[field.name]
+      }
+    }
+
     if (field.type === 'date' && operation === 'read' && field.name in ref && ref[field.name]) {
       if (config.localization && fieldShouldBeLocalized({ field, parentIsLocalized })) {
         const fieldRef = ref[field.name] as Record<string, unknown>
@@ -550,8 +594,13 @@ export const transform = ({
   })
 
   if (operation === 'write') {
-    if (!data.updatedAt) {
+    if (typeof data.updatedAt === 'undefined') {
+      // If data.updatedAt is explicitly set to `null` we should not set it - this means we don't want to change the value of updatedAt.
       data.updatedAt = new Date().toISOString()
+    } else if (data.updatedAt === null) {
+      // `updatedAt` may be explicitly set to null to disable updating it - if that is the case, we need to delete the property. Keeping it as null will
+      // cause the database to think we want to set it to null, which we don't.
+      delete data.updatedAt
     }
   }
 }

packages/drizzle/src/transform/write/array.ts

@@ -71,6 +71,7 @@ export const transformArray = ({
     data.forEach((arrayRow, i) => {
       const newRow: ArrayRowToInsert = {
         arrays: {},
+        arraysToPush: {},
         locales: {},
         row: {
           _order: i + 1,
@@ -104,6 +105,7 @@ export const transformArray = ({
       traverseFields({
         adapter,
         arrays: newRow.arrays,
+        arraysToPush: newRow.arraysToPush,
         baseTableName,
         blocks,
         blocksToDelete,

packages/drizzle/src/transform/write/blocks.ts

@@ -78,6 +78,7 @@ export const transformBlocks = ({
 
     const newRow: BlockRowToInsert = {
       arrays: {},
+      arraysToPush: {},
       locales: {},
       row: {
         _order: i + 1,
@@ -116,6 +117,7 @@ export const transformBlocks = ({
     traverseFields({
       adapter,
       arrays: newRow.arrays,
+      arraysToPush: newRow.arraysToPush,
       baseTableName,
       blocks,
       blocksToDelete,

packages/drizzle/src/transform/write/index.ts

@@ -27,6 +27,7 @@ export const transformForWrite = ({
   // Split out the incoming data into rows to insert / delete
   const rowToInsert: RowToInsert = {
     arrays: {},
+    arraysToPush: {},
     blocks: {},
     blocksToDelete: new Set(),
     locales: {},
@@ -45,6 +46,7 @@ export const transformForWrite = ({
   traverseFields({
     adapter,
     arrays: rowToInsert.arrays,
+    arraysToPush: rowToInsert.arraysToPush,
     baseTableName: tableName,
     blocks: rowToInsert.blocks,
     blocksToDelete: rowToInsert.blocksToDelete,

packages/drizzle/src/transform/write/traverseFields.ts

@@ -4,13 +4,7 @@ import { fieldIsVirtual, fieldShouldBeLocalized } from 'payload/shared'
 import toSnakeCase from 'to-snake-case'
 
 import type { DrizzleAdapter } from '../../types.js'
-import type {
-  ArrayRowToInsert,
-  BlockRowToInsert,
-  NumberToDelete,
-  RelationshipToDelete,
-  TextToDelete,
-} from './types.js'
+import type { NumberToDelete, RelationshipToDelete, RowToInsert, TextToDelete } from './types.js'
 
 import { isArrayOfRows } from '../../utilities/isArrayOfRows.js'
 import { resolveBlockTableName } from '../../utilities/validateExistingBlockIsIdentical.js'
@@ -23,16 +17,20 @@ import { transformTexts } from './texts.js'
 
 type Args = {
   adapter: DrizzleAdapter
-  arrays: {
-    [tableName: string]: ArrayRowToInsert[]
-  }
+  /**
+   * This will delete the array table and then re-insert all the new array rows.
+   */
+  arrays: RowToInsert['arrays']
+  /**
+   * Array rows to push to the existing array. This will simply create
+   * a new row in the array table.
+   */
+  arraysToPush: RowToInsert['arraysToPush']
   /**
    * This is the name of the base table
    */
   baseTableName: string
-  blocks: {
-    [blockType: string]: BlockRowToInsert[]
-  }
+  blocks: RowToInsert['blocks']
   blocksToDelete: Set<string>
   /**
    * A snake-case field prefix, representing prior fields
@@ -82,6 +80,7 @@ type Args = {
 export const traverseFields = ({
   adapter,
   arrays,
+  arraysToPush,
   baseTableName,
   blocks,
   blocksToDelete,
@@ -129,13 +128,24 @@ export const traverseFields = ({
     if (field.type === 'array') {
       const arrayTableName = adapter.tableNameMap.get(`${parentTableName}_${columnName}`)
 
-      if (!arrays[arrayTableName]) {
-        arrays[arrayTableName] = []
-      }
-
       if (isLocalized) {
-        if (typeof data[field.name] === 'object' && data[field.name] !== null) {
-          Object.entries(data[field.name]).forEach(([localeKey, localeData]) => {
+        let value: {
+          [locale: string]: unknown[]
+        } = data[field.name] as any
+
+        let push = false
+        if (typeof value === 'object' && '$push' in value) {
+          value = value.$push as any
+          push = true
+        }
+
+        if (typeof value === 'object' && value !== null) {
+          Object.entries(value).forEach(([localeKey, _localeData]) => {
+            let localeData = _localeData
+            if (push && !Array.isArray(localeData)) {
+              localeData = [localeData]
+            }
+
             if (Array.isArray(localeData)) {
               const newRows = transformArray({
                 adapter,
@@ -158,18 +168,35 @@ export const traverseFields = ({
                 withinArrayOrBlockLocale: localeKey,
               })
 
-              arrays[arrayTableName] = arrays[arrayTableName].concat(newRows)
+              if (push) {
+                if (!arraysToPush[arrayTableName]) {
+                  arraysToPush[arrayTableName] = []
+                }
+                arraysToPush[arrayTableName] = arraysToPush[arrayTableName].concat(newRows)
+              } else {
+                if (!arrays[arrayTableName]) {
+                  arrays[arrayTableName] = []
+                }
+                arrays[arrayTableName] = arrays[arrayTableName].concat(newRows)
+              }
             }
           })
         }
       } else {
+        let value = data[field.name]
+        let push = false
+        if (typeof value === 'object' && '$push' in value) {
+          value = Array.isArray(value.$push) ? value.$push : [value.$push]
+          push = true
+        }
+
         const newRows = transformArray({
           adapter,
           arrayTableName,
           baseTableName,
           blocks,
           blocksToDelete,
-          data: data[field.name],
+          data: value,
           field,
           numbers,
           numbersToDelete,
@@ -183,7 +210,17 @@ export const traverseFields = ({
           withinArrayOrBlockLocale,
         })
 
-        arrays[arrayTableName] = arrays[arrayTableName].concat(newRows)
+        if (push) {
+          if (!arraysToPush[arrayTableName]) {
+            arraysToPush[arrayTableName] = []
+          }
+          arraysToPush[arrayTableName] = arraysToPush[arrayTableName].concat(newRows)
+        } else {
+          if (!arrays[arrayTableName]) {
+            arrays[arrayTableName] = []
+          }
+          arrays[arrayTableName] = arrays[arrayTableName].concat(newRows)
+        }
       }
 
       return
@@ -264,6 +301,7 @@ export const traverseFields = ({
             traverseFields({
               adapter,
               arrays,
+              arraysToPush,
               baseTableName,
               blocks,
               blocksToDelete,
@@ -298,6 +336,7 @@ export const traverseFields = ({
           traverseFields({
             adapter,
             arrays,
+            arraysToPush,
             baseTableName,
             blocks,
             blocksToDelete,
@@ -547,8 +586,8 @@ export const traverseFields = ({
       let formattedValue = value
 
       if (field.type === 'date') {
-        if (fieldName === 'updatedAt' && !formattedValue) {
-          // let the db handle this
+        if (fieldName === 'updatedAt' && typeof formattedValue === 'undefined') {
+          // let the db handle this. If formattedValue is explicitly set to `null` we should not set it - this means we don't want to change the value of updatedAt.
           formattedValue = new Date().toISOString()
         } else {
           if (typeof value === 'number' && !Number.isNaN(value)) {

packages/drizzle/src/transform/write/types.ts

@@ -2,6 +2,9 @@ export type ArrayRowToInsert = {
   arrays: {
     [tableName: string]: ArrayRowToInsert[]
   }
+  arraysToPush: {
+    [tableName: string]: ArrayRowToInsert[]
+  }
   locales: {
     [locale: string]: Record<string, unknown>
   }
@@ -12,6 +15,9 @@ export type BlockRowToInsert = {
   arrays: {
     [tableName: string]: ArrayRowToInsert[]
   }
+  arraysToPush: {
+    [tableName: string]: ArrayRowToInsert[]
+  }
   locales: {
     [locale: string]: Record<string, unknown>
   }
@@ -37,6 +43,9 @@ export type RowToInsert = {
   arrays: {
     [tableName: string]: ArrayRowToInsert[]
   }
+  arraysToPush: {
+    [tableName: string]: ArrayRowToInsert[]
+  }
   blocks: {
     [tableName: string]: BlockRowToInsert[]
   }