-
Notifications
You must be signed in to change notification settings - Fork 27.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[unstable_cache] Don't track dynamic fetches in an unstable_cache cal…
…lback (#65010) <!-- 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 # --> ### What? When pages are rendered using partial prerendering (PPR), they can easily trigger cases that attempt to interrupt static rendering. If a user calls `fetch` from within a `unstable_cache` callback with `cache: "no-store"`, we currently break out, as that fetch operation is called within a cached callback. ### Why? Without this change, using `unstable_cache` would have limited affect when dealing with external code that explicitly sets `cache: "no-store"` preventing it from utilizing the user-specified-cache. ### How? This modifies the fetch patching so it doesn't bail static rendering due to dynamic fetches within an `unstable_cache` callback. Closes NEXT-3220
- Loading branch information
Showing
8 changed files
with
203 additions
and
29 deletions.
There are no files selected for viewing
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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| export default function Layout({ children }) { | ||
| return ( | ||
| <html> | ||
| <body>{children}</body> | ||
| </html> | ||
| ) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| import { unstable_cache } from 'next/cache' | ||
|
|
||
| const getData = unstable_cache( | ||
| async () => { | ||
| const noStore = await fetch( | ||
| process.env.TEST_DATA_SERVER + '?cache=no-store', | ||
| { method: 'GET', cache: 'no-store' } | ||
| ).then((res) => res.text()) | ||
|
|
||
| const forceCache = await fetch( | ||
| process.env.TEST_DATA_SERVER + '?cache=force-cache', | ||
| { method: 'GET', cache: 'force-cache' } | ||
| ).then((res) => res.text()) | ||
|
|
||
| return JSON.stringify( | ||
| { | ||
| random: Math.floor(Math.random() * 1000).toString(), | ||
| data: { | ||
| forceCache, | ||
| noStore, | ||
| }, | ||
| }, | ||
| null, | ||
| 2 | ||
| ) | ||
| }, | ||
| undefined, | ||
| { | ||
| tags: ['unstable-cache-fetch'], | ||
| } | ||
| ) | ||
|
|
||
| export default async function Page() { | ||
| const data = await getData() | ||
|
|
||
| return <pre id="data">{data}</pre> | ||
| } |
6 changes: 6 additions & 0 deletions
6
test/e2e/app-dir/ppr-unstable-cache/app/revalidate-tag/route.js
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| import { revalidateTag } from 'next/cache' | ||
|
|
||
| export const POST = async () => { | ||
| revalidateTag('unstable-cache-fetch') | ||
| return new Response('OK', { status: 200 }) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| module.exports = { | ||
| experimental: { | ||
| ppr: true, | ||
| }, | ||
| } |
103 changes: 103 additions & 0 deletions
103
test/e2e/app-dir/ppr-unstable-cache/ppr-unstable-cache.test.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| import { NextInstance, createNext, isNextDeploy, isNextDev } from 'e2e-utils' | ||
| import { findPort } from 'next-test-utils' | ||
| import http from 'node:http' | ||
|
|
||
| describe('ppr-unstable-cache', () => { | ||
| if (isNextDeploy) { | ||
| it.skip('should not run in deploy mode', () => {}) | ||
| return | ||
| } | ||
|
|
||
| if (isNextDev) { | ||
| it.skip('should not run in dev mode', () => {}) | ||
| return | ||
| } | ||
|
|
||
| let next: NextInstance | null = null | ||
| let server: http.Server | null = null | ||
| afterEach(async () => { | ||
| if (next) { | ||
| await next.destroy() | ||
| next = null | ||
| } | ||
|
|
||
| if (server) { | ||
| await server.close() | ||
| server = null | ||
| } | ||
| }) | ||
|
|
||
| it('should not cache inner fetch calls', async () => { | ||
| let generations: string[] = [] | ||
| server = http.createServer(async (req, res) => { | ||
| try { | ||
| if (!req.url) throw new Error('No URL') | ||
|
|
||
| const cache = new URL(req.url, 'http://n').searchParams.get('cache') | ||
| if (!cache) throw new Error('No cache key') | ||
|
|
||
| const random = Math.floor(Math.random() * 1000).toString() | ||
| const data = cache + ':' + random | ||
| generations.push(data) | ||
| res.end(data) | ||
| } catch (err) { | ||
| res.statusCode = 500 | ||
| res.end(err.message) | ||
| } | ||
| }) | ||
| const port = await findPort() | ||
| server.listen(port) | ||
|
|
||
| next = await createNext({ | ||
| files: __dirname, | ||
| env: { TEST_DATA_SERVER: `http://localhost:${port}/` }, | ||
| }) | ||
|
|
||
| expect(generations).toHaveLength(3) | ||
|
|
||
| const first = await next | ||
| .render$('/') | ||
| .then(($) => JSON.parse($('#data').text())) | ||
|
|
||
| expect(generations).toHaveLength(3) | ||
|
|
||
| expect(first.data.forceCache).toBeOneOf(generations) | ||
| expect(first.data.noStore).toBeOneOf(generations) | ||
|
|
||
| // Try a few more times, we should always get the same result. | ||
| for (let i = 0; i < 3; i++) { | ||
| const again = await next | ||
| .render$('/') | ||
| .then(($) => JSON.parse($('#data').text())) | ||
|
|
||
| expect(generations).toHaveLength(3) | ||
| expect(first).toEqual(again) | ||
| } | ||
|
|
||
| // Revalidate the tag associated with the `unstable_cache` call. | ||
| const revalidate = await next.fetch('/revalidate-tag', { method: 'POST' }) | ||
| expect(revalidate.status).toBe(200) | ||
| await revalidate.text() | ||
|
|
||
| const revalidated = await next | ||
| .render$('/') | ||
| .then(($) => JSON.parse($('#data').text())) | ||
|
|
||
| // Expect that the `cache: no-store` value has been updated, but not | ||
| // the `cache: force-cache` value. | ||
| expect(generations).toHaveLength(5) | ||
|
|
||
| // We know now that the generations have been updated, so let's try to | ||
| // validate the value. We don't need to do this within the retry. | ||
| expect(revalidated.random).not.toEqual(first.random) | ||
| expect(revalidated.data.forceCache).toBeOneOf(generations.slice(0, 3)) | ||
| expect(revalidated.data.noStore).toBeOneOf(generations.slice(3)) | ||
| expect(revalidated).not.toEqual(first) | ||
|
|
||
| // Ensure that the `force-cache` value has not been updated, and only called | ||
| // once. | ||
| expect(generations.filter((g) => g.startsWith('force-cache'))).toHaveLength( | ||
| 1 | ||
| ) | ||
| }) | ||
| }) |