Fix missing client reference manifest error when using route groups (#…

…73606) While splitting up the `"use cache"` e2e test pages into two separate root layout groups (one with a suspense boundary, one without), I noticed that there's a bug when retrieving the client reference manifest for a page in a route group. To fix it, we're now normalizing the `page` that's passed into `setReferenceManifestsSingleton` with the existing `normalizeAppPath` helper. When the manifest is retrieved, we're using the already normalized `workStore.route` instead of `workStore.page`.
vercel · Dec 6, 2024 · 2772f8e · 2772f8e
1 parent 3fbb2a6
commit 2772f8e
Show file tree

Hide file tree

Showing 35 changed files with 20 additions and 12 deletions.
diff --git a/packages/next/src/server/app-render/encryption-utils.ts b/packages/next/src/server/app-render/encryption-utils.ts
@@ -5,6 +5,7 @@ import type {
 } from '../../build/webpack/plugins/flight-manifest-plugin'
 import type { DeepReadonly } from '../../shared/lib/deep-readonly'
 import { InvariantError } from '../../shared/lib/invariant-error'
+import { normalizeAppPath } from '../../shared/lib/router/utils/app-paths'
 import { workAsyncStorage } from './work-async-storage.external'
 
 let __next_loaded_action_key: CryptoKey
@@ -98,7 +99,7 @@ export function setReferenceManifestsSingleton({
   globalThis[SERVER_ACTION_MANIFESTS_SINGLETON] = {
     clientReferenceManifestsPerPage: {
       ...clientReferenceManifestsPerPage,
-      [normalizePage(page)]: clientReferenceManifest,
+      [normalizeAppPath(page)]: clientReferenceManifest,
     },
     serverActionsManifest,
     serverModuleMap,
@@ -153,12 +154,13 @@ export function getClientReferenceManifestForRsc(): DeepReadonly<ClientReference
     return mergeClientReferenceManifests(clientReferenceManifestsPerPage)
   }
 
-  const page = normalizePage(workStore.page)
-
-  const clientReferenceManifest = clientReferenceManifestsPerPage[page]
+  const clientReferenceManifest =
+    clientReferenceManifestsPerPage[workStore.route]
 
   if (!clientReferenceManifest) {
-    throw new InvariantError(`Missing Client Reference Manifest for ${page}.`)
+    throw new InvariantError(
+      `Missing Client Reference Manifest for ${workStore.route}.`
+    )
   }
 
   return clientReferenceManifest
@@ -198,10 +200,6 @@ export async function getActionEncryptionKey() {
   return __next_loaded_action_key
 }
 
-function normalizePage(page: string): string {
-  return page.replace(/\/(page|route)$/, '')
-}
-
 function mergeClientReferenceManifests(
   clientReferenceManifestsPerPage: DeepReadonly<
     Record<string, ClientReferenceManifest>

diff --git a/test/e2e/app-dir/use-cache/app/[id]/page.tsx → ...use-cache/app/(no-suspense)/[id]/page.tsx b/test/e2e/app-dir/use-cache/app/[id]/page.tsx → ...use-cache/app/(no-suspense)/[id]/page.tsx
diff --git a/test/e2e/app-dir/use-cache/app/api/route.ts → .../use-cache/app/(no-suspense)/api/route.ts b/test/e2e/app-dir/use-cache/app/api/route.ts → .../use-cache/app/(no-suspense)/api/route.ts
diff --git a/...e-cache/app/cache-fetch-no-store/page.tsx → ...o-suspense)/cache-fetch-no-store/page.tsx b/...e-cache/app/cache-fetch-no-store/page.tsx → ...o-suspense)/cache-fetch-no-store/page.tsx
diff --git a/...pp-dir/use-cache/app/cache-fetch/page.tsx → ...he/app/(no-suspense)/cache-fetch/page.tsx b/...pp-dir/use-cache/app/cache-fetch/page.tsx → ...he/app/(no-suspense)/cache-fetch/page.tsx
diff --git a/...app-dir/use-cache/app/cache-life/page.tsx → ...che/app/(no-suspense)/cache-life/page.tsx b/...app-dir/use-cache/app/cache-life/page.tsx → ...che/app/(no-suspense)/cache-life/page.tsx
diff --git a/...p-dir/use-cache/app/cache-tag/buttons.tsx → ...e/app/(no-suspense)/cache-tag/buttons.tsx b/...p-dir/use-cache/app/cache-tag/buttons.tsx → ...e/app/(no-suspense)/cache-tag/buttons.tsx
diff --git a/.../app-dir/use-cache/app/cache-tag/page.tsx → ...ache/app/(no-suspense)/cache-tag/page.tsx b/.../app-dir/use-cache/app/cache-tag/page.tsx → ...ache/app/(no-suspense)/cache-tag/page.tsx
diff --git a/test/e2e/app-dir/use-cache/app/form/page.tsx → ...use-cache/app/(no-suspense)/form/page.tsx b/test/e2e/app-dir/use-cache/app/form/page.tsx → ...use-cache/app/(no-suspense)/form/page.tsx
diff --git a/...-cache/app/imported-from-client/cached.ts → ...-suspense)/imported-from-client/cached.ts b/...-cache/app/imported-from-client/cached.ts → ...-suspense)/imported-from-client/cached.ts
diff --git a/...e-cache/app/imported-from-client/page.tsx → ...o-suspense)/imported-from-client/page.tsx b/...e-cache/app/imported-from-client/page.tsx → ...o-suspense)/imported-from-client/page.tsx
@@ -1,7 +1,7 @@
 'use client'
 
 import { foo, bar, baz } from './cached'
