fix revalidation issue with route handlers #63213
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
ijjk
added
area: tests
created-by: Next.js team
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Stats from current PRDefault Build (Increase detected
|
| vercel/next.js canary | vercel/next.js 03-12-fix_revalidation_issue_with_route_handlers | Change | |
|---|---|---|---|
| buildDuration | 13.9s | 14s | N/A |
| buildDurationCached | 7.4s | 6.2s | N/A |
| nodeModulesSize | 198 MB | 198 MB | |
| nextStartRea..uration (ms) | 435ms | 429ms | N/A |
Client Bundles (main, webpack)
| vercel/next.js canary | vercel/next.js 03-12-fix_revalidation_issue_with_route_handlers | Change | |
|---|---|---|---|
| 2453-HASH.js gzip | 30.5 kB | 30.5 kB | N/A |
| 3304.HASH.js gzip | 181 B | 181 B | ✓ |
| 3f784ff6-HASH.js gzip | 53.7 kB | 53.7 kB | N/A |
| 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 | 242 B | ✓ |
| 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 | 45.6 kB | 45.6 kB | ✓ |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | vercel/next.js 03-12-fix_revalidation_issue_with_route_handlers | 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-12-fix_revalidation_issue_with_route_handlers | 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-12-fix_revalidation_issue_with_route_handlers | 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-12-fix_revalidation_issue_with_route_handlers | Change | |
|---|---|---|---|
| index.html gzip | 528 B | 529 B | N/A |
| link.html gzip | 541 B | 541 B | ✓ |
| withRouter.html gzip | 523 B | 523 B | ✓ |
| Overall change | 1.06 kB | 1.06 kB | ✓ |
Edge SSR bundle Size
| vercel/next.js canary | vercel/next.js 03-12-fix_revalidation_issue_with_route_handlers | Change | |
|---|---|---|---|
| edge-ssr.js gzip | 95.1 kB | 95.1 kB | N/A |
| page.js gzip | 3.06 kB | 3.07 kB | N/A |
| Overall change | 0 B | 0 B | ✓ |
Middleware size
| vercel/next.js canary | vercel/next.js 03-12-fix_revalidation_issue_with_route_handlers | Change | |
|---|---|---|---|
| middleware-b..fest.js gzip | 626 B | 623 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-12-fix_revalidation_issue_with_route_handlers | Change | |
|---|---|---|---|
| app-page-exp...dev.js gzip | 171 kB | 171 kB | ✓ |
| app-page-exp..prod.js gzip | 96.6 kB | 96.6 kB | ✓ |
| app-page-tur..prod.js gzip | 98.3 kB | 98.3 kB | ✓ |
| app-page-tur..prod.js gzip | 92.8 kB | 92.8 kB | ✓ |
| app-page.run...dev.js gzip | 149 kB | 149 kB | ✓ |
| app-page.run..prod.js gzip | 91.3 kB | 91.3 kB | ✓ |
| app-route-ex...dev.js gzip | 21.3 kB | 21.3 kB | ✓ |
| app-route-ex..prod.js gzip | 15 kB | 15 kB | ✓ |
| app-route-tu..prod.js gzip | 15 kB | 15 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.52 kB | 9.52 kB | ✓ |
| pages-api.ru...dev.js gzip | 9.8 kB | 9.8 kB | ✓ |
| pages-api.ru..prod.js gzip | 9.52 kB | 9.52 kB | ✓ |
| pages-turbo...prod.js gzip | 22.3 kB | 22.3 kB | ✓ |
| pages.runtim...dev.js gzip | 22.9 kB | 22.9 kB | ✓ |
| pages.runtim..prod.js gzip | 22.3 kB | 22.3 kB | ✓ |
| server.runti..prod.js gzip | 50.5 kB | 50.5 kB | ✓ |
| Overall change | 948 kB | 948 kB | ✓ |
build cache Overall increase ⚠️
| vercel/next.js canary | vercel/next.js 03-12-fix_revalidation_issue_with_route_handlers | Change | |
|---|---|---|---|
| 0.pack gzip | 1.56 MB | 1.56 MB | N/A |
| index.pack gzip | 105 kB | 106 kB | |
| Overall change | 105 kB | 106 kB |
Diff details
Diff for middleware.js
Diff too large to display
Tests Passed |
ztanner
force-pushed
the
03-12-fix_revalidation_issue_with_route_handlers
branch
from
60bea91
to
9377add
Compare
ztanner
force-pushed
the
03-12-fix_revalidation_issue_with_route_handlers
branch
from
9377add
to
14a1beb
Compare
ztanner
requested review from
timneutkens,
ijjk,
shuding,
huozhi,
feedthejim and
wyattjoh
as code owners
ijjk
approved these changes
Mar 12, 2024
wyattjoh
reviewed
Mar 18, 2024
Comment on lines
+94
to
+97
| const revalidate = | ||
| typeof context.renderOpts.store?.revalidate === 'undefined' | ||
| ? false | ||
| : context.renderOpts.store.revalidate |
There was a problem hiding this comment.
Good use case for the ?? operator!
ztanner
added a commit
that referenced
this pull request
Mar 18, 2024
### What When a route handler uses an API that opts it into dynamic rendering (such as `no-store` on a fetch), and also specifies a `revalidate` time, the `revalidate` time is ignored and route is treated as fully static. ### Why `revalidate: 0` and `revalidate: false` have different semantic meanings: `false` essentially means cache forever, whereas `0` means it's dynamic. Since `0` is also falsey, the code we have to fallback with a default `revalidate` value for route handlers is incorrectly not marking the route as dynamic, and as a result, caching the route without an expiration time. ### How This updates the fallback handling for app routes respect a revalidation value of `0`, so that the page can properly be marked dynamic. ### Test Explanation This adds 2 new routes handlers: both have a revalidation time specified & use `no-store` on a fetch, but only one of them specifies `export const dynamic = 'force-static'`. The one that doesn't specify `force-static` is correctly omitted from the prerender manifest. The one that is `force-static` is correctly in the prerender manifest with the right expiration time. An additional test case was added to verify that this data refreshes after the specified interval. Closes NEXT-2764
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.
What
When a route handler uses an API that opts it into dynamic rendering (such as
no-storeon a fetch), and also specifies arevalidatetime, therevalidatetime is ignored and route is treated as fully static.Why
revalidate: 0andrevalidate: falsehave different semantic meanings:falseessentially means cache forever, whereas0means it's dynamic. Since0is also falsey, the code we have to fallback with a defaultrevalidatevalue for route handlers is incorrectly not marking the route as dynamic, and as a result, caching the route without an expiration time.How
This updates the fallback handling for app routes respect a revalidation value of
0, so that the page can properly be marked dynamic.Test Explanation
This adds 2 new routes handlers: both have a revalidation time specified & use
no-storeon a fetch, but only one of them specifiesexport const dynamic = 'force-static'. The one that doesn't specifyforce-staticis correctly omitted from the prerender manifest. The one that isforce-staticis correctly in the prerender manifest with the right expiration time. An additional test case was added to verify that this data refreshes after the specified interval.Closes NEXT-2764