| import type { DeepReadonly } from '../../shared/lib/deep-readonly' |
| |
| import { |
| renderToReadableStream, |
| decodeReply, |
| decodeReplyFromAsyncIterable, |
| createTemporaryReferenceSet as createServerTemporaryReferenceSet, |
| } from 'react-server-dom-webpack/server' |
| import { |
| createFromReadableStream, |
| encodeReply, |
| createTemporaryReferenceSet as createClientTemporaryReferenceSet, |
| } from 'react-server-dom-webpack/client' |
| import { unstable_prerender as prerender } from 'react-server-dom-webpack/static' |
| |
|
|
| import type { WorkStore } from '../app-render/work-async-storage.external' |
| import { workAsyncStorage } from '../app-render/work-async-storage.external' |
| import type { |
| PrerenderStoreModernClient, |
| PrivateUseCacheStore, |
| RequestStore, |
| RevalidateStore, |
| UseCacheStore, |
| WorkUnitStore, |
| } from '../app-render/work-unit-async-storage.external' |
| import { |
| getHmrRefreshHash, |
| getRenderResumeDataCache, |
| getPrerenderResumeDataCache, |
| workUnitAsyncStorage, |
| getDraftModeProviderForCacheScope, |
| getCacheSignal, |
| } from '../app-render/work-unit-async-storage.external' |
|
|
| import { makeHangingPromise } from '../dynamic-rendering-utils' |
|
|
| import type { ClientReferenceManifestForRsc } from '../../build/webpack/plugins/flight-manifest-plugin' |
|
|
| import { |
| getClientReferenceManifestForRsc, |
| getServerModuleMap, |
| } from '../app-render/encryption-utils' |
| import type { CacheEntry } from '../lib/cache-handlers/types' |
| import type { CacheSignal } from '../app-render/cache-signal' |
| import { decryptActionBoundArgs } from '../app-render/encryption' |
| import { InvariantError } from '../../shared/lib/invariant-error' |
| import { getDigestForWellKnownError } from '../app-render/create-error-handler' |
| import { DYNAMIC_EXPIRE, DYNAMIC_PREFETCH_DYNAMIC_STALE } from './constants' |
| import { getCacheHandler } from './handlers' |
| import { UseCacheTimeoutError } from './use-cache-errors' |
| import { |
| createHangingInputAbortSignal, |
| postponeWithTracking, |
| throwToInterruptStaticGeneration, |
| } from '../app-render/dynamic-rendering' |
| import { |
| makeErroringExoticSearchParamsForUseCache, |
| type SearchParams, |
| } from '../request/search-params' |
| import type { Params } from '../request/params' |
| import React from 'react' |
| import { createLazyResult, isResolvedLazyResult } from '../lib/lazy-result' |
| import { dynamicAccessAsyncStorage } from '../app-render/dynamic-access-async-storage.external' |
| import { isReactLargeShellError } from '../app-render/react-large-shell-error' |
| import type { CacheLife } from './cache-life' |
|
|
| interface PrivateCacheContext { |
| readonly kind: 'private' |
| |
| readonly outerWorkUnitStore: RequestStore | PrivateUseCacheStore |
| } |
|
|
| interface PublicCacheContext { |
| readonly kind: 'public' |
| |
| readonly outerWorkUnitStore: |
| | Exclude<WorkUnitStore, PrerenderStoreModernClient> |
| | undefined |
| } |
|
|
| type CacheContext = PrivateCacheContext | PublicCacheContext |
|
|
| type CacheKeyParts = |
| | [buildId: string, id: string, args: unknown[]] |
| | [buildId: string, id: string, args: unknown[], hmrRefreshHash: string] |
|
|
| export interface UseCachePageComponentProps { |
| params: Promise<Params> |
| searchParams: Promise<SearchParams> |
| $$isPageComponent: true |
| } |
|
|
| export type UseCacheLayoutComponentProps = { |
| params: Promise<Params> |
| $$isLayoutComponent: true |
| } & { |
| |
| |
| [slot: string]: any |
| } |
|
|
| const isEdgeRuntime = process.env.NEXT_RUNTIME === 'edge' |
|
|
| const debug = process.env.NEXT_PRIVATE_DEBUG_CACHE |
| ? console.debug.bind(console, 'use-cache:') |
| : undefined |
|
|
| const filterStackFrame = |
| process.env.NODE_ENV !== 'production' |
| ? (require('../lib/source-maps') as typeof import('../lib/source-maps')) |
| .filterStackFrameDEV |
| : undefined |
|
|
| function generateCacheEntry( |
| workStore: WorkStore, |
| cacheContext: CacheContext, |
| clientReferenceManifest: DeepReadonly<ClientReferenceManifestForRsc>, |
| encodedArguments: FormData | string, |
| fn: (...args: unknown[]) => Promise<unknown>, |
| sharedErrorStack: string | undefined |
| ) { |
| |
| |
| |
| |
| |
| return workStore.runInCleanSnapshot( |
| generateCacheEntryWithRestoredWorkStore, |
| workStore, |
| cacheContext, |
| clientReferenceManifest, |
| encodedArguments, |
| fn, |
| sharedErrorStack |
| ) |
| } |
|
|
| function generateCacheEntryWithRestoredWorkStore( |
| workStore: WorkStore, |
| cacheContext: CacheContext, |
| clientReferenceManifest: DeepReadonly<ClientReferenceManifestForRsc>, |
| encodedArguments: FormData | string, |
| fn: (...args: unknown[]) => Promise<unknown>, |
| sharedErrorStack: string | undefined |
| ) { |
| |
| |
| |
| |
| |
| |
| |
| return workAsyncStorage.run( |
| workStore, |
| generateCacheEntryWithCacheContext, |
| workStore, |
| cacheContext, |
| clientReferenceManifest, |
| encodedArguments, |
| fn, |
| sharedErrorStack |
| ) |
| } |
|
|
| function createUseCacheStore( |
| workStore: WorkStore, |
| cacheContext: CacheContext, |
| defaultCacheLife: Required<CacheLife> |
| ): UseCacheStore { |
| if (cacheContext.kind === 'private') { |
| const outerWorkUnitStore = cacheContext.outerWorkUnitStore |
|
|
| return { |
| type: 'private-cache', |
| phase: 'render', |
| implicitTags: outerWorkUnitStore?.implicitTags, |
| revalidate: defaultCacheLife.revalidate, |
| expire: defaultCacheLife.expire, |
| stale: defaultCacheLife.stale, |
| explicitRevalidate: undefined, |
| explicitExpire: undefined, |
| explicitStale: undefined, |
| tags: null, |
| hmrRefreshHash: |
| outerWorkUnitStore && getHmrRefreshHash(workStore, outerWorkUnitStore), |
| isHmrRefresh: outerWorkUnitStore?.isHmrRefresh ?? false, |
| serverComponentsHmrCache: outerWorkUnitStore?.serverComponentsHmrCache, |
| forceRevalidate: shouldForceRevalidate(workStore, outerWorkUnitStore), |
| draftMode: |
| outerWorkUnitStore && |
| getDraftModeProviderForCacheScope(workStore, outerWorkUnitStore), |
| cookies: outerWorkUnitStore.cookies, |
| } |
| } else { |
| let useCacheOrRequestStore: RequestStore | UseCacheStore | undefined |
| const outerWorkUnitStore = cacheContext.outerWorkUnitStore |
|
|
| if (outerWorkUnitStore) { |
| switch (outerWorkUnitStore?.type) { |
| case 'cache': |
| case 'private-cache': |
| case 'request': |
| useCacheOrRequestStore = outerWorkUnitStore |
| break |
| case 'prerender': |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| case 'unstable-cache': |
| break |
| default: |
| outerWorkUnitStore satisfies never |
| } |
| } |
|
|
| return { |
| type: 'cache', |
| phase: 'render', |
| implicitTags: outerWorkUnitStore?.implicitTags, |
| revalidate: defaultCacheLife.revalidate, |
| expire: defaultCacheLife.expire, |
| stale: defaultCacheLife.stale, |
| explicitRevalidate: undefined, |
| explicitExpire: undefined, |
| explicitStale: undefined, |
| tags: null, |
| hmrRefreshHash: |
| outerWorkUnitStore && getHmrRefreshHash(workStore, outerWorkUnitStore), |
| isHmrRefresh: useCacheOrRequestStore?.isHmrRefresh ?? false, |
| serverComponentsHmrCache: |
| useCacheOrRequestStore?.serverComponentsHmrCache, |
| forceRevalidate: shouldForceRevalidate(workStore, outerWorkUnitStore), |
| draftMode: |
| outerWorkUnitStore && |
| getDraftModeProviderForCacheScope(workStore, outerWorkUnitStore), |
| } |
| } |
| } |
|
|
| function assertDefaultCacheLife( |
| defaultCacheLife: CacheLife | undefined |
| ): asserts defaultCacheLife is Required<CacheLife> { |
| if ( |
| !defaultCacheLife || |
| defaultCacheLife.revalidate == null || |
| defaultCacheLife.expire == null || |
| defaultCacheLife.stale == null |
| ) { |
| throw new InvariantError( |
| 'A default cacheLife profile must always be provided.' |
| ) |
| } |
| } |
|
|
| function generateCacheEntryWithCacheContext( |
| workStore: WorkStore, |
| cacheContext: CacheContext, |
| clientReferenceManifest: DeepReadonly<ClientReferenceManifestForRsc>, |
| encodedArguments: FormData | string, |
| fn: (...args: unknown[]) => Promise<unknown>, |
| sharedErrorStack: string | undefined |
| ) { |
| if (!workStore.cacheLifeProfiles) { |
| throw new InvariantError('cacheLifeProfiles should always be provided.') |
| } |
| const defaultCacheLife = workStore.cacheLifeProfiles['default'] |
| assertDefaultCacheLife(defaultCacheLife) |
|
|
| |
| const cacheStore = createUseCacheStore( |
| workStore, |
| cacheContext, |
| defaultCacheLife |
| ) |
|
|
| return workUnitAsyncStorage.run(cacheStore, () => |
| dynamicAccessAsyncStorage.run( |
| { abortController: new AbortController() }, |
| generateCacheEntryImpl, |
| workStore, |
| cacheContext, |
| cacheStore, |
| clientReferenceManifest, |
| encodedArguments, |
| fn, |
| sharedErrorStack |
| ) |
| ) |
| } |
|
|
| function propagateCacheLifeAndTagsToRevalidateStore( |
| revalidateStore: RevalidateStore, |
| entry: CacheEntry |
| ): void { |
| const outerTags = (revalidateStore.tags ??= []) |
|
|
| for (const tag of entry.tags) { |
| if (!outerTags.includes(tag)) { |
| outerTags.push(tag) |
| } |
| } |
|
|
| if (revalidateStore.stale > entry.stale) { |
| revalidateStore.stale = entry.stale |
| } |
|
|
| if (revalidateStore.revalidate > entry.revalidate) { |
| revalidateStore.revalidate = entry.revalidate |
| } |
|
|
| if (revalidateStore.expire > entry.expire) { |
| revalidateStore.expire = entry.expire |
| } |
| } |
|
|
| function propagateCacheLifeAndTags( |
| cacheContext: CacheContext, |
| entry: CacheEntry |
| ): void { |
| if (cacheContext.kind === 'private') { |
| switch (cacheContext.outerWorkUnitStore?.type) { |
| |
| case 'private-cache': |
| propagateCacheLifeAndTagsToRevalidateStore( |
| cacheContext.outerWorkUnitStore, |
| entry |
| ) |
| break |
| case 'request': |
| case undefined: |
| break |
| default: |
| cacheContext.outerWorkUnitStore satisfies never |
| } |
| } else { |
| switch (cacheContext.outerWorkUnitStore?.type) { |
| case 'cache': |
| case 'private-cache': |
| case 'prerender': |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| propagateCacheLifeAndTagsToRevalidateStore( |
| cacheContext.outerWorkUnitStore, |
| entry |
| ) |
| break |
| case 'request': |
| case 'unstable-cache': |
| case undefined: |
| break |
| default: |
| cacheContext.outerWorkUnitStore satisfies never |
| } |
| } |
| } |
|
|
| async function collectResult( |
| savedStream: ReadableStream, |
| workStore: WorkStore, |
| cacheContext: CacheContext, |
| innerCacheStore: UseCacheStore, |
| startTime: number, |
| errors: Array<unknown> |
| ): Promise<CacheEntry> { |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
|
| const buffer: any[] = [] |
| const reader = savedStream.getReader() |
|
|
| try { |
| for (let entry; !(entry = await reader.read()).done; ) { |
| buffer.push(entry.value) |
| } |
| } catch (error) { |
| errors.push(error) |
| } |
|
|
| let idx = 0 |
| const bufferStream = new ReadableStream({ |
| pull(controller) { |
| if (workStore.invalidDynamicUsageError) { |
| controller.error(workStore.invalidDynamicUsageError) |
| } else if (idx < buffer.length) { |
| controller.enqueue(buffer[idx++]) |
| } else if (errors.length > 0) { |
| |
| controller.error(errors[0]) |
| } else { |
| controller.close() |
| } |
| }, |
| }) |
|
|
| const collectedTags = innerCacheStore.tags |
| |
| |
| |
| const collectedRevalidate = |
| innerCacheStore.explicitRevalidate !== undefined |
| ? innerCacheStore.explicitRevalidate |
| : innerCacheStore.revalidate |
| const collectedExpire = |
| innerCacheStore.explicitExpire !== undefined |
| ? innerCacheStore.explicitExpire |
| : innerCacheStore.expire |
| const collectedStale = |
| innerCacheStore.explicitStale !== undefined |
| ? innerCacheStore.explicitStale |
| : innerCacheStore.stale |
|
|
| const entry: CacheEntry = { |
| value: bufferStream, |
| timestamp: startTime, |
| revalidate: collectedRevalidate, |
| expire: collectedExpire, |
| stale: collectedStale, |
| tags: collectedTags === null ? [] : collectedTags, |
| } |
|
|
| |
| if (cacheContext) { |
| propagateCacheLifeAndTags(cacheContext, entry) |
| } |
|
|
| const cacheSignal = cacheContext.outerWorkUnitStore |
| ? getCacheSignal(cacheContext.outerWorkUnitStore) |
| : null |
|
|
| if (cacheSignal) { |
| cacheSignal.endRead() |
| } |
|
|
| return entry |
| } |
|
|
| type GenerateCacheEntryResult = |
| | { |
| readonly type: 'cached' |
| readonly stream: ReadableStream |
| readonly pendingCacheEntry: Promise<CacheEntry> |
| } |
| | { |
| readonly type: 'prerender-dynamic' |
| readonly hangingPromise: Promise<never> |
| } |
|
|
| async function generateCacheEntryImpl( |
| workStore: WorkStore, |
| cacheContext: CacheContext, |
| innerCacheStore: UseCacheStore, |
| clientReferenceManifest: DeepReadonly<ClientReferenceManifestForRsc>, |
| encodedArguments: FormData | string, |
| fn: (...args: unknown[]) => Promise<unknown>, |
| sharedErrorStack: string | undefined |
| ): Promise<GenerateCacheEntryResult> { |
| const temporaryReferences = createServerTemporaryReferenceSet() |
| const outerWorkUnitStore = cacheContext.outerWorkUnitStore |
|
|
| const [, , args] = |
| typeof encodedArguments === 'string' |
| ? await decodeReply<CacheKeyParts>( |
| encodedArguments, |
| getServerModuleMap(), |
| { temporaryReferences } |
| ) |
| : await decodeReplyFromAsyncIterable<CacheKeyParts>( |
| { |
| async *[Symbol.asyncIterator]() { |
| for (const entry of encodedArguments) { |
| yield entry |
| } |
|
|
| if (outerWorkUnitStore) { |
| switch (outerWorkUnitStore.type) { |
| case 'prerender': |
| |
| |
| |
| |
| |
| await new Promise<void>((resolve) => { |
| if (outerWorkUnitStore.renderSignal.aborted) { |
| resolve() |
| } else { |
| outerWorkUnitStore.renderSignal.addEventListener( |
| 'abort', |
| () => resolve(), |
| { once: true } |
| ) |
| } |
| }) |
| break |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| case 'request': |
| case 'cache': |
| case 'private-cache': |
| case 'unstable-cache': |
| break |
| default: |
| outerWorkUnitStore satisfies never |
| } |
| } |
| }, |
| }, |
| getServerModuleMap(), |
| { temporaryReferences } |
| ) |
|
|
| |
| const startTime = performance.timeOrigin + performance.now() |
|
|
| |
| |
| |
| |
| const resultPromise = createLazyResult(() => fn.apply(null, args)) |
|
|
| let errors: Array<unknown> = [] |
|
|
| |
| |
| |
| |
| const handleError = (error: unknown): string | undefined => { |
| const digest = getDigestForWellKnownError(error) |
|
|
| if (digest) { |
| return digest |
| } |
|
|
| if (isReactLargeShellError(error)) { |
| |
| console.error(error) |
| return undefined |
| } |
|
|
| if (process.env.NODE_ENV !== 'development') { |
| |
| |
| |
| console.error(error) |
| } |
|
|
| errors.push(error) |
| } |
|
|
| let stream: ReadableStream<Uint8Array> |
|
|
| switch (outerWorkUnitStore?.type) { |
| |
| case 'prerender': |
| const timeoutAbortController = new AbortController() |
|
|
| |
| |
| |
| const timer = setTimeout(() => { |
| const error = new UseCacheTimeoutError() |
| if (sharedErrorStack) { |
| error.stack = error.name + ': ' + error.message + sharedErrorStack |
| } |
| workStore.invalidDynamicUsageError = error |
| timeoutAbortController.abort(error) |
| }, 50000) |
|
|
| const dynamicAccessAbortSignal = |
| dynamicAccessAsyncStorage.getStore()?.abortController.signal |
|
|
| const abortSignal = dynamicAccessAbortSignal |
| ? AbortSignal.any([ |
| dynamicAccessAbortSignal, |
| outerWorkUnitStore.renderSignal, |
| timeoutAbortController.signal, |
| ]) |
| : timeoutAbortController.signal |
|
|
| const { prelude } = await prerender( |
| resultPromise, |
| clientReferenceManifest.clientModules, |
| { |
| environmentName: 'Cache', |
| filterStackFrame, |
| signal: abortSignal, |
| temporaryReferences, |
| onError(error) { |
| if (abortSignal.aborted && abortSignal.reason === error) { |
| return undefined |
| } |
|
|
| return handleError(error) |
| }, |
| } |
| ) |
|
|
| clearTimeout(timer) |
|
|
| if (timeoutAbortController.signal.aborted) { |
| |
| |
| |
| |
| |
| |
| stream = new ReadableStream({ |
| start(controller) { |
| controller.error(timeoutAbortController.signal.reason) |
| }, |
| }) |
| } else if (dynamicAccessAbortSignal?.aborted) { |
| |
| |
| |
| const hangingPromise = makeHangingPromise<never>( |
| outerWorkUnitStore.renderSignal, |
| abortSignal.reason |
| ) |
|
|
| if (outerWorkUnitStore.cacheSignal) { |
| outerWorkUnitStore.cacheSignal.endRead() |
| } |
|
|
| return { type: 'prerender-dynamic', hangingPromise } |
| } else { |
| stream = prelude |
| } |
| break |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| case 'request': |
| case 'cache': |
| case 'private-cache': |
| case 'unstable-cache': |
| case undefined: |
| stream = renderToReadableStream( |
| resultPromise, |
| clientReferenceManifest.clientModules, |
| { |
| environmentName: 'Cache', |
| filterStackFrame, |
| temporaryReferences, |
| onError: handleError, |
| } |
| ) |
| break |
| default: |
| return outerWorkUnitStore satisfies never |
| } |
|
|
| const [returnStream, savedStream] = stream.tee() |
|
|
| const pendingCacheEntry = collectResult( |
| savedStream, |
| workStore, |
| cacheContext, |
| innerCacheStore, |
| startTime, |
| errors |
| ) |
|
|
| return { |
| type: 'cached', |
| |
| |
| |
| stream: returnStream, |
| pendingCacheEntry, |
| } |
| } |
|
|
| function cloneCacheEntry(entry: CacheEntry): [CacheEntry, CacheEntry] { |
| const [streamA, streamB] = entry.value.tee() |
| entry.value = streamA |
| const clonedEntry: CacheEntry = { |
| value: streamB, |
| timestamp: entry.timestamp, |
| revalidate: entry.revalidate, |
| expire: entry.expire, |
| stale: entry.stale, |
| tags: entry.tags, |
| } |
| return [entry, clonedEntry] |
| } |
|
|
| async function clonePendingCacheEntry( |
| pendingCacheEntry: Promise<CacheEntry> |
| ): Promise<[CacheEntry, CacheEntry]> { |
| const entry = await pendingCacheEntry |
| return cloneCacheEntry(entry) |
| } |
|
|
| async function getNthCacheEntry( |
| split: Promise<[CacheEntry, CacheEntry]>, |
| i: number |
| ): Promise<CacheEntry> { |
| return (await split)[i] |
| } |
|
|
| async function encodeFormData(formData: FormData): Promise<string> { |
| let result = '' |
| for (let [key, value] of formData) { |
| |
| |
| |
| |
| |
| result += key.length.toString(16) + ':' + key |
| let stringValue |
| if (typeof value === 'string') { |
| stringValue = value |
| } else { |
| |
| |
| |
| const arrayBuffer = await value.arrayBuffer() |
| if (arrayBuffer.byteLength % 2 === 0) { |
| stringValue = String.fromCodePoint(...new Uint16Array(arrayBuffer)) |
| } else { |
| stringValue = |
| String.fromCodePoint( |
| ...new Uint16Array(arrayBuffer, 0, (arrayBuffer.byteLength - 1) / 2) |
| ) + |
| String.fromCodePoint( |
| new Uint8Array(arrayBuffer, arrayBuffer.byteLength - 1, 1)[0] |
| ) |
| } |
| } |
| result += stringValue.length.toString(16) + ':' + stringValue |
| } |
| return result |
| } |
|
|
| function createTrackedReadableStream( |
| stream: ReadableStream, |
| cacheSignal: CacheSignal |
| ) { |
| const reader = stream.getReader() |
| return new ReadableStream({ |
| async pull(controller) { |
| const { done, value } = await reader.read() |
| if (done) { |
| controller.close() |
| cacheSignal.endRead() |
| } else { |
| controller.enqueue(value) |
| } |
| }, |
| }) |
| } |
|
|
| function wrapAsInvalidDynamicUsageError( |
| error: Error, |
| sharedErrorStack: string | undefined, |
| workStore: WorkStore |
| ) { |
| if (sharedErrorStack) { |
| error.stack = error.name + ': ' + error.message + sharedErrorStack |
| } |
|
|
| workStore.invalidDynamicUsageError ??= error |
|
|
| return error |
| } |
|
|
| export function cache( |
| kind: string, |
| id: string, |
| boundArgsLength: number, |
| originalFn: (...args: unknown[]) => Promise<unknown> |
| ) { |
| const isPrivate = kind === 'private' |
|
|
| |
| |
| const cacheHandler = isPrivate ? undefined : getCacheHandler(kind) |
|
|
| if (!isPrivate && !cacheHandler) { |
| throw new Error('Unknown cache handler: ' + kind) |
| } |
|
|
| |
| const sharedError = new Error() |
| Error.captureStackTrace(sharedError, cache) |
| const sharedErrorStack = sharedError.stack?.slice( |
| sharedError.stack.indexOf('\n') |
| ) |
|
|
| const name = originalFn.name |
| const cachedFn = { |
| [name]: async function (...args: any[]) { |
| const workStore = workAsyncStorage.getStore() |
| if (workStore === undefined) { |
| throw new Error( |
| '"use cache" cannot be used outside of App Router. Expected a WorkStore.' |
| ) |
| } |
|
|
| let fn = originalFn |
|
|
| const workUnitStore = workUnitAsyncStorage.getStore() |
|
|
| let cacheContext: CacheContext |
|
|
| if (isPrivate) { |
| const expression = '"use cache: private"' |
|
|
| switch (workUnitStore?.type) { |
| |
| case 'prerender': |
| return makeHangingPromise(workUnitStore.renderSignal, expression) |
| case 'prerender-ppr': |
| return postponeWithTracking( |
| workStore.route, |
| expression, |
| workUnitStore.dynamicTracking |
| ) |
| case 'prerender-legacy': |
| return throwToInterruptStaticGeneration( |
| expression, |
| workStore, |
| workUnitStore |
| ) |
| case 'prerender-client': |
| throw new InvariantError( |
| `${expression} must not be used within a client component. Next.js should be preventing ${expression} from being allowed in client components statically, but did not in this case.` |
| ) |
| case 'unstable-cache': { |
| throw wrapAsInvalidDynamicUsageError( |
| new Error( |
| |
| `${expression} must not be used within \`unstable_cache()\`.` |
| ), |
| sharedErrorStack, |
| workStore |
| ) |
| } |
| case 'cache': { |
| throw wrapAsInvalidDynamicUsageError( |
| new Error( |
| |
| `${expression} must not be used within "use cache". It can only be nested inside of another ${expression}.` |
| ), |
| sharedErrorStack, |
| workStore |
| ) |
| } |
| case 'request': |
| case 'private-cache': |
| cacheContext = { |
| kind: 'private', |
| outerWorkUnitStore: workUnitStore, |
| } |
| break |
| case undefined: |
| throw wrapAsInvalidDynamicUsageError( |
| new Error( |
| |
| `${expression} cannot be used outside of a request context.` |
| ), |
| sharedErrorStack, |
| workStore |
| ) |
| default: |
| workUnitStore satisfies never |
| |
| |
| throw new InvariantError(`Unexpected work unit store.`) |
| } |
| } else { |
| switch (workUnitStore?.type) { |
| case 'prerender-client': |
| const expression = '"use cache"' |
| throw new InvariantError( |
| `${expression} must not be used within a client component. Next.js should be preventing ${expression} from being allowed in client components statically, but did not in this case.` |
| ) |
| case 'prerender': |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| case 'request': |
| case 'cache': |
| case 'private-cache': |
| |
| |
| case 'unstable-cache': |
| case undefined: |
| cacheContext = { |
| kind: 'public', |
| outerWorkUnitStore: workUnitStore, |
| } |
| break |
| default: |
| workUnitStore satisfies never |
| |
| |
| throw new InvariantError(`Unexpected work unit store.`) |
| } |
| } |
|
|
| |
| |
| const clientReferenceManifest = getClientReferenceManifestForRsc() |
|
|
| |
| |
| |
| |
| const buildId = workStore.buildId |
|
|
| |
| |
| |
| |
| |
| const hmrRefreshHash = |
| workUnitStore && getHmrRefreshHash(workStore, workUnitStore) |
|
|
| const hangingInputAbortSignal = workUnitStore |
| ? createHangingInputAbortSignal(workUnitStore) |
| : undefined |
|
|
| let isPageOrLayout = false |
|
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| if (isPageComponent(args)) { |
| isPageOrLayout = true |
|
|
| const [{ params: outerParams, searchParams: outerSearchParams }] = args |
| const keepSearchParams = workStore.cacheComponentsEnabled || isPrivate |
|
|
| args = [ |
| { |
| params: outerParams, |
| searchParams: keepSearchParams |
| ? outerSearchParams |
| : Promise.resolve({}), |
| |
| }, |
| ] |
|
|
| fn = { |
| [name]: async ({ |
| params: _innerParams, |
| searchParams: innerSearchParams, |
| }: Omit<UseCachePageComponentProps, '$$isPageComponent'>) => |
| originalFn.apply(null, [ |
| { |
| params: outerParams, |
| searchParams: keepSearchParams |
| ? innerSearchParams |
| : |
| |
| |
| |
| |
| |
| |
| |
| makeErroringExoticSearchParamsForUseCache(workStore), |
| }, |
| ]), |
| }[name] as (...args: unknown[]) => Promise<unknown> |
| } else if (isLayoutComponent(args)) { |
| isPageOrLayout = true |
|
|
| const [{ params: outerParams, $$isLayoutComponent, ...outerSlots }] = |
| args |
| |
| args = [{ params: outerParams, ...outerSlots }] |
|
|
| fn = { |
| [name]: async ({ |
| params: _innerParams, |
| ...innerSlots |
| }: Omit<UseCacheLayoutComponentProps, '$$isLayoutComponent'>) => |
| originalFn.apply(null, [{ params: outerParams, ...innerSlots }]), |
| }[name] as (...args: unknown[]) => Promise<unknown> |
| } |
|
|
| if (boundArgsLength > 0) { |
| if (args.length === 0) { |
| throw new InvariantError( |
| `Expected the "use cache" function ${JSON.stringify(fn.name)} to receive its encrypted bound arguments as the first argument.` |
| ) |
| } |
|
|
| const encryptedBoundArgs = args.shift() |
| const boundArgs = await decryptActionBoundArgs(id, encryptedBoundArgs) |
|
|
| if (!Array.isArray(boundArgs)) { |
| throw new InvariantError( |
| `Expected the bound arguments of "use cache" function ${JSON.stringify(fn.name)} to deserialize into an array, got ${typeof boundArgs} instead.` |
| ) |
| } |
|
|
| if (boundArgsLength !== boundArgs.length) { |
| throw new InvariantError( |
| `Expected the "use cache" function ${JSON.stringify(fn.name)} to receive ${boundArgsLength} bound arguments, got ${boundArgs.length} instead.` |
| ) |
| } |
|
|
| args.unshift(boundArgs) |
| } |
|
|
| const temporaryReferences = createClientTemporaryReferenceSet() |
|
|
| |
| |
| |
| |
| |
| |
| |
| |
| const cacheKeyParts: CacheKeyParts = hmrRefreshHash |
| ? [buildId, id, args, hmrRefreshHash] |
| : [buildId, id, args] |
|
|
| const encodeCacheKeyParts = () => |
| encodeReply(cacheKeyParts, { |
| temporaryReferences, |
| signal: hangingInputAbortSignal, |
| }) |
|
|
| let encodedCacheKeyParts: FormData | string |
|
|
| switch (workUnitStore?.type) { |
| case 'prerender': |
| if (!isPageOrLayout) { |
| |
| |
| |
| |
| |
| |
| |
| const dynamicAccessAbortController = new AbortController() |
|
|
| encodedCacheKeyParts = await dynamicAccessAsyncStorage.run( |
| { abortController: dynamicAccessAbortController }, |
| encodeCacheKeyParts |
| ) |
|
|
| if (dynamicAccessAbortController.signal.aborted) { |
| return makeHangingPromise( |
| workUnitStore.renderSignal, |
| dynamicAccessAbortController.signal.reason.message |
| ) |
| } |
| break |
| } |
| |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| case 'request': |
| case 'cache': |
| case 'private-cache': |
| case 'unstable-cache': |
| case undefined: |
| encodedCacheKeyParts = await encodeCacheKeyParts() |
| break |
| default: |
| return workUnitStore satisfies never |
| } |
|
|
| const serializedCacheKey = |
| typeof encodedCacheKeyParts === 'string' |
| ? |
| |
| encodedCacheKeyParts |
| : await encodeFormData(encodedCacheKeyParts) |
|
|
| let stream: undefined | ReadableStream = undefined |
|
|
| |
| const prerenderResumeDataCache = workUnitStore |
| ? getPrerenderResumeDataCache(workUnitStore) |
| : null |
| const renderResumeDataCache = workUnitStore |
| ? getRenderResumeDataCache(workUnitStore) |
| : null |
|
|
| if (renderResumeDataCache) { |
| const cacheSignal = workUnitStore ? getCacheSignal(workUnitStore) : null |
|
|
| if (cacheSignal) { |
| cacheSignal.beginRead() |
| } |
| const cachedEntry = renderResumeDataCache.cache.get(serializedCacheKey) |
| if (cachedEntry !== undefined) { |
| const existingEntry = await cachedEntry |
| propagateCacheLifeAndTags(cacheContext, existingEntry) |
|
|
| if (workUnitStore !== undefined && existingEntry !== undefined) { |
| if ( |
| existingEntry.revalidate === 0 || |
| existingEntry.expire < DYNAMIC_EXPIRE |
| ) { |
| switch (workUnitStore.type) { |
| case 'prerender': |
| |
| |
| |
| |
| |
| |
| if (cacheSignal) { |
| cacheSignal.endRead() |
| } |
| return makeHangingPromise( |
| workUnitStore.renderSignal, |
| 'dynamic "use cache"' |
| ) |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| case 'request': |
| case 'cache': |
| case 'private-cache': |
| case 'unstable-cache': |
| break |
| default: |
| workUnitStore satisfies never |
| } |
| } |
|
|
| if (existingEntry.stale < DYNAMIC_PREFETCH_DYNAMIC_STALE) { |
| |
| } |
| } |
|
|
| const [streamA, streamB] = existingEntry.value.tee() |
| existingEntry.value = streamB |
|
|
| if (cacheSignal) { |
| |
| |
| stream = createTrackedReadableStream(streamA, cacheSignal) |
| } else { |
| stream = streamA |
| } |
| } else { |
| if (cacheSignal) { |
| cacheSignal.endRead() |
| } |
|
|
| if (workUnitStore) { |
| switch (workUnitStore.type) { |
| case 'prerender': |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| if (workUnitStore.allowEmptyStaticShell) { |
| return makeHangingPromise( |
| workUnitStore.renderSignal, |
| 'dynamic "use cache"' |
| ) |
| } |
| break |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| case 'request': |
| case 'cache': |
| case 'private-cache': |
| case 'unstable-cache': |
| break |
| default: |
| workUnitStore satisfies never |
| } |
| } |
| } |
| } |
|
|
| if (stream === undefined) { |
| const cacheSignal = workUnitStore ? getCacheSignal(workUnitStore) : null |
| if (cacheSignal) { |
| |
| |
| cacheSignal.beginRead() |
| } |
|
|
| const lazyRefreshTags = workStore.refreshTagsByCacheKind.get(kind) |
|
|
| if (lazyRefreshTags && !isResolvedLazyResult(lazyRefreshTags)) { |
| await lazyRefreshTags |
| } |
|
|
| let entry: CacheEntry | undefined |
|
|
| |
| if (cacheHandler && !shouldForceRevalidate(workStore, workUnitStore)) { |
| entry = await cacheHandler.get( |
| serializedCacheKey, |
| workUnitStore?.implicitTags?.tags ?? [] |
| ) |
| } |
|
|
| if (entry) { |
| const implicitTags = workUnitStore?.implicitTags?.tags ?? [] |
| let implicitTagsExpiration = 0 |
|
|
| if (workUnitStore?.implicitTags) { |
| const lazyExpiration = |
| workUnitStore.implicitTags.expirationsByCacheKind.get(kind) |
|
|
| if (lazyExpiration) { |
| const expiration = isResolvedLazyResult(lazyExpiration) |
| ? lazyExpiration.value |
| : await lazyExpiration |
|
|
| |
| |
| |
| |
| |
| if (expiration < Infinity) { |
| implicitTagsExpiration = expiration |
| } |
| } |
| } |
|
|
| if ( |
| shouldDiscardCacheEntry( |
| entry, |
| workStore, |
| workUnitStore, |
| implicitTags, |
| implicitTagsExpiration |
| ) |
| ) { |
| debug?.('discarding stale entry', serializedCacheKey) |
| entry = undefined |
| } |
| } |
|
|
| const currentTime = performance.timeOrigin + performance.now() |
| if ( |
| workUnitStore !== undefined && |
| entry !== undefined && |
| (entry.revalidate === 0 || entry.expire < DYNAMIC_EXPIRE) |
| ) { |
| switch (workUnitStore.type) { |
| case 'prerender': |
| |
| |
| |
| |
| |
| if (cacheSignal) { |
| cacheSignal.endRead() |
| } |
| return makeHangingPromise( |
| workUnitStore.renderSignal, |
| 'dynamic "use cache"' |
| ) |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| case 'request': |
| case 'cache': |
| case 'private-cache': |
| case 'unstable-cache': |
| break |
| default: |
| workUnitStore satisfies never |
| } |
| } |
|
|
| if ( |
| entry === undefined || |
| currentTime > entry.timestamp + entry.expire * 1000 || |
| (workStore.isStaticGeneration && |
| currentTime > entry.timestamp + entry.revalidate * 1000) |
| ) { |
| |
|
|
| |
| |
| |
|
|
| |
| |
| |
| |
| |
|
|
| if (entry) { |
| if (currentTime > entry.timestamp + entry.expire * 1000) { |
| debug?.('entry is expired', serializedCacheKey) |
| } |
|
|
| if ( |
| workStore.isStaticGeneration && |
| currentTime > entry.timestamp + entry.revalidate * 1000 |
| ) { |
| debug?.('static generation, entry is stale', serializedCacheKey) |
| } |
| } |
|
|
| const result = await generateCacheEntry( |
| workStore, |
| cacheContext, |
| clientReferenceManifest, |
| encodedCacheKeyParts, |
| fn, |
| sharedErrorStack |
| ) |
|
|
| if (result.type === 'prerender-dynamic') { |
| return result.hangingPromise |
| } |
|
|
| const { stream: newStream, pendingCacheEntry } = result |
|
|
| |
| if (!workStore.isDraftMode) { |
| let savedCacheEntry |
|
|
| if (prerenderResumeDataCache) { |
| |
| const split = clonePendingCacheEntry(pendingCacheEntry) |
| savedCacheEntry = getNthCacheEntry(split, 0) |
| prerenderResumeDataCache.cache.set( |
| serializedCacheKey, |
| getNthCacheEntry(split, 1) |
| ) |
| } else { |
| savedCacheEntry = pendingCacheEntry |
| } |
|
|
| if (cacheHandler) { |
| const promise = cacheHandler.set( |
| serializedCacheKey, |
| savedCacheEntry |
| ) |
|
|
| workStore.pendingRevalidateWrites ??= [] |
| workStore.pendingRevalidateWrites.push(promise) |
| } |
| } |
|
|
| stream = newStream |
| } else { |
| |
| |
| if (cacheContext.kind === 'private') { |
| throw new InvariantError( |
| `A private cache entry must not be retrieved from the cache handler.` |
| ) |
| } |
|
|
| propagateCacheLifeAndTags(cacheContext, entry) |
|
|
| |
| stream = entry.value |
|
|
| |
| |
| if (prerenderResumeDataCache) { |
| const [entryLeft, entryRight] = cloneCacheEntry(entry) |
| if (cacheSignal) { |
| stream = createTrackedReadableStream(entryLeft.value, cacheSignal) |
| } else { |
| stream = entryLeft.value |
| } |
|
|
| prerenderResumeDataCache.cache.set( |
| serializedCacheKey, |
| Promise.resolve(entryRight) |
| ) |
| } else { |
| |
| |
| |
| cacheSignal?.endRead() |
| } |
|
|
| if (currentTime > entry.timestamp + entry.revalidate * 1000) { |
| |
| |
| |
| const result = await generateCacheEntry( |
| workStore, |
| |
| { kind: cacheContext.kind, outerWorkUnitStore: undefined }, |
| clientReferenceManifest, |
| encodedCacheKeyParts, |
| fn, |
| sharedErrorStack |
| ) |
|
|
| if (result.type === 'cached') { |
| const { stream: ignoredStream, pendingCacheEntry } = result |
| let savedCacheEntry: Promise<CacheEntry> |
|
|
| if (prerenderResumeDataCache) { |
| const split = clonePendingCacheEntry(pendingCacheEntry) |
| savedCacheEntry = getNthCacheEntry(split, 0) |
| prerenderResumeDataCache.cache.set( |
| serializedCacheKey, |
| getNthCacheEntry(split, 1) |
| ) |
| } else { |
| savedCacheEntry = pendingCacheEntry |
| } |
|
|
| if (cacheHandler) { |
| const promise = cacheHandler.set( |
| serializedCacheKey, |
| savedCacheEntry |
| ) |
|
|
| workStore.pendingRevalidateWrites ??= [] |
| workStore.pendingRevalidateWrites.push(promise) |
| } |
|
|
| await ignoredStream.cancel() |
| } |
| } |
| } |
| } |
|
|
| |
| |
| |
| |
| |
| |
| |
| const replayConsoleLogs = true |
|
|
| const serverConsumerManifest = { |
| |
| |
| |
| moduleLoading: null, |
| moduleMap: isEdgeRuntime |
| ? clientReferenceManifest.edgeRscModuleMapping |
| : clientReferenceManifest.rscModuleMapping, |
| serverModuleMap: getServerModuleMap(), |
| } |
|
|
| return createFromReadableStream(stream, { |
| serverConsumerManifest, |
| temporaryReferences, |
| replayConsoleLogs, |
| environmentName: 'Cache', |
| }) |
| }, |
| }[name] |
|
|
| return React.cache(cachedFn) |
| } |
|
|
| function isPageComponent( |
| args: any[] |
| ): args is [UseCachePageComponentProps, undefined] { |
| if (args.length !== 2) { |
| return false |
| } |
|
|
| const [props, ref] = args |
|
|
| return ( |
| ref === undefined && |
| props !== null && |
| typeof props === 'object' && |
| (props as UseCachePageComponentProps).$$isPageComponent |
| ) |
| } |
|
|
| function isLayoutComponent( |
| args: any[] |
| ): args is [UseCacheLayoutComponentProps, undefined] { |
| if (args.length !== 2) { |
| return false |
| } |
|
|
| const [props, ref] = args |
|
|
| return ( |
| ref === undefined && |
| props !== null && |
| typeof props === 'object' && |
| (props as UseCacheLayoutComponentProps).$$isLayoutComponent |
| ) |
| } |
|
|
| function shouldForceRevalidate( |
| workStore: WorkStore, |
| workUnitStore: WorkUnitStore | undefined |
| ): boolean { |
| if (workStore.isOnDemandRevalidate || workStore.isDraftMode) { |
| return true |
| } |
|
|
| if (workStore.dev && workUnitStore) { |
| switch (workUnitStore.type) { |
| case 'request': |
| return workUnitStore.headers.get('cache-control') === 'no-cache' |
| case 'cache': |
| case 'private-cache': |
| return workUnitStore.forceRevalidate |
| case 'prerender': |
| case 'prerender-client': |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| case 'unstable-cache': |
| break |
| default: |
| workUnitStore satisfies never |
| } |
| } |
|
|
| return false |
| } |
|
|
| function shouldDiscardCacheEntry( |
| entry: CacheEntry, |
| workStore: WorkStore, |
| workUnitStore: WorkUnitStore | undefined, |
| implicitTags: string[], |
| implicitTagsExpiration: number |
| ): boolean { |
| |
| |
| if (entry.timestamp <= implicitTagsExpiration) { |
| debug?.( |
| 'entry was created at', |
| entry.timestamp, |
| 'before implicit tags were revalidated at', |
| implicitTagsExpiration |
| ) |
|
|
| return true |
| } |
|
|
| |
| |
| |
| |
| |
| if (workUnitStore) { |
| switch (workUnitStore.type) { |
| case 'prerender': |
| return false |
| case 'prerender-client': |
| case 'prerender-ppr': |
| case 'prerender-legacy': |
| case 'request': |
| case 'cache': |
| case 'private-cache': |
| case 'unstable-cache': |
| break |
| default: |
| workUnitStore satisfies never |
| } |
| } |
|
|
| |
| |
| if (entry.tags.some((tag) => isRecentlyRevalidatedTag(tag, workStore))) { |
| return true |
| } |
|
|
| |
| |
| if (implicitTags.some((tag) => isRecentlyRevalidatedTag(tag, workStore))) { |
| return true |
| } |
|
|
| return false |
| } |
|
|
| function isRecentlyRevalidatedTag(tag: string, workStore: WorkStore): boolean { |
| const { previouslyRevalidatedTags, pendingRevalidatedTags } = workStore |
|
|
| |
| if (previouslyRevalidatedTags.includes(tag)) { |
| debug?.('tag', tag, 'was previously revalidated') |
|
|
| return true |
| } |
|
|
| |
| |
| |
| |
| if (pendingRevalidatedTags?.includes(tag)) { |
| debug?.('tag', tag, 'was just revalidated') |
|
|
| return true |
| } |
|
|
| return false |
| } |
|
|