@payloadcms/drizzle 4.0.0-internal.9496957 → 4.0.0-internal.952ed66

package/dist/queries/getTableColumnFromPath.js

@@ -1,5 +1,5 @@
-import { and, eq, getTableName, like, sql } from 'drizzle-orm';
-import { APIError, getFieldByPath } from 'payload';
+import { and, eq, getTableName, isNull, like, notInArray, or, sql } from 'drizzle-orm';
+import { APIError, getBranchPredicateSync, getFieldByPath, resolveBranchReadState } from 'payload';
 import { fieldShouldBeLocalized, tabHasName } from 'payload/shared';
 import toSnakeCase from 'to-snake-case';
 import { validate as uuidValidate } from 'uuid';
@@ -9,8 +9,77 @@ import { jsonBuildObject } from '../utilities/json.js';
 import { DistinctSymbol } from '../utilities/rawConstraint.js';
 import { resolveBlockTableName } from '../utilities/validateExistingBlockIsIdentical.js';
 import { addJoinTable } from './addJoinTable.js';
+import { buildBranchVisibility } from './buildBranchVisibility.js';
 import { getTableAlias } from './getTableAlias.js';
 import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRelationshipPath.js';
+const getRelationshipJoinCondition = ({ adapter, collectionSlug, relationshipID, req, table, value })=>{
+    const branchReadState = resolveBranchReadState({
+        collectionSlug,
+        req
+    });
+    const branchPredicate = branchReadState.useBranching ? null : getBranchPredicateSync({
+        collectionSlug,
+        req
+    });
+    const shouldMatchCanonicalID = Boolean(table._branchDocID && (branchReadState.useBranching || branchPredicate || value === DistinctSymbol));
+    const identityCondition = shouldMatchCanonicalID ? or(eq(table.id, relationshipID), eq(table._branchDocID, relationshipID)) : eq(table.id, relationshipID);
+    const branchCondition = getBranchTableCondition({
+        adapter,
+        collectionSlug,
+        req,
+        table
+    });
+    return branchCondition ? and(identityCondition, branchCondition) : identityCondition;
+};
+const getBranchTableCondition = ({ adapter, collectionSlug, req, table })=>{
+    const branchReadState = resolveBranchReadState({
+        collectionSlug,
+        req
+    });
+    if (branchReadState.useBranching) {
+        return buildBranchVisibility({
+            adapter,
+            branch: branchReadState.branch,
+            collectionSlug,
+            table
+        });
+    }
+    const branchPredicate = getBranchPredicateSync({
+        collectionSlug,
+        req
+    });
+    return branchPredicate ? buildBranchPredicateCondition({
+        table,
+        where: branchPredicate
+    }) : undefined;
+};
+const buildBranchPredicateCondition = ({ table, where })=>{
+    const conditions = [];
+    for (const [fieldName, condition] of Object.entries(where)){
+        if ((fieldName === 'and' || fieldName === 'or') && Array.isArray(condition)) {
+            const nestedConditions = condition.map((nestedWhere)=>buildBranchPredicateCondition({
+                    table,
+                    where: nestedWhere
+                })).filter((nestedCondition)=>Boolean(nestedCondition));
+            const nestedResult = fieldName === 'and' ? and(...nestedConditions) : or(...nestedConditions);
+            if (nestedResult) {
+                conditions.push(nestedResult);
+            }
+            continue;
+        }
+        const column = table[fieldName];
+        if (!column || !condition || typeof condition !== 'object') {
+            continue;
+        }
+        if ('equals' in condition) {
+            conditions.push(condition.equals === null ? isNull(column) : eq(column, condition.equals));
+        }
+        if ('not_in' in condition && Array.isArray(condition.not_in) && condition.not_in.length > 0) {
+            conditions.push(notInArray(column, condition.not_in));
+        }
+    }
+    return conditions.length === 1 ? conditions[0] : and(...conditions);
+};
 /**
  * Resolves a field path to the database table and column that store its value.
  *
@@ -22,7 +91,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
  * to the `movies` table. The returned column is `movies.name`.
  *
  * @returns The final field and column, plus any extra constraints discovered while resolving it.
- */ export const getTableColumnFromPath = ({ adapter, aliasTable, collectionPath, columnPrefix = '', constraintPath: incomingConstraintPath, constraints = [], fields, joins, locale: incomingLocale, parentAliasTable, parentIsLocalized, pathSegments: incomingSegments, rootTableName: incomingRootTableName, selectFields, selectLocale, tableName, tableNameSuffix = '', value })=>{
+ */ export const getTableColumnFromPath = ({ adapter, aliasTable, collectionPath, columnPrefix = '', constraintPath: incomingConstraintPath, constraints = [], fields, joins, locale: incomingLocale, parentAliasTable, parentIsLocalized, pathSegments: incomingSegments, req, rootTableName: incomingRootTableName, selectFields, selectLocale, tableName, tableNameSuffix = '', value })=>{
     const fieldPath = incomingSegments[0];
     let locale = incomingLocale;
     const rootTableName = incomingRootTableName || tableName;
@@ -31,7 +100,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
     const field = fields.find((fieldToFind)=>fieldToFind.name === fieldPath);
     let newTableName = tableName;
     if (!field && fieldPath === 'id') {
-        selectFields.id = adapter.tables[newTableName].id;
+        const idTable = aliasTable ?? adapter.tables[newTableName];
         return {
             columnName: 'id',
             constraints,
@@ -39,7 +108,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                 name: 'id',
                 type: isUUIDType(adapter.idType) ? 'text' : 'number'
             },
-            table: adapter.tables[newTableName]
+            table: idTable
         };
     }
     let localizedPathQuery = false;
@@ -106,6 +175,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                         parentAliasTable: aliasTable,
                         parentIsLocalized: parentIsLocalized || field.localized,
                         pathSegments: pathSegments.slice(1),
+                        req,
                         rootTableName,
                         selectFields,
                         selectLocale,
@@ -189,6 +259,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                                 locale,
                                 parentIsLocalized: parentIsLocalized || field.localized,
                                 pathSegments: pathSegments.slice(1),
+                                req,
                                 rootTableName,
                                 selectFields: blockSelectFields,
                                 selectLocale,
@@ -255,6 +326,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                         locale,
                         parentIsLocalized: parentIsLocalized || field.localized,
                         pathSegments: pathSegments.slice(1),
+                        req,
                         rootTableName,
                         selectFields,
                         selectLocale,
@@ -269,6 +341,15 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                         throw new APIError('Not supported');
                     }
                     const newCollectionPath = pathSegments.slice(1).join('.');
