-
Notifications
You must be signed in to change notification settings - Fork 27k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
32 changed files
with
510 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| 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 './utils' | ||
|
|
||
| interface CacheLifetime {} | ||
| const CachedParams = new WeakMap<CacheLifetime, Promise<Params>>() | ||
|
|
||
| export async function unstable_rootParams(): Promise<Params> { | ||
| const workStore = workAsyncStorage.getStore() | ||
| const workUnitStore = workUnitAsyncStorage.getStore() | ||
|
|
||
| if (!workStore) { | ||
| throw new InvariantError('Missing workStore in unstable_rootParams') | ||
| } | ||
|
|
||
| const underlyingParams = workStore.rootParams | ||
|
|
||
| if (workUnitStore) { | ||
| switch (workUnitStore.type) { | ||
| case 'prerender': | ||
| case 'prerender-ppr': | ||
| case 'prerender-legacy': | ||
| return createPrerenderParams(underlyingParams, workStore, workUnitStore) | ||
| default: | ||
| // fallthrough | ||
| } | ||
| } | ||
| return makeUntrackedRootParams(underlyingParams) | ||
| } | ||
|
|
||
| function createPrerenderParams( | ||
| underlyingParams: Params, | ||
| workStore: WorkStore, | ||
| prerenderStore: PrerenderStore | ||
| ): Promise<Params> { | ||
| const fallbackParams = workStore.fallbackRouteParams | ||
| if (fallbackParams) { | ||
| let hasSomeFallbackParams = false | ||
| for (const key in underlyingParams) { | ||
| if (fallbackParams.has(key)) { | ||
| hasSomeFallbackParams = true | ||
| break | ||
| } | ||
| } | ||
|
|
||
| if (hasSomeFallbackParams) { | ||
| // params need to be treated as dynamic because we have at least one fallback param | ||
| if (prerenderStore.type === 'prerender') { | ||
| // We are in a dynamicIO (PPR or otherwise) prerender | ||
| const cachedParams = CachedParams.get(underlyingParams) | ||
| if (cachedParams) { | ||
| return cachedParams | ||
| } | ||
|
|
||
| const promise = makeHangingPromise<Params>( | ||
| prerenderStore.renderSignal, | ||
| '`unstable_rootParams`' | ||
| ) | ||
| CachedParams.set(underlyingParams, promise) | ||
|
|
||
| return promise | ||
| } | ||
| // remaining cases are prerender-ppr and prerender-legacy | ||
| // We aren't in a dynamicIO prerender but we do 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 | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| // We don't have any fallback params so we have an entirely static safe params object | ||
| return makeUntrackedRootParams(underlyingParams) | ||
| } | ||
|
|
||
| function makeErroringRootParams( | ||
| underlyingParams: Params, | ||
| fallbackParams: FallbackRouteParams, | ||
| workStore: WorkStore, | ||
| prerenderStore: PrerenderStorePPR | PrerenderStoreLegacy | ||
| ): Promise<Params> { | ||
| 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('params', 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 dynamicIO is the default since there | ||
| // will be no `dynamic = "error"` | ||
| if (prerenderStore.type === 'prerender-ppr') { | ||
| // PPR Prerender (no dynamicIO) | ||
| postponeWithTracking( | ||
| workStore.route, | ||
| expression, | ||
| prerenderStore.dynamicTracking | ||
| ) | ||
| } else { | ||
| // Legacy Prerender | ||
| throwToInterruptStaticGeneration( | ||
| expression, | ||
| workStore, | ||
| prerenderStore | ||
| ) | ||
| } | ||
| }, | ||
| enumerable: true, | ||
| }) | ||
| } else { | ||
| ;(promise as any)[prop] = underlyingParams[prop] | ||
| } | ||
| } | ||
| }) | ||
|
|
||
| return promise | ||
| } | ||
|
|
||
| function makeUntrackedRootParams(underlyingParams: Params): Promise<Params> { | ||
| const cachedParams = CachedParams.get(underlyingParams) | ||
| if (cachedParams) { | ||
| return cachedParams | ||
| } | ||
|
|
||
| // 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(underlyingParams) | ||
| 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 { | ||
| ;(promise as any)[prop] = underlyingParams[prop] | ||
| } | ||
| }) | ||
|
|
||
| return promise | ||
| } |
Oops, something went wrong.