Skip to content

Commit

Permalink
prevent duplicate RSC fetch when action redirects (#66620)
Browse files Browse the repository at this point in the history
When checking which segment(s) need to be refreshed, we currently
compare the current page URL with the segment's refresh marker.

We should inspect the `mutable.canonicalUrl` value first since that's
the URL we're changing to, followed by `state.canonicalUrl` as a
fallback (indicating that there's no URL change pending). This is
because the server action handler will receive a redirect URL prior to
`location.pathname` being updated, so the router will incorrectly think
it needs to refresh the data for the page we're going to.

Closes NEXT-3500
  • Loading branch information
ztanner committed Jun 10, 2024
1 parent dd6ab93 commit f7ec039
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ export function refreshReducer(
updatedTree: newTree,
updatedCache: cache,
includeNextUrl,
canonicalUrl: mutable.canonicalUrl || state.canonicalUrl,
})

mutable.cache = cache
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,11 @@ export function serverActionReducer(
// Remove cache.data as it has been resolved at this point.
mutable.inFlightServerAction = null

if (redirectLocation) {
const newHref = createHrefFromUrl(redirectLocation, false)
mutable.canonicalUrl = newHref
}

for (const flightDataPath of flightData) {
// FlightDataPath with more than two items means unexpected Flight data was returned
if (flightDataPath.length !== 3) {
Expand Down Expand Up @@ -266,23 +271,17 @@ export function serverActionReducer(
updatedTree: newTree,
updatedCache: cache,
includeNextUrl: Boolean(nextUrl),
canonicalUrl: mutable.canonicalUrl || state.canonicalUrl,
})

mutable.cache = cache
mutable.prefetchCache = new Map()
}

mutable.patchedTree = newTree
mutable.canonicalUrl = href

currentTree = newTree
}

if (redirectLocation) {
const newHref = createHrefFromUrl(redirectLocation, false)
mutable.canonicalUrl = newHref
}

resolve(actionResult)

return handleMutable(state, mutable)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ interface RefreshInactiveParallelSegments {
updatedTree: FlightRouterState
updatedCache: CacheNode
includeNextUrl: boolean
canonicalUrl: string
}

/**
Expand Down Expand Up @@ -41,6 +42,7 @@ async function refreshInactiveParallelSegmentsImpl({
includeNextUrl,
fetchedSegments,
rootTree = updatedTree,
canonicalUrl,
}: RefreshInactiveParallelSegments & {
fetchedSegments: Set<string>
rootTree: FlightRouterState
Expand All @@ -50,7 +52,7 @@ async function refreshInactiveParallelSegmentsImpl({

if (
refetchPath &&
refetchPath !== location.pathname + location.search &&
refetchPath !== canonicalUrl &&
refetchMarker === 'refresh' &&
// it's possible for the tree to contain multiple segments that contain data at the same URL
// we keep track of them so we can dedupe the requests
Expand Down Expand Up @@ -94,6 +96,7 @@ async function refreshInactiveParallelSegmentsImpl({
includeNextUrl,
fetchedSegments,
rootTree,
canonicalUrl,
})

fetchPromises.push(parallelFetchPromise)
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/app-dir/parallel-routes-revalidation/app/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default async function Home() {
).then((res) => res.text())

return (
<div>
<div id="root-page">
<Link href="/revalidate-modal">Open Revalidate Modal</Link>
<Link href="/refresh-modal">Open Refresh Modal</Link>
<Link href="/redirect-modal">Open Redirect Modal</Link>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ export default function Page() {
redirect('/')
}}
>
<button type="submit">Redirect</button>
<button type="submit" id="redirect-page">
Redirect
</button>
</form>
)
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ createNextDescribe(
{
files: __dirname,
},
({ next }) => {
({ next, isNextStart }) => {
it('should submit the action and revalidate the page data', async () => {
const browser = await next.browser('/')
await check(() => browser.hasElementByCssSelector('#create-entry'), false)
Expand Down Expand Up @@ -423,5 +423,38 @@ createNextDescribe(
})
})
})

it('should not trigger a refresh for the page that is being redirected to', async () => {
const rscRequests = []
const prefetchRequests = []
const browser = await next.browser('/redirect', {
beforePageLoad(page) {
page.on('request', async (req) => {
const headers = await req.allHeaders()
if (headers['rsc']) {
const pathname = new URL(req.url()).pathname

if (headers['next-router-prefetch']) {
prefetchRequests.push(pathname)
} else {
rscRequests.push(pathname)
}
}
})
},
})

await browser.elementByCss('button').click()
await browser.waitForElementByCss('#root-page')
await browser.waitForIdleNetwork()

await retry(async () => {
expect(rscRequests.length).toBe(0)

if (isNextStart) {
expect(prefetchRequests.length).toBe(4)
}
})
})
}
)

0 comments on commit f7ec039

Please sign in to comment.