fix(ui): req not being threaded through to views (#12213)

Author: JarrodMFlesch

packages/next/src/elements/Nav/getNavPrefs.ts

@@ -1,41 +1,36 @@
-import type { DefaultDocumentIDType, NavPreferences, Payload, User } from 'payload'
+import type { NavPreferences, PayloadRequest } from 'payload'
 
 import { cache } from 'react'
 
-export const getNavPrefs = cache(
-  async (
-    payload: Payload,
-    userID: DefaultDocumentIDType,
-    userSlug: string,
-  ): Promise<NavPreferences> => {
-    return userSlug
-      ? await payload
-          .find({
-            collection: 'payload-preferences',
-            depth: 0,
-            limit: 1,
-            pagination: false,
-            where: {
-              and: [
-                {
-                  key: {
-                    equals: 'nav',
-                  },
+export const getNavPrefs = cache(async (req: PayloadRequest): Promise<NavPreferences> => {
+  return req?.user?.collection
+    ? await req.payload
+        .find({
+          collection: 'payload-preferences',
+          depth: 0,
+          limit: 1,
+          pagination: false,
+          req,
+          where: {
+            and: [
+              {
+                key: {
+                  equals: 'nav',
                 },
-                {
-                  'user.relationTo': {
-                    equals: userSlug,
-                  },
+              },
+              {
+                'user.relationTo': {
+                  equals: req.user.collection,
                 },
-                {
-                  'user.value': {
-                    equals: userID,
-                  },
+              },
+              {
+                'user.value': {
+                  equals: req?.user?.id,
                 },
-              ],
-            },
-          })
-          ?.then((res) => res?.docs?.[0]?.value)
-      : null
-  },
-)
+              },
+            ],
+          },
+        })
+        ?.then((res) => res?.docs?.[0]?.value)
+    : null
+})

packages/next/src/elements/Nav/index.tsx

@@ -1,5 +1,5 @@
 import type { EntityToGroup } from '@payloadcms/ui/shared'
-import type { ServerProps } from 'payload'
+import type { PayloadRequest, ServerProps } from 'payload'
 
 import { Logout } from '@payloadcms/ui'
 import { RenderServerComponent } from '@payloadcms/ui/elements/RenderServerComponent'
@@ -15,7 +15,9 @@ const baseClass = 'nav'
 import { getNavPrefs } from './getNavPrefs.js'
 import { DefaultNavClient } from './index.client.js'
 
-export type NavProps = ServerProps
+export type NavProps = {
+  req?: PayloadRequest
+} & ServerProps
 
 export const DefaultNav: React.FC<NavProps> = async (props) => {
   const {
@@ -25,6 +27,7 @@ export const DefaultNav: React.FC<NavProps> = async (props) => {
     params,
     payload,
     permissions,
+    req,
     searchParams,
     user,
     viewType,
@@ -68,7 +71,7 @@ export const DefaultNav: React.FC<NavProps> = async (props) => {
     i18n,
   )
 
-  const navPreferences = await getNavPrefs(payload, user?.id, user?.collection)
+  const navPreferences = await getNavPrefs(req)
 
   const LogoutComponent = RenderServerComponent({
     clientProps: {

packages/next/src/layouts/Root/index.tsx

@@ -79,7 +79,7 @@ export const RootLayout = async ({
     })
   }
 
-  const navPrefs = await getNavPrefs(req.payload, req.user?.id, req.user?.collection)
+  const navPrefs = await getNavPrefs(req)
 
   const clientConfig = getClientConfig({
     config,

packages/next/src/templates/Default/index.tsx

@@ -1,6 +1,7 @@
 import type {
   CustomComponent,
   DocumentSubViewTypes,
+  PayloadRequest,
   ServerProps,
   ViewTypes,
   VisibleEntities,
@@ -32,6 +33,7 @@ export type DefaultTemplateProps = {
   docID?: number | string
   documentSubViewType?: DocumentSubViewTypes
   globalSlug?: string
+  req?: PayloadRequest
   viewActions?: CustomComponent[]
   viewType?: ViewTypes
   visibleEntities: VisibleEntities
@@ -49,6 +51,7 @@ export const DefaultTemplate: React.FC<DefaultTemplateProps> = ({
   params,
   payload,
   permissions,
+  req,
   searchParams,
   user,
   viewActions,
@@ -84,6 +87,7 @@ export const DefaultTemplate: React.FC<DefaultTemplateProps> = ({
       params,
       payload,
       permissions,
+      req,
       searchParams,
       user,
     }),
@@ -98,6 +102,7 @@ export const DefaultTemplate: React.FC<DefaultTemplateProps> = ({
       globalSlug,
       collectionSlug,
       docID,
+      req,
     ],
   )
 

packages/next/src/views/Document/getDocumentData.ts

@@ -29,6 +29,7 @@ export const getDocumentData = async ({
 }: Args): Promise<null | Record<string, unknown> | TypeWithID> => {
   const id = sanitizeID(idArg)
   let resolvedData: Record<string, unknown> | TypeWithID = null
+  const { transactionID, ...rest } = req
 
   try {
     if (collectionSlug && id) {
@@ -41,9 +42,7 @@ export const getDocumentData = async ({
         locale: locale?.code,
         overrideAccess: false,
         req: {
-          query: req?.query,
-          search: req?.search,
-          searchParams: req?.searchParams,
+          ...rest,
         },
         user,
       })
@@ -58,9 +57,7 @@ export const getDocumentData = async ({
         locale: locale?.code,
         overrideAccess: false,
         req: {
-          query: req?.query,
-          search: req?.search,
-          searchParams: req?.searchParams,
+          ...rest,
         },
         user,
       })

packages/next/src/views/Root/index.tsx

@@ -167,6 +167,7 @@ export const RootPage = async ({
           params={params}
           payload={initPageResult?.req.payload}
           permissions={initPageResult?.permissions}
+          req={initPageResult?.req}
           searchParams={searchParams}
           user={initPageResult?.req.user}
           viewActions={serverProps.viewActions}