fix(plugin-multi-tenant): prevent double-wrapping arrays when hasMany is true

Author: PatrikKozak

packages/plugin-multi-tenant/src/filters/filterDocumentsByTenants.ts

@@ -11,8 +11,9 @@ type Args<ConfigType = unknown> = {
   /**
    * If the document this filter is run belongs to a tenant, the tenant ID should be passed here.
    * If set, this will be used instead of the tenant cookie
+   * Can be an array when hasMany is true
    */
-  docTenantID?: number | string
+  docTenantID?: number | number[] | string | string[]
   filterFieldName: string
   req: PayloadRequest
   tenantsArrayFieldName?: string
@@ -41,7 +42,7 @@ export const filterDocumentsByTenants = <ConfigType = unknown>({
   if (selectedTenant) {
     return {
       [filterFieldName]: {
-        in: [selectedTenant],
+        in: Array.isArray(selectedTenant) ? selectedTenant : [selectedTenant],
       },
     }
   }

test/plugin-multi-tenant/collections/MultiTenantPosts.ts

@@ -0,0 +1,22 @@
+import type { CollectionConfig } from 'payload'
+
+import { multiTenantPostsSlug } from '../shared.js'
+
+export const MultiTenantPosts: CollectionConfig = {
+  slug: multiTenantPostsSlug,
+  admin: {
+    useAsTitle: 'title',
+  },
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+      required: true,
+    },
+    {
+      name: 'parent',
+      type: 'relationship',
+      relationTo: multiTenantPostsSlug,
+    },
+  ],
+}

test/plugin-multi-tenant/config.base.ts

@@ -12,11 +12,18 @@ import type { Config as ConfigType } from './payload-types.js'
 import { AutosaveGlobal } from './collections/AutosaveGlobal.js'
 import { Menu } from './collections/Menu.js'
 import { MenuItems } from './collections/MenuItems.js'
+import { MultiTenantPosts } from './collections/MultiTenantPosts.js'
 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, notTenantedSlug } from './shared.js'
