validateUniquess optional prismaClient parameter (#5763)

* validateUniques optional prismaClient parameter

* update docs: new option for validateUniqueness

* s/prismaClient/db/

* example usage of db option

* tested docs

* docs fine tuning

* test default message still respected when using custom db option

Co-authored-by: Alejandro Frias <[email protected]>

docs/docs/services.md

@@ -645,14 +645,14 @@ So `validateUniqueness()` first tries to find a record with the given fields, an
 > **Why use this when the database can verify uniqueness with a UNIQUE INDEX database constraint?**
 >
 > You may be in a situation where you can't have a unique index (supporting a legacy schema, perhaps), but still want to make sure the data is unique before proceeding. There is also the belief that you shouldn't have to count on the database to validate your data—that's a core concern of your business logic, and your business logic should live in your Services in a Redwood app.
-> 
-> Another issue is that the error raised by Prisma when a record validates a unique index is swallowed by GraphQL and so you can't report it to the user (there are still ways around this, but it involves catching and re-throwing a different error). The error raised by `validateUniqueness()` is already safe-listed and allowed to be sent to the browser. 
+>
+> Another issue is that the error raised by Prisma when a record validates a unique index is swallowed by GraphQL and so you can't report it to the user (there are still ways around this, but it involves catching and re-throwing a different error). The error raised by `validateUniqueness()` is already safe-listed and allowed to be sent to the browser.
 
 #### Arguments
 
 1. The name of the db table accessor that will be checked (what you would call on `db` in a normal Prisma call). If you'd call `db.user` then this value is `"user"`.
 2. An object, containing the db fields/values to check for uniqueness, like `{ email: '[email protected]' }`. Can also include additional options explained below that provide for a narrower scope for uniqueness requirements, and a way for the record to identify itself and not create a false positive for an existing record.
-3. [Optional] An object with options.
+3. [Optional] An object with options. `message` - custom error message. `db` - custom instance of the PrismaClient to use
 4. Callback to be invoked if record is found to be unique.
 
 In its most basic usage, say you want to make sure that a user's email address is unique before creating the record. `input` is an object containing all the user fields to save to the database, including `email` which must be unique:
@@ -677,6 +677,21 @@ const createUser = (input) => {
 }
 ```
 
+You can provide the PrismaClient to be used for the transaction and callback.
+```jsx
+import { db } from 'src/lib/db'
+
+const createUser = (input) => {
+  return validateUniqueness('user',
+    { email: input.email },
+    { db },
+    (db) => db.user.create({ data: input })
+  )
+}
+```
+
+> If you are overwriting the DATABASE_URL in your `src/lib/db` instantiation of the PrismaClient, you need to use this option. If not provided, a vanilla `new PrismaClient()` is used to run the callback that will not respect any custom configurations not represented in your `prisma.schema`
+
 Be sure that both your callback and the surrounding `validateUniqueness()` function are `return`ed or else your service function will have nothing to return to its consumers, like GraphQL.
 
 ##### $self

packages/api/src/validations/__tests__/validations.test.js

@@ -1144,4 +1144,34 @@ describe('validateUniqueness', () => {
     }
     expect.assertions(1)
   })
+
+  it('uses the given prisma client', async () => {
+    const mockFindFirstOther = jest.fn()
+    mockFindFirstOther.mockImplementation(() => ({
+      id: 2,
+      email: '[email protected]',
+    }))
+    const mockPrismaClient = {
+      $transaction: async (func) =>
+        func({
+          user: {
+            findFirst: mockFindFirstOther,
+          },
+        }),
+    }
+
+    expect(mockFindFirstOther).not.toBeCalled()
+
+    await expect(
+      validateUniqueness(
+        'user',
+        { email: '[email protected]' },
+        { db: mockPrismaClient },
+        () => {}
+      )
+    ).rejects.toThrowError('email must be unique')
+
+    expect(mockFindFirstOther).toBeCalled()
+    expect(mockFindFirst).not.toBeCalled()
+  })
 })

packages/api/src/validations/validations.ts

@@ -143,7 +143,9 @@ interface PresenceValidatorOptions extends WithOptionalMessage {
   allowEmptyString?: boolean
 }
 
-interface UniquenessValidatorOptions extends WithRequiredMessage {}
+interface UniquenessValidatorOptions extends WithOptionalMessage {
+  db?: PrismaClient
+}
 type UniquenessWhere = Record<'AND' | 'NOT', Array<Record<string, unknown>>>
 
 interface ValidationRecipe {
@@ -612,6 +614,18 @@ export const validateWith = (func: () => void) => {
 // }, (db) => {
 //   return db.create(data: { email })
 // })
+//
+// const myCustomDb = new PrismaClient({
+//   log: emitLogLevels(['info', 'warn', 'error']),
+//   datasources: {
+//     db: {
+//       url: process.env.DATABASE_URL,
+//     },
+//   },
+// })
+// return validateUniqueness('user', { email: 'rob@redwoodjs.com' }, { prismaClient: myCustomDb}, (db) => {
+//   return db.create(data: { email })
+// })
 export async function validateUniqueness(
   model: string,
   fields: Record<string, unknown>,
@@ -632,10 +646,10 @@ export async function validateUniqueness(
     | ((tx: PrismaClient) => Promise<any>),
   callback?: (tx: PrismaClient) => Promise<any>
 ): Promise<any> {
-  const db = new PrismaClient()
   const { $self, $scope, ...rest } = fields
-  let options = {}
+  let options: UniquenessValidatorOptions = {}
   let validCallback: (tx: PrismaClient) => Promise<any>
+  let db = null
 
   if (typeof optionsOrCallback === 'function') {
     validCallback = optionsOrCallback
@@ -644,6 +658,14 @@ export async function validateUniqueness(
     validCallback = callback as (tx: PrismaClient) => Promise<any>
   }
 
+  if (options.db) {
+    const { db: customDb, ...restOptions } = options
+    options = restOptions
+    db = customDb
+  } else {
+    db = new PrismaClient()
+  }
+
   const where: UniquenessWhere = {
     AND: [rest],
     NOT: [],