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 refreshing inactive segments that contained searchParams #64086

Conversation

ztanner
Copy link
Member

@ztanner ztanner commented Apr 4, 2024

When adding refresh markers for refetching segments that are "stale" (the soft navigation case where they are still in the Router State Tree but not part of the page that we're rendering), they only contained a reference to the pathname. Once the actual refresh was triggered we added the current search params to the request.

However, this causes an issue: segments in the FlightRouterState can contain searchParams (ie, __PAGE__?{"foo": "bar} is what the segment becomes when adding ?foo=bar to a page). This means that when we refresh those nodes from the server, it won't know how to find the CacheNode for the stale segment since we won't have them in the refetch tree. This updates to keep a reference to the searchParams that were part of the request that made it active.

While fixing this, I also noticed that we were missing a spot to add the refetch marker in applyRouterStatePatchToTree in the case of a root refresh (caught by these tests failing in PPR)

x-ref

Closes NEXT-3007

Copy link
Member Author

ztanner commented Apr 4, 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 4, 2024

Tests Passed

@ijjk
Copy link
Member

ijjk commented Apr 4, 2024

Stats from current PR

Default Build (Increase detected ⚠️)
General
vercel/next.js canary vercel/next.js 04-04-fix_refreshing_inactive_segments_that_contained_searchParams Change
buildDuration 14s 14.1s N/A
buildDurationCached 7.5s 6.3s N/A
nodeModulesSize 199 MB 199 MB N/A
nextStartRea..uration (ms) 406ms 404ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js 04-04-fix_refreshing_inactive_segments_that_contained_searchParams 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 241 B 242 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-04-fix_refreshing_inactive_segments_that_contained_searchParams 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-04-fix_refreshing_inactive_segments_that_contained_searchParams 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-04-fix_refreshing_inactive_segments_that_contained_searchParams 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-04-fix_refreshing_inactive_segments_that_contained_searchParams Change
index.html gzip 528 B 528 B
link.html gzip 540 B 541 B N/A
withRouter.html gzip 523 B 524 B N/A
Overall change 528 B 528 B
Edge SSR bundle Size
vercel/next.js canary vercel/next.js 04-04-fix_refreshing_inactive_segments_that_contained_searchParams 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-04-fix_refreshing_inactive_segments_that_contained_searchParams Change
middleware-b..fest.js gzip 625 B 624 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-04-fix_refreshing_inactive_segments_that_contained_searchParams 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.1 kB 51.1 kB
Overall change 945 kB 945 kB
build cache Overall increase ⚠️
vercel/next.js canary vercel/next.js 04-04-fix_refreshing_inactive_segments_that_contained_searchParams Change
0.pack gzip 1.58 MB 1.58 MB N/A
index.pack gzip 106 kB 107 kB ⚠️ +341 B
Overall change 106 kB 107 kB ⚠️ +341 B
Diff details
Diff for middleware.js

Diff too large to display

Diff for 2453-HASH.js

Diff too large to display

Commit: f694ef9

@ztanner ztanner force-pushed the 04-04-fix_refreshing_inactive_segments_that_contained_searchParams branch 4 times, most recently from 98839ba to 3ccca88 Compare April 4, 2024 22:52
@ztanner ztanner marked this pull request as ready for review April 4, 2024 23:10
@ztanner ztanner force-pushed the 04-04-fix_refreshing_inactive_segments_that_contained_searchParams branch from 3ccca88 to f694ef9 Compare April 4, 2024 23:21
@ztanner ztanner enabled auto-merge (squash) April 4, 2024 23:29
@ztanner ztanner merged commit 51549d9 into canary Apr 4, 2024
74 of 79 checks passed
@ztanner ztanner deleted the 04-04-fix_refreshing_inactive_segments_that_contained_searchParams branch April 4, 2024 23:44
epiloguess pushed a commit to epiloguess/next.js that referenced this pull request Apr 5, 2024
…64086)

When adding refresh markers for refetching segments that are "stale"
(the soft navigation case where they are still in the Router State Tree
but not part of the page that we're rendering), they only contained a
reference to the pathname. Once the actual refresh was triggered we
added the current search params to the request.

However, this causes an issue: segments in the `FlightRouterState` can
contain searchParams (ie, `__PAGE__?{"foo": "bar}` is what the segment
becomes when adding `?foo=bar` to a page). This means that when we
refresh those nodes from the server, it won't know how to find the
`CacheNode` for the stale segment since we won't have them in the
refetch tree. This updates to keep a reference to the searchParams that
were part of the request that made it active.

While fixing this, I also noticed that we were missing a spot to add the
refetch marker in `applyRouterStatePatchToTree` in the case of a root
refresh (caught by these tests failing in PPR)


[x-ref](vercel#63900 (reply in thread))

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->


Closes NEXT-3007
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 19, 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.

2 participants