fix: respect draft: true when querying docs for the join field (#11763)

Previously, if you were querying a collection that has a join field with
`draft: true`, and the join field's collection also has
`versions.drafts: true` our db adapter would still query the original
SQL table / mongodb collection instead of the versions one which isn't
quite right since we respect `draft: true` when populating relationships

Author: r1tsuu

packages/db-mongodb/src/find.ts

@@ -18,6 +18,7 @@ export const find: Find = async function find(
   this: MongooseAdapter,
   {
     collection: collectionSlug,
+    draftsEnabled,
     joins = {},
     limit = 0,
     locale,
@@ -128,6 +129,7 @@ export const find: Find = async function find(
     adapter: this,
     collection: collectionSlug,
     collectionConfig,
+    draftsEnabled,
     joins,
     locale,
     query,

packages/db-mongodb/src/findOne.ts

@@ -14,7 +14,7 @@ import { transform } from './utilities/transform.js'
 
 export const findOne: FindOne = async function findOne(
   this: MongooseAdapter,
-  { collection: collectionSlug, joins, locale, req, select, where = {} },
+  { collection: collectionSlug, draftsEnabled, joins, locale, req, select, where = {} },
 ) {
   const { collectionConfig, Model } = getCollection({ adapter: this, collectionSlug })
 
@@ -42,6 +42,7 @@ export const findOne: FindOne = async function findOne(
     adapter: this,
     collection: collectionSlug,
     collectionConfig,
+    draftsEnabled,
     joins,
     locale,
     projection,

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

@@ -2,14 +2,19 @@ import type { PipelineStage } from 'mongoose'
 
 import {
   APIError,
+  appendVersionToQueryKey,
+  buildVersionCollectionFields,
   type CollectionSlug,
+  combineQueries,
   type FlattenedField,
+  getQueryDraftsSort,
   type JoinQuery,
   type SanitizedCollectionConfig,
 } from 'payload'
 import { fieldShouldBeLocalized } from 'payload/shared'
 
 import type { MongooseAdapter } from '../index.js'
+import type { CollectionModel } from '../types.js'
 
 import { buildQuery } from '../queries/buildQuery.js'
 import { buildSortParam } from '../queries/buildSortParam.js'
@@ -19,6 +24,7 @@ type BuildJoinAggregationArgs = {
   adapter: MongooseAdapter
   collection: CollectionSlug
   collectionConfig: SanitizedCollectionConfig
+  draftsEnabled?: boolean
   joins?: JoinQuery
   locale?: string
   projection?: Record<string, true>
@@ -32,6 +38,7 @@ export const buildJoinAggregation = async ({
   adapter,
   collection,
   collectionConfig,
+  draftsEnabled,
   joins,
   locale,
   projection,
@@ -262,10 +269,27 @@ export const buildJoinAggregation = async ({
         continue
       }
 
-      const { collectionConfig, Model: JoinModel } = getCollection({
-        adapter,
-        collectionSlug: join.field.collection as string,
-      })
+      const collectionConfig = adapter.payload.collections[join.field.collection as string]?.config
+
+      if (!collectionConfig) {
+        throw new APIError(
+          `Collection config for ${join.field.collection.toString()} was not found`,
+        )
+      }
+
+      let JoinModel: CollectionModel | undefined
+
+      const useDrafts = (draftsEnabled || versions) && Boolean(collectionConfig.versions.drafts)
+
+      if (useDrafts) {
+        JoinModel = adapter.versions[collectionConfig.slug]
+      } else {
+        JoinModel = adapter.collections[collectionConfig.slug]
+      }
+
+      if (!JoinModel) {
+        throw new APIError(`Join Model was not found for ${collectionConfig.slug}`)
+      }
 
       const {
         count,
@@ -279,12 +303,16 @@ export const buildJoinAggregation = async ({
         throw new Error('Unreachable')
       }
 
+      const fields = useDrafts
+        ? buildVersionCollectionFields(adapter.payload.config, collectionConfig, true)
+        : collectionConfig.flattenedFields
+
       const sort = buildSortParam({
         adapter,
         config: adapter.payload.config,
-        fields: collectionConfig.flattenedFields,
+        fields,
         locale,
-        sort: sortJoin,
+        sort: useDrafts ? getQueryDraftsSort({ collectionConfig, sort: sortJoin }) : sortJoin,
         timestamps: true,
       })
       const sortProperty = Object.keys(sort)[0]!
@@ -293,7 +321,13 @@ export const buildJoinAggregation = async ({
       const $match = await JoinModel.buildQuery({
         locale,
         payload: adapter.payload,
-        where: whereJoin,
+        where: useDrafts
+          ? combineQueries(appendVersionToQueryKey(whereJoin), {
+              latest: {
+                equals: true,
+              },
+            })
+          : whereJoin,
       })
 
       const pipeline: Exclude<PipelineStage, PipelineStage.Merge | PipelineStage.Out>[] = [
@@ -345,6 +379,12 @@ export const buildJoinAggregation = async ({
           },
         )
 
+      let foreignFieldPrefix = ''
+
+      if (useDrafts) {
+        foreignFieldPrefix = 'version.'
+      }
+
       if (adapter.payload.config.localization && locale === 'all') {
         adapter.payload.config.localization.localeCodes.forEach((code) => {
           const as = `${versions ? `version.${join.joinPath}` : join.joinPath}${code}`
@@ -353,7 +393,7 @@ export const buildJoinAggregation = async ({
             {
               $lookup: {
                 as: `${as}.docs`,
-                foreignField: `${join.field.on}${code}${polymorphicSuffix}`,
+                foreignField: `${foreignFieldPrefix}${join.field.on}${code}${polymorphicSuffix}`,
                 from: JoinModel.collection.name,
                 localField: versions ? 'parent' : '_id',
                 pipeline,
@@ -364,7 +404,7 @@ export const buildJoinAggregation = async ({
                 [`${as}.docs`]: {
                   $map: {
                     as: 'doc',
-                    in: '$$doc._id',
+                    in: useDrafts ? `$$doc.parent` : '$$doc._id',
                     input: `$${as}.docs`,
                   },
                 }, // Slicing the docs to match the limit
@@ -387,7 +427,10 @@ export const buildJoinAggregation = async ({
           }
 
           if (count) {
-            addTotalDocsAggregation(as, `${join.field.on}${code}${polymorphicSuffix}`)
+            addTotalDocsAggregation(
+              as,
+              `${foreignFieldPrefix}${join.field.on}${code}${polymorphicSuffix}`,
+            )
           }
         })
       } else {
@@ -414,7 +457,7 @@ export const buildJoinAggregation = async ({
           {
             $lookup: {
               as: `${as}.docs`,
-              foreignField,
+              foreignField: `${foreignFieldPrefix}${foreignField}`,
               from: JoinModel.collection.name,
               localField: versions ? 'parent' : '_id',
               pipeline,
@@ -425,7 +468,7 @@ export const buildJoinAggregation = async ({
               [`${as}.docs`]: {
                 $map: {
                   as: 'doc',
-                  in: '$$doc._id',
+                  in: useDrafts ? `$$doc.parent` : '$$doc._id',
                   input: `$${as}.docs`,
                 },
               }, // Slicing the docs to match the limit
@@ -437,7 +480,7 @@ export const buildJoinAggregation = async ({
         )
 
         if (count) {
-          addTotalDocsAggregation(as, foreignField)
+          addTotalDocsAggregation(as, `${foreignFieldPrefix}${foreignField}`)
         }
 
         if (limitJoin > 0) {

packages/drizzle/src/find.ts

@@ -8,7 +8,19 @@ import { findMany } from './find/findMany.js'
 
 export const find: Find = async function find(
   this: DrizzleAdapter,
-  { collection, joins, limit, locale, page = 1, pagination, req, select, sort: sortArg, where },
+  {
+    collection,
+    draftsEnabled,
+    joins,
+    limit,
+    locale,
+    page = 1,
+    pagination,
+    req,
+    select,
+    sort: sortArg,
+    where,
+  },
 ) {
   const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config
   const sort = sortArg !== undefined && sortArg !== null ? sortArg : collectionConfig.defaultSort
@@ -18,6 +30,7 @@ export const find: Find = async function find(
   return findMany({
     adapter: this,
     collectionSlug: collectionConfig.slug,
+    draftsEnabled,
     fields: collectionConfig.flattenedFields,
     joins,
     limit,

packages/drizzle/src/find/buildFindManyArgs.ts

@@ -11,6 +11,7 @@ type BuildFindQueryArgs = {
   adapter: DrizzleAdapter
   collectionSlug?: string
   depth: number
+  draftsEnabled?: boolean
   fields: FlattenedField[]
   joinQuery?: JoinQuery
   /**
@@ -35,6 +36,7 @@ export const buildFindManyArgs = ({
   adapter,
   collectionSlug,
   depth,
+  draftsEnabled,
   fields,
   joinQuery,
   joins = [],
@@ -80,6 +82,7 @@ export const buildFindManyArgs = ({
     currentArgs: result,
     currentTableName: tableName,
     depth,
+    draftsEnabled,
     fields,
     joinQuery,
     joins,

packages/drizzle/src/find/findMany.ts

@@ -22,6 +22,7 @@ type Args = {
 export const findMany = async function find({
   adapter,
   collectionSlug,
+  draftsEnabled,
   fields,
   joins: joinQuery,
   limit: limitArg,
@@ -74,6 +75,7 @@ export const findMany = async function find({
     adapter,
     collectionSlug,
     depth: 0,
+    draftsEnabled,
     fields,
     joinQuery,
     joins,