chore(plugin-multi-tenant): test suite enhancements (#10732)

### What? Updates test suite multi-tenant config as a better example. ### Why? So it is easier to follow and write logical tests for in the future.
payloadcms · Jan 22, 2025 · 9a87699 · 9a87699
1 parent be2c482
commit 9a87699
Show file tree

Hide file tree

Showing 15 changed files with 232 additions and 224 deletions.
diff --git a/packages/plugin-multi-tenant/src/utilities/addFilterOptionsToFields.ts b/packages/plugin-multi-tenant/src/utilities/addFilterOptionsToFields.ts
@@ -1,4 +1,4 @@
-import type { Field, FilterOptionsProps, RelationshipField, Where } from 'payload'
+import type { Field, FilterOptionsProps, RelationshipField } from 'payload'
 
 import { getTenantFromCookie } from './getTenantFromCookie.js'
 
@@ -7,6 +7,7 @@ type AddFilterOptionsToFieldsArgs = {
   tenantEnabledCollectionSlugs: string[]
   tenantEnabledGlobalSlugs: string[]
 }
+
 export function addFilterOptionsToFields({
   fields,
   tenantEnabledCollectionSlugs,

diff --git a/test/plugin-multi-tenant/collections/Links.ts b/test/plugin-multi-tenant/collections/Links.ts
diff --git a/test/plugin-multi-tenant/collections/Menu.ts b/test/plugin-multi-tenant/collections/Menu.ts
@@ -0,0 +1,43 @@
+import type { CollectionConfig } from 'payload'
+
+import { menuSlug } from '../shared.js'
+
+export const Menu: CollectionConfig = {
+  slug: menuSlug,
+  admin: {
+    useAsTitle: 'title',
+  },
+  fields: [
+    {
+      name: 'title',
+      label: 'Title',
+      type: 'text',
+      required: true,
+    },
+    {
+      name: 'description',
+      type: 'textarea',
+    },
+    {
+      name: 'menuItems',
+      label: 'Menu Items',
+      type: 'array',
+      fields: [
+        {
+          name: 'menuItem',
+          label: 'Menu Item',
+          type: 'relationship',
+          relationTo: 'menu-items',
+          required: true,
+          admin: {
+            description: 'Automatically filtered by selected tenant',
+          },
+        },
+        {
+          name: 'active',
+          type: 'checkbox',
+        },
+      ],
+    },
+  ],
+}
diff --git a/test/plugin-multi-tenant/collections/MenuItems.ts b/test/plugin-multi-tenant/collections/MenuItems.ts
@@ -0,0 +1,17 @@
+import type { CollectionConfig } from 'payload'
+
+import { menuItemsSlug } from '../shared.js'
+
+export const MenuItems: CollectionConfig = {
+  slug: menuItemsSlug,
+  admin: {
+    useAsTitle: 'name',
+  },
+  fields: [
+    {
+      name: 'name',
+      type: 'text',
+      required: true,
+    },
+  ],
+}
diff --git a/test/plugin-multi-tenant/collections/Posts.ts b/test/plugin-multi-tenant/collections/Posts.ts
diff --git a/test/plugin-multi-tenant/collections/Tenants.ts b/test/plugin-multi-tenant/collections/Tenants.ts
@@ -19,14 +19,15 @@ export const Tenants: CollectionConfig = {
       required: true,
     },
     {
-      name: 'slug',
+      name: 'domain',
       type: 'text',
       required: true,
     },
     {
-      name: 'domain',
-      type: 'text',
-      required: true,
+      type: 'join',
+      name: 'users',
+      collection: 'users',
+      on: 'tenants.tenant',
     },
   ],
 }
diff --git a/test/plugin-multi-tenant/collections/Users.ts b/test/plugin-multi-tenant/collections/Users.ts
diff --git a/test/plugin-multi-tenant/collections/Users/filterOptions.ts b/test/plugin-multi-tenant/collections/Users/filterOptions.ts
@@ -1,4 +1,4 @@
-import type { FilterOptions, Where } from 'payload'
+import type { FilterOptions } from 'payload'
 
 import { getTenantFromCookie } from '@payloadcms/plugin-multi-tenant/utilities'
 
@@ -9,17 +9,8 @@ export const userFilterOptions: FilterOptions = ({ req }) => {
   }
 
   return {
-    or: [
-      {
-        'tenants.tenant': {
-          equals: selectedTenant,
-        },
-      },
-      {
-        roles: {
-          in: ['admin'],
-        },
-      },
-    ],
-  } as Where
+    'tenants.tenant': {
+      equals: selectedTenant,
+    },
+  }
 }
diff --git a/test/plugin-multi-tenant/components/Icon/styles.css b/test/plugin-multi-tenant/components/Icon/styles.css
@@ -2,6 +2,7 @@
   border-radius: 100%;
   height: 18px;
   width: 18px;
+  background-color: var(--theme-error-300);
 }
 
 [data-selected-tenant-title="Blue Dog"] #tenant-icon {

diff --git a/test/plugin-multi-tenant/components/Logo/styles.css b/test/plugin-multi-tenant/components/Logo/styles.css
@@ -2,6 +2,7 @@
   border-radius: 100%;
   height: 18px;
   width: 18px;
+  background-color: var(--theme-error-300);
 }
 
 [data-selected-tenant-title="Blue Dog"] #tenant-logo {

diff --git a/test/plugin-multi-tenant/config.ts b/test/plugin-multi-tenant/config.ts
@@ -7,15 +7,14 @@ const dirname = path.dirname(filename)
 import type { Config as ConfigType } from './payload-types.js'
 
 import { buildConfigWithDefaults } from '../buildConfigWithDefaults.js'
-import { LinksCollection } from './collections/Links.js'
-import { Posts } from './collections/Posts.js'
+import { Menu } from './collections/Menu.js'
+import { MenuItems } from './collections/MenuItems.js'
 import { Tenants } from './collections/Tenants.js'
-import { Users } from './collections/Users.js'
-import { NavigationGlobalCollection } from './globals/Navigation.js'
+import { Users } from './collections/Users/index.js'
 import { seed } from './seed/index.js'
 
 export default buildConfigWithDefaults({
-  collections: [Users, Tenants, Posts, LinksCollection, NavigationGlobalCollection],
+  collections: [Tenants, Users, Menu, MenuItems],
   admin: {
     importMap: {
       baseDir: path.resolve(dirname),
@@ -47,9 +46,8 @@ export default buildConfigWithDefaults({
         access: {},
       },
       collections: {
-        posts: {},
-        links: {},
-        'navigation-global': {
+        'menu-items': {},
+        menu: {
           isGlobal: true,
         },
       },

diff --git a/test/plugin-multi-tenant/globals/Navigation.ts b/test/plugin-multi-tenant/globals/Navigation.ts