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

Ensure fetch cache TTL is updated properly #69164

Merged
merged 4 commits into from
Aug 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions packages/next/src/server/lib/incremental-cache/fetch-cache.ts
Original file line number Diff line number Diff line change
Expand Up @@ -337,26 +337,6 @@ export default class FetchCache implements CacheHandler {
public async set(...args: Parameters<CacheHandler['set']>) {
const [key, data, ctx] = args

const newValue =
data?.kind === CachedRouteKind.FETCH ? data.data : undefined
const existingCache = memoryCache?.get(key)
const existingValue = existingCache?.value
if (
existingValue?.kind === CachedRouteKind.FETCH &&
Object.keys(existingValue.data).every(
(field) =>
JSON.stringify(
(existingValue.data as Record<string, string | Object>)[field]
) ===
JSON.stringify((newValue as Record<string, string | Object>)[field])
)
) {
if (DEBUG) {
console.log(`skipping cache set for ${key} as not modified`)
}
return
}

const { fetchCache, fetchIdx, fetchUrl, tags } = ctx
if (!fetchCache) return

Expand Down
3 changes: 2 additions & 1 deletion test/ppr-tests-manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
"passed": [],
"failed": [
"fetch-cache should have correct fetchUrl field for fetches and unstable_cache",
"fetch-cache should not retry for failed fetch-cache GET",
"fetch-cache should retry 3 times when revalidate times out",
"fetch-cache should not retry for failed fetch-cache GET"
"fetch-cache should update cache TTL even if cache data does not change"
],
"pending": [],
"flakey": [],
Expand Down
33 changes: 33 additions & 0 deletions test/production/app-dir/fetch-cache/app/not-changed/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { unstable_cache } from 'next/cache'

export const dynamic = 'force-dynamic'
export const fetchCache = 'default-cache'

// this is ensuring we still update TTL even
// if the cache value didn't change during revalidate
const stableCacheItem = unstable_cache(
async () => {
return 'consistent value'
},
[],
{
revalidate: 3,
tags: ['thankyounext'],
}
)

export default async function Page() {
const data = await fetch('https://example.vercel.sh', {
next: { tags: ['thankyounext'], revalidate: 3 },
}).then((res) => res.text())

const cachedValue = stableCacheItem()

return (
<>
<p>hello world</p>
<p id="data">{data}</p>
<p id="cache">{cachedValue}</p>
</>
)
}
54 changes: 53 additions & 1 deletion test/production/app-dir/fetch-cache/fetch-cache.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import glob from 'glob'
import http from 'http'
import fs from 'fs-extra'
import { join } from 'path'
import rawBody from 'next/dist/compiled/raw-body'
import { FileRef, NextInstance, createNext } from 'e2e-utils'
import {
retry,
Expand All @@ -25,6 +26,8 @@ describe('fetch-cache', () => {
method: string
headers: Record<string, string | string[]>
}> = []
let storeCacheItems = false
const fetchCacheStore = new Map<string, any>()
let fetchCacheEnv: Record<string, string> = {
SUSPENSE_CACHE_PROTO: 'http',
}
Expand Down Expand Up @@ -107,8 +110,9 @@ describe('fetch-cache', () => {
fetchGetReqIndex = 0
revalidateReqIndex = 0
fetchCacheRequests = []
storeCacheItems = false
fetchGetShouldError = false
fetchCacheServer = http.createServer((req, res) => {
fetchCacheServer = http.createServer(async (req, res) => {
console.log(`fetch cache request ${req.url} ${req.method}`, req.headers)
const parsedUrl = new URL(req.url || '/', 'http://n')

Expand Down Expand Up @@ -148,6 +152,19 @@ describe('fetch-cache', () => {
res.end('internal server error')
return
}

if (storeCacheItems && fetchCacheStore.has(key)) {
console.log(`returned cache for ${key}`)
res.statusCode = 200
res.end(JSON.stringify(fetchCacheStore.get(key)))
return
}
}

if (type === 'post' && storeCacheItems) {
const body = await rawBody(req, { encoding: 'utf8' })
fetchCacheStore.set(key, JSON.parse(body.toString()))
console.log(`set cache for ${key}`)
}
res.statusCode = type === 'post' ? 200 : 404
res.end(`${type} for ${key}`)
Expand Down Expand Up @@ -237,4 +254,39 @@ describe('fetch-cache', () => {
fetchGetShouldError = false
}
})

it('should update cache TTL even if cache data does not change', async () => {
storeCacheItems = true
const fetchCacheRequestsIndex = fetchCacheRequests.length

try {
for (let i = 0; i < 3; i++) {
const res = await fetchViaHTTP(appPort, '/not-changed')
expect(res.status).toBe(200)
// give time for revalidate period to pass
await new Promise((resolve) => setTimeout(resolve, 3_000))
}

const newCacheGets = []
const newCacheSets = []

for (
let i = fetchCacheRequestsIndex - 1;
i < fetchCacheRequests.length;
i++
) {
const requestItem = fetchCacheRequests[i]
if (requestItem.method === 'get') {
newCacheGets.push(requestItem)
}
if (requestItem.method === 'post') {
newCacheSets.push(requestItem)
}
}
expect(newCacheGets.length).toBeGreaterThanOrEqual(2)
expect(newCacheSets.length).toBeGreaterThanOrEqual(2)
} finally {
storeCacheItems = false
}
})
})
3 changes: 2 additions & 1 deletion test/turbopack-build-tests-manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -15637,7 +15637,8 @@
"failed": [
"fetch-cache should have correct fetchUrl field for fetches and unstable_cache",
"fetch-cache should not retry for failed fetch-cache GET",
"fetch-cache should retry 3 times when revalidate times out"
"fetch-cache should retry 3 times when revalidate times out",
"fetch-cache should update cache TTL even if cache data does not change"
],
"pending": [],
"flakey": [],
Expand Down
Loading