Unverified Commit 929d6fa3 authored by Josh Story's avatar Josh Story Committed by GitHub

[Cache Components] Defer Request Data API resolution to another task in dev when…

[Cache Components] Defer Request Data API resolution to another task in dev when it would suspend when prerendering (#82386)

Stacked on #82381

When resolving these Request Data APIs in dev we now do so in a new
Task. This allows the environment tracking to properly move stuff that
was previously in the Prerender environment to the Server environment
when a Request Data API is used before them. This also has the nice side
effect of causing these functions to appear as IO in the new
suspended-by features of React Devtools.

In Prod we don't need to do any additional delaying because the all of
the features this is designed to interact with are dev only.
parent 1766a1ab
...@@ -1783,6 +1783,8 @@ async function renderToHTMLOrFlightImpl( ...@@ -1783,6 +1783,8 @@ async function renderToHTMLOrFlightImpl(
renderOpts.renderResumeDataCache ?? postponedState?.renderResumeDataCache renderOpts.renderResumeDataCache ?? postponedState?.renderResumeDataCache
const rootParams = getRootParams(loaderTree, ctx.getDynamicParamFromSegment) const rootParams = getRootParams(loaderTree, ctx.getDynamicParamFromSegment)
const devValidatingFallbackParams =
getRequestMeta(req, 'devValidatingFallbackParams') || null
const requestStore = createRequestStoreForRender( const requestStore = createRequestStoreForRender(
req, req,
res, res,
...@@ -1793,7 +1795,8 @@ async function renderToHTMLOrFlightImpl( ...@@ -1793,7 +1795,8 @@ async function renderToHTMLOrFlightImpl(
renderOpts.previewProps, renderOpts.previewProps,
isHmrRefresh, isHmrRefresh,
serverComponentsHmrCache, serverComponentsHmrCache,
renderResumeDataCache renderResumeDataCache,
devValidatingFallbackParams
) )
if ( if (
...@@ -1865,7 +1868,8 @@ async function renderToHTMLOrFlightImpl( ...@@ -1865,7 +1868,8 @@ async function renderToHTMLOrFlightImpl(
notFoundLoaderTree, notFoundLoaderTree,
formState, formState,
postponedState, postponedState,
metadata metadata,
devValidatingFallbackParams
) )
return new RenderResult(stream, { return new RenderResult(stream, {
...@@ -1896,7 +1900,8 @@ async function renderToHTMLOrFlightImpl( ...@@ -1896,7 +1900,8 @@ async function renderToHTMLOrFlightImpl(
loaderTree, loaderTree,
formState, formState,
postponedState, postponedState,
metadata metadata,
devValidatingFallbackParams
) )
// Invalid dynamic usages should only error the request in development. // Invalid dynamic usages should only error the request in development.
...@@ -2079,7 +2084,8 @@ async function renderToStream( ...@@ -2079,7 +2084,8 @@ async function renderToStream(
tree: LoaderTree, tree: LoaderTree,
formState: any, formState: any,
postponedState: PostponedState | null, postponedState: PostponedState | null,
metadata: AppPageRenderResultMetadata metadata: AppPageRenderResultMetadata,
devValidatingFallbackParams: FallbackRouteParams | null
): Promise<ReadableStream<Uint8Array>> { ): Promise<ReadableStream<Uint8Array>> {
const { assetPrefix, nonce, pagePath, renderOpts } = ctx const { assetPrefix, nonce, pagePath, renderOpts } = ctx
...@@ -2226,9 +2232,6 @@ async function renderToStream( ...@@ -2226,9 +2232,6 @@ async function renderToStream(
} }
) )
const devValidatingFallbackParams =
getRequestMeta(req, 'devValidatingFallbackParams') || null
spawnDynamicValidationInDev( spawnDynamicValidationInDev(
resolveValidation, resolveValidation,
tree, tree,
......
...@@ -18,6 +18,7 @@ import type { Params } from '../request/params' ...@@ -18,6 +18,7 @@ import type { Params } from '../request/params'
import type { ImplicitTags } from '../lib/implicit-tags' import type { ImplicitTags } from '../lib/implicit-tags'
import type { WorkStore } from './work-async-storage.external' import type { WorkStore } from './work-async-storage.external'
import { NEXT_HMR_REFRESH_HASH_COOKIE } from '../../client/components/app-router-headers' import { NEXT_HMR_REFRESH_HASH_COOKIE } from '../../client/components/app-router-headers'
import { InvariantError } from '../../shared/lib/invariant-error'
export type WorkUnitPhase = 'action' | 'render' | 'after' export type WorkUnitPhase = 'action' | 'render' | 'after'
...@@ -67,6 +68,7 @@ export interface RequestStore extends CommonWorkUnitStore { ...@@ -67,6 +68,7 @@ export interface RequestStore extends CommonWorkUnitStore {
// DEV-only // DEV-only
usedDynamic?: boolean usedDynamic?: boolean
prerenderPhase?: boolean prerenderPhase?: boolean
devFallbackParams?: FallbackRouteParams | null
} }
/** /**
...@@ -335,6 +337,10 @@ export function throwForMissingRequestStore(callingExpression: string): never { ...@@ -335,6 +337,10 @@ export function throwForMissingRequestStore(callingExpression: string): never {
) )
} }
export function throwInvariantForMissingStore(): never {
throw new InvariantError('Expected workUnitAsyncStorage to have a store.')
}
export function getPrerenderResumeDataCache( export function getPrerenderResumeDataCache(
workUnitStore: WorkUnitStore workUnitStore: WorkUnitStore
): PrerenderResumeDataCache | null { ): PrerenderResumeDataCache | null {
......
...@@ -24,6 +24,7 @@ import type { ServerComponentsHmrCache } from '../response-cache' ...@@ -24,6 +24,7 @@ import type { ServerComponentsHmrCache } from '../response-cache'
import type { RenderResumeDataCache } from '../resume-data-cache/resume-data-cache' import type { RenderResumeDataCache } from '../resume-data-cache/resume-data-cache'
import type { Params } from '../request/params' import type { Params } from '../request/params'
import type { ImplicitTags } from '../lib/implicit-tags' import type { ImplicitTags } from '../lib/implicit-tags'
import type { FallbackRouteParams } from '../request/fallback-params'
function getHeaders(headers: Headers | IncomingHttpHeaders): ReadonlyHeaders { function getHeaders(headers: Headers | IncomingHttpHeaders): ReadonlyHeaders {
const cleaned = HeadersAdapter.from(headers) const cleaned = HeadersAdapter.from(headers)
...@@ -114,7 +115,8 @@ export function createRequestStoreForRender( ...@@ -114,7 +115,8 @@ export function createRequestStoreForRender(
previewProps: WrapperRenderOpts['previewProps'], previewProps: WrapperRenderOpts['previewProps'],
isHmrRefresh: RequestContext['isHmrRefresh'], isHmrRefresh: RequestContext['isHmrRefresh'],
serverComponentsHmrCache: RequestContext['serverComponentsHmrCache'], serverComponentsHmrCache: RequestContext['serverComponentsHmrCache'],
renderResumeDataCache: RenderResumeDataCache | undefined renderResumeDataCache: RenderResumeDataCache | undefined,
devFallbackParams: FallbackRouteParams | null
): RequestStore { ): RequestStore {
return createRequestStoreImpl( return createRequestStoreImpl(
// Pages start in render phase by default // Pages start in render phase by default
...@@ -128,7 +130,8 @@ export function createRequestStoreForRender( ...@@ -128,7 +130,8 @@ export function createRequestStoreForRender(
renderResumeDataCache, renderResumeDataCache,
previewProps, previewProps,
isHmrRefresh, isHmrRefresh,
serverComponentsHmrCache serverComponentsHmrCache,
devFallbackParams
) )
} }
...@@ -151,7 +154,8 @@ export function createRequestStoreForAPI( ...@@ -151,7 +154,8 @@ export function createRequestStoreForAPI(
undefined, undefined,
previewProps, previewProps,
false, false,
undefined undefined,
null
) )
} }
...@@ -166,7 +170,8 @@ function createRequestStoreImpl( ...@@ -166,7 +170,8 @@ function createRequestStoreImpl(
renderResumeDataCache: RenderResumeDataCache | undefined, renderResumeDataCache: RenderResumeDataCache | undefined,
previewProps: WrapperRenderOpts['previewProps'], previewProps: WrapperRenderOpts['previewProps'],
isHmrRefresh: RequestContext['isHmrRefresh'], isHmrRefresh: RequestContext['isHmrRefresh'],
serverComponentsHmrCache: RequestContext['serverComponentsHmrCache'] serverComponentsHmrCache: RequestContext['serverComponentsHmrCache'],
devFallbackParams: FallbackRouteParams | null | undefined
): RequestStore { ): RequestStore {
function defaultOnUpdateCookies(cookies: string[]) { function defaultOnUpdateCookies(cookies: string[]) {
if (res) { if (res) {
...@@ -258,6 +263,7 @@ function createRequestStoreImpl( ...@@ -258,6 +263,7 @@ function createRequestStoreImpl(
serverComponentsHmrCache: serverComponentsHmrCache:
serverComponentsHmrCache || serverComponentsHmrCache ||
(globalThis as any).__serverComponentsHmrCache, (globalThis as any).__serverComponentsHmrCache,
devFallbackParams,
} }
} }
......
...@@ -72,3 +72,14 @@ export function makeHangingPromise<T>( ...@@ -72,3 +72,14 @@ export function makeHangingPromise<T>(
} }
function ignoreReject() {} function ignoreReject() {}
export function makeDevtoolsIOAwarePromise<T>(underlying: T): Promise<T> {
// in React DevTools if we resolve in a setTimeout we will observe
// the promise resolution as something that can suspend a boundary or root.
return new Promise<T>((resolve) => {
// Must use setTimeout to be considered IO React DevTools. setImmediate will not work.
setTimeout(() => {
resolve(underlying)
}, 0)
})
}
import { workAsyncStorage } from '../app-render/work-async-storage.external' import { workAsyncStorage } from '../app-render/work-async-storage.external'
import { workUnitAsyncStorage } from '../app-render/work-unit-async-storage.external' import {
throwForMissingRequestStore,
workUnitAsyncStorage,
} from '../app-render/work-unit-async-storage.external'
import { import {
postponeWithTracking, postponeWithTracking,
throwToInterruptStaticGeneration, throwToInterruptStaticGeneration,
trackDynamicDataInDynamicRender, trackDynamicDataInDynamicRender,
} from '../app-render/dynamic-rendering' } from '../app-render/dynamic-rendering'
import { StaticGenBailoutError } from '../../client/components/static-generation-bailout' import { StaticGenBailoutError } from '../../client/components/static-generation-bailout'
import { makeHangingPromise } from '../dynamic-rendering-utils' import {
makeHangingPromise,
makeDevtoolsIOAwarePromise,
} from '../dynamic-rendering-utils'
import { isRequestAPICallableInsideAfter } from './utils' import { isRequestAPICallableInsideAfter } from './utils'
/** /**
...@@ -15,6 +21,7 @@ import { isRequestAPICallableInsideAfter } from './utils' ...@@ -15,6 +21,7 @@ import { isRequestAPICallableInsideAfter } from './utils'
* During prerendering it will never resolve and during rendering it resolves immediately. * During prerendering it will never resolve and during rendering it resolves immediately.
*/ */
export function connection(): Promise<void> { export function connection(): Promise<void> {
const callingExpression = 'connection'
const workStore = workAsyncStorage.getStore() const workStore = workAsyncStorage.getStore()
const workUnitStore = workUnitAsyncStorage.getStore() const workUnitStore = workUnitAsyncStorage.getStore()
...@@ -94,12 +101,20 @@ export function connection(): Promise<void> { ...@@ -94,12 +101,20 @@ export function connection(): Promise<void> {
) )
case 'request': case 'request':
trackDynamicDataInDynamicRender(workUnitStore) trackDynamicDataInDynamicRender(workUnitStore)
break if (process.env.NODE_ENV === 'development') {
// Semantically we only need the dev tracking when running in `next dev`
// but since you would never use next dev with production NODE_ENV we use this
// as a proxy so we can statically exclude this code from production builds.
return makeDevtoolsIOAwarePromise(undefined)
} else {
return Promise.resolve(undefined)
}
default: default:
workUnitStore satisfies never workUnitStore satisfies never
} }
} }
} }
return Promise.resolve(undefined) // If we end up here, there was no work store or work unit store present.
throwForMissingRequestStore(callingExpression)
} }
...@@ -22,9 +22,11 @@ import { ...@@ -22,9 +22,11 @@ import {
trackSynchronousRequestDataAccessInDev, trackSynchronousRequestDataAccessInDev,
} from '../app-render/dynamic-rendering' } from '../app-render/dynamic-rendering'
import { StaticGenBailoutError } from '../../client/components/static-generation-bailout' import { StaticGenBailoutError } from '../../client/components/static-generation-bailout'
import { makeHangingPromise } from '../dynamic-rendering-utils' import {
makeDevtoolsIOAwarePromise,
makeHangingPromise,
} from '../dynamic-rendering-utils'
import { createDedupedByCallsiteServerErrorLoggerDev } from '../create-deduped-by-callsite-server-error-logger' import { createDedupedByCallsiteServerErrorLoggerDev } from '../create-deduped-by-callsite-server-error-logger'
import { scheduleImmediate } from '../../lib/scheduler'
import { isRequestAPICallableInsideAfter } from './utils' import { isRequestAPICallableInsideAfter } from './utils'
import { InvariantError } from '../../shared/lib/invariant-error' import { InvariantError } from '../../shared/lib/invariant-error'
import { ReflectAdapter } from '../web/spec-extension/adapters/reflect' import { ReflectAdapter } from '../web/spec-extension/adapters/reflect'
...@@ -143,10 +145,10 @@ export function cookies(): Promise<ReadonlyRequestCookies> { ...@@ -143,10 +145,10 @@ export function cookies(): Promise<ReadonlyRequestCookies> {
underlyingCookies = workUnitStore.cookies underlyingCookies = workUnitStore.cookies
} }
if ( if (process.env.NODE_ENV === 'development') {
process.env.NODE_ENV === 'development' && // Semantically we only need the dev tracking when running in `next dev`
!workStore?.isPrefetchRequest // but since you would never use next dev with production NODE_ENV we use this
) { // as a proxy so we can statically exclude this code from production builds.
if (process.env.__NEXT_CACHE_COMPONENTS) { if (process.env.__NEXT_CACHE_COMPONENTS) {
return makeUntrackedCookiesWithDevWarnings( return makeUntrackedCookiesWithDevWarnings(
underlyingCookies, underlyingCookies,
...@@ -290,9 +292,7 @@ function makeUntrackedExoticCookiesWithDevWarnings( ...@@ -290,9 +292,7 @@ function makeUntrackedExoticCookiesWithDevWarnings(
return cachedCookies return cachedCookies
} }
const promise = new Promise<ReadonlyRequestCookies>((resolve) => const promise = makeDevtoolsIOAwarePromise(underlyingCookies)
scheduleImmediate(() => resolve(underlyingCookies))
)
CachedCookies.set(underlyingCookies, promise) CachedCookies.set(underlyingCookies, promise)
Object.defineProperties(promise, { Object.defineProperties(promise, {
...@@ -443,9 +443,7 @@ function makeUntrackedCookiesWithDevWarnings( ...@@ -443,9 +443,7 @@ function makeUntrackedCookiesWithDevWarnings(
return cachedCookies return cachedCookies
} }
const promise = new Promise<ReadonlyRequestCookies>((resolve) => const promise = makeDevtoolsIOAwarePromise(underlyingCookies)
scheduleImmediate(() => resolve(underlyingCookies))
)
const proxiedPromise = new Proxy(promise, { const proxiedPromise = new Proxy(promise, {
get(target, prop, receiver) { get(target, prop, receiver) {
......
...@@ -6,8 +6,8 @@ import { ...@@ -6,8 +6,8 @@ import {
workAsyncStorage, workAsyncStorage,
type WorkStore, type WorkStore,
} from '../app-render/work-async-storage.external' } from '../app-render/work-async-storage.external'
import { throwForMissingRequestStore } from '../app-render/work-unit-async-storage.external'
import { import {
throwForMissingRequestStore,
workUnitAsyncStorage, workUnitAsyncStorage,
type PrerenderStoreModern, type PrerenderStoreModern,
} from '../app-render/work-unit-async-storage.external' } from '../app-render/work-unit-async-storage.external'
...@@ -18,9 +18,11 @@ import { ...@@ -18,9 +18,11 @@ import {
trackSynchronousRequestDataAccessInDev, trackSynchronousRequestDataAccessInDev,
} from '../app-render/dynamic-rendering' } from '../app-render/dynamic-rendering'
import { StaticGenBailoutError } from '../../client/components/static-generation-bailout' import { StaticGenBailoutError } from '../../client/components/static-generation-bailout'
import { makeHangingPromise } from '../dynamic-rendering-utils' import {
makeDevtoolsIOAwarePromise,
makeHangingPromise,
} from '../dynamic-rendering-utils'
import { createDedupedByCallsiteServerErrorLoggerDev } from '../create-deduped-by-callsite-server-error-logger' import { createDedupedByCallsiteServerErrorLoggerDev } from '../create-deduped-by-callsite-server-error-logger'
import { scheduleImmediate } from '../../lib/scheduler'
import { isRequestAPICallableInsideAfter } from './utils' import { isRequestAPICallableInsideAfter } from './utils'
import { InvariantError } from '../../shared/lib/invariant-error' import { InvariantError } from '../../shared/lib/invariant-error'
import { ReflectAdapter } from '../web/spec-extension/adapters/reflect' import { ReflectAdapter } from '../web/spec-extension/adapters/reflect'
...@@ -153,10 +155,10 @@ export function headers(): Promise<ReadonlyHeaders> { ...@@ -153,10 +155,10 @@ export function headers(): Promise<ReadonlyHeaders> {
case 'request': case 'request':
trackDynamicDataInDynamicRender(workUnitStore) trackDynamicDataInDynamicRender(workUnitStore)
if ( if (process.env.NODE_ENV === 'development') {
process.env.NODE_ENV === 'development' && // Semantically we only need the dev tracking when running in `next dev`
!workStore?.isPrefetchRequest // but since you would never use next dev with production NODE_ENV we use this
) { // as a proxy so we can statically exclude this code from production builds.
if (process.env.__NEXT_CACHE_COMPONENTS) { if (process.env.__NEXT_CACHE_COMPONENTS) {
return makeUntrackedHeadersWithDevWarnings( return makeUntrackedHeadersWithDevWarnings(
workUnitStore.headers, workUnitStore.headers,
...@@ -281,9 +283,7 @@ function makeUntrackedExoticHeadersWithDevWarnings( ...@@ -281,9 +283,7 @@ function makeUntrackedExoticHeadersWithDevWarnings(
return cachedHeaders return cachedHeaders
} }
const promise = new Promise<ReadonlyHeaders>((resolve) => const promise = makeDevtoolsIOAwarePromise(underlyingHeaders)
scheduleImmediate(() => resolve(underlyingHeaders))
)
CachedHeaders.set(underlyingHeaders, promise) CachedHeaders.set(underlyingHeaders, promise)
...@@ -402,9 +402,7 @@ function makeUntrackedHeadersWithDevWarnings( ...@@ -402,9 +402,7 @@ function makeUntrackedHeadersWithDevWarnings(
return cachedHeaders return cachedHeaders
} }
const promise = new Promise<ReadonlyHeaders>((resolve) => const promise = makeDevtoolsIOAwarePromise(underlyingHeaders)
scheduleImmediate(() => resolve(underlyingHeaders))
)
const proxiedPromise = new Proxy(promise, { const proxiedPromise = new Proxy(promise, {
get(target, prop, receiver) { get(target, prop, receiver) {
......
This diff is collapsed.
...@@ -7,6 +7,7 @@ import { ...@@ -7,6 +7,7 @@ import {
} from '../app-render/dynamic-rendering' } from '../app-render/dynamic-rendering'
import { import {
throwInvariantForMissingStore,
workUnitAsyncStorage, workUnitAsyncStorage,
type StaticPrerenderStore, type StaticPrerenderStore,
} from '../app-render/work-unit-async-storage.external' } from '../app-render/work-unit-async-storage.external'
...@@ -43,12 +44,12 @@ export function createServerPathnameForMetadata( ...@@ -43,12 +44,12 @@ export function createServerPathnameForMetadata(
createRenderPathname(underlyingPathname) createRenderPathname(underlyingPathname)
) )
case 'request': case 'request':
break return createRenderPathname(underlyingPathname)
default: default:
workUnitStore satisfies never workUnitStore satisfies never
} }
} }
return createRenderPathname(underlyingPathname) throwInvariantForMissingStore()
} }
function createPrerenderPathname( function createPrerenderPathname(
......
...@@ -15,10 +15,15 @@ import { ...@@ -15,10 +15,15 @@ import {
type PrerenderStoreLegacy, type PrerenderStoreLegacy,
type PrerenderStorePPR, type PrerenderStorePPR,
type PrerenderStoreModern, type PrerenderStoreModern,
type PrerenderStoreModernRuntime,
type StaticPrerenderStore, type StaticPrerenderStore,
throwInvariantForMissingStore,
} from '../app-render/work-unit-async-storage.external' } from '../app-render/work-unit-async-storage.external'
import { InvariantError } from '../../shared/lib/invariant-error' import { InvariantError } from '../../shared/lib/invariant-error'
import { makeHangingPromise } from '../dynamic-rendering-utils' import {
makeDevtoolsIOAwarePromise,
makeHangingPromise,
} from '../dynamic-rendering-utils'
import { createDedupedByCallsiteServerErrorLoggerDev } from '../create-deduped-by-callsite-server-error-logger' import { createDedupedByCallsiteServerErrorLoggerDev } from '../create-deduped-by-callsite-server-error-logger'
import { import {
describeStringPropertyAccess, describeStringPropertyAccess,
...@@ -29,7 +34,6 @@ import { ...@@ -29,7 +34,6 @@ import {
throwWithStaticGenerationBailoutErrorWithDynamicError, throwWithStaticGenerationBailoutErrorWithDynamicError,
throwForSearchParamsAccessInUseCache, throwForSearchParamsAccessInUseCache,
} from './utils' } from './utils'
import { scheduleImmediate } from '../../lib/scheduler'
export type SearchParams = { [key: string]: string | string[] | undefined } export type SearchParams = { [key: string]: string | string[] | undefined }
...@@ -64,7 +68,7 @@ export type UnsafeUnwrappedSearchParams<P> = ...@@ -64,7 +68,7 @@ export type UnsafeUnwrappedSearchParams<P> =
export function createSearchParamsFromClient( export function createSearchParamsFromClient(
underlyingSearchParams: SearchParams, underlyingSearchParams: SearchParams,
workStore: WorkStore workStore: WorkStore
) { ): Promise<SearchParams> {
const workUnitStore = workUnitAsyncStorage.getStore() const workUnitStore = workUnitAsyncStorage.getStore()
if (workUnitStore) { if (workUnitStore) {
switch (workUnitStore.type) { switch (workUnitStore.type) {
...@@ -72,7 +76,7 @@ export function createSearchParamsFromClient( ...@@ -72,7 +76,7 @@ export function createSearchParamsFromClient(
case 'prerender-client': case 'prerender-client':
case 'prerender-ppr': case 'prerender-ppr':
case 'prerender-legacy': case 'prerender-legacy':
return createPrerenderSearchParams(workStore, workUnitStore) return createStaticPrerenderSearchParams(workStore, workUnitStore)
case 'prerender-runtime': case 'prerender-runtime':
throw new InvariantError( throw new InvariantError(
'createSearchParamsFromClient should not be called in a runtime prerender.' 'createSearchParamsFromClient should not be called in a runtime prerender.'
...@@ -84,12 +88,12 @@ export function createSearchParamsFromClient( ...@@ -84,12 +88,12 @@ export function createSearchParamsFromClient(
'createSearchParamsFromClient should not be called in cache contexts.' 'createSearchParamsFromClient should not be called in cache contexts.'
) )
case 'request': case 'request':
break return createRenderSearchParams(underlyingSearchParams, workStore)
default: default:
workUnitStore satisfies never workUnitStore satisfies never
} }
} }
return createRenderSearchParams(underlyingSearchParams, workStore) throwInvariantForMissingStore()
} }
// generateMetadata always runs in RSC context so it is equivalent to a Server Page Component // generateMetadata always runs in RSC context so it is equivalent to a Server Page Component
...@@ -107,7 +111,7 @@ export function createServerSearchParamsForServerPage( ...@@ -107,7 +111,7 @@ export function createServerSearchParamsForServerPage(
case 'prerender-client': case 'prerender-client':
case 'prerender-ppr': case 'prerender-ppr':
case 'prerender-legacy': case 'prerender-legacy':
return createPrerenderSearchParams(workStore, workUnitStore) return createStaticPrerenderSearchParams(workStore, workUnitStore)
case 'cache': case 'cache':
case 'private-cache': case 'private-cache':
case 'unstable-cache': case 'unstable-cache':
...@@ -115,17 +119,17 @@ export function createServerSearchParamsForServerPage( ...@@ -115,17 +119,17 @@ export function createServerSearchParamsForServerPage(
'createServerSearchParamsForServerPage should not be called in cache contexts.' 'createServerSearchParamsForServerPage should not be called in cache contexts.'
) )
case 'prerender-runtime': case 'prerender-runtime':
return delayUntilRuntimeStage( return createRuntimePrerenderSearchParams(
workUnitStore, underlyingSearchParams,
createRenderSearchParams(underlyingSearchParams, workStore) workUnitStore
) )
case 'request': case 'request':
break return createRenderSearchParams(underlyingSearchParams, workStore)
default: default:
workUnitStore satisfies never workUnitStore satisfies never
} }
} }
return createRenderSearchParams(underlyingSearchParams, workStore) throwInvariantForMissingStore()
} }
export function createPrerenderSearchParamsForClientPage( export function createPrerenderSearchParamsForClientPage(
...@@ -162,18 +166,15 @@ export function createPrerenderSearchParamsForClientPage( ...@@ -162,18 +166,15 @@ export function createPrerenderSearchParamsForClientPage(
case 'prerender-ppr': case 'prerender-ppr':
case 'prerender-legacy': case 'prerender-legacy':
case 'request': case 'request':
break return Promise.resolve({})
default: default:
workUnitStore satisfies never workUnitStore satisfies never
} }
} }
// We're prerendering in a mode that does not abort. We resolve the promise throwInvariantForMissingStore()
// without any tracking because we're just transporting a value from server to
// client where the tracking will be applied.
return Promise.resolve({})
} }
function createPrerenderSearchParams( function createStaticPrerenderSearchParams(
workStore: WorkStore, workStore: WorkStore,
prerenderStore: StaticPrerenderStore prerenderStore: StaticPrerenderStore
): Promise<SearchParams> { ): Promise<SearchParams> {
...@@ -198,6 +199,18 @@ function createPrerenderSearchParams( ...@@ -198,6 +199,18 @@ function createPrerenderSearchParams(
} }
} }
function createRuntimePrerenderSearchParams(
underlyingSearchParams: SearchParams,
workUnitStore: PrerenderStoreModernRuntime
): Promise<SearchParams> {
return delayUntilRuntimeStage(
workUnitStore,
process.env.__NEXT_CACHE_COMPONENTS
? makeUntrackedSearchParams(underlyingSearchParams)
: makeUntrackedExoticSearchParams(underlyingSearchParams)
)
}
function createRenderSearchParams( function createRenderSearchParams(
underlyingSearchParams: SearchParams, underlyingSearchParams: SearchParams,
workStore: WorkStore workStore: WorkStore
...@@ -207,10 +220,10 @@ function createRenderSearchParams( ...@@ -207,10 +220,10 @@ function createRenderSearchParams(
// dictionary object. // dictionary object.
return Promise.resolve({}) return Promise.resolve({})
} else { } else {
if ( if (process.env.NODE_ENV === 'development') {
process.env.NODE_ENV === 'development' && // Semantically we only need the dev tracking when running in `next dev`
!workStore.isPrefetchRequest // but since you would never use next dev with production NODE_ENV we use this
) { // as a proxy so we can statically exclude this code from production builds.
if (process.env.__NEXT_CACHE_COMPONENTS) { if (process.env.__NEXT_CACHE_COMPONENTS) {
return makeUntrackedSearchParamsWithDevWarnings( return makeUntrackedSearchParamsWithDevWarnings(
underlyingSearchParams, underlyingSearchParams,
...@@ -633,9 +646,7 @@ function makeDynamicallyTrackedExoticSearchParamsWithDevWarnings( ...@@ -633,9 +646,7 @@ function makeDynamicallyTrackedExoticSearchParamsWithDevWarnings(
// We don't use makeResolvedReactPromise here because searchParams // We don't use makeResolvedReactPromise here because searchParams
// supports copying with spread and we don't want to unnecessarily // supports copying with spread and we don't want to unnecessarily
// instrument the promise with spreadable properties of ReactPromise. // instrument the promise with spreadable properties of ReactPromise.
const promise = new Promise<SearchParams>((resolve) => const promise = makeDevtoolsIOAwarePromise(underlyingSearchParams)
scheduleImmediate(() => resolve(underlyingSearchParams))
)
promise.then(() => { promise.then(() => {
promiseInitialized = true promiseInitialized = true
}) })
...@@ -736,7 +747,7 @@ function makeUntrackedSearchParamsWithDevWarnings( ...@@ -736,7 +747,7 @@ function makeUntrackedSearchParamsWithDevWarnings(
const proxiedProperties = new Set<string>() const proxiedProperties = new Set<string>()
const unproxiedProperties: Array<string> = [] const unproxiedProperties: Array<string> = []
const promise = Promise.resolve(underlyingSearchParams) const promise = makeDevtoolsIOAwarePromise(underlyingSearchParams)
Object.keys(underlyingSearchParams).forEach((prop) => { Object.keys(underlyingSearchParams).forEach((prop) => {
if (wellKnownProperties.has(prop)) { if (wellKnownProperties.has(prop)) {
......
...@@ -1275,7 +1275,7 @@ describe('Cache Components Errors', () => { ...@@ -1275,7 +1275,7 @@ describe('Cache Components Errors', () => {
[ [
{ {
"description": "Route "/sync-cookies-runtime" used \`cookies().get\`. \`cookies()\` should be awaited before using its value. Learn more: https://nextjs.org/docs/messages/sync-dynamic-apis", "description": "Route "/sync-cookies-runtime" used \`cookies().get\`. \`cookies()\` should be awaited before using its value. Learn more: https://nextjs.org/docs/messages/sync-dynamic-apis",
"environmentLabel": "Prerender", "environmentLabel": "Server",
"label": "Console Error", "label": "Console Error",
"source": "app/sync-cookies-runtime/page.tsx (24:25) @ CookiesReadingComponent "source": "app/sync-cookies-runtime/page.tsx (24:25) @ CookiesReadingComponent
> 24 | const token = (cookies() as unknown as UnsafeUnwrappedCookies).get('token') > 24 | const token = (cookies() as unknown as UnsafeUnwrappedCookies).get('token')
...@@ -1287,7 +1287,7 @@ describe('Cache Components Errors', () => { ...@@ -1287,7 +1287,7 @@ describe('Cache Components Errors', () => {
}, },
{ {
"description": "(0 , <turbopack-module-id>.cookies)(...).get is not a function", "description": "(0 , <turbopack-module-id>.cookies)(...).get is not a function",
"environmentLabel": "Prerender", "environmentLabel": "Server",
"label": "Runtime TypeError", "label": "Runtime TypeError",
"source": "app/sync-cookies-runtime/page.tsx (24:66) @ CookiesReadingComponent "source": "app/sync-cookies-runtime/page.tsx (24:66) @ CookiesReadingComponent
> 24 | const token = (cookies() as unknown as UnsafeUnwrappedCookies).get('token') > 24 | const token = (cookies() as unknown as UnsafeUnwrappedCookies).get('token')
...@@ -1303,7 +1303,7 @@ describe('Cache Components Errors', () => { ...@@ -1303,7 +1303,7 @@ describe('Cache Components Errors', () => {
[ [
{ {
"description": "Route "/sync-cookies-runtime" used \`cookies().get\`. \`cookies()\` should be awaited before using its value. Learn more: https://nextjs.org/docs/messages/sync-dynamic-apis", "description": "Route "/sync-cookies-runtime" used \`cookies().get\`. \`cookies()\` should be awaited before using its value. Learn more: https://nextjs.org/docs/messages/sync-dynamic-apis",
"environmentLabel": "Prerender", "environmentLabel": "Server",
"label": "Console Error", "label": "Console Error",
"source": "app/sync-cookies-runtime/page.tsx (24:17) @ CookiesReadingComponent "source": "app/sync-cookies-runtime/page.tsx (24:17) @ CookiesReadingComponent
> 24 | const token = (cookies() as unknown as UnsafeUnwrappedCookies).get('token') > 24 | const token = (cookies() as unknown as UnsafeUnwrappedCookies).get('token')
...@@ -1315,7 +1315,7 @@ describe('Cache Components Errors', () => { ...@@ -1315,7 +1315,7 @@ describe('Cache Components Errors', () => {
}, },
{ {
"description": "(0 , <webpack-module-id>.cookies)(...).get is not a function", "description": "(0 , <webpack-module-id>.cookies)(...).get is not a function",
"environmentLabel": "Prerender", "environmentLabel": "Server",
"label": "Runtime TypeError", "label": "Runtime TypeError",
"source": "app/sync-cookies-runtime/page.tsx (24:66) @ CookiesReadingComponent "source": "app/sync-cookies-runtime/page.tsx (24:66) @ CookiesReadingComponent
> 24 | const token = (cookies() as unknown as UnsafeUnwrappedCookies).get('token') > 24 | const token = (cookies() as unknown as UnsafeUnwrappedCookies).get('token')
...@@ -1592,7 +1592,7 @@ describe('Cache Components Errors', () => { ...@@ -1592,7 +1592,7 @@ describe('Cache Components Errors', () => {
[ [
{ {
"description": "Route "/sync-headers-runtime" used \`headers().get\`. \`headers()\` should be awaited before using its value. Learn more: https://nextjs.org/docs/messages/sync-dynamic-apis", "description": "Route "/sync-headers-runtime" used \`headers().get\`. \`headers()\` should be awaited before using its value. Learn more: https://nextjs.org/docs/messages/sync-dynamic-apis",
"environmentLabel": "Prerender", "environmentLabel": "Server",
"label": "Console Error", "label": "Console Error",
"source": "app/sync-headers-runtime/page.tsx (24:29) @ HeadersReadingComponent "source": "app/sync-headers-runtime/page.tsx (24:29) @ HeadersReadingComponent
> 24 | const userAgent = (headers() as unknown as UnsafeUnwrappedHeaders).get( > 24 | const userAgent = (headers() as unknown as UnsafeUnwrappedHeaders).get(
...@@ -1604,7 +1604,7 @@ describe('Cache Components Errors', () => { ...@@ -1604,7 +1604,7 @@ describe('Cache Components Errors', () => {
}, },
{ {
"description": "(0 , <turbopack-module-id>.headers)(...).get is not a function", "description": "(0 , <turbopack-module-id>.headers)(...).get is not a function",
"environmentLabel": "Prerender", "environmentLabel": "Server",
"label": "Runtime TypeError", "label": "Runtime TypeError",
"source": "app/sync-headers-runtime/page.tsx (24:70) @ HeadersReadingComponent "source": "app/sync-headers-runtime/page.tsx (24:70) @ HeadersReadingComponent
> 24 | const userAgent = (headers() as unknown as UnsafeUnwrappedHeaders).get( > 24 | const userAgent = (headers() as unknown as UnsafeUnwrappedHeaders).get(
...@@ -1620,7 +1620,7 @@ describe('Cache Components Errors', () => { ...@@ -1620,7 +1620,7 @@ describe('Cache Components Errors', () => {
[ [
{ {
"description": "Route "/sync-headers-runtime" used \`headers().get\`. \`headers()\` should be awaited before using its value. Learn more: https://nextjs.org/docs/messages/sync-dynamic-apis", "description": "Route "/sync-headers-runtime" used \`headers().get\`. \`headers()\` should be awaited before using its value. Learn more: https://nextjs.org/docs/messages/sync-dynamic-apis",
"environmentLabel": "Prerender", "environmentLabel": "Server",
"label": "Console Error", "label": "Console Error",
"source": "app/sync-headers-runtime/page.tsx (24:21) @ HeadersReadingComponent "source": "app/sync-headers-runtime/page.tsx (24:21) @ HeadersReadingComponent
> 24 | const userAgent = (headers() as unknown as UnsafeUnwrappedHeaders).get( > 24 | const userAgent = (headers() as unknown as UnsafeUnwrappedHeaders).get(
...@@ -1632,7 +1632,7 @@ describe('Cache Components Errors', () => { ...@@ -1632,7 +1632,7 @@ describe('Cache Components Errors', () => {
}, },
{ {
"description": "(0 , <webpack-module-id>.headers)(...).get is not a function", "description": "(0 , <webpack-module-id>.headers)(...).get is not a function",
"environmentLabel": "Prerender", "environmentLabel": "Server",
"label": "Runtime TypeError", "label": "Runtime TypeError",
"source": "app/sync-headers-runtime/page.tsx (24:70) @ HeadersReadingComponent "source": "app/sync-headers-runtime/page.tsx (24:70) @ HeadersReadingComponent
> 24 | const userAgent = (headers() as unknown as UnsafeUnwrappedHeaders).get( > 24 | const userAgent = (headers() as unknown as UnsafeUnwrappedHeaders).get(
......
...@@ -624,7 +624,7 @@ describe('opentelemetry', () => { ...@@ -624,7 +624,7 @@ describe('opentelemetry', () => {
}, },
{ {
attributes: { attributes: {
'next.clientComponentLoadCount': isNextDev ? 9 : 8, 'next.clientComponentLoadCount': isNextDev ? 11 : 8,
'next.span_type': 'next.span_type':
'NextNodeServer.clientComponentLoading', 'NextNodeServer.clientComponentLoading',
}, },
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment