Add support for providing prisma transaction options (#9280)

keystonejs · Aug 12, 2024 · 6bdf320 · 6bdf320
1 parent 3dc6c5a
commit 6bdf320
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 5 deletions.
diff --git a/.changeset/kind-grapes-return.md b/.changeset/kind-grapes-return.md
@@ -0,0 +1,5 @@
+---
+"@keystone-6/core": minor
+---
+
+Adds context.transaction passthrough for prisma $transaction options
diff --git a/examples/custom-output-paths/my-types.ts b/examples/custom-output-paths/my-types.ts
@@ -167,6 +167,7 @@ export type TypeInfo<Session = any> = {
     readonly Post: Lists.Post.TypeInfo<Session>
   }
   prisma: import('./node_modules/.myprisma/client').PrismaClient
+  prismaTypes: import('./node_modules/.myprisma/client').Prisma
   session: Session
 }
 

diff --git a/examples/extend-graphql-schema-nexus/keystone-types.ts b/examples/extend-graphql-schema-nexus/keystone-types.ts
@@ -284,6 +284,7 @@ export type TypeInfo<Session = any> = {
     readonly Author: Lists.Author.TypeInfo<Session>
   }
   prisma: import('./node_modules/.myprisma/client').PrismaClient
+  prismaTypes: import('./node_modules/.myprisma/client').Prisma
   session: Session
 }
 

diff --git a/packages/core/src/lib/context/createContext.ts b/packages/core/src/lib/context/createContext.ts
@@ -97,7 +97,7 @@ export function createContext ({
 
       sudo: () => construct({ prisma, session, sudo: true, req, res }),
 
-      transaction: async (f) => {
+      transaction: async (f, opts) => {
         return await prisma.$transaction(async (prisma_: any) => {
           const newContext = construct({
             prisma: prisma_,
@@ -108,7 +108,7 @@ export function createContext ({
           })
 
           return await f(newContext)
-        })
+        }, opts)
       },
 
       req,

diff --git a/packages/core/src/lib/typescript-schema-printer.ts b/packages/core/src/lib/typescript-schema-printer.ts
@@ -201,6 +201,7 @@ export function printGeneratedTypes (
     })(),
     `  }`,
     `  prisma: import('${prismaClientPath}').PrismaClient`,
+    `  prismaTypes: import('${prismaClientPath}').Prisma`,
     `  session: Session`,
     `}`,
     ``,

diff --git a/packages/core/src/types/context.ts b/packages/core/src/types/context.ts
@@ -15,7 +15,7 @@ import {
   type BaseKeystoneTypeInfo,
   type BaseListTypeInfo,
 } from './type-info'
-import { type MaybePromise } from '../../types'
+import { type MaybePromise } from './utils'
 
 export type KeystoneContext<TypeInfo extends BaseKeystoneTypeInfo = BaseKeystoneTypeInfo> = {
   req?: IncomingMessage
@@ -27,7 +27,14 @@ export type KeystoneContext<TypeInfo extends BaseKeystoneTypeInfo = BaseKeystone
   withSession: (session?: TypeInfo['session']) => KeystoneContext<TypeInfo>
   withRequest: (req: IncomingMessage, res?: ServerResponse) => Promise<KeystoneContext<TypeInfo>>
   prisma: TypeInfo['prisma']
-  transaction: <T>(f: (context: KeystoneContext<TypeInfo>) => MaybePromise<T>) => Promise<T>
+  transaction: <T>(
+    f: (context: KeystoneContext<TypeInfo>) => MaybePromise<T>,
+    options?: {
+      maxWait?: number
+      timeout?: number
+      isolationLevel?: TypeInfo['prismaTypes']['TransactionIsolationLevel']
+    }
+  ) => Promise<T>
 
   files: FilesContext
   images: ImagesContext

diff --git a/packages/core/src/types/type-info.ts b/packages/core/src/types/type-info.ts
@@ -32,5 +32,6 @@ export type KeystoneContextFromListTypeInfo<ListTypeInfo extends BaseListTypeInf
 export type BaseKeystoneTypeInfo<Session = any> = {
   lists: Record<string, BaseListTypeInfo<Session>>
   prisma: any
+  prismaTypes: any
   session: any
 }
diff --git a/packages/core/src/types/type-tests.ts b/packages/core/src/types/type-tests.ts
@@ -8,6 +8,7 @@ const someContext: KeystoneContext<{
     ListOrSingleton: BaseListTypeInfo
   }
   prisma: any
+  prismaTypes: any
   session: any
 }> = undefined!
 

diff --git a/tests/cli-tests/__snapshots__/artifacts.test.ts.snap b/tests/cli-tests/__snapshots__/artifacts.test.ts.snap
@@ -148,6 +148,7 @@ export type TypeInfo<Session = any> = {
     readonly Todo: Lists.Todo.TypeInfo<Session>
   }
   prisma: import('@prisma/client').PrismaClient
+  prismaTypes: import('@prisma/client').Prisma
   session: Session
 }
 
@@ -159,4 +160,4 @@ export type Lists<Session = any> = {
 
 export {}
 
-`
+`;