fix: join field works on collections with versions enabled (#8715)

- Fixes errors with drizzle when building the schema
#8680
- Adds `joins` to `db.queryDrafts` to have them when doing `.find` with
`draft: true`

Author: r1tsuu

packages/db-mongodb/src/queryDrafts.ts

@@ -6,12 +6,23 @@ import { combineQueries, flattenWhereToOperators } from 'payload'
 import type { MongooseAdapter } from './index.js'
 
 import { buildSortParam } from './queries/buildSortParam.js'
+import { buildJoinAggregation } from './utilities/buildJoinAggregation.js'
 import { sanitizeInternalFields } from './utilities/sanitizeInternalFields.js'
 import { withSession } from './withSession.js'
 
 export const queryDrafts: QueryDrafts = async function queryDrafts(
   this: MongooseAdapter,
-  { collection, limit, locale, page, pagination, req = {} as PayloadRequest, sort: sortArg, where },
+  {
+    collection,
+    joins,
+    limit,
+    locale,
+    page,
+    pagination,
+    req = {} as PayloadRequest,
+    sort: sortArg,
+    where,
+  },
 ) {
   const VersionModel = this.versions[collection]
   const collectionConfig = this.payload.collections[collection].config
@@ -89,7 +100,29 @@ export const queryDrafts: QueryDrafts = async function queryDrafts(
     paginationOptions.options.limit = limit
   }
 
-  const result = await VersionModel.paginate(versionQuery, paginationOptions)
+  let result
+
+  const aggregate = await buildJoinAggregation({
+    adapter: this,
+    collection,
+    collectionConfig,
+    joins,
+    limit,
+    locale,
+    query: versionQuery,
+    versions: true,
+  })
+
+  // build join aggregation
+  if (aggregate) {
+    result = await VersionModel.aggregatePaginate(
+      VersionModel.aggregate(aggregate),
+      paginationOptions,
+    )
+  } else {
+    result = await VersionModel.paginate(versionQuery, paginationOptions)
+  }
+
   const docs = JSON.parse(JSON.stringify(result.docs))
 
   return {

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

@@ -15,6 +15,8 @@ type BuildJoinAggregationArgs = {
   locale: string
   // the where clause for the top collection
   query?: Where
+  /** whether the query is from drafts */
+  versions?: boolean
 }
 
 export const buildJoinAggregation = async ({
@@ -25,6 +27,7 @@ export const buildJoinAggregation = async ({
   limit,
   locale,
   query,
+  versions,
 }: BuildJoinAggregationArgs): Promise<PipelineStage[] | undefined> => {
   if (Object.keys(collectionConfig.joins).length === 0 || joins === false) {
     return
@@ -90,15 +93,15 @@ export const buildJoinAggregation = async ({
 
       if (adapter.payload.config.localization && locale === 'all') {
         adapter.payload.config.localization.localeCodes.forEach((code) => {
-          const as = `${join.schemaPath}${code}`
+          const as = `${versions ? `version.${join.schemaPath}` : join.schemaPath}${code}`
 
           aggregate.push(
             {
               $lookup: {
                 as: `${as}.docs`,
                 foreignField: `${join.field.on}${code}`,
                 from: slug,
-                localField: '_id',
+                localField: versions ? 'parent' : '_id',
                 pipeline,
               },
             },
@@ -131,15 +134,15 @@ export const buildJoinAggregation = async ({
       } else {
         const localeSuffix =
           join.field.localized && adapter.payload.config.localization && locale ? `.${locale}` : ''
-        const as = `${join.schemaPath}${localeSuffix}`
+        const as = `${versions ? `version.${join.schemaPath}` : join.schemaPath}${localeSuffix}`
 
         aggregate.push(
           {
             $lookup: {
               as: `${as}.docs`,
               foreignField: `${join.field.on}${localeSuffix}`,
               from: slug,
-              localField: '_id',
+              localField: versions ? 'parent' : '_id',
               pipeline,
             },
           },

packages/db-sqlite/src/init.ts

@@ -70,7 +70,6 @@ export const init: Init = async function init(this: SQLiteAdapter) {
       disableNotNull: !!collection?.versions?.drafts,
       disableUnique: false,
       fields: collection.fields,
-      joins: collection.joins,
       locales,
       tableName,
       timestamps: collection.timestamps,

packages/db-sqlite/src/schema/build.ts

@@ -61,7 +61,6 @@ type Args = {
   disableRelsTableUnique?: boolean
   disableUnique: boolean
   fields: Field[]
-  joins?: SanitizedJoins
   locales?: [string, ...string[]]
   rootRelationships?: Set<string>
   rootRelationsToBuild?: RelationMap
@@ -95,7 +94,6 @@ export const buildTable = ({
   disableRelsTableUnique,
   disableUnique = false,
   fields,
-  joins,
   locales,
   rootRelationships,
   rootRelationsToBuild,
@@ -144,7 +142,6 @@ export const buildTable = ({
     disableUnique,
     fields,
     indexes,
-    joins,
     locales,
     localesColumns,
     localesIndexes,

packages/db-sqlite/src/schema/traverseFields.ts

@@ -44,7 +44,6 @@ type Args = {
   fields: (Field | TabAsField)[]
   forceLocalized?: boolean
   indexes: Record<string, (cols: GenericColumns) => IndexBuilder>
-  joins?: SanitizedJoins
   locales: [string, ...string[]]
   localesColumns: Record<string, SQLiteColumnBuilder>
   localesIndexes: Record<string, (cols: GenericColumns) => IndexBuilder>
@@ -84,7 +83,6 @@ export const traverseFields = ({
   fields,
   forceLocalized,
   indexes,
-  joins,
   locales,
   localesColumns,
   localesIndexes,
@@ -669,7 +667,6 @@ export const traverseFields = ({
             fields: field.fields,
             forceLocalized,
             indexes,
-            joins,
             locales,
             localesColumns,
             localesIndexes,
@@ -725,7 +722,6 @@ export const traverseFields = ({
           fields: field.fields,
           forceLocalized: field.localized,
           indexes,
-          joins,
           locales,
           localesColumns,
           localesIndexes,
@@ -782,7 +778,6 @@ export const traverseFields = ({
           fields: field.tabs.map((tab) => ({ ...tab, type: 'tab' })),
           forceLocalized,
           indexes,
-          joins,
           locales,
           localesColumns,
           localesIndexes,
@@ -839,7 +834,6 @@ export const traverseFields = ({
           fields: field.fields,
           forceLocalized,
           indexes,
-          joins,
           locales,
           localesColumns,
           localesIndexes,
@@ -937,30 +931,6 @@ export const traverseFields = ({
 
         break
 
-      case 'join': {
-        // fieldName could be 'posts' or 'group_posts'
-        // using `on` as the key for the relation
-        const localized = adapter.payload.config.localization && field.localized
-        const fieldSchemaPath = `${fieldPrefix || ''}${field.name}`
-        let target: string
-        const joinConfig = joins[field.collection].find(
-          ({ schemaPath }) => fieldSchemaPath === schemaPath,
-        )
-        if (joinConfig.targetField.hasMany) {
-          target = `${adapter.tableNameMap.get(toSnakeCase(field.collection))}${adapter.relationshipsSuffix}`
-        } else {
-          target = `${adapter.tableNameMap.get(toSnakeCase(field.collection))}${localized ? adapter.localesSuffix : ''}`
-        }
-        relationsToBuild.set(fieldName, {
-          type: 'many',
-          // joins are not localized on the parent table
-          localized: false,
-          relationName: field.on.replaceAll('.', '_'),
-          target,
-        })
-        break
-      }
-
       default:
         break
     }

packages/drizzle/src/find/buildFindManyArgs.ts

@@ -16,6 +16,7 @@ type BuildFindQueryArgs = {
   joins?: BuildQueryJoinAliases
   locale?: string
   tableName: string
+  versions?: boolean
 }
 
 export type Result = {
@@ -34,6 +35,7 @@ export const buildFindManyArgs = ({
   joins = [],
   locale,
   tableName,
+  versions,
 }: BuildFindQueryArgs): Record<string, unknown> => {
   const result: Result = {
     extras: {},
@@ -97,6 +99,7 @@ export const buildFindManyArgs = ({
     tablePath: '',
     topLevelArgs: result,
     topLevelTableName: tableName,
+    versions,
   })
 
   return result

packages/drizzle/src/find/findMany.ts

@@ -14,6 +14,7 @@ type Args = {
   adapter: DrizzleAdapter
   fields: Field[]
   tableName: string
+  versions?: boolean
 } & Omit<FindArgs, 'collection'>
 
 export const findMany = async function find({
@@ -28,6 +29,7 @@ export const findMany = async function find({
   skip,
   sort,
   tableName,
+  versions,
   where: whereArg,
 }: Args) {
   const db = adapter.sessions[await req.transactionID]?.db || adapter.drizzle
@@ -71,6 +73,7 @@ export const findMany = async function find({
     joinQuery,
     joins,
     tableName,
+    versions,
   })
 
   selectDistinctMethods.push({ args: [offset], method: 'offset' })