-import { Form } from '../form'
+import { Form } from '../../form'
 
 export default function Page() {
   return <Form foo={foo} bar={bar} baz={baz} />

diff --git a/test/e2e/app-dir/use-cache/app/(no-suspense)/layout.tsx b/test/e2e/app-dir/use-cache/app/(no-suspense)/layout.tsx
@@ -0,0 +1,7 @@
+export default function Root({ children }: { children: React.ReactNode }) {
+  return (
+    <html>
+      <body>{children}</body>
+    </html>
+  )
+}
diff --git a/...-dir/use-cache/app/method-props/cached.ts → .../app/(no-suspense)/method-props/cached.ts b/...-dir/use-cache/app/method-props/cached.ts → .../app/(no-suspense)/method-props/cached.ts
diff --git a/...p-dir/use-cache/app/method-props/form.tsx → ...e/app/(no-suspense)/method-props/form.tsx b/...p-dir/use-cache/app/method-props/form.tsx → ...e/app/(no-suspense)/method-props/form.tsx
diff --git a/...p-dir/use-cache/app/method-props/page.tsx → ...e/app/(no-suspense)/method-props/page.tsx b/...p-dir/use-cache/app/method-props/page.tsx → ...e/app/(no-suspense)/method-props/page.tsx
diff --git a/...r/use-cache/app/passed-to-client/page.tsx → ...p/(no-suspense)/passed-to-client/page.tsx b/...r/use-cache/app/passed-to-client/page.tsx → ...p/(no-suspense)/passed-to-client/page.tsx
@@ -1,4 +1,4 @@
-import { Form } from '../form'
+import { Form } from '../../form'
 
 function getRandomValue() {
   const v = Math.random()

diff --git a/...pp-dir/use-cache/app/react-cache/page.tsx → ...he/app/(no-suspense)/react-cache/page.tsx b/...pp-dir/use-cache/app/react-cache/page.tsx → ...he/app/(no-suspense)/react-cache/page.tsx
diff --git a/...e-cache/app/static-class-method/cached.ts → ...o-suspense)/static-class-method/cached.ts b/...e-cache/app/static-class-method/cached.ts → ...o-suspense)/static-class-method/cached.ts
diff --git a/...se-cache/app/static-class-method/form.tsx → ...no-suspense)/static-class-method/form.tsx b/...se-cache/app/static-class-method/form.tsx → ...no-suspense)/static-class-method/form.tsx
diff --git a/...se-cache/app/static-class-method/page.tsx → ...no-suspense)/static-class-method/page.tsx b/...se-cache/app/static-class-method/page.tsx → ...no-suspense)/static-class-method/page.tsx
diff --git a/.../use-cache/app/use-action-state/cached.ts → .../(no-suspense)/use-action-state/cached.ts b/.../use-cache/app/use-action-state/cached.ts → .../(no-suspense)/use-action-state/cached.ts
diff --git a/...r/use-cache/app/use-action-state/page.tsx → ...p/(no-suspense)/use-action-state/page.tsx b/...r/use-cache/app/use-action-state/page.tsx → ...p/(no-suspense)/use-action-state/page.tsx
diff --git a/...ache/app/cache-fetch-auth-header/page.tsx → ...uspense)/cache-fetch-auth-header/page.tsx b/...ache/app/cache-fetch-auth-header/page.tsx → ...uspense)/cache-fetch-auth-header/page.tsx
diff --git a/...p-dir/use-cache/app/complex-args/page.tsx → ...ache/app/(suspense)/complex-args/page.tsx b/...p-dir/use-cache/app/complex-args/page.tsx → ...ache/app/(suspense)/complex-args/page.tsx
diff --git a/...dir/use-cache/app/custom-handler/page.tsx → ...he/app/(suspense)/custom-handler/page.tsx b/...dir/use-cache/app/custom-handler/page.tsx → ...he/app/(suspense)/custom-handler/page.tsx
diff --git a/...r/use-cache/app/errors/error-boundary.tsx → .../app/(suspense)/errors/error-boundary.tsx b/...r/use-cache/app/errors/error-boundary.tsx → .../app/(suspense)/errors/error-boundary.tsx
diff --git a/...e2e/app-dir/use-cache/app/errors/page.tsx → .../use-cache/app/(suspense)/errors/page.tsx b/...e2e/app-dir/use-cache/app/errors/page.tsx → .../use-cache/app/(suspense)/errors/page.tsx
diff --git a/.../e2e/app-dir/use-cache/app/errors/util.ts → ...r/use-cache/app/(suspense)/errors/util.ts b/.../e2e/app-dir/use-cache/app/errors/util.ts → ...r/use-cache/app/(suspense)/errors/util.ts
diff --git a/...r/use-cache/app/fetch-revalidate/page.tsx → .../app/(suspense)/fetch-revalidate/page.tsx b/...r/use-cache/app/fetch-revalidate/page.tsx → .../app/(suspense)/fetch-revalidate/page.tsx
diff --git a/test/e2e/app-dir/use-cache/app/layout.tsx → ...p-dir/use-cache/app/(suspense)/layout.tsx b/test/e2e/app-dir/use-cache/app/layout.tsx → ...p-dir/use-cache/app/(suspense)/layout.tsx
diff --git a/.../app-dir/use-cache/app/not-found/page.tsx → ...e-cache/app/(suspense)/not-found/page.tsx b/.../app-dir/use-cache/app/not-found/page.tsx → ...e-cache/app/(suspense)/not-found/page.tsx
@@ -1,3 +1,4 @@
+// TODO: This should not need the suspense boundary in the root layout.
 'use cache'
 
 import { notFound } from 'next/navigation'

diff --git a/test/e2e/app-dir/use-cache/app/page.tsx → ...app-dir/use-cache/app/(suspense)/page.tsx b/test/e2e/app-dir/use-cache/app/page.tsx → ...app-dir/use-cache/app/(suspense)/page.tsx
@@ -1,4 +1,4 @@
-import { Foo } from './client'
+import { Foo } from '../client'
 
 async function getCachedRandom(x: number, children: React.ReactNode) {
   'use cache'

diff --git a/...use-cache/app/with-server-action/form.tsx → ...pp/(suspense)/with-server-action/form.tsx b/...use-cache/app/with-server-action/form.tsx → ...pp/(suspense)/with-server-action/form.tsx
diff --git a/...use-cache/app/with-server-action/page.tsx → ...pp/(suspense)/with-server-action/page.tsx b/...use-cache/app/with-server-action/page.tsx → ...pp/(suspense)/with-server-action/page.tsx
@@ -1,3 +1,5 @@
+// TODO: This should not need the suspense boundary in the root layout, but
+// currently does with Turbopack.
 import { Form } from './form'
 
 async function action() {

diff --git a/test/e2e/app-dir/use-cache/public/favicon.ico b/test/e2e/app-dir/use-cache/public/favicon.ico