+                    // Filtering through a polymorphic `on` relationship is not supported: it is stored in the
+                    // `_rels` table with no direct column to correlate on, which would otherwise build invalid SQL.
+                    const onRelationshipField = getFieldByPath({
+                        fields: adapter.payload.collections[field.collection].config.flattenedFields,
+                        path: field.on
+                    })?.field;
+                    if (onRelationshipField && (onRelationshipField.type === 'relationship' || onRelationshipField.type === 'upload') && Array.isArray(onRelationshipField.relationTo)) {
+                        throw new APIError('Not supported');
+                    }
                     if (field.hasMany) {
                         const relationTableName = `${adapter.tableNameMap.get(toSnakeCase(field.collection))}${adapter.relationshipsSuffix}`;
                         const existingTable = joins.find((e)=>e.queryPath === `${constraintPath}${field.name}._rels`);
@@ -312,8 +393,15 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                             tableName: relationshipTableName
                         }).newAliasTable;
                         if (!existingMainTable) {
+                            const branchCondition = getBranchTableCondition({
+                                adapter,
+                                collectionSlug: field.collection,
+                                req,
+                                table: relationshipTable
+                            });
+                            const relationshipCondition = eq(aliasRelationshipTable.parent, relationshipTable.id);
                             joins.push({
-                                condition: eq(aliasRelationshipTable.parent, relationshipTable.id),
+                                condition: branchCondition ? and(relationshipCondition, branchCondition) : relationshipCondition,
                                 queryPath: `${constraintPath}${field.name}`,
                                 table: relationshipTable
                             });
@@ -329,6 +417,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                             // A join reads from a different collection, so localization does not carry over
                             parentIsLocalized: false,
                             pathSegments: pathSegments.slice(1),
+                            req,
                             rootTableName: relationshipTableName,
                             selectFields,
                             selectLocale,
@@ -359,13 +448,29 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                                 table: arrayAliasTable
                             });
                             joins.push({
-                                condition: eq(newAliasTable.id, arrayAliasTable._parentID),
+                                condition: (()=>{
+                                    const relationshipCondition = eq(newAliasTable['id'], arrayAliasTable._parentID);
+                                    const branchCondition = getBranchTableCondition({
+                                        adapter,
+                                        collectionSlug: field.collection,
+                                        req,
+                                        table: newAliasTable
+                                    });
+                                    return branchCondition ? and(relationshipCondition, branchCondition) : relationshipCondition;
+                                })(),
                                 queryPath: `${constraintPath}${field.name}`,
                                 table: newAliasTable
                             });
                         } else {
+                            const relationshipCondition = eq(newAliasTable[field.on.replaceAll('.', '_')], aliasTable ? aliasTable.id : adapter.tables[tableName].id);
+                            const branchCondition = getBranchTableCondition({
+                                adapter,
+                                collectionSlug: field.collection,
+                                req,
+                                table: newAliasTable
+                            });
                             joins.push({
-                                condition: eq(newAliasTable[field.on.replaceAll('.', '_')], aliasTable ? aliasTable.id : adapter.tables[tableName].id),
+                                condition: branchCondition ? and(relationshipCondition, branchCondition) : relationshipCondition,
                                 queryPath: `${constraintPath}${field.name}`,
                                 table: newAliasTable
                             });
@@ -394,6 +499,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                         // A join reads from a different collection, so localization does not carry over
                         parentIsLocalized: false,
                         pathSegments: pathSegments.slice(1),
+                        req,
                         selectFields,
                         tableName: newTableName,
                         value
@@ -454,6 +560,8 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
             case 'upload':
                 {
                     const newCollectionPath = pathSegments.slice(1).join('.');
+                    const relationshipQueryPath = `${getTableName(tableContainingField)}.${fieldStoragePath}._rels`;
+                    const targetQueryPath = `${getTableName(tableContainingField)}.${fieldStoragePath}._target${isFieldLocalized && locale ? `.${locale}` : ''}`;
                     if (Array.isArray(field.relationTo) || field.hasMany) {
                         const relationshipPath = resolveRelationshipPath({
                             adapter,
@@ -468,7 +576,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                         }
                         let relationshipFields;
                         const relationTableName = `${rootTableName}${adapter.relationshipsSuffix}`;
-                        const existingJoin = joins.find((e)=>e.queryPath === `${constraintPath}.${field.name}`);
+                        const existingJoin = joins.find((e)=>e.queryPath === relationshipQueryPath);
                         let aliasRelationshipTable;
                         let aliasRelationshipTableName;
                         if (existingJoin) {
@@ -495,7 +603,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                             addJoinTable({
                                 condition: and(...conditions),
                                 joins,
-                                queryPath: `${constraintPath}.${field.name}`,
+                                queryPath: relationshipQueryPath,
                                 table: aliasRelationshipTable
                             });
                         } else {
@@ -503,7 +611,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                             addJoinTable({
                                 condition: and(eq(tableContainingField.id, aliasRelationshipTable.parent), like(aliasRelationshipTable.path, relationshipPath.path)),
                                 joins,
-                                queryPath: `${constraintPath}.${field.name}`,
+                                queryPath: relationshipQueryPath,
                                 table: aliasRelationshipTable
                             });
                         }
@@ -514,15 +622,31 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                             newTableName = adapter.tableNameMap.get(toSnakeCase(relationshipConfig.slug));
                             // parent to relationship join table
                             relationshipFields = relationshipConfig.flattenedFields;
-                            ({ newAliasTable } = getTableAlias({
-                                adapter,
-                                tableName: newTableName
-                            }));
-                            joins.push({
-                                condition: eq(newAliasTable.id, aliasRelationshipTable[`${field.relationTo}ID`]),
-                                table: newAliasTable
-                            });
-                            if (newCollectionPath === '' || newCollectionPath === 'id') {
+                            const existingTargetJoin = joins.find((join)=>join.queryPath === targetQueryPath);
+                            if (existingTargetJoin) {
+                                newAliasTable = existingTargetJoin.table;
+                            } else {
+                                ;
+                                ({ newAliasTable } = getTableAlias({
+                                    adapter,
+                                    tableName: newTableName
+                                }));
+                                const relationshipID = aliasRelationshipTable[`${field.relationTo}ID`];
+                                const condition = getRelationshipJoinCondition({
+                                    adapter,
+                                    collectionSlug: field.relationTo,
+                                    relationshipID,
+                                    req,
+                                    table: newAliasTable,
+                                    value
+                                });
+                                joins.push({
+                                    condition,
+                                    queryPath: targetQueryPath,
+                                    table: newAliasTable
+                                });
+                            }
+                            if (newCollectionPath === '' || newCollectionPath === 'id' && !existingTargetJoin) {
                                 return {
                                     columnName: `${field.relationTo}ID`,
                                     constraints,
@@ -625,21 +749,23 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                             // A relationship jumps to a different collection, so localization does not carry over
                             parentIsLocalized: false,
                             pathSegments: pathSegments.slice(1),
+                            req,
                             rootTableName: newTableName,
                             selectFields,
                             selectLocale,
                             tableName: newTableName,
                             value
                         });
-                    } else if (pathSegments.length > 1 && !(pathSegments.length === 2 && pathSegments[1] === 'id')) {
+                    } else if (pathSegments.length > 1 && (!(pathSegments.length === 2 && pathSegments[1] === 'id') || joins.some((join)=>join.queryPath === targetQueryPath))) {
                         // simple relationships
                         const columnName = `${columnPrefix}${field.name}`;
                         const newTableName = adapter.tableNameMap.get(toSnakeCase(adapter.payload.collections[field.relationTo].config.slug));
-                        const { newAliasTable } = getTableAlias({
+                        const existingTargetJoin = joins.find((join)=>join.queryPath === targetQueryPath);
+                        const newAliasTable = existingTargetJoin?.table ?? getTableAlias({
                             adapter,
                             tableName: newTableName
-                        });
-                        if (isFieldLocalized && adapter.payload.config.localization) {
+                        }).newAliasTable;
+                        if (!existingTargetJoin && isFieldLocalized && adapter.payload.config.localization) {
                             const { newAliasTable: aliasLocaleTable } = getTableAlias({
                                 adapter,
                                 tableName: `${rootTableName}${adapter.localesSuffix}`
@@ -653,19 +779,37 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                             if (locale !== 'all') {
                                 condtions.push(eq(aliasLocaleTable._locale, locale));
                             }
-                            const localesTable = adapter.tables[`${rootTableName}${adapter.localesSuffix}`];
                             addJoinTable({
                                 condition: and(...condtions),
                                 joins,
-                                table: localesTable
+                                table: aliasLocaleTable
+                            });
+                            const condition = getRelationshipJoinCondition({
+                                adapter,
+                                collectionSlug: field.relationTo,
+                                relationshipID: aliasLocaleTable[columnName],
+                                req,
+                                table: newAliasTable,
+                                value
                             });
                             joins.push({
-                                condition: eq(localesTable[columnName], newAliasTable.id),
+                                condition,
+                                queryPath: targetQueryPath,
                                 table: newAliasTable
                             });
-                        } else {
+                        } else if (!existingTargetJoin) {
+                            const relationshipID = aliasTable ? aliasTable[columnName] : adapter.tables[tableName][columnName];
+                            const condition = getRelationshipJoinCondition({
+                                adapter,
+                                collectionSlug: field.relationTo,
+                                relationshipID,
+                                req,
+                                table: newAliasTable,
+                                value
+                            });
                             joins.push({
-                                condition: eq(newAliasTable.id, aliasTable ? aliasTable[columnName] : adapter.tables[tableName][columnName]),
+                                condition,
+                                queryPath: targetQueryPath,
                                 table: newAliasTable
                             });
                         }
@@ -681,6 +825,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                             // A relationship jumps to a different collection, so localization does not carry over
                             parentIsLocalized: false,
                             pathSegments: pathSegments.slice(1),
+                            req,
                             selectFields,
                             tableName: newTableName,
                             value
@@ -737,6 +882,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                             locale,
                             parentIsLocalized: parentIsLocalized || field.localized,
                             pathSegments: pathSegments.slice(1),
+                            req,
                             rootTableName,
                             selectFields,
                             selectLocale,
@@ -757,6 +903,7 @@ import { appendFieldToStoragePath, resolveRelationshipPath } from './resolveRela
                         locale,
                         parentIsLocalized: parentIsLocalized || field.localized,
                         pathSegments: pathSegments.slice(1),
+                        req,
                         rootTableName,
                         selectFields,
                         selectLocale,