fix(plugin-multi-tenant): relationTo arrays inflating filterOptions where query size (#14944)

JarrodMFlesch · web-flow · commit 98b67913aa0b · 2025-12-16T14:54:14.000-05:00
Before the plugin was looping over relationTo arrays and would build up
duplicate tenant queries. Now it just ensures that there is at lease 1
tenant enabled collection and adds a single tenant constraint to the
filterOptions.

Helpful to note that the relationships are populated 1 at a time and the
filterOptions receives `relationTo` arg, the injected filter checks to
see if the requested relation is a tenant enabled collection also before
applying the constraint.
diff --git a/packages/plugin-multi-tenant/src/utilities/addFilterOptionsToFields.ts b/packages/plugin-multi-tenant/src/utilities/addFilterOptionsToFields.ts
@@ -36,6 +36,7 @@ export function addFilterOptionsToFields<ConfigType = unknown>({
   for (const field of fields) {
     let newField: Field = { ...field }
     if (newField.type === 'relationship') {
+      let hasTenantRelationsips = false
       /**
        * Adjusts relationship fields to filter by tenant
        * and ensures relationTo cannot be a tenant global collection
@@ -47,15 +48,7 @@ export function addFilterOptionsToFields<ConfigType = unknown>({
           )
         }
         if (tenantEnabledCollectionSlugs.includes(newField.relationTo)) {
-          newField = addFilter({
-            field: newField,
-            tenantEnabledCollectionSlugs,
-            tenantFieldName,
-            tenantsArrayFieldName,
-            tenantsArrayTenantFieldName,
-            tenantsCollectionSlug,
-            userHasAccessToAllTenants,
-          })
+          hasTenantRelationsips = true
         }
       } else {
         for (const relationTo of newField.relationTo) {
@@ -65,18 +58,22 @@ export function addFilterOptionsToFields<ConfigType = unknown>({
             )
           }
           if (tenantEnabledCollectionSlugs.includes(relationTo)) {
-            newField = addFilter({
-              field: newField as RelationshipField,
-              tenantEnabledCollectionSlugs,
-              tenantFieldName,
-              tenantsArrayFieldName,
-              tenantsArrayTenantFieldName,
-              tenantsCollectionSlug,
-              userHasAccessToAllTenants,
-            })
+            hasTenantRelationsips = true
           }
         }
       }
+
+      if (hasTenantRelationsips) {
+        newField = addRelationshipFilter({
+          field: newField as RelationshipField,
+          tenantEnabledCollectionSlugs,
+          tenantFieldName,
+          tenantsArrayFieldName,
+          tenantsArrayTenantFieldName,
+          tenantsCollectionSlug,
+          userHasAccessToAllTenants,
+        })
+      }
     }
 
     if (
@@ -175,7 +172,7 @@ type AddFilterArgs<ConfigType = unknown> = {
     MultiTenantPluginConfig<ConfigType>
   >['userHasAccessToAllTenants']
 }
-function addFilter<ConfigType = unknown>({
+function addRelationshipFilter<ConfigType = unknown>({
   field,
   tenantEnabledCollectionSlugs,
   tenantFieldName,
diff --git a/test/helpers/e2e/fields/relationship/openRelationshipFieldDrawer.ts b/test/helpers/e2e/fields/relationship/openRelationshipFieldDrawer.ts
@@ -0,0 +1,59 @@
+import type { Page } from '@playwright/test'
+
+import { expect } from '@playwright/test'
+import { wait } from 'payload/shared'
+
+import { selectInput } from '../../selectInput.js'
+
+/**
+ * Opens a list drawer for a relationship field with appearance="drawer"
+ * and optionally selects a specific collection type for polymorphic relationships.
+ *
+ * @param page - Playwright Page object
+ * @param fieldName - Name of the relationship field (e.g., 'relationship', 'relationshipHasMany')
+ * @param selectRelation - Optional: Collection slug to select for polymorphic relationships (e.g., 'posts', 'users')
+ *
+ * @example
+ * // Open list drawer for a non-polymorphic relationship
+ * await openRelationshipFieldDrawer({ page, fieldName: 'relationship' })
+ *
+ * @example
+ * // Open list drawer and select a specific collection for polymorphic relationship
+ * await openRelationshipFieldDrawer({
+ *   page,
+ *   fieldName: 'polymorphicRelationship',
+ *   selectRelation: 'tenants'
+ * })
+ */
+export async function openRelationshipFieldDrawer({
+  fieldName,
+  page,
+  selectRelation,
+}: {
+  fieldName: string
+  page: Page
+  selectRelation?: string
+}): Promise<void> {
+  await wait(300)
+
+  // Click the relationship field to open the list drawer
+  const relationshipField = page.locator(`#field-${fieldName}`)
+  await relationshipField.click()
+
+  // Wait for list drawer to be visible
+  const listDrawerContent = page.locator('.list-drawer').locator('.drawer__content')
+  await expect(listDrawerContent).toBeVisible()
+
+  // If a specific relation type should be selected (for polymorphic relationships)
+  if (selectRelation) {
+    const relationToSelector = page.locator('.list-header__select-collection')
+    await expect(relationToSelector).toBeVisible()
+
+    await selectInput({
+      selectLocator: relationToSelector,
+      option: selectRelation,
+      multiSelect: false,
+      selectType: 'select',
+    })
+  }
+}
diff --git a/test/plugin-multi-tenant/collections/MenuItems.ts b/test/plugin-multi-tenant/collections/MenuItems.ts
@@ -2,7 +2,7 @@ import type { Access, CollectionConfig, Where } from 'payload'
 
 import { getUserTenantIDs } from '@payloadcms/plugin-multi-tenant/utilities'
 
-import { menuItemsSlug } from '../shared.js'
+import { menuItemsSlug, notTenantedSlug, relationshipsSlug } from '../shared.js'
 
 const collectionTenantReadAccess: Access = ({ req }) => {
   // admins can access all tenants
@@ -97,5 +97,13 @@ export const MenuItems: CollectionConfig = {
       name: 'content',
       type: 'richText',
     },
+    {
+      name: 'polymorphicRelationship',
+      type: 'relationship',
+      relationTo: [relationshipsSlug, menuItemsSlug, notTenantedSlug],
+      admin: {
+        appearance: 'drawer',
+      },
+    },
   ],
 }
diff --git a/test/plugin-multi-tenant/collections/Relationships.ts b/test/plugin-multi-tenant/collections/Relationships.ts
@@ -1,7 +1,9 @@
 import type { CollectionConfig } from 'payload'
 
+import { relationshipsSlug } from '../shared.js'
+
 export const Relationships: CollectionConfig = {
-  slug: 'relationships',
+  slug: relationshipsSlug,
   admin: {
     useAsTitle: 'title',
     group: 'Tenant Collections',
@@ -15,7 +17,7 @@ export const Relationships: CollectionConfig = {
     {
       name: 'relationship',
       type: 'relationship',
-      relationTo: 'relationships',
+      relationTo: relationshipsSlug,
     },
   ],
 }
diff --git a/test/plugin-multi-tenant/config.ts b/test/plugin-multi-tenant/config.ts
@@ -15,10 +15,29 @@ import { Relationships } from './collections/Relationships.js'
 import { Tenants } from './collections/Tenants.js'
 import { Users } from './collections/Users/index.js'
 import { seed } from './seed/index.js'
-import { autosaveGlobalSlug, menuItemsSlug, menuSlug } from './shared.js'
+import { autosaveGlobalSlug, menuItemsSlug, menuSlug, notTenantedSlug } from './shared.js'
 
 export default buildConfigWithDefaults({
-  collections: [Tenants, Users, MenuItems, Menu, AutosaveGlobal, Relationships],
+  collections: [
+    Tenants,
+    Users,
+    MenuItems,
+    Menu,
+    AutosaveGlobal,
+    Relationships,
+    {
+      slug: notTenantedSlug,
+      admin: {
+        useAsTitle: 'name',
+      },
+      fields: [
+        {
+          name: 'name',
+          type: 'text',
+        },
+      ],
+    },
+  ],
   admin: {
     autoLogin: false,
     importMap: {
diff --git a/test/plugin-multi-tenant/e2e.spec.ts b/test/plugin-multi-tenant/e2e.spec.ts
@@ -17,6 +17,7 @@ import {
 } from '../helpers.js'
 import { AdminUrlUtil } from '../helpers/adminUrlUtil.js'
 import { loginClientSide } from '../helpers/e2e/auth/login.js'
+import { openRelationshipFieldDrawer } from '../helpers/e2e/fields/relationship/openRelationshipFieldDrawer.js'
 import { goToListDoc } from '../helpers/e2e/goToListDoc.js'
 import {
   clearSelectInput,
@@ -516,6 +517,78 @@ test.describe('Multi Tenant', () => {
     })
   })
 
+  test.describe('Polymorphic Relationships', () => {
+    test('should not duplicate tenant constraints in polymorphic relationship queries', async () => {
+      await loginClientSide({
+        data: credentials.admin,
+        page,
+        serverURL,
+      })
+
+      // Capture render-list server action requests
+      const renderListRequests: Array<{
+        payload: any[]
+        url: string
+      }> = []
+
+      page.on('request', (request) => {
+        // Check for server action POST requests
+        if (
+          request.method() === 'POST' &&
+          request.url().includes(`/admin/collections/${menuItemsSlug}`)
+        ) {
+          const postData = request.postData()
+          if (postData) {
+            try {
+              const parsedPayload = JSON.parse(postData)
+              // Check if this is a render-list action
+              if (Array.isArray(parsedPayload) && parsedPayload[0]?.name === 'render-list') {
+                renderListRequests.push({
+                  url: request.url(),
+                  payload: parsedPayload,
+                })
+              }
+            } catch (e) {
+              // Ignore parse errors
+            }
+          }
+        }
+      })
+
+      // Navigate to existing menu item
+      await page.goto(menuItemsURL.list)
+      await clearTenantFilter({ page })
+
+      await goToListDoc({
+        cellClass: '.cell-name',
+        page,
+        textToMatch: 'Spicy Mac',
+        urlUtil: menuItemsURL,
+      })
+
+      await openRelationshipFieldDrawer({
+        page,
+        fieldName: 'polymorphicRelationship',
+        selectRelation: 'Relationship', // select a tenant-enabled collection
+      })
+
+      await expect.poll(() => renderListRequests.length).toBeGreaterThan(0)
+
+      // Check the query.where clause for tenant constraint duplication
+      for (const request of renderListRequests) {
+        const renderListAction = request.payload[0]
+        await expect.poll(() => renderListAction.name).toBe('render-list')
+        await expect.poll(() => renderListAction.args).toBeDefined()
+        await expect.poll(() => renderListAction.args.query).toBeDefined()
+
+        const whereString = JSON.stringify(renderListAction.args.query.where)
+        const tenantMatches = whereString.match(/"tenant":/g)?.length
+
+        await expect.poll(() => tenantMatches).toEqual(1)
+      }
+    })
+  })
+
   test.describe('Tenant Selector', () => {
     test('should populate tenant selector on login', async () => {
       await loginClientSide({
diff --git a/test/plugin-multi-tenant/payload-types.ts b/test/plugin-multi-tenant/payload-types.ts
@@ -73,6 +73,7 @@ export interface Config {
     'food-menu': FoodMenu;
     'autosave-global': AutosaveGlobal;
     relationships: Relationship;
+    notTenanted: NotTenanted;
     'payload-kv': PayloadKv;
     'payload-locked-documents': PayloadLockedDocument;
     'payload-preferences': PayloadPreference;
@@ -90,6 +91,7 @@ export interface Config {
     'food-menu': FoodMenuSelect<false> | FoodMenuSelect<true>;
     'autosave-global': AutosaveGlobalSelect<false> | AutosaveGlobalSelect<true>;
     relationships: RelationshipsSelect<false> | RelationshipsSelect<true>;
+    notTenanted: NotTenantedSelect<false> | NotTenantedSelect<true>;
     'payload-kv': PayloadKvSelect<false> | PayloadKvSelect<true>;
     'payload-locked-documents': PayloadLockedDocumentsSelect<false> | PayloadLockedDocumentsSelect<true>;
     'payload-preferences': PayloadPreferencesSelect<false> | PayloadPreferencesSelect<true>;
@@ -201,6 +203,41 @@ export interface FoodItem {
     };
     [k: string]: unknown;
   } | null;
+  polymorphicRelationship?:
+    | ({
+        relationTo: 'relationships';
+        value: string | Relationship;
+      } | null)
+    | ({
+        relationTo: 'food-items';
+        value: string | FoodItem;
+      } | null)
+    | ({
+        relationTo: 'notTenanted';
+        value: string | NotTenanted;
+      } | null);
+  updatedAt: string;
+  createdAt: string;
+}
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "relationships".
+ */
+export interface Relationship {
+  id: string;
+  tenant?: (string | null) | Tenant;
+  title: string;
+  relationship?: (string | null) | Relationship;
+  updatedAt: string;
+  createdAt: string;
+}
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "notTenanted".
+ */
+export interface NotTenanted {
+  id: string;
+  name?: string | null;
   updatedAt: string;
   createdAt: string;
 }
@@ -239,18 +276,6 @@ export interface AutosaveGlobal {
   createdAt: string;
   _status?: ('draft' | 'published') | null;
 }
-/**
- * This interface was referenced by `Config`'s JSON-Schema
- * via the `definition` "relationships".
- */
-export interface Relationship {
-  id: string;
-  tenant?: (string | null) | Tenant;
-  title: string;
-  relationship?: (string | null) | Relationship;
-  updatedAt: string;
-  createdAt: string;
-}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "payload-kv".
@@ -298,6 +323,10 @@ export interface PayloadLockedDocument {
     | ({
         relationTo: 'relationships';
         value: string | Relationship;
+      } | null)
+    | ({
+        relationTo: 'notTenanted';
+        value: string | NotTenanted;
       } | null);
   globalSlug?: string | null;
   user: {
@@ -392,6 +421,7 @@ export interface FoodItemsSelect<T extends boolean = true> {
   name?: T;
   localizedName?: T;
   content?: T;
+  polymorphicRelationship?: T;
   updatedAt?: T;
   createdAt?: T;
 }
@@ -436,6 +466,15 @@ export interface RelationshipsSelect<T extends boolean = true> {
   updatedAt?: T;
   createdAt?: T;
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "notTenanted_select".
+ */
+export interface NotTenantedSelect<T extends boolean = true> {
+  name?: T;
+  updatedAt?: T;
+  createdAt?: T;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "payload-kv_select".
diff --git a/test/plugin-multi-tenant/shared.ts b/test/plugin-multi-tenant/shared.ts
