fix(cache): serve stale use cache entries during refresh

[NathanDrake2406]

Fixes #2672

Summary

goal	core change	expected impact
Match use cache stale-while-revalidate semantics	Serve valid stale entries during ordinary App Router requests and coordinate one background refresh per logical cache key	Dynamic requests no longer wait for regeneration after the revalidate window
Reject unusable cache values	Choose an explicit read action from the handler state and request policy	Expired or unrecognized entries regenerate in the foreground and are never returned
Keep ISR artifacts fresh	Use the request-scoped cache revalidation policy for both unstable_cache and use cache	Page and route-handler ISR regeneration await fresh data instead of storing an artifact with a stale dependency
Isolate draft previews	Bypass persistent shared-cache reads and writes while retaining the normal "use cache" execution scope	Preview requests return fresh preview data and cannot replace published cache entries
Preserve cache-scope APIs during refresh	Give detached refreshes a disabled draft-mode provider with empty headers and cookies	Cached callbacks can read draftMode().isEnabled without inheriting request data
Coordinate background work	Share one per-key scheduler across both cache APIs	Deduplication, cleanup, error handling, and waitUntil attachment have one owner

Why

A cache value is usable only when both its stored state and its consumer allow it. An ordinary dynamic request may return a stale value immediately and refresh it in the background. A page or route-handler ISR regeneration must await that refresh so the new full-route artifact contains fresh data. An expired value is no longer usable in either context and must regenerate before the caller continues.

The request boundary owns this distinction because a cached function cannot know whether it is answering a user request or constructing a persistent artifact. Both function/data-cache APIs now consume the same decision:

handler state	background request	foreground regeneration
fresh (cacheState absent)	serve	serve
stale	serve and revalidate	revalidate
expired or unrecognized	revalidate	revalidate

Draft mode is a separate cache boundary. Preview data can differ from published data, so a draft request executes the callback without reading or populating the persistent shared cache.

Non-draft background refreshes still need the request APIs supported inside public cache scopes. draftMode().isEnabled must return false; it must not fail because the detached context omitted its provider. The refresh receives a disabled provider with empty header and cookie stores. The draft-mode secret is retained, but no request data is copied.

What changed

scenario	before	after
Ordinary App Router request	Stale use cache data blocked on regeneration	Returns the deserialized stale value and schedules one isolated refresh
Build-time or runtime ISR regeneration	Runtime ISR could detach the refresh and store stale data in the regenerated artifact	Both paths await the refresh under cacheRevalidationMode: "foreground"
Expired handler value	Any state other than "stale" was accepted as a hit, so the memory handler could return an expired value indefinitely	Both cache APIs skip the stored value, execute in the foreground, and write the fresh result
Draft-mode request	Could return stale published data and write preview output into shared storage	Executes inside the cache scope with no persistent get, set, or background refresh
Background callback using draftMode()	The detached context had no provider, so regeneration threw	Reads isEnabled: false from a minimal provider and completes the cache write
Background cache lifecycle	unstable_cache and use cache owned separate pending maps and cleanup logic	Both use one isolate-wide per-key scheduler
Refresh request state	The initial implementation copied full headers and cookies into regeneration	A named helper retains supported cache inputs, provides empty headers and cookies, and creates fresh response-output and fetch-deduplication containers

Stored tags and cache-control metadata are applied to a stale response only after successful deserialization. Refresh-time metadata stays in the isolated context.

Validation

• Added explicit state-decision and expired-entry regressions for unstable_cache and use cache. Both behavior tests failed against the previous implementation by returning the stored expired value.
• Existing regression coverage verifies non-blocking stale reads, cross-request deduplication, waitUntil ownership, metadata isolation, disabled draft-mode access without request-data inheritance, draft-mode bypass, write-failure retry, missing waitUntil, build-time foreground refresh, and runtime ISR foreground refresh.
• Corrected the App Router page-builder test mock so the CI shard supplies the new isDraftModeEnabled() shim export.
• Passed 1,557 targeted tests across cache shims, unified request contexts, RSC handling, page construction, page dispatch, and route-handler execution.
• Passed the repository-wide format, lint, and type check across 2,649 formatted files and 1,143 checked files.
• Passed the vinext production build.
• The pre-commit hook passed its full check, staged unit and integration tests, and Knip.

