Unverified Commit 071a0592 authored by Josh Story's avatar Josh Story Committed by GitHub

Refactor: scope requestStore to dynamic renders only (#72312)

This completes the refactor to eliminate a requestStore scoped around
prerenders. Now we only scope requestStore around dynamic renders. If
you are prerendering then the workUnitAsyncStorage will only have a
prerneder store or undefined. While it is possible to shadow stores
because you can enter a cache scope from a render or prerender it
generally should never be the case that you enter a prerender from a
request or enter a request from a prerender. These are effectively top
level scopes.

This should not change any program behavior

stacked on #72212
parent 719a187f
...@@ -45,6 +45,7 @@ import { isNodeNextRequest, isWebNextRequest } from '../base-http/helpers' ...@@ -45,6 +45,7 @@ import { isNodeNextRequest, isWebNextRequest } from '../base-http/helpers'
import { RedirectStatusCode } from '../../client/components/redirect-status-code' import { RedirectStatusCode } from '../../client/components/redirect-status-code'
import { synchronizeMutableCookies } from '../async-storage/request-store' import { synchronizeMutableCookies } from '../async-storage/request-store'
import type { TemporaryReferenceSet } from 'react-server-dom-webpack/server.edge' import type { TemporaryReferenceSet } from 'react-server-dom-webpack/server.edge'
import { workUnitAsyncStorage } from '../app-render/work-unit-async-storage.external'
function formDataFromSearchQueryString(query: string) { function formDataFromSearchQueryString(query: string) {
const searchParams = new URLSearchParams(query) const searchParams = new URLSearchParams(query)
...@@ -561,7 +562,7 @@ export async function handleAction({ ...@@ -561,7 +562,7 @@ export async function handleAction({
return { return {
type: 'done', type: 'done',
result: await finalizeAndGenerateFlight(req, ctx, { result: await finalizeAndGenerateFlight(req, ctx, requestStore, {
actionResult: promise, actionResult: promise,
// if the page was not revalidated, we can skip the rendering the flight tree // if the page was not revalidated, we can skip the rendering the flight tree
skipFlight: !workStore.pathWasRevalidated, skipFlight: !workStore.pathWasRevalidated,
...@@ -878,7 +879,9 @@ export async function handleAction({ ...@@ -878,7 +879,9 @@ export async function handleAction({
actionId! actionId!
] ]
const returnVal = await actionHandler.apply(null, boundActionArguments) const returnVal = await workUnitAsyncStorage.run(requestStore, () =>
actionHandler.apply(null, boundActionArguments)
)
// For form actions, we need to continue rendering the page. // For form actions, we need to continue rendering the page.
if (isFetchAction) { if (isFetchAction) {
...@@ -887,7 +890,7 @@ export async function handleAction({ ...@@ -887,7 +890,7 @@ export async function handleAction({
requestStore, requestStore,
}) })
actionResult = await finalizeAndGenerateFlight(req, ctx, { actionResult = await finalizeAndGenerateFlight(req, ctx, requestStore, {
actionResult: Promise.resolve(returnVal), actionResult: Promise.resolve(returnVal),
// if the page was not revalidated, or if the action was forwarded from another worker, we can skip the rendering the flight tree // if the page was not revalidated, or if the action was forwarded from another worker, we can skip the rendering the flight tree
skipFlight: !workStore.pathWasRevalidated || actionWasForwarded, skipFlight: !workStore.pathWasRevalidated || actionWasForwarded,
...@@ -963,7 +966,7 @@ export async function handleAction({ ...@@ -963,7 +966,7 @@ export async function handleAction({
} }
return { return {
type: 'done', type: 'done',
result: await finalizeAndGenerateFlight(req, ctx, { result: await finalizeAndGenerateFlight(req, ctx, requestStore, {
skipFlight: false, skipFlight: false,
actionResult: promise, actionResult: promise,
temporaryReferences, temporaryReferences,
...@@ -998,7 +1001,7 @@ export async function handleAction({ ...@@ -998,7 +1001,7 @@ export async function handleAction({
requestStore.phase = 'render' requestStore.phase = 'render'
return { return {
type: 'done', type: 'done',
result: await generateFlight(req, ctx, { result: await generateFlight(req, ctx, requestStore, {
actionResult: promise, actionResult: promise,
// if the page was not revalidated, or if the action was forwarded from another worker, we can skip the rendering the flight tree // if the page was not revalidated, or if the action was forwarded from another worker, we can skip the rendering the flight tree
skipFlight: !workStore.pathWasRevalidated || actionWasForwarded, skipFlight: !workStore.pathWasRevalidated || actionWasForwarded,
......
...@@ -509,6 +509,7 @@ function createErrorContext( ...@@ -509,6 +509,7 @@ function createErrorContext(
async function generateDynamicFlightRenderResult( async function generateDynamicFlightRenderResult(
req: BaseNextRequest, req: BaseNextRequest,
ctx: AppRenderContext, ctx: AppRenderContext,
requestStore: RequestStore,
options?: { options?: {
actionResult: ActionResult actionResult: ActionResult
skipFlight: boolean skipFlight: boolean
...@@ -534,7 +535,12 @@ async function generateDynamicFlightRenderResult( ...@@ -534,7 +535,12 @@ async function generateDynamicFlightRenderResult(
const RSCPayload: RSCPayload & { const RSCPayload: RSCPayload & {
/** Only available during dynamicIO development builds. Used for logging errors. */ /** Only available during dynamicIO development builds. Used for logging errors. */
_validation?: Promise<React.ReactNode> _validation?: Promise<React.ReactNode>
} = await generateDynamicRSCPayload(ctx, options) } = await workUnitAsyncStorage.run(
requestStore,
generateDynamicRSCPayload,
ctx,
options
)
if ( if (
// We only want this behavior when running `next dev` // We only want this behavior when running `next dev`
...@@ -559,7 +565,9 @@ async function generateDynamicFlightRenderResult( ...@@ -559,7 +565,9 @@ async function generateDynamicFlightRenderResult(
// For app dir, use the bundled version of Flight server renderer (renderToReadableStream) // For app dir, use the bundled version of Flight server renderer (renderToReadableStream)
// which contains the subset React. // which contains the subset React.
const flightReadableStream = ctx.componentMod.renderToReadableStream( const flightReadableStream = workUnitAsyncStorage.run(
requestStore,
ctx.componentMod.renderToReadableStream,
RSCPayload, RSCPayload,
ctx.clientReferenceManifest.clientModules, ctx.clientReferenceManifest.clientModules,
{ {
...@@ -583,13 +591,7 @@ async function generateDynamicFlightRenderResult( ...@@ -583,13 +591,7 @@ async function generateDynamicFlightRenderResult(
async function warmupDevRender( async function warmupDevRender(
req: BaseNextRequest, req: BaseNextRequest,
ctx: AppRenderContext, ctx: AppRenderContext,
requestStore: RequestStore, requestStore: RequestStore
options?: {
actionResult: ActionResult
skipFlight: boolean
componentTree?: CacheNodeSeedData
preloadCallbacks?: PreloadCallbacks
}
): Promise<RenderResult> { ): Promise<RenderResult> {
const renderOpts = ctx.renderOpts const renderOpts = ctx.renderOpts
if (!renderOpts.dev) { if (!renderOpts.dev) {
...@@ -622,8 +624,7 @@ async function warmupDevRender( ...@@ -622,8 +624,7 @@ async function warmupDevRender(
const rscPayload = await workUnitAsyncStorage.run( const rscPayload = await workUnitAsyncStorage.run(
requestStore, requestStore,
generateDynamicRSCPayload, generateDynamicRSCPayload,
ctx, ctx
options
) )
// For app dir, use the bundled version of Flight server renderer (renderToReadableStream) // For app dir, use the bundled version of Flight server renderer (renderToReadableStream)
...@@ -989,12 +990,12 @@ async function renderToHTMLOrFlightImpl( ...@@ -989,12 +990,12 @@ async function renderToHTMLOrFlightImpl(
pagePath: string, pagePath: string,
query: NextParsedUrlQuery, query: NextParsedUrlQuery,
renderOpts: RenderOpts, renderOpts: RenderOpts,
requestStore: RequestStore,
workStore: WorkStore, workStore: WorkStore,
parsedRequestHeaders: ParsedRequestHeaders, parsedRequestHeaders: ParsedRequestHeaders,
requestEndedState: { ended?: boolean }, requestEndedState: { ended?: boolean },
postponedState: PostponedState | null, postponedState: PostponedState | null,
implicitTags: Array<string> implicitTags: Array<string>,
serverComponentsHmrCache: ServerComponentsHmrCache | undefined
) { ) {
const isNotFoundPath = pagePath === '/404' const isNotFoundPath = pagePath === '/404'
if (isNotFoundPath) { if (isNotFoundPath) {
...@@ -1047,26 +1048,6 @@ async function renderToHTMLOrFlightImpl( ...@@ -1047,26 +1048,6 @@ async function renderToHTMLOrFlightImpl(
isNodeNextRequest(req) isNodeNextRequest(req)
) { ) {
req.originalRequest.on('end', () => { req.originalRequest.on('end', () => {
const prerenderStore = workUnitAsyncStorage.getStore()
const isPPR =
prerenderStore &&
(prerenderStore.type === 'prerender' ||
prerenderStore.type === 'prerender-ppr')
? !!prerenderStore.dynamicTracking?.dynamicAccesses?.length
: false
if (
process.env.NODE_ENV === 'development' &&
renderOpts.setAppIsrStatus &&
!isPPR &&
!requestStore.usedDynamic &&
!workStore.forceDynamic
) {
// only node can be ISR so we only need to update the status here
const { pathname } = new URL(req.url || '/', 'http://n')
renderOpts.setAppIsrStatus(pathname, true)
}
requestEndedState.ended = true requestEndedState.ended = true
if ('performance' in globalThis) { if ('performance' in globalThis) {
...@@ -1130,6 +1111,7 @@ async function renderToHTMLOrFlightImpl( ...@@ -1130,6 +1111,7 @@ async function renderToHTMLOrFlightImpl(
isPrefetchRequest, isPrefetchRequest,
isRSCRequest, isRSCRequest,
isDevWarmupRequest, isDevWarmupRequest,
isHmrRefresh,
nonce, nonce,
} = parsedRequestHeaders } = parsedRequestHeaders
...@@ -1287,10 +1269,44 @@ async function renderToHTMLOrFlightImpl( ...@@ -1287,10 +1269,44 @@ async function renderToHTMLOrFlightImpl(
return new RenderResult(await streamToString(response.stream), options) return new RenderResult(await streamToString(response.stream), options)
} else { } else {
// We're rendering dynamically // We're rendering dynamically
const renderResumeDataCache =
renderOpts.devWarmupRenderResumeDataCache ??
postponedState?.renderResumeDataCache
const requestStore = createRequestStoreForRender(
req,
res,
url,
implicitTags,
renderOpts.onUpdateCookies,
renderOpts.previewProps,
isHmrRefresh,
serverComponentsHmrCache,
renderResumeDataCache
)
if (
process.env.NODE_ENV === 'development' &&
renderOpts.setAppIsrStatus &&
// The type check here ensures that `req` is correctly typed, and the
// environment variable check provides dead code elimination.
process.env.NEXT_RUNTIME !== 'edge' &&
isNodeNextRequest(req)
) {
const setAppIsrStatus = renderOpts.setAppIsrStatus
req.originalRequest.on('end', () => {
if (!requestStore.usedDynamic && !workStore.forceDynamic) {
// only node can be ISR so we only need to update the status here
const { pathname } = new URL(req.url || '/', 'http://n')
setAppIsrStatus(pathname, true)
}
})
}
if (isDevWarmupRequest) { if (isDevWarmupRequest) {
return warmupDevRender(req, ctx, requestStore) return warmupDevRender(req, ctx, requestStore)
} else if (isRSCRequest) { } else if (isRSCRequest) {
return generateDynamicFlightRenderResult(req, ctx) return generateDynamicFlightRenderResult(req, ctx, requestStore)
} }
const renderToStreamWithTracing = getTracer().wrap( const renderToStreamWithTracing = getTracer().wrap(
...@@ -1415,7 +1431,7 @@ export const renderToHTMLOrFlight: AppPageRender = ( ...@@ -1415,7 +1431,7 @@ export const renderToHTMLOrFlight: AppPageRender = (
isRoutePPREnabled: renderOpts.experimental.isRoutePPREnabled === true, isRoutePPREnabled: renderOpts.experimental.isRoutePPREnabled === true,
}) })
const { isHmrRefresh, isPrefetchRequest } = parsedRequestHeaders const { isPrefetchRequest } = parsedRequestHeaders
const requestEndedState = { ended: false } const requestEndedState = { ended: false }
let postponedState: PostponedState | null = null let postponedState: PostponedState | null = null
...@@ -1444,32 +1460,12 @@ export const renderToHTMLOrFlight: AppPageRender = ( ...@@ -1444,32 +1460,12 @@ export const renderToHTMLOrFlight: AppPageRender = (
) )
} }
const renderResumeDataCache =
renderOpts.devWarmupRenderResumeDataCache ??
postponedState?.renderResumeDataCache
const implicitTags = getImplicitTags( const implicitTags = getImplicitTags(
renderOpts.routeModule.definition.page, renderOpts.routeModule.definition.page,
url, url,
fallbackRouteParams fallbackRouteParams
) )
// TODO: We need to refactor this so that prerenders do not rely upon the
// existence of an outer scoped request store. Then we should move this
// store generation inside the appropriate scope like `renderToStream` where
// we know we're handling a Request and not a Prerender
const requestStore = createRequestStoreForRender(
req,
res,
url,
implicitTags,
renderOpts.onUpdateCookies,
renderResumeDataCache,
renderOpts.previewProps,
isHmrRefresh,
serverComponentsHmrCache
)
const workStore = createWorkStore({ const workStore = createWorkStore({
page: renderOpts.routeModule.definition.page, page: renderOpts.routeModule.definition.page,
fallbackRouteParams, fallbackRouteParams,
...@@ -1479,24 +1475,24 @@ export const renderToHTMLOrFlight: AppPageRender = ( ...@@ -1479,24 +1475,24 @@ export const renderToHTMLOrFlight: AppPageRender = (
isPrefetchRequest, isPrefetchRequest,
}) })
return workAsyncStorage.run(workStore, () => { return workAsyncStorage.run(
return workUnitAsyncStorage.run(requestStore, () => { workStore,
return renderToHTMLOrFlightImpl( // The function to run
req, renderToHTMLOrFlightImpl,
res, // all of it's args
url, req,
pagePath, res,
query, url,
renderOpts, pagePath,
requestStore, query,
workStore, renderOpts,
parsedRequestHeaders, workStore,
requestEndedState, parsedRequestHeaders,
postponedState, requestEndedState,
implicitTags postponedState,
) implicitTags,
}) serverComponentsHmrCache
}) )
} }
async function renderToStream( async function renderToStream(
......
...@@ -108,10 +108,10 @@ export function createRequestStoreForRender( ...@@ -108,10 +108,10 @@ export function createRequestStoreForRender(
url: RequestContext['url'], url: RequestContext['url'],
implicitTags: RequestContext['implicitTags'], implicitTags: RequestContext['implicitTags'],
onUpdateCookies: RenderOpts['onUpdateCookies'], onUpdateCookies: RenderOpts['onUpdateCookies'],
renderResumeDataCache: RenderResumeDataCache | undefined,
previewProps: WrapperRenderOpts['previewProps'], previewProps: WrapperRenderOpts['previewProps'],
isHmrRefresh: RequestContext['isHmrRefresh'], isHmrRefresh: RequestContext['isHmrRefresh'],
serverComponentsHmrCache: RequestContext['serverComponentsHmrCache'] serverComponentsHmrCache: RequestContext['serverComponentsHmrCache'],
renderResumeDataCache: RenderResumeDataCache | undefined
): RequestStore { ): RequestStore {
return createRequestStoreImpl( return createRequestStoreImpl(
// Pages start in render phase by default // Pages start in render phase by default
......
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