add experimental client router cache config #62856
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Mar 5, 2024
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Tests Passed |
ztanner
force-pushed
the
02-21-Expire_loading_state_cache_separately_from_cache_node_data
branch
from
964927d to
ff5bc7d
Compare
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
2 times, most recently
from
b3d3302 to
98f5d0d
Compare
Stats from current PRDefault Build (Increase detected
|
| vercel/next.js canary | vercel/next.js 03-04-add_experimental_client_router_cache_config | Change | |
|---|---|---|---|
| buildDuration | 14s | 14s | N/A |
| buildDurationCached | 7.6s | 6.2s | N/A |
| nodeModulesSize | 199 MB | 199 MB | |
| nextStartRea..uration (ms) | 402ms | 396ms | N/A |
Client Bundles (main, webpack)
| vercel/next.js canary | vercel/next.js 03-04-add_experimental_client_router_cache_config | Change | |
|---|---|---|---|
| 2453-HASH.js gzip | 31.4 kB | 31.3 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 | 240 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 03-04-add_experimental_client_router_cache_config | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31 kB | 31 kB | ✓ |
| Overall change | 31 kB | 31 kB | ✓ |
Client Pages
| vercel/next.js canary | vercel/next.js 03-04-add_experimental_client_router_cache_config | 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 03-04-add_experimental_client_router_cache_config | 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 03-04-add_experimental_client_router_cache_config | Change | |
|---|---|---|---|
| index.html gzip | 530 B | 528 B | N/A |
| link.html gzip | 541 B | 540 B | N/A |
| withRouter.html gzip | 525 B | 522 B | N/A |
| Overall change | 0 B | 0 B | ✓ |
Edge SSR bundle Size
| vercel/next.js canary | vercel/next.js 03-04-add_experimental_client_router_cache_config | Change | |
|---|---|---|---|
| edge-ssr.js gzip | 95.3 kB | 95.4 kB | N/A |
| page.js gzip | 3.04 kB | 3.06 kB | N/A |
| Overall change | 0 B | 0 B | ✓ |
Middleware size
| vercel/next.js canary | vercel/next.js 03-04-add_experimental_client_router_cache_config | Change | |
|---|---|---|---|
| middleware-b..fest.js gzip | 627 B | 625 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 03-04-add_experimental_client_router_cache_config | 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.1 kB | 15.1 kB | ✓ |
| app-route-tu..prod.js gzip | 15.1 kB | 15.1 kB | ✓ |
| app-route-tu..prod.js gzip | 14.8 kB | 14.8 kB | ✓ |
| app-route.ru...dev.js gzip | 21 kB | 21 kB | ✓ |
| app-route.ru..prod.js gzip | 14.8 kB | 14.8 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 | 944 kB | 944 kB | ✓ |
build cache Overall increase ⚠️
| vercel/next.js canary | vercel/next.js 03-04-add_experimental_client_router_cache_config | Change | |
|---|---|---|---|
| 0.pack gzip | 1.58 MB | 1.58 MB | |
| index.pack gzip | 106 kB | 106 kB | N/A |
| Overall change | 1.58 MB | 1.58 MB |
Diff details
Diff for page.js
Diff too large to display
Diff for middleware.js
Diff too large to display
Diff for edge-ssr.js
Diff too large to display
Diff for 2453-HASH.js
Diff too large to display
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
from
98f5d0d to
372bacb
Compare
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
from
4cb8f43 to
bde812e
Compare
ztanner
changed the title
ztanner
requested review from
timneutkens,
ijjk,
shuding,
huozhi,
feedthejim,
a team and
wyattjoh
as code owners
ztanner
force-pushed
the
02-21-Expire_loading_state_cache_separately_from_cache_node_data
branch
from
ff5bc7d to
af906b6
Compare
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
from
bde812e to
042fda8
Compare
AkifumiSato
reviewed
Mar 6, 2024
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
from
042fda8 to
1413c39
Compare
ztanner
force-pushed
the
02-21-Expire_loading_state_cache_separately_from_cache_node_data
branch
2 times, most recently
from
9200fd8 to
0d8d595
Compare
ztanner
force-pushed
the
03-13-Fix_instant_loading_states
branch
from
8546e49 to
2adea1d
Compare
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
from
da39e05 to
f6cccd0
Compare
ztanner
force-pushed
the
03-13-Fix_instant_loading_states
branch
from
2adea1d to
be44437
Compare
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
from
f6cccd0 to
4e9566a
Compare
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
from
4e9566a to
c0fdedb
Compare
|
may I kindly ask this receive some attention? a lot of us are waiting on this! |
|
same here. Would be nice if this got merged and released |
|
Same here, this fix is very important |
|
upd pls |
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
3 times, most recently
from
a460ea6 to
5d280ab
Compare
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
2 times, most recently
from
58f79f0 to
c31c2c0
Compare
ztanner
force-pushed
the
03-04-add_experimental_client_router_cache_config
branch
from
c31c2c0 to
3098fd1
Compare
feedthejim
approved these changes
Apr 2, 2024
ztanner
added a commit
that referenced
this pull request
Apr 4, 2024
This documents the behavior introduced in #62856 to allow globally overriding the router cache invalidation period. `static` and `dynamic` in this case refer to variable levels of "liveness" and are unrelated to whether the segment itself is opting into static or dynamic rendering. In other words, the current `dynamic` default of 30s suggests that we consider the 30s delta to feel dynamic while still providing some caching for performance reasons. Others might prefer a value of 0s here, hence the configuration. <!-- 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-2995
epiloguess
pushed a commit
to epiloguess/next.js
that referenced
this pull request
Apr 5, 2024
This documents the behavior introduced in vercel#62856 to allow globally overriding the router cache invalidation period. `static` and `dynamic` in this case refer to variable levels of "liveness" and are unrelated to whether the segment itself is opting into static or dynamic rendering. In other words, the current `dynamic` default of 30s suggests that we consider the 30s delta to feel dynamic while still providing some caching for performance reasons. Others might prefer a value of 0s here, hence the configuration. <!-- 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-2995
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This introduces an experimental router flag (
experimental.staleTimes) to change the router cache behavior. Specifically:dynamicis the value that is used when theprefetchLinkprop is left unspecified. (Default 30 seconds)staticis the value that is used when theprefetchLinkprop istrue. (Default 5 minutes)Additional details:
staticproperty (default 5 minutes)Please see the original proposal here for more information. The primary difference is that this is a global configuration, rather than a per-segment configuration, and it isn't applied to layouts. (We expect this to be a "stop-gap" and not the final router caching solution)
Closes NEXT-2703