Commands

vp test run tests/shims.test.ts
vp test run tests/app-page-element-builder.test.ts tests/unified-request-context.test.ts tests/app-page-dispatch.test.ts tests/app-route-handler-execution.test.ts tests/app-rsc-handler.test.ts
vp check
vp run vinext#build
git diff --check

Risk

Moderate. The behavior change is confined to persistent function/data-cache entries. Draft requests now match unstable_cache by bypassing persistent storage; request-local "use cache: private" remains available. Fresh published hits, misses, invalidated entries, the development bypass, and cache serialization retain their existing behavior. Unknown handler states fail closed by regenerating, so a custom handler that labels fresh values instead of leaving cacheState absent will lose a cache hit rather than serve a potentially unusable value.

The request policy does not govern patched fetch() response caching. That path retains its response-stream, refetch-map, and timeout lifecycle.

A refresh that never settles remains deduplicated for the isolate lifetime. This preserves the existing unstable_cache lifecycle behavior and does not introduce a new timeout policy.

References

reference	why it matters
Vinext issue #2672	Report and expected stale-while-revalidate behavior
Next.js issue #74882	Upstream bug report
Next.js PR #92636	Upstream use cache stale-while-revalidate fix
Next.js stale refresh implementation	Returns stale data during dynamic rendering, skips outer metadata propagation, and tracks background work
Next.js expired-entry handling	Treats an entry past expire as a miss and regenerates before use
Next.js empty draft-mode behavior	Returns a disabled draft-mode object inside cache and prerender scopes when no enabled provider exists
Next.js draft-mode write guard	Avoids saving generated "use cache" entries while draft mode is enabled
Next.js use cache SWR tests	Non-blocking response and cross-request deduplication behavior ported to Vinext's harness
Next.js foreground ISR regression	Establishes that ISR must await fresh cache data before completing the regenerated page
Next.js cacheLife documentation	Documents immediate stale serving and background regeneration
Vinext cache-read policy	Defines the function/data-cache policy boundary and explicit read actions
Vinext cache-read decision	Maps fresh, stale, expired, and unrecognized states to serve or revalidate behavior
Vinext memory-handler expiration	Returns expired entries with cacheState: "expired", which exposed the previous negative-state test
Vinext use cache read path	Applies draft bypass, explicit cache disposition, metadata propagation, and isolated background refresh
Vinext unstable_cache read path	Uses the same cache disposition for persistent function-cache reads
Vinext minimal refresh context	Provides disabled draft mode and retains supported cache inputs without copying request headers or cookies
Vinext shared scheduler	Owns isolate-wide deduplication, cleanup, rejection handling, and runtime lifetime attachment

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@vinext/cloudflare@2680

npm i https://pkg.pr.new/create-vinext-app@2680

npm i https://pkg.pr.new/@vinext/types@2680

npm i https://pkg.pr.new/vinext@2680

commit: 99bffbb

[github-actions]

Performance benchmarks

Compared d3a902c against base 22f106e using alternating same-runner rounds. Next.js was unchanged and skipped.

0 improved · 0 regressed · 6 within ±1.5%

Scenario	Framework	Baseline	Current	Change
Client bundle size (gzip)	vinext	131.9 KB	131.9 KB	⚫ +0.0%
Client entry size (gzip)	vinext	119.3 KB	119.3 KB	⚫ +0.0%
Dev server cold start	vinext	2.73 s	2.71 s	⚫ -0.7%
Production build time	vinext	2.88 s	2.87 s	⚫ -0.3%
RSC entry closure size (gzip)	vinext	103.2 KB	103.2 KB	⚫ -0.0%
Server bundle size (gzip)	vinext	177.5 KB	177.5 KB	⚫ -0.0%

View detailed results and traces

_{🟢 improvement · 🔴 regression · ⚫ change below 1.5% · paired base/head}

[NathanDrake2406]

Superseded by #2682. The original PR head stopped tracking updates from the fork branch, so this replacement uses a fresh head ref at the same verified commit.