Unverified Commit 7cc0ed1f authored by Jude Gao's avatar Jude Gao Committed by GitHub

Fix: Resolve <Head> PPR resume mismatch by search params (#82587)

The `key` prop on `<Head>` component differs during prerender and a PPR
resume because of search params being part of the key, causing the
resume to treat them as distinct components, hence the error\*. However,
it is necessary semantically to include search params in the key for
`<Head>`, so we will remove the search params from the key during the
resume SSR.

\*Mismatch Error:
```
 ⨯ [Error: Couldn't find all resumable slots by key/index during replaying.
The tree doesn't match so React will fallback to client rendering.]
```
parent 9c9aaed5
...@@ -474,8 +474,17 @@ function Router({ ...@@ -474,8 +474,17 @@ function Router({
// //
// The `key` is used to remount the component whenever the head moves to // The `key` is used to remount the component whenever the head moves to
// a different segment. // a different segment.
const [headCacheNode, headKey] = matchingHead const [headCacheNode, headKey, headKeyWithoutSearchParams] = matchingHead
head = <Head key={headKey} headCacheNode={headCacheNode} />
head = (
<Head
key={
// Necessary for PPR: omit search params from the key to match prerendered keys
typeof window === 'undefined' ? headKeyWithoutSearchParams : headKey
}
headCacheNode={headCacheNode}
/>
)
} else { } else {
head = null head = null
} }
......
...@@ -6,19 +6,20 @@ import { createRouterCacheKey } from '../create-router-cache-key' ...@@ -6,19 +6,20 @@ import { createRouterCacheKey } from '../create-router-cache-key'
export function findHeadInCache( export function findHeadInCache(
cache: CacheNode, cache: CacheNode,
parallelRoutes: FlightRouterState[1] parallelRoutes: FlightRouterState[1]
): [CacheNode, string] | null { ): [CacheNode, string, string] | null {
return findHeadInCacheImpl(cache, parallelRoutes, '') return findHeadInCacheImpl(cache, parallelRoutes, '', '')
} }
function findHeadInCacheImpl( function findHeadInCacheImpl(
cache: CacheNode, cache: CacheNode,
parallelRoutes: FlightRouterState[1], parallelRoutes: FlightRouterState[1],
keyPrefix: string keyPrefix: string,
): [CacheNode, string] | null { keyPrefixWithoutSearchParams: string
): [CacheNode, string, string] | null {
const isLastItem = Object.keys(parallelRoutes).length === 0 const isLastItem = Object.keys(parallelRoutes).length === 0
if (isLastItem) { if (isLastItem) {
// Returns the entire Cache Node of the segment whose head we will render. // Returns the entire Cache Node of the segment whose head we will render.
return [cache, keyPrefix] return [cache, keyPrefix, keyPrefixWithoutSearchParams]
} }
// First try the 'children' parallel route if it exists // First try the 'children' parallel route if it exists
...@@ -45,6 +46,7 @@ function findHeadInCacheImpl( ...@@ -45,6 +46,7 @@ function findHeadInCacheImpl(
} }
const cacheKey = createRouterCacheKey(segment) const cacheKey = createRouterCacheKey(segment)
const cacheKeyWithoutSearchParams = createRouterCacheKey(segment, true)
const cacheNode = childSegmentMap.get(cacheKey) const cacheNode = childSegmentMap.get(cacheKey)
if (!cacheNode) { if (!cacheNode) {
...@@ -54,8 +56,10 @@ function findHeadInCacheImpl( ...@@ -54,8 +56,10 @@ function findHeadInCacheImpl(
const item = findHeadInCacheImpl( const item = findHeadInCacheImpl(
cacheNode, cacheNode,
childParallelRoutes, childParallelRoutes,
keyPrefix + '/' + cacheKey keyPrefix + '/' + cacheKey,
keyPrefix + '/' + cacheKeyWithoutSearchParams
) )
if (item) { if (item) {
return item return item
} }
......
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html lang="en">
<body>{children}</body>
</html>
)
}
import { connection } from 'next/server'
import { Suspense } from 'react'
export default function Page() {
return (
<p>
hello world
<Suspense>
<DynamicHole />
</Suspense>
</p>
)
}
export const generateMetadata = async () => {
await connection()
return {
title: `Hello World`,
}
}
const DynamicHole = async () => {
await connection()
return <p>Dynamic Hole</p>
}
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {
experimental: {
cacheComponents: true,
clientSegmentCache: true,
},
}
module.exports = nextConfig
import { nextTestSetup } from 'e2e-utils'
describe('resuming-head-runtime-search-param', () => {
const { next } = nextTestSetup({
files: __dirname,
})
it('should not show resumable slots error when using runtime search params', async () => {
const browser = await next.browser('/?foo=bar&test=123')
// Check that the page renders correctly
await browser.waitForElementByCss('p')
const text = await browser.elementByCss('p').text()
expect(text).toContain('hello world')
// Wait for dynamic content to load (it's rendered inside the first p element)
await browser.waitForElementByCss('p p')
const dynamicText = await browser.elementByCss('p p').text()
expect(dynamicText).toContain('Dynamic Hole')
// Check server logs for the specific error message
expect(next.cliOutput).not.toContain(
"Couldn't find all resumable slots by key/index during replaying. The tree doesn't match so React will fallback to client rendering."
)
})
})
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment