Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix interception route refresh behavior with dynamic params #64006

Conversation

ztanner
Copy link
Member

@ztanner ztanner commented Apr 3, 2024

What

When triggering an interception route that has a parent with dynamic params, and then later going to "refresh" the tree, either by calling router.refresh or revalidating in a server action, the refresh action would silently fail and the router would be in a bad state.

Why

Because of the dependency that interception routes currently have on FlightRouterState for dynamic params extraction, we need to make sure the refetch has the full tree so that it can properly extract earlier params. Since the refreshing logic traversed parallel routes and scoped the refresh to that particular segment, it would skip over earlier segments, and so when the server attempted to diff the tree, it would return an updated tree that corresponded with the wrong segment ([locale] rather than ["locale", "en", "d]).

Separately, since a page segment might be __PAGE__?{"locale": "en"} rather than just __PAGE__, this updates the refetch marker logic to do a partial match on the page segment key.

How

This keeps a reference to the root of the updated tree so that the refresh always starts at the top. This has the side effect of re-rendering more data when making the "stale" refetch request, but this is necessary until we can decouple FlightRouterState from interception routes.

shout-out to @steve-marmalade for helping find this bug and providing excellent Replays to help track it down 🙏

x-ref:

Closes NEXT-2986

Copy link
Member Author

ztanner commented Apr 3, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @ztanner and the rest of your teammates on Graphite Graphite

@ijjk
Copy link
Member

ijjk commented Apr 3, 2024

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary vercel/next.js 04-02-fix_interception_route_refresh_behavior_with_dynamic_params Change
buildDuration 13.9s 13.8s N/A
buildDurationCached 8.4s 6.1s N/A
nodeModulesSize 199 MB 199 MB ⚠️ +2.18 kB
nextStartRea..uration (ms) 384ms 401ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js 04-02-fix_interception_route_refresh_behavior_with_dynamic_params Change
2453-HASH.js gzip 31.4 kB 31.4 kB N/A
3304.HASH.js gzip 181 B 181 B
3f784ff6-HASH.js gzip 53.7 kB 53.7 kB
8299-HASH.js gzip 5.04 kB 5.04 kB N/A
framework-HASH.js gzip 45.2 kB 45.2 kB
main-app-HASH.js gzip 242 B 243 B N/A
main-HASH.js gzip 32.2 kB 32.2 kB N/A
webpack-HASH.js gzip 1.68 kB 1.68 kB N/A
Overall change 99 kB 99 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js 04-02-fix_interception_route_refresh_behavior_with_dynamic_params Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary vercel/next.js 04-02-fix_interception_route_refresh_behavior_with_dynamic_params Change
_app-HASH.js gzip 196 B 197 B N/A
_error-HASH.js gzip 184 B 184 B
amp-HASH.js gzip 505 B 505 B
css-HASH.js gzip 324 B 325 B N/A
dynamic-HASH.js gzip 2.5 kB 2.5 kB N/A
edge-ssr-HASH.js gzip 258 B 258 B
head-HASH.js gzip 352 B 352 B
hooks-HASH.js gzip 370 B 371 B N/A
image-HASH.js gzip 4.21 kB 4.21 kB
index-HASH.js gzip 259 B 259 B
link-HASH.js gzip 2.67 kB 2.67 kB N/A
routerDirect..HASH.js gzip 314 B 312 B N/A
script-HASH.js gzip 386 B 386 B
withRouter-HASH.js gzip 309 B 309 B
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 6.57 kB 6.57 kB
Client Build Manifests
vercel/next.js canary vercel/next.js 04-02-fix_interception_route_refresh_behavior_with_dynamic_params Change
_buildManifest.js gzip 481 B 484 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary vercel/next.js 04-02-fix_interception_route_refresh_behavior_with_dynamic_params Change
index.html gzip 528 B 528 B
link.html gzip 541 B 541 B
withRouter.html gzip 524 B 523 B N/A
Overall change 1.07 kB 1.07 kB
Edge SSR bundle Size
vercel/next.js canary vercel/next.js 04-02-fix_interception_route_refresh_behavior_with_dynamic_params Change
edge-ssr.js gzip 95.4 kB 95.4 kB N/A
page.js gzip 3.06 kB 3.06 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary vercel/next.js 04-02-fix_interception_route_refresh_behavior_with_dynamic_params Change
middleware-b..fest.js gzip 625 B 628 B N/A
middleware-r..fest.js gzip 151 B 151 B
middleware.js gzip 25.5 kB 25.5 kB N/A
edge-runtime..pack.js gzip 839 B 839 B
Overall change 990 B 990 B
Next Runtimes
vercel/next.js canary vercel/next.js 04-02-fix_interception_route_refresh_behavior_with_dynamic_params Change
app-page-exp...dev.js gzip 170 kB 170 kB
app-page-exp..prod.js gzip 97 kB 97 kB
app-page-tur..prod.js gzip 98.8 kB 98.8 kB
app-page-tur..prod.js gzip 93 kB 93 kB
app-page.run...dev.js gzip 144 kB 144 kB
app-page.run..prod.js gzip 91.5 kB 91.5 kB
app-route-ex...dev.js gzip 21.4 kB 21.4 kB
app-route-ex..prod.js gzip 15.2 kB 15.2 kB
app-route-tu..prod.js gzip 15.2 kB 15.2 kB
app-route-tu..prod.js gzip 14.9 kB 14.9 kB
app-route.ru...dev.js gzip 21.1 kB 21.1 kB
app-route.ru..prod.js gzip 14.9 kB 14.9 kB
pages-api-tu..prod.js gzip 9.55 kB 9.55 kB
pages-api.ru...dev.js gzip 9.82 kB 9.82 kB
pages-api.ru..prod.js gzip 9.55 kB 9.55 kB
pages-turbo...prod.js gzip 22.5 kB 22.5 kB
pages.runtim...dev.js gzip 23.1 kB 23.1 kB
pages.runtim..prod.js gzip 22.4 kB 22.4 kB
server.runti..prod.js gzip 51 kB 51 kB
Overall change 945 kB 945 kB
build cache Overall increase ⚠️
vercel/next.js canary vercel/next.js 04-02-fix_interception_route_refresh_behavior_with_dynamic_params Change
0.pack gzip 1.58 MB 1.58 MB ⚠️ +1.93 kB
index.pack gzip 106 kB 106 kB N/A
Overall change 1.58 MB 1.58 MB ⚠️ +1.93 kB
Diff details
Diff for middleware.js

Diff too large to display

Diff for 2453-HASH.js

Diff too large to display

Commit: b06c0fb

@ijjk
Copy link
Member

ijjk commented Apr 3, 2024

Tests Passed

@ztanner ztanner force-pushed the 04-02-fix_interception_route_refresh_behavior_with_dynamic_params branch 2 times, most recently from 6a4b624 to 533c194 Compare April 3, 2024 13:48
@ztanner ztanner force-pushed the 04-02-fix_interception_route_refresh_behavior_with_dynamic_params branch from 533c194 to b06c0fb Compare April 3, 2024 13:51
@ztanner ztanner marked this pull request as ready for review April 3, 2024 14:04
@ztanner ztanner merged commit ad98cda into canary Apr 3, 2024
83 checks passed
@ztanner ztanner deleted the 04-02-fix_interception_route_refresh_behavior_with_dynamic_params branch April 3, 2024 16:04
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants