Unverified Commit d2548b54 authored by Zack Tanner's avatar Zack Tanner Committed by GitHub

fix router revalidation behavior for dynamic interception routes (#63768)

### What
When calling `revalidatePath` or `revalidateTag` in a server action for
an intercepted route with dynamic segments, the page would do a full
browser refresh.

### Why
When constructing rewrites for interception routes, the route params
leading up to the interception route are "voided" with a
`__NEXT_EMPTY_PARAM__` demarcation. When it comes time to look up the
values for these dynamic segments, since the params aren't going to be
part of the URL, they get matched via `FlightRouterState`
([ref](https://github.com/vercel/next.js/blob/d67d658ce7396c4b6be1b724be5f45763d5a1803/packages/next/src/server/app-render/app-render.tsx#L153-L201)).

The `shouldProvideFlightRouterState` variable only passes it through for
RSC requests; however, since the server action will perform the action &
return the flight data in a single pass, that means the updated tree
from the server action isn't going to receive the `FlightRouterState`
when constructing the new tree. This means the old tree will have a
`["locale", "en", "d"]` segment, and the new tree from the server action
will have `"[locale]"`. When the router detects this kind of segment
mismatch, it assumes the user navigated to a new root layout, and
triggers an MPA navigation.

### How
This unconditionally provides the `FlightRouterState` to
`makeGetDynamicParamFromSegment` so that it can properly extract dynamic
params for interception routes. We currently enforce interception routes
to be dynamic due to this `FlightRouterState` dependency.

Fixes #59796
Closes NEXT-2079
parent 68de4c03
...@@ -133,7 +133,7 @@ export type AppRenderContext = AppRenderBaseContext & { ...@@ -133,7 +133,7 @@ export type AppRenderContext = AppRenderBaseContext & {
isPrefetch: boolean isPrefetch: boolean
requestTimestamp: number requestTimestamp: number
appUsingSizeAdjustment: boolean appUsingSizeAdjustment: boolean
providedFlightRouterState?: FlightRouterState flightRouterState?: FlightRouterState
requestId: string requestId: string
defaultRevalidate: Revalidate defaultRevalidate: Revalidate
pagePath: string pagePath: string
...@@ -158,7 +158,7 @@ function createNotFoundLoaderTree(loaderTree: LoaderTree): LoaderTree { ...@@ -158,7 +158,7 @@ function createNotFoundLoaderTree(loaderTree: LoaderTree): LoaderTree {
* so we need to read it from the router state. * so we need to read it from the router state.
*/ */
function findDynamicParamFromRouterState( function findDynamicParamFromRouterState(
providedFlightRouterState: FlightRouterState | undefined, flightRouterState: FlightRouterState | undefined,
segment: string segment: string
): { ): {
param: string param: string
...@@ -166,11 +166,11 @@ function findDynamicParamFromRouterState( ...@@ -166,11 +166,11 @@ function findDynamicParamFromRouterState(
treeSegment: Segment treeSegment: Segment
type: DynamicParamTypesShort type: DynamicParamTypesShort
} | null { } | null {
if (!providedFlightRouterState) { if (!flightRouterState) {
return null return null
} }
const treeSegment = providedFlightRouterState[0] const treeSegment = flightRouterState[0]
if (canSegmentBeOverridden(segment, treeSegment)) { if (canSegmentBeOverridden(segment, treeSegment)) {
if (!Array.isArray(treeSegment) || Array.isArray(segment)) { if (!Array.isArray(treeSegment) || Array.isArray(segment)) {
...@@ -185,9 +185,7 @@ function findDynamicParamFromRouterState( ...@@ -185,9 +185,7 @@ function findDynamicParamFromRouterState(
} }
} }
for (const parallelRouterState of Object.values( for (const parallelRouterState of Object.values(flightRouterState[1])) {
providedFlightRouterState[1]
)) {
const maybeDynamicParam = findDynamicParamFromRouterState( const maybeDynamicParam = findDynamicParamFromRouterState(
parallelRouterState, parallelRouterState,
segment segment
...@@ -207,7 +205,7 @@ export type CreateSegmentPath = (child: FlightSegmentPath) => FlightSegmentPath ...@@ -207,7 +205,7 @@ export type CreateSegmentPath = (child: FlightSegmentPath) => FlightSegmentPath
*/ */
function makeGetDynamicParamFromSegment( function makeGetDynamicParamFromSegment(
params: { [key: string]: any }, params: { [key: string]: any },
providedFlightRouterState: FlightRouterState | undefined flightRouterState: FlightRouterState | undefined
): GetDynamicParamFromSegment { ): GetDynamicParamFromSegment {
return function getDynamicParamFromSegment( return function getDynamicParamFromSegment(
// [slug] / [[slug]] / [...slug] // [slug] / [[slug]] / [...slug]
...@@ -245,7 +243,7 @@ function makeGetDynamicParamFromSegment( ...@@ -245,7 +243,7 @@ function makeGetDynamicParamFromSegment(
treeSegment: [key, '', type], treeSegment: [key, '', type],
} }
} }
return findDynamicParamFromRouterState(providedFlightRouterState, segment) return findDynamicParamFromRouterState(flightRouterState, segment)
} }
const type = getShortDynamicParamType(segmentParam.type) const type = getShortDynamicParamType(segmentParam.type)
...@@ -285,7 +283,7 @@ async function generateFlight( ...@@ -285,7 +283,7 @@ async function generateFlight(
staticGenerationStore: { urlPathname }, staticGenerationStore: { urlPathname },
query, query,
requestId, requestId,
providedFlightRouterState, flightRouterState,
} = ctx } = ctx
if (!options?.skipFlight) { if (!options?.skipFlight) {
...@@ -304,7 +302,7 @@ async function generateFlight( ...@@ -304,7 +302,7 @@ async function generateFlight(
createSegmentPath: (child) => child, createSegmentPath: (child) => child,
loaderTreeToFilter: loaderTree, loaderTreeToFilter: loaderTree,
parentParams: {}, parentParams: {},
flightRouterState: providedFlightRouterState, flightRouterState,
isFirst: true, isFirst: true,
// For flight, render metadata inside leaf page // For flight, render metadata inside leaf page
rscPayloadHead: ( rscPayloadHead: (
...@@ -752,11 +750,9 @@ async function renderToHTMLOrFlightImpl( ...@@ -752,11 +750,9 @@ async function renderToHTMLOrFlightImpl(
// extract dynamic params. // extract dynamic params.
isInterceptionRouteAppPath(pagePath)) isInterceptionRouteAppPath(pagePath))
let providedFlightRouterState = shouldProvideFlightRouterState const parsedFlightRouterState = parseAndValidateFlightRouterState(
? parseAndValidateFlightRouterState( req.headers[NEXT_ROUTER_STATE_TREE.toLowerCase()]
req.headers[NEXT_ROUTER_STATE_TREE.toLowerCase()] )
)
: undefined
/** /**
* The metadata items array created in next-app-loader with all relevant information * The metadata items array created in next-app-loader with all relevant information
...@@ -777,7 +773,9 @@ async function renderToHTMLOrFlightImpl( ...@@ -777,7 +773,9 @@ async function renderToHTMLOrFlightImpl(
const getDynamicParamFromSegment = makeGetDynamicParamFromSegment( const getDynamicParamFromSegment = makeGetDynamicParamFromSegment(
params, params,
providedFlightRouterState // `FlightRouterState` is unconditionally provided here because this method uses it
// to extract dynamic params as a fallback if they're not present in the path.
parsedFlightRouterState
) )
const ctx: AppRenderContext = { const ctx: AppRenderContext = {
...@@ -787,7 +785,9 @@ async function renderToHTMLOrFlightImpl( ...@@ -787,7 +785,9 @@ async function renderToHTMLOrFlightImpl(
isPrefetch: isPrefetchRSCRequest, isPrefetch: isPrefetchRSCRequest,
requestTimestamp, requestTimestamp,
appUsingSizeAdjustment, appUsingSizeAdjustment,
providedFlightRouterState, flightRouterState: shouldProvideFlightRouterState
? parsedFlightRouterState
: undefined,
requestId, requestId,
defaultRevalidate: false, defaultRevalidate: false,
pagePath, pagePath,
......
'use client'
import { usePathname } from 'next/navigation'
import { ReactNode } from 'react'
export default function Layout({ children }: { children: ReactNode }) {
const pathname = usePathname()
return <>{pathname.endsWith('view') ? children : null}</>
}
import Modal from '../../../../modal'
export default function Page({ params }: { params: { id: string } }) {
return (
<div>
<h1 id="intercepted-page">Intercepted Page</h1>
<Modal photoId={params.id} />
</div>
)
}
'use server'
import { revalidatePath } from 'next/cache'
export async function doAction() {
revalidatePath('/en/photos/1/view')
// sleep 1s
await new Promise((resolve) => setTimeout(resolve, 1000))
return Math.random()
}
import React from 'react'
export default function Root({
children,
modal,
}: {
children: React.ReactNode
modal: React.ReactNode
}) {
return (
<html>
<body>
{children}
{modal}
</body>
</html>
)
}
'use client'
import { useState } from 'react'
import { doAction } from './actions'
export default function Modal({ photoId }: { photoId: string }) {
const [loading, setLoading] = useState(false)
const [result, setResult] = useState<number>()
async function handleClick() {
setLoading(true)
const result = await doAction()
setLoading(false)
setResult(result)
}
return (
<>
<h2>Photo Id: {photoId}</h2>
<button onClick={handleClick}>Revalidate</button>
{loading && <div id="loading">Loading...</div>}
{result && <div id="result">Result: {result}</div>}
</>
)
}
import Link from 'next/link'
export default async function Home() {
return (
<div>
Root Page <Link href="/en/photos/1/view">To Photo</Link>
</div>
)
}
import Modal from '../../../modal'
export default function PhotoPage({
params: { id },
}: {
params: { id: string }
}) {
return (
<div className="container mx-auto my-10">
<div className="w-1/2 mx-auto border border-gray-700">
<h1 id="full-page">Full Page</h1>
<Modal photoId={id} />
</div>
</div>
)
}
import { nextTestSetup } from 'e2e-utils'
import { retry } from 'next-test-utils'
describe('dynamic-interception-route-revalidate', () => {
const { next } = nextTestSetup({
files: __dirname,
})
it('should refresh the dynamic intercepted route when the interception route is revalidated', async () => {
const browser = await next.browser('/en')
// trigger the interception
await browser.elementByCss("[href='/en/photos/1/view']").click()
// verify we're on the intercepted page
await browser.waitForElementByCss('#intercepted-page')
expect(await browser.elementByCss('h2').text()).toBe('Photo Id: 1')
// trigger the revalidate
await browser.elementByCss('button').click()
// make sure the loading state fired
await browser.waitForElementByCss('#loading')
// verify that we get a result from the server action
await retry(async () => {
const result = await browser.elementByCss('#result').text()
expect(result).toMatch(/^Result: 0(\.\d+)?$/)
})
// make sure we're still on the intercepted page
expect(await browser.hasElementByCssSelector('#intercepted-page')).toBe(
true
)
// refresh the page to get the full (non-intercepted) page
await browser.refresh()
expect(await browser.hasElementByCssSelector('#intercepted-page')).toBe(
false
)
expect(await browser.hasElementByCssSelector('#full-page')).toBe(true)
})
})
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {}
module.exports = nextConfig
...@@ -1382,6 +1382,15 @@ ...@@ -1382,6 +1382,15 @@
"flakey": [], "flakey": [],
"runtimeError": false "runtimeError": false
}, },
"test/e2e/app-dir/dynamic-interception-route-revalidate/dynamic-interception-route-revalidate.test.ts": {
"passed": [],
"failed": [
"dynamic-interception-route-revalidate should refresh the dynamic intercepted route when the interception route is revalidated"
],
"pending": [],
"flakey": [],
"runtimeError": false
},
"test/e2e/app-dir/dynamic-requests/dynamic-requests.test.ts": { "test/e2e/app-dir/dynamic-requests/dynamic-requests.test.ts": {
"passed": [ "passed": [
"dynamic-requests should not error for dynamic requests in pages", "dynamic-requests should not error for dynamic requests in pages",
......
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