fix(db-*): make db.begintransactions required (#8419)

Changing the transcations functions on the db so that projects using
typescript `strict: true` do not need to type narrow before using it.

Author: DanRibbens

packages/db-mongodb/src/index.ts

@@ -6,7 +6,7 @@ import type { BaseDatabaseAdapter, DatabaseAdapterObj, Payload, UpdateOneArgs }
 import fs from 'fs'
 import mongoose from 'mongoose'
 import path from 'path'
-import { createDatabaseAdapter } from 'payload'
+import { createDatabaseAdapter, defaultBeginTransaction } from 'payload'
 
 import type { CollectionModel, GlobalModel, MigrateDownArgs, MigrateUpArgs } from './types.js'
 
@@ -163,7 +163,7 @@ export function mongooseAdapter({
       url,
       versions: {},
       // DatabaseAdapter
-      beginTransaction: transactionOptions ? beginTransaction : undefined,
+      beginTransaction: transactionOptions === false ? defaultBeginTransaction() : beginTransaction,
       commitTransaction,
       connect,
       create,

packages/db-postgres/src/index.ts

@@ -47,7 +47,7 @@ import {
   requireDrizzleKit,
 } from '@payloadcms/drizzle/postgres'
 import { pgEnum, pgSchema, pgTable } from 'drizzle-orm/pg-core'
-import { createDatabaseAdapter } from 'payload'
+import { createDatabaseAdapter, defaultBeginTransaction } from 'payload'
 
 import type { Args, PostgresAdapter } from './types.js'
 
@@ -107,7 +107,8 @@ export function postgresAdapter(args: Args): DatabaseAdapterObj<PostgresAdapter>
       versionsSuffix: args.versionsSuffix || '_v',
 
       // DatabaseAdapter
-      beginTransaction: args.transactionOptions === false ? undefined : beginTransaction,
+      beginTransaction:
+        args.transactionOptions === false ? defaultBeginTransaction() : beginTransaction,
       commitTransaction,
       connect,
       convertPathToJSONTraversal,

packages/db-sqlite/src/index.ts

@@ -34,7 +34,7 @@ import {
   updateVersion,
 } from '@payloadcms/drizzle'
 import { like } from 'drizzle-orm'
-import { createDatabaseAdapter } from 'payload'
+import { createDatabaseAdapter, defaultBeginTransaction } from 'payload'
 
 import type { Args, SQLiteAdapter } from './types.js'
 
@@ -108,7 +108,7 @@ export function sqliteAdapter(args: Args): DatabaseAdapterObj<SQLiteAdapter> {
       versionsSuffix: args.versionsSuffix || '_v',
 
       // DatabaseAdapter
-      beginTransaction: args.transactionOptions ? beginTransaction : undefined,
+      beginTransaction: args.transactionOptions ? beginTransaction : defaultBeginTransaction(),
       commitTransaction,
       connect,
       convertPathToJSONTraversal,

packages/db-vercel-postgres/src/index.ts

@@ -47,7 +47,7 @@ import {
   requireDrizzleKit,
 } from '@payloadcms/drizzle/postgres'
 import { pgEnum, pgSchema, pgTable } from 'drizzle-orm/pg-core'
-import { createDatabaseAdapter } from 'payload'
+import { createDatabaseAdapter, defaultBeginTransaction } from 'payload'
 
 import type { Args, VercelPostgresAdapter } from './types.js'
 
@@ -107,7 +107,8 @@ export function vercelPostgresAdapter(args: Args = {}): DatabaseAdapterObj<Verce
       versionsSuffix: args.versionsSuffix || '_v',
 
       // DatabaseAdapter
-      beginTransaction: args.transactionOptions === false ? undefined : beginTransaction,
+      beginTransaction:
+        args.transactionOptions === false ? defaultBeginTransaction() : beginTransaction,
       commitTransaction,
       connect,
       convertPathToJSONTraversal,

packages/payload/src/database/defaultBeginTransaction.ts

@@ -0,0 +1,9 @@
+import type { BeginTransaction } from './types.js'
+
+/**
+ * Default implementation of `beginTransaction` that returns a resolved promise of null
+ */
+export function defaultBeginTransaction(): BeginTransaction {
+  const promiseSingleton: Promise<null> = Promise.resolve(null)
+  return () => promiseSingleton
+}

packages/payload/src/database/types.ts

@@ -9,11 +9,11 @@ export interface BaseDatabaseAdapter {
    * Start a transaction, requiring commitTransaction() to be called for any changes to be made.
    * @returns an identifier for the transaction or null if one cannot be established
    */
-  beginTransaction?: BeginTransaction
+  beginTransaction: BeginTransaction
   /**
    * Persist the changes made since the start of the transaction.
    */
-  commitTransaction?: CommitTransaction
+  commitTransaction: CommitTransaction
 
   /**
    * Open the connection to the database
@@ -116,7 +116,7 @@ export interface BaseDatabaseAdapter {
   /**
    * Abort any changes since the start of the transaction.
    */
-  rollbackTransaction?: RollbackTransaction
+  rollbackTransaction: RollbackTransaction
   /**
    * A key-value store of all sessions open (used for transactions)
    */

packages/payload/src/index.ts

@@ -751,6 +751,7 @@ export { sanitizeConfig } from './config/sanitize.js'
 export type * from './config/types.js'
 export { combineQueries } from './database/combineQueries.js'
 export { createDatabaseAdapter } from './database/createDatabaseAdapter.js'
+export { defaultBeginTransaction } from './database/defaultBeginTransaction.js'
 export { default as flattenWhereToOperators } from './database/flattenWhereToOperators.js'
 export { getLocalizedPaths } from './database/getLocalizedPaths.js'
 export { createMigration } from './database/migrations/createMigration.js'

packages/payload/src/utilities/initTransaction.ts

@@ -25,8 +25,7 @@ export async function initTransaction(req: PayloadRequest): Promise<boolean> {
 
       return transactionID
     })
-    await req.transactionID
-    return !!req.transactionID
+    return !!(await req.transactionID)
   }
   return false
 }