+import {
+  autosaveGlobalSlug,
+  menuItemsSlug,
+  menuSlug,
+  multiTenantPostsSlug,
+  notTenantedSlug,
+} from './shared.js'
 
 export const baseConfig: Partial<Config> = {
   collections: [
@@ -26,6 +33,7 @@ export const baseConfig: Partial<Config> = {
     Menu,
     AutosaveGlobal,
     Relationships,
+    MultiTenantPosts,
     {
       slug: notTenantedSlug,
       admin: {
@@ -76,8 +84,12 @@ export const baseConfig: Partial<Config> = {
         [autosaveGlobalSlug]: {
           isGlobal: true,
         },
-
         ['relationships']: {},
+        [multiTenantPostsSlug]: {
+          tenantFieldOverrides: {
+            hasMany: true,
+          },
+        },
       },
       i18n: {
         translations: {

test/plugin-multi-tenant/int.spec.ts

@@ -9,7 +9,7 @@ import type { Relationship } from './payload-types.js'
 
 import { initPayloadInt } from '../__helpers/shared/initPayloadInt.js'
 import { devUser } from '../credentials.js'
-import { relationshipsSlug, tenantsSlug, usersSlug } from './shared.js'
+import { multiTenantPostsSlug, relationshipsSlug, tenantsSlug, usersSlug } from './shared.js'
 
 let payload: Payload
 let restClient: NextRESTClient
@@ -195,7 +195,7 @@ describe('@payloadcms/plugin-multi-tenant', () => {
       })
 
       expect(result.docs).toHaveLength(1)
-      expect(result.docs[0].id).toBe(noTenantUser.id)
+      expect(result.docs[0]?.id).toBe(noTenantUser.id)
 
       // Cleanup
       await payload.delete({ id: noTenantUser.id, collection: usersSlug })
@@ -292,4 +292,47 @@ describe('@payloadcms/plugin-multi-tenant', () => {
       await payload.delete({ id: tenantB.id, collection: tenantsSlug })
     })
   })
+
+  describe('hasMany tenant field filtering', () => {
+    it('should not double-wrap tenant arrays in filterOptions', async () => {
+      const tenant1 = await payload.create({
+        collection: tenantsSlug,
+        data: { name: 'Tenant 1', domain: 'tenant1.test' },
+      })
+      const tenant2 = await payload.create({
+        collection: tenantsSlug,
+        data: { name: 'Tenant 2', domain: 'tenant2.test' },
+      })
+
+      // Create a post with multiple tenants (hasMany: true)
+      const post = await payload.create({
+        collection: multiTenantPostsSlug,
+        data: {
+          title: 'Multi-tenant post',
+          tenant: [tenant1.id, tenant2.id],
+        },
+      })
+
+      // Get the parent relationship field
+      const parentField = payload.collections[multiTenantPostsSlug].config.fields.find(
+        (f) => 'name' in f && f.name === 'parent',
+      ) as any
+
+      // Call filterOptions - this internally calls filterDocumentsByTenants with the array
+      const filter = await parentField.filterOptions({
+        data: post,
+        relationTo: multiTenantPostsSlug,
+        req: { payload } as any,
+      })
+
+      // Array should not be double-wrapped
+      expect(Array.isArray(filter.tenant.in[0])).toBe(false)
+      expect(Array.isArray(filter.tenant.in[1])).toBe(false)
+
+      // Cleanup
+      await payload.delete({ id: post.id, collection: multiTenantPostsSlug })
+      await payload.delete({ id: tenant1.id, collection: tenantsSlug })
+      await payload.delete({ id: tenant2.id, collection: tenantsSlug })
+    })
+  })
 })

test/plugin-multi-tenant/payload-types.ts

@@ -73,6 +73,7 @@ export interface Config {
     'food-menu': FoodMenu;
     'autosave-global': AutosaveGlobal;
     relationships: Relationship;
+    'multi-tenant-posts': MultiTenantPost;
     notTenanted: NotTenanted;
     'payload-kv': PayloadKv;
     'payload-locked-documents': PayloadLockedDocument;
@@ -91,6 +92,7 @@ export interface Config {
     'food-menu': FoodMenuSelect<false> | FoodMenuSelect<true>;
     'autosave-global': AutosaveGlobalSelect<false> | AutosaveGlobalSelect<true>;
     relationships: RelationshipsSelect<false> | RelationshipsSelect<true>;
+    'multi-tenant-posts': MultiTenantPostsSelect<false> | MultiTenantPostsSelect<true>;
     notTenanted: NotTenantedSelect<false> | NotTenantedSelect<true>;
     'payload-kv': PayloadKvSelect<false> | PayloadKvSelect<true>;
     'payload-locked-documents': PayloadLockedDocumentsSelect<false> | PayloadLockedDocumentsSelect<true>;
@@ -275,6 +277,18 @@ export interface AutosaveGlobal {
   createdAt: string;
   _status?: ('draft' | 'published') | null;
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "multi-tenant-posts".
+ */
+export interface MultiTenantPost {
+  id: string;
+  tenant?: (string | Tenant)[] | null;
+  title: string;
+  parent?: (string | null) | MultiTenantPost;
+  updatedAt: string;
+  createdAt: string;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "payload-kv".
@@ -323,6 +337,10 @@ export interface PayloadLockedDocument {
         relationTo: 'relationships';
         value: string | Relationship;
       } | null)
+    | ({
+        relationTo: 'multi-tenant-posts';
+        value: string | MultiTenantPost;
+      } | null)
     | ({
         relationTo: 'notTenanted';
         value: string | NotTenanted;
@@ -465,6 +483,17 @@ export interface RelationshipsSelect<T extends boolean = true> {
   updatedAt?: T;
   createdAt?: T;
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "multi-tenant-posts_select".
+ */
+export interface MultiTenantPostsSelect<T extends boolean = true> {
+  tenant?: T;
+  title?: T;
+  parent?: T;
+  updatedAt?: T;
+  createdAt?: T;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "notTenanted_select".

test/plugin-multi-tenant/shared.ts

@@ -11,3 +11,5 @@ export const autosaveGlobalSlug = 'autosave-global'
 export const relationshipsSlug = 'relationships'
 
 export const notTenantedSlug = 'notTenanted'
+
+export const multiTenantPostsSlug = 'multi-tenant-posts'