fix: hasMany / polymorphic relationships to custom number IDs (#14201)

Fixes #14197
Ensures that any numeric column is sanitized to a number JS type on
Drizzle side
Properly converts `BigInt` relationship values if
`useBigIntForNumberIDs: true` is passed to the mongodb adapter (e.g
`compatibilityOptions.firestore`)

Author: r1tsuu

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

@@ -38,6 +38,7 @@ const processRelationshipValues = (
   config: SanitizedConfig,
   operation: 'read' | 'write',
   validateRelationships: boolean,
+  adapter: MongooseAdapter,
 ) => {
   return items.map((item) => {
     // Handle polymorphic relationships
@@ -47,6 +48,7 @@ const processRelationshipValues = (
         return {
           relationTo: item.relationTo,
           value: convertRelationshipValue({
+            adapter,
             operation,
             relatedCollection,
             validateRelationships,
@@ -62,6 +64,7 @@ const processRelationshipValues = (
       const relatedCollection = config.collections?.find(({ slug }) => slug === field.relationTo)
       if (relatedCollection) {
         return convertRelationshipValue({
+          adapter,
           operation,
           relatedCollection,
           validateRelationships,
@@ -75,11 +78,13 @@ const processRelationshipValues = (
 }
 
 const convertRelationshipValue = ({
+  adapter,
   operation,
   relatedCollection,
   validateRelationships,
   value,
 }: {
+  adapter: MongooseAdapter
   operation: Args['operation']
   relatedCollection: CollectionConfig
   validateRelationships?: boolean
@@ -94,6 +99,14 @@ const convertRelationshipValue = ({
       return value.toHexString()
     }
 
+    if (
+      customIDField?.type === 'number' &&
+      typeof value === 'bigint' &&
+      adapter.useBigIntForNumberIDs
+    ) {
+      return Number(value)
+    }
+
     return value
   }
 
@@ -116,6 +129,7 @@ const convertRelationshipValue = ({
 }
 
 const sanitizeRelationship = ({
+  adapter,
   config,
   field,
   locale,
@@ -124,6 +138,7 @@ const sanitizeRelationship = ({
   validateRelationships,
   value,
 }: {
+  adapter: MongooseAdapter
   config: SanitizedConfig
   field: JoinField | RelationshipField | UploadField
   locale?: string
@@ -175,6 +190,7 @@ const sanitizeRelationship = ({
           return {
             relationTo: val.relationTo,
             value: convertRelationshipValue({
+              adapter,
               operation,
               relatedCollection: relatedCollectionForSingleValue,
               validateRelationships,
@@ -186,6 +202,7 @@ const sanitizeRelationship = ({
 
       if (relatedCollection) {
         return convertRelationshipValue({
+          adapter,
           operation,
           relatedCollection,
           validateRelationships,
@@ -204,6 +221,7 @@ const sanitizeRelationship = ({
       result = {
         relationTo: value.relationTo,
         value: convertRelationshipValue({
+          adapter,
           operation,
           relatedCollection,
           validateRelationships,
@@ -215,6 +233,7 @@ const sanitizeRelationship = ({
   // Handle has one
   else if (relatedCollection) {
     result = convertRelationshipValue({
+      adapter,
       operation,
       relatedCollection,
       validateRelationships,
@@ -657,6 +676,7 @@ export const transform = ({
                 config,
                 operation,
                 validateRelationships,
+                adapter,
               )
               $addToSet[`${parentPath}${field.name}.${localeKey}`] = { $each: processedLocaleItems }
             }
@@ -675,6 +695,7 @@ export const transform = ({
             config,
             operation,
             validateRelationships,
+            adapter,
           )
           $addToSet[`${parentPath}${field.name}`] = { $each: processedItems }
           delete ref[field.name]
@@ -721,6 +742,7 @@ export const transform = ({
                 config,
                 operation,
                 validateRelationships,
+                adapter,
               )
               $pull[`${parentPath}${field.name}.${localeKey}`] = { $in: processedLocaleItems }
             }
@@ -739,6 +761,7 @@ export const transform = ({
             config,
             operation,
             validateRelationships,
+            adapter,
           )
           $pull[`${parentPath}${field.name}`] = { $in: processedItems }
           delete ref[field.name]
@@ -792,6 +815,7 @@ export const transform = ({
           const value = fieldRef[code]
           if (value) {
             sanitizeRelationship({
+              adapter,
               config,
               field,
               locale: code,
@@ -805,6 +829,7 @@ export const transform = ({
       } else {
         // handle non-localized relationships
         sanitizeRelationship({
+          adapter,
           config,
           field,
           locale: undefined,

packages/drizzle/src/postgres/columnToCodeConverter.ts

@@ -34,6 +34,10 @@ export const columnToCodeConverter: ColumnToCodeConverter = ({
       }
       break
     }
+    case 'numeric': {
+      columnBuilderArgsArray.push("mode: 'number'")
+      break
+    }
     case 'timestamp': {
       columnBuilderArgsArray.push(`mode: '${column.mode}'`)
       if (column.withTimezone) {

packages/drizzle/src/postgres/schema/buildDrizzleTable.ts

@@ -74,6 +74,11 @@ export const buildDrizzleTable = ({
         break
       }
 
+      case 'numeric': {
+        columns[key] = numeric(column.name, { mode: 'number' })
+        break
+      }
+
       case 'sparsevec': {
         const builder = sparsevec(column.name, { dimensions: column.dimensions })
 

packages/drizzle/src/sqlite/columnToCodeConverter.ts

@@ -44,6 +44,11 @@ export const columnToCodeConverter: ColumnToCodeConverter = ({
       break
     }
 
+    case 'numeric': {
+      columnBuilderArgsArray.push("mode: 'number'")
+      break
+    }
+
     case 'serial': {
       columnBuilderFn = 'integer'
       break

packages/drizzle/src/sqlite/schema/buildDrizzleTable.ts

@@ -44,6 +44,11 @@ export const buildDrizzleTable: BuildDrizzleTable = ({ adapter, locales, rawTabl
         break
       }
 
+      case 'numeric': {
+        columns[key] = numeric(column.name, { mode: 'number' })
+        break
+      }
+
       case 'serial': {
         columns[key] = integer(column.name)
         break

test/database/getConfig.ts

@@ -147,6 +147,12 @@ export const getConfig: () => Partial<Config> = () => ({
           hasMany: true,
           name: 'categories',
         },
+        {
+          type: 'relationship',
+          relationTo: 'categories-custom-id',
+          hasMany: true,
+          name: 'categoriesCustomID',
+        },
         {
           type: 'relationship',
           relationTo: ['categories'],

test/database/int.spec.ts

@@ -212,6 +212,18 @@ describe('database', () => {
       expect(duplicate.arrayWithIDs[0].id).not.toStrictEqual(arrayRowID)
       expect(duplicate.blocksWithIDs[0].id).not.toStrictEqual(blockID)
     })
+
+    it('should properly give the result with hasMany relationships with custom numeric IDs', async () => {
+      await payload.create({ collection: 'categories-custom-id', data: { id: 9999 } })
+      const res = await payload.create({
+        collection: 'posts',
+        data: { title: 'post', categoriesCustomID: [9999] },
+        depth: 0,
+      })
+      expect(res.categoriesCustomID[0]).toBe(9999)
+      const resFind = await payload.findByID({ collection: 'posts', id: res.id, depth: 0 })
+      expect(resFind.categoriesCustomID[0]).toBe(9999)
+    })
   })
 
   describe('timestamps', () => {