Unverified Commit 3cd9264a authored by Zack Tanner's avatar Zack Tanner Committed by GitHub

tweak cache + revalidate fetch warning (#58505)

### What?
When using a `Request` object with fetch, we'll log a warning indicating that using the `cache` property in addition to `revalidate` is unsupported.

### Why?
`Request` sets some defaults on the request init, such as `cache: "default"`. This makes the warning confusing and there's no way to avoid it aside from switching the resource argument to be a URL string instead.

### How?
This keeps existing behavior but omits the log in the case where a request object is used and no explicit cache overrides are specified.

Fixes #58109
parent d6d6d561
...@@ -266,9 +266,13 @@ export function patchFetch({ ...@@ -266,9 +266,13 @@ export function patchFetch({
typeof _cache === 'string' && typeof _cache === 'string' &&
typeof curRevalidate !== 'undefined' typeof curRevalidate !== 'undefined'
) { ) {
Log.warn( // when providing fetch with a Request input, it'll automatically set a cache value of 'default'
`fetch for ${fetchUrl} on ${staticGenerationStore.urlPathname} specified "cache: ${_cache}" and "revalidate: ${curRevalidate}", only one should be specified.` // we only want to warn if the user is explicitly setting a cache value
) if (!(isRequestInput && _cache === 'default')) {
Log.warn(
`fetch for ${fetchUrl} on ${staticGenerationStore.urlPathname} specified "cache: ${_cache}" and "revalidate: ${curRevalidate}", only one should be specified.`
)
}
_cache = undefined _cache = undefined
} }
......
export const fetchCache = 'default-cache'
export default async function Page() {
await fetch(
new Request(
'https://next-data-api-endpoint.vercel.app/api/random?request-input'
),
{
next: {
revalidate: 3,
},
}
)
await fetch(
new Request(
'https://next-data-api-endpoint.vercel.app/api/random?request-input-cache-override',
{
cache: 'force-cache',
}
),
{
next: {
revalidate: 3,
},
}
)
await fetch(
'https://next-data-api-endpoint.vercel.app/api/random?request-string',
{
next: {
revalidate: 3,
},
cache: 'force-cache',
}
)
return <div>Hello World!</div>
}
import { check } from 'next-test-utils'
import { createNextDescribe } from 'e2e-utils'
createNextDescribe(
'app-dir - fetch warnings',
{
skipDeployment: true,
files: __dirname,
},
({ next }) => {
beforeAll(async () => {
// we don't need verbose logging (enabled by default in this Next app) for these tests to work
// we avoid enabling it since it's not currently compatible with Turbopack.
await next.stop()
await next.deleteFile('next.config.js')
await next.start()
await next.fetch('/cache-revalidate')
})
it('should log when request input is a string', async () => {
await check(() => {
return next.cliOutput.includes(
'fetch for https://next-data-api-endpoint.vercel.app/api/random?request-string on /cache-revalidate specified "cache: force-cache" and "revalidate: 3", only one should be specified'
)
? 'success'
: 'fail'
}, 'success')
})
it('should log when request input is a Request instance', async () => {
await check(() => {
return next.cliOutput.includes(
'fetch for https://next-data-api-endpoint.vercel.app/api/random?request-input-cache-override on /cache-revalidate specified "cache: force-cache" and "revalidate: 3", only one should be specified.'
)
? 'success'
: 'fail'
}, 'success')
})
it('should not log when overriding cache within the Request object', async () => {
await check(() => {
return next.cliOutput.includes(
`fetch for https://next-data-api-endpoint.vercel.app/api/random?request-input on /cache-revalidate specified "cache: default" and "revalidate: 3", only one should be specified.`
)
? 'fail'
: 'success'
}, 'success')
})
}
)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment