import { InvariantError } from '../../shared/lib/invariant-error' import { postponeWithTracking, throwToInterruptStaticGeneration, } from '../app-render/dynamic-rendering' import { workAsyncStorage, type WorkStore, } from '../app-render/work-async-storage.external' import { workUnitAsyncStorage, type PrerenderStore, type PrerenderStoreLegacy, type PrerenderStorePPR, } from '../app-render/work-unit-async-storage.external' import { makeHangingPromise } from '../dynamic-rendering-utils' import type { FallbackRouteParams } from './fallback-params' import type { Params } from './params' import { describeStringPropertyAccess, wellKnownProperties, } from '../../shared/lib/utils/reflect-utils' interface CacheLifetime {} const CachedParams = new WeakMap>() export async function unstable_rootParams(): Promise { const workStore = workAsyncStorage.getStore() if (!workStore) { throw new InvariantError('Missing workStore in unstable_rootParams') } const workUnitStore = workUnitAsyncStorage.getStore() if (!workUnitStore) { throw new Error( `Route ${workStore.route} used \`unstable_rootParams()\` in Pages Router. This API is only available within App Router.` ) } switch (workUnitStore.type) { case 'cache': case 'private-cache': case 'unstable-cache': { throw new Error( `Route ${workStore.route} used \`unstable_rootParams()\` inside \`"use cache"\` or \`unstable_cache\`. Support for this API inside cache scopes is planned for a future version of Next.js.` ) } case 'prerender': case 'prerender-client': case 'prerender-ppr': case 'prerender-legacy': return createPrerenderRootParams( workUnitStore.rootParams, workStore, workUnitStore ) case 'request': return Promise.resolve(workUnitStore.rootParams) default: return workUnitStore satisfies never } } function createPrerenderRootParams( underlyingParams: Params, workStore: WorkStore, prerenderStore: PrerenderStore ): Promise { switch (prerenderStore.type) { case 'prerender-client': { const exportName = '`unstable_rootParams`' throw new InvariantError( `${exportName} must not be used within a client component. Next.js should be preventing ${exportName} from being included in client components statically, but did not in this case.` ) } case 'prerender': { const fallbackParams = prerenderStore.fallbackRouteParams if (fallbackParams) { for (const key in underlyingParams) { if (fallbackParams.has(key)) { const cachedParams = CachedParams.get(underlyingParams) if (cachedParams) { return cachedParams } const promise = makeHangingPromise( prerenderStore.renderSignal, '`unstable_rootParams`' ) CachedParams.set(underlyingParams, promise) return promise } } } break } case 'prerender-ppr': { const fallbackParams = prerenderStore.fallbackRouteParams if (fallbackParams) { for (const key in underlyingParams) { if (fallbackParams.has(key)) { // We have fallback params at this level so we need to make an erroring // params object which will postpone if you access the fallback params return makeErroringRootParams( underlyingParams, fallbackParams, workStore, prerenderStore ) } } } break } case 'prerender-legacy': break default: prerenderStore satisfies never } // We don't have any fallback params so we have an entirely static safe params object return Promise.resolve(underlyingParams) } function makeErroringRootParams( underlyingParams: Params, fallbackParams: FallbackRouteParams, workStore: WorkStore, prerenderStore: PrerenderStorePPR | PrerenderStoreLegacy ): Promise { const cachedParams = CachedParams.get(underlyingParams) if (cachedParams) { return cachedParams } const augmentedUnderlying = { ...underlyingParams } // We don't use makeResolvedReactPromise here because params // supports copying with spread and we don't want to unnecessarily // instrument the promise with spreadable properties of ReactPromise. const promise = Promise.resolve(augmentedUnderlying) CachedParams.set(underlyingParams, promise) Object.keys(underlyingParams).forEach((prop) => { if (wellKnownProperties.has(prop)) { // These properties cannot be shadowed because they need to be the // true underlying value for Promises to work correctly at runtime } else { if (fallbackParams.has(prop)) { Object.defineProperty(augmentedUnderlying, prop, { get() { const expression = describeStringPropertyAccess( 'unstable_rootParams', prop ) // In most dynamic APIs we also throw if `dynamic = "error"` however // for params is only dynamic when we're generating a fallback shell // and even when `dynamic = "error"` we still support generating dynamic // fallback shells // TODO remove this comment when cacheComponents is the default since there // will be no `dynamic = "error"` if (prerenderStore.type === 'prerender-ppr') { // PPR Prerender (no cacheComponents) postponeWithTracking( workStore.route, expression, prerenderStore.dynamicTracking ) } else { // Legacy Prerender throwToInterruptStaticGeneration( expression, workStore, prerenderStore ) } }, enumerable: true, }) } else { ;(promise as any)[prop] = underlyingParams[prop] } } }) return promise }