Download next.js/packages/next/src/server/app-render/app-render.tsx from Devendra174/react-code-dataset: direct link, hf CLI and curl.
- Browser
- Download file 145 kB
-
https://huggingface.co/datasets/Devendra174/react-code-dataset/resolve/main/next.js/packages/next/src/server/app-render/app-render.tsx
- Command line
-
hf download hf://datasets/Devendra174/react-code-dataset/next.js/packages/next/src/server/app-render/app-render.tsx
-
curl -L -o app-render.tsx https://huggingface.co/datasets/Devendra174/react-code-dataset/resolve/main/next.js/packages/next/src/server/app-render/app-render.tsx
145 kB
| import type { | |
| ActionResult, | |
| DynamicParamTypesShort, | |
| FlightRouterState, | |
| RenderOpts, | |
| Segment, | |
| CacheNodeSeedData, | |
| PreloadCallbacks, | |
| RSCPayload, | |
| FlightData, | |
| InitialRSCPayload, | |
| FlightDataPath, | |
| } from './types' | |
| import { | |
| workAsyncStorage, | |
| type WorkStore, | |
| } from '../app-render/work-async-storage.external' | |
| import type { RequestStore } from '../app-render/work-unit-async-storage.external' | |
| import type { NextParsedUrlQuery } from '../request-meta' | |
| import type { LoaderTree } from '../lib/app-dir-module' | |
| import type { AppPageModule } from '../route-modules/app-page/module' | |
| import type { | |
| ClientReferenceManifest, | |
| ManifestNode, | |
| } from '../../build/webpack/plugins/flight-manifest-plugin' | |
| import type { DeepReadonly } from '../../shared/lib/deep-readonly' | |
| import type { BaseNextRequest, BaseNextResponse } from '../base-http' | |
| import type { IncomingHttpHeaders } from 'http' | |
| import React, { type ErrorInfo, type JSX } from 'react' | |
| import RenderResult, { | |
| type AppPageRenderResultMetadata, | |
| type RenderResultOptions, | |
| } from '../render-result' | |
| import { | |
| chainStreams, | |
| renderToInitialFizzStream, | |
| createDocumentClosingStream, | |
| continueFizzStream, | |
| continueDynamicPrerender, | |
| continueStaticPrerender, | |
| continueDynamicHTMLResume, | |
| streamToBuffer, | |
| streamToString, | |
| } from '../stream-utils/node-web-streams-helper' | |
| import { stripInternalQueries } from '../internal-utils' | |
| import { | |
| NEXT_HMR_REFRESH_HEADER, | |
| NEXT_ROUTER_PREFETCH_HEADER, | |
| NEXT_ROUTER_STATE_TREE_HEADER, | |
| NEXT_ROUTER_STALE_TIME_HEADER, | |
| NEXT_URL, | |
| RSC_HEADER, | |
| NEXT_ROUTER_SEGMENT_PREFETCH_HEADER, | |
| NEXT_HMR_REFRESH_HASH_COOKIE, | |
| } from '../../client/components/app-router-headers' | |
| import { createMetadataContext } from '../../lib/metadata/metadata-context' | |
| import { createRequestStoreForRender } from '../async-storage/request-store' | |
| import { createWorkStore } from '../async-storage/work-store' | |
| import { | |
| getAccessFallbackErrorTypeByStatus, | |
| getAccessFallbackHTTPStatus, | |
| isHTTPAccessFallbackError, | |
| } from '../../client/components/http-access-fallback/http-access-fallback' | |
| import { | |
| getURLFromRedirectError, | |
| getRedirectStatusCodeFromError, | |
| } from '../../client/components/redirect' | |
| import { isRedirectError } from '../../client/components/redirect-error' | |
| import { getImplicitTags, type ImplicitTags } from '../lib/implicit-tags' | |
| import { AppRenderSpan, NextNodeServerSpan } from '../lib/trace/constants' | |
| import { getTracer } from '../lib/trace/tracer' | |
| import { FlightRenderResult } from './flight-render-result' | |
| import { | |
| createFlightReactServerErrorHandler, | |
| createHTMLReactServerErrorHandler, | |
| createHTMLErrorHandler, | |
| type DigestedError, | |
| isUserLandError, | |
| getDigestForWellKnownError, | |
| } from './create-error-handler' | |
| import { | |
| getShortDynamicParamType, | |
| dynamicParamTypes, | |
| } from './get-short-dynamic-param-type' | |
| import { getSegmentParam } from './get-segment-param' | |
| import { getScriptNonceFromHeader } from './get-script-nonce-from-header' | |
| import { parseAndValidateFlightRouterState } from './parse-and-validate-flight-router-state' | |
| import { createFlightRouterStateFromLoaderTree } from './create-flight-router-state-from-loader-tree' | |
| import { handleAction } from './action-handler' | |
| import { isBailoutToCSRError } from '../../shared/lib/lazy-dynamic/bailout-to-csr' | |
| import { warn, error } from '../../build/output/log' | |
| import { appendMutableCookies } from '../web/spec-extension/adapters/request-cookies' | |
| import { createServerInsertedHTML } from './server-inserted-html' | |
| import { getRequiredScripts } from './required-scripts' | |
| import { addPathPrefix } from '../../shared/lib/router/utils/add-path-prefix' | |
| import { makeGetServerInsertedHTML } from './make-get-server-inserted-html' | |
| import { walkTreeWithFlightRouterState } from './walk-tree-with-flight-router-state' | |
| import { createComponentTree, getRootParams } from './create-component-tree' | |
| import { getAssetQueryString } from './get-asset-query-string' | |
| import { | |
| getServerModuleMap, | |
| setReferenceManifestsSingleton, | |
| } from './encryption-utils' | |
| import { | |
| DynamicState, | |
| type PostponedState, | |
| parsePostponedState, | |
| } from './postponed-state' | |
| import { | |
| getDynamicDataPostponedState, | |
| getDynamicHTMLPostponedState, | |
| getPostponedFromState, | |
| } from './postponed-state' | |
| import { isDynamicServerError } from '../../client/components/hooks-server-context' | |
| import { | |
| useFlightStream, | |
| createInlinedDataReadableStream, | |
| } from './use-flight-response' | |
| import { | |
| StaticGenBailoutError, | |
| isStaticGenBailoutError, | |
| } from '../../client/components/static-generation-bailout' | |
| import { getStackWithoutErrorMessage } from '../../lib/format-server-error' | |
| import { | |
| accessedDynamicData, | |
| createRenderInBrowserAbortSignal, | |
| formatDynamicAPIAccesses, | |
| isPrerenderInterruptedError, | |
| createDynamicTrackingState, | |
| createDynamicValidationState, | |
| trackAllowedDynamicAccess, | |
| throwIfDisallowedDynamic, | |
| PreludeState, | |
| consumeDynamicAccess, | |
| type DynamicAccess, | |
| logDisallowedDynamicError, | |
| } from './dynamic-rendering' | |
| import { | |
| getClientComponentLoaderMetrics, | |
| wrapClientComponentLoader, | |
| } from '../client-component-renderer-logger' | |
| import { createServerModuleMap } from './action-utils' | |
| import { isNodeNextRequest } from '../base-http/helpers' | |
| import { parseParameter } from '../../shared/lib/router/utils/route-regex' | |
| import { parseRelativeUrl } from '../../shared/lib/router/utils/parse-relative-url' | |
| import AppRouter from '../../client/components/app-router' | |
| import type { ServerComponentsHmrCache } from '../response-cache' | |
| import type { RequestErrorContext } from '../instrumentation/types' | |
| import { getIsPossibleServerAction } from '../lib/server-action-request-meta' | |
| import { createInitialRouterState } from '../../client/components/router-reducer/create-initial-router-state' | |
| import { createMutableActionQueue } from '../../client/components/app-router-instance' | |
| import { getRevalidateReason } from '../instrumentation/utils' | |
| import { PAGE_SEGMENT_KEY } from '../../shared/lib/segment' | |
| import type { FallbackRouteParams } from '../request/fallback-params' | |
| import { processPrelude } from './app-render-prerender-utils' | |
| import { | |
| type ReactServerPrerenderResult, | |
| ReactServerResult, | |
| createReactServerPrerenderResult, | |
| createReactServerPrerenderResultFromRender, | |
| prerenderAndAbortInSequentialTasks, | |
| } from './app-render-prerender-utils' | |
| import { printDebugThrownValueForProspectiveRender } from './prospective-render-utils' | |
| import { scheduleInSequentialTasks } from './app-render-render-utils' | |
| import { waitAtLeastOneReactRenderTask } from '../../lib/scheduler' | |
| import { | |
| workUnitAsyncStorage, | |
| type PrerenderStore, | |
| } from './work-unit-async-storage.external' | |
| import { CacheSignal } from './cache-signal' | |
| import { getTracedMetadata } from '../lib/trace/utils' | |
| import { InvariantError } from '../../shared/lib/invariant-error' | |
| import { HTML_CONTENT_TYPE_HEADER, INFINITE_CACHE } from '../../lib/constants' | |
| import { createComponentStylesAndScripts } from './create-component-styles-and-scripts' | |
| import { parseLoaderTree } from './parse-loader-tree' | |
| import { | |
| createPrerenderResumeDataCache, | |
| createRenderResumeDataCache, | |
| type PrerenderResumeDataCache, | |
| type RenderResumeDataCache, | |
| } from '../resume-data-cache/resume-data-cache' | |
| import type { MetadataErrorType } from '../../lib/metadata/resolve-metadata' | |
| import isError from '../../lib/is-error' | |
| import { createServerInsertedMetadata } from './metadata-insertion/create-server-inserted-metadata' | |
| import { getPreviouslyRevalidatedTags } from '../server-utils' | |
| import { executeRevalidates } from '../revalidation-utils' | |
| import { | |
| trackPendingChunkLoad, | |
| trackPendingImport, | |
| trackPendingModules, | |
| } from './module-loading/track-module-loading.external' | |
| import { isReactLargeShellError } from './react-large-shell-error' | |
| import type { GlobalErrorComponent } from '../../client/components/builtin/global-error' | |
| import { normalizeConventionFilePath } from './segment-explorer-path' | |
| export type GetDynamicParamFromSegment = ( | |
| // [slug] / [[slug]] / [...slug] | |
| segment: string | |
| ) => { | |
| param: string | |
| value: string | string[] | null | |
| treeSegment: Segment | |
| type: DynamicParamTypesShort | |
| } | null | |
| export type GenerateFlight = typeof generateDynamicFlightRenderResult | |
| export type AppSharedContext = { | |
| buildId: string | |
| } | |
| export type AppRenderContext = { | |
| sharedContext: AppSharedContext | |
| workStore: WorkStore | |
| url: ReturnType<typeof parseRelativeUrl> | |
| componentMod: AppPageModule | |
| renderOpts: RenderOpts | |
| parsedRequestHeaders: ParsedRequestHeaders | |
| getDynamicParamFromSegment: GetDynamicParamFromSegment | |
| query: NextParsedUrlQuery | |
| isPrefetch: boolean | |
| isPossibleServerAction: boolean | |
| requestTimestamp: number | |
| appUsingSizeAdjustment: boolean | |
| flightRouterState?: FlightRouterState | |
| requestId: string | |
| pagePath: string | |
| clientReferenceManifest: DeepReadonly<ClientReferenceManifest> | |
| assetPrefix: string | |
| isNotFoundPath: boolean | |
| nonce: string | undefined | |
| res: BaseNextResponse | |
| /** | |
| * For now, the implicit tags are common for the whole route. If we ever start | |
| * rendering/revalidating segments independently, they need to move to the | |
| * work unit store. | |
| */ | |
| implicitTags: ImplicitTags | |
| } | |
| interface ParseRequestHeadersOptions { | |
| readonly isDevWarmup: undefined | boolean | |
| readonly isRoutePPREnabled: boolean | |
| readonly previewModeId: string | undefined | |
| } | |
| const flightDataPathHeadKey = 'h' | |
| const getFlightViewportKey = (requestId: string) => requestId + 'v' | |
| const getFlightMetadataKey = (requestId: string) => requestId + 'm' | |
| const filterStackFrame = | |
| process.env.NODE_ENV !== 'production' | |
| ? (require('../lib/source-maps') as typeof import('../lib/source-maps')) | |
| .filterStackFrameDEV | |
| : undefined | |
| interface ParsedRequestHeaders { | |
| /** | |
| * Router state provided from the client-side router. Used to handle rendering | |
| * from the common layout down. This value will be undefined if the request is | |
| * not a client-side navigation request, or if the request is a prefetch | |
| * request. | |
| */ | |
| readonly flightRouterState: FlightRouterState | undefined | |
| readonly isPrefetchRequest: boolean | |
| readonly isRouteTreePrefetchRequest: boolean | |
| readonly isDevWarmupRequest: boolean | |
| readonly isHmrRefresh: boolean | |
| readonly isRSCRequest: boolean | |
| readonly nonce: string | undefined | |
| readonly previouslyRevalidatedTags: string[] | |
| } | |
| function parseRequestHeaders( | |
| headers: IncomingHttpHeaders, | |
| options: ParseRequestHeadersOptions | |
| ): ParsedRequestHeaders { | |
| const isDevWarmupRequest = options.isDevWarmup === true | |
| // dev warmup requests are treated as prefetch RSC requests | |
| const isPrefetchRequest = | |
| isDevWarmupRequest || | |
| headers[NEXT_ROUTER_PREFETCH_HEADER.toLowerCase()] !== undefined | |
| const isHmrRefresh = | |
| headers[NEXT_HMR_REFRESH_HEADER.toLowerCase()] !== undefined | |
| // dev warmup requests are treated as prefetch RSC requests | |
| const isRSCRequest = | |
| isDevWarmupRequest || headers[RSC_HEADER.toLowerCase()] !== undefined | |
| const shouldProvideFlightRouterState = | |
| isRSCRequest && (!isPrefetchRequest || !options.isRoutePPREnabled) | |
| const flightRouterState = shouldProvideFlightRouterState | |
| ? parseAndValidateFlightRouterState( | |
| headers[NEXT_ROUTER_STATE_TREE_HEADER.toLowerCase()] | |
| ) | |
| : undefined | |
| // Checks if this is a prefetch of the Route Tree by the Segment Cache | |
| const isRouteTreePrefetchRequest = | |
| headers[NEXT_ROUTER_SEGMENT_PREFETCH_HEADER.toLowerCase()] === '/_tree' | |
| const csp = | |
| headers['content-security-policy'] || | |
| headers['content-security-policy-report-only'] | |
| const nonce = | |
| typeof csp === 'string' ? getScriptNonceFromHeader(csp) : undefined | |
| const previouslyRevalidatedTags = getPreviouslyRevalidatedTags( | |
| headers, | |
| options.previewModeId | |
| ) | |
| return { | |
| flightRouterState, | |
| isPrefetchRequest, | |
| isRouteTreePrefetchRequest, | |
| isHmrRefresh, | |
| isRSCRequest, | |
| isDevWarmupRequest, | |
| nonce, | |
| previouslyRevalidatedTags, | |
| } | |
| } | |
| function createNotFoundLoaderTree(loaderTree: LoaderTree): LoaderTree { | |
| const components = loaderTree[2] | |
| const hasGlobalNotFound = !!components['global-not-found'] | |
| return [ | |
| '', | |
| { | |
| children: [ | |
| PAGE_SEGMENT_KEY, | |
| {}, | |
| { | |
| page: components['global-not-found'] ?? components['not-found'], | |
| }, | |
| ], | |
| }, | |
| // When global-not-found is present, skip layout from components | |
| hasGlobalNotFound ? components : {}, | |
| ] | |
| } | |
| /** | |
| * Returns a function that parses the dynamic segment and return the associated value. | |
| */ | |
| function makeGetDynamicParamFromSegment( | |
| params: { [key: string]: any }, | |
| pagePath: string, | |
| fallbackRouteParams: FallbackRouteParams | null | |
| ): GetDynamicParamFromSegment { | |
| return function getDynamicParamFromSegment( | |
| // [slug] / [[slug]] / [...slug] | |
| segment: string | |
| ) { | |
| const segmentParam = getSegmentParam(segment) | |
| if (!segmentParam) { | |
| return null | |
| } | |
| const key = segmentParam.param | |
| let value = params[key] | |
| if (fallbackRouteParams && fallbackRouteParams.has(segmentParam.param)) { | |
| value = fallbackRouteParams.get(segmentParam.param) | |
| } else if (Array.isArray(value)) { | |
| value = value.map((i) => encodeURIComponent(i)) | |
| } else if (typeof value === 'string') { | |
| value = encodeURIComponent(value) | |
| } | |
| if (!value) { | |
| const isCatchall = segmentParam.type === 'catchall' | |
| const isOptionalCatchall = segmentParam.type === 'optional-catchall' | |
| if (isCatchall || isOptionalCatchall) { | |
| const dynamicParamType = dynamicParamTypes[segmentParam.type] | |
| // handle the case where an optional catchall does not have a value, | |
| // e.g. `/dashboard/[[...slug]]` when requesting `/dashboard` | |
| if (isOptionalCatchall) { | |
| return { | |
| param: key, | |
| value: null, | |
| type: dynamicParamType, | |
| treeSegment: [key, '', dynamicParamType], | |
| } | |
| } | |
| // handle the case where a catchall or optional catchall does not have a value, | |
| // e.g. `/foo/bar/hello` and `@slot/[...catchall]` or `@slot/[[...catchall]]` is matched | |
| value = pagePath | |
| .split('/') | |
| // remove the first empty string | |
| .slice(1) | |
| // replace any dynamic params with the actual values | |
| .flatMap((pathSegment) => { | |
| const param = parseParameter(pathSegment) | |
| // if the segment matches a param, return the param value | |
| // otherwise, it's a static segment, so just return that | |
| return params[param.key] ?? param.key | |
| }) | |
| return { | |
| param: key, | |
| value, | |
| type: dynamicParamType, | |
| // This value always has to be a string. | |
| treeSegment: [key, value.join('/'), dynamicParamType], | |
| } | |
| } | |
| } | |
| const type = getShortDynamicParamType(segmentParam.type) | |
| return { | |
| param: key, | |
| // The value that is passed to user code. | |
| value: value, | |
| // The value that is rendered in the router tree. | |
| treeSegment: [key, Array.isArray(value) ? value.join('/') : value, type], | |
| type: type, | |
| } | |
| } | |
| } | |
| function NonIndex({ | |
| pagePath, | |
| statusCode, | |
| isPossibleServerAction, | |
| }: { | |
| pagePath: string | |
| statusCode: number | undefined | |
| isPossibleServerAction: boolean | |
| }) { | |
| const is404Page = pagePath === '/404' | |
| const isInvalidStatusCode = typeof statusCode === 'number' && statusCode > 400 | |
| // Only render noindex for page request, skip for server actions | |
| // TODO: is this correct if `isPossibleServerAction` is a false positive? | |
| if (!isPossibleServerAction && (is404Page || isInvalidStatusCode)) { | |
| return <meta name="robots" content="noindex" /> | |
| } | |
| return null | |
| } | |
| /** | |
| * This is used by server actions & client-side navigations to generate RSC data from a client-side request. | |
| * This function is only called on "dynamic" requests (ie, there wasn't already a static response). | |
| * It uses request headers (namely `Next-Router-State-Tree`) to determine where to start rendering. | |
| */ | |
| async function generateDynamicRSCPayload( | |
| ctx: AppRenderContext, | |
| options?: { | |
| actionResult: ActionResult | |
| skipFlight: boolean | |
| } | |
| ): Promise<RSCPayload> { | |
| // Flight data that is going to be passed to the browser. | |
| // Currently a single item array but in the future multiple patches might be combined in a single request. | |
| // We initialize `flightData` to an empty string because the client router knows how to tolerate | |
| // it (treating it as an MPA navigation). The only time this function wouldn't generate flight data | |
| // is for server actions, if the server action handler instructs this function to skip it. When the server | |
| // action reducer sees a falsy value, it'll simply resolve the action with no data. | |
| let flightData: FlightData = '' | |
| const { | |
| componentMod: { | |
| tree: loaderTree, | |
| createMetadataComponents, | |
| MetadataBoundary, | |
| ViewportBoundary, | |
| }, | |
| getDynamicParamFromSegment, | |
| appUsingSizeAdjustment, | |
| query, | |
| requestId, | |
| flightRouterState, | |
| workStore, | |
| url, | |
| } = ctx | |
| const serveStreamingMetadata = !!ctx.renderOpts.serveStreamingMetadata | |
| if (!options?.skipFlight) { | |
| const preloadCallbacks: PreloadCallbacks = [] | |
| const { | |
| ViewportTree, | |
| MetadataTree, | |
| getViewportReady, | |
| getMetadataReady, | |
| StreamingMetadataOutlet, | |
| } = createMetadataComponents({ | |
| tree: loaderTree, | |
| parsedQuery: query, | |
| pathname: url.pathname, | |
| metadataContext: createMetadataContext(ctx.renderOpts), | |
| getDynamicParamFromSegment, | |
| appUsingSizeAdjustment, | |
| workStore, | |
| MetadataBoundary, | |
| ViewportBoundary, | |
| serveStreamingMetadata, | |
| }) | |
| flightData = ( | |
| await walkTreeWithFlightRouterState({ | |
| ctx, | |
| loaderTreeToFilter: loaderTree, | |
| parentParams: {}, | |
| flightRouterState, | |
| // For flight, render metadata inside leaf page | |
| rscHead: ( | |
| <React.Fragment key={flightDataPathHeadKey}> | |
| {/* noindex needs to be blocking */} | |
| <NonIndex | |
| pagePath={ctx.pagePath} | |
| statusCode={ctx.res.statusCode} | |
| isPossibleServerAction={ctx.isPossibleServerAction} | |
| /> | |
| {/* Adding requestId as react key to make metadata remount for each render */} | |
| <ViewportTree key={getFlightViewportKey(requestId)} /> | |
| <MetadataTree key={getFlightMetadataKey(requestId)} /> | |
| </React.Fragment> | |
| ), | |
| injectedCSS: new Set(), | |
| injectedJS: new Set(), | |
| injectedFontPreloadTags: new Set(), | |
| rootLayoutIncluded: false, | |
| getViewportReady, | |
| getMetadataReady, | |
| preloadCallbacks, | |
| StreamingMetadataOutlet, | |
| }) | |
| ).map((path) => path.slice(1)) // remove the '' (root) segment | |
| } | |
| // If we have an action result, then this is a server action response. | |
| // We can rely on this because `ActionResult` will always be a promise, even if | |
| // the result is falsey. | |
| if (options?.actionResult) { | |
| return { | |
| a: options.actionResult, | |
| f: flightData, | |
| b: ctx.sharedContext.buildId, | |
| } | |
| } | |
| // Otherwise, it's a regular RSC response. | |
| return { | |
| b: ctx.sharedContext.buildId, | |
| f: flightData, | |
| S: workStore.isStaticGeneration, | |
| } | |
| } | |
| function createErrorContext( | |
| ctx: AppRenderContext, | |
| renderSource: RequestErrorContext['renderSource'] | |
| ): RequestErrorContext { | |
| return { | |
| routerKind: 'App Router', | |
| routePath: ctx.pagePath, | |
| // TODO: is this correct if `isPossibleServerAction` is a false positive? | |
| routeType: ctx.isPossibleServerAction ? 'action' : 'render', | |
| renderSource, | |
| revalidateReason: getRevalidateReason(ctx.workStore), | |
| } | |
| } | |
| /** | |
| * Produces a RenderResult containing the Flight data for the given request. See | |
| * `generateDynamicRSCPayload` for information on the contents of the render result. | |
| */ | |
| async function generateDynamicFlightRenderResult( | |
| req: BaseNextRequest, | |
| ctx: AppRenderContext, | |
| requestStore: RequestStore, | |
| options?: { | |
| actionResult: ActionResult | |
| skipFlight: boolean | |
| componentTree?: CacheNodeSeedData | |
| preloadCallbacks?: PreloadCallbacks | |
| temporaryReferences?: WeakMap<any, string> | |
| } | |
| ): Promise<RenderResult> { | |
| const renderOpts = ctx.renderOpts | |
| function onFlightDataRenderError(err: DigestedError) { | |
| return renderOpts.onInstrumentationRequestError?.( | |
| err, | |
| req, | |
| createErrorContext(ctx, 'react-server-components-payload') | |
| ) | |
| } | |
| const onError = createFlightReactServerErrorHandler( | |
| !!renderOpts.dev, | |
| onFlightDataRenderError | |
| ) | |
| const RSCPayload: RSCPayload & { | |
| /** Only available during cacheComponents development builds. Used for logging errors. */ | |
| _validation?: Promise<React.ReactNode> | |
| } = await workUnitAsyncStorage.run( | |
| requestStore, | |
| generateDynamicRSCPayload, | |
| ctx, | |
| options | |
| ) | |
| if ( | |
| // We only want this behavior when running `next dev` | |
| renderOpts.dev && | |
| // We only want this behavior when we have React's dev builds available | |
| process.env.NODE_ENV === 'development' && | |
| // We only have a Prerender environment for projects opted into cacheComponents | |
| renderOpts.experimental.cacheComponents | |
| ) { | |
| const [resolveValidation, validationOutlet] = createValidationOutlet() | |
| RSCPayload._validation = validationOutlet | |
| spawnDynamicValidationInDev( | |
| resolveValidation, | |
| ctx.componentMod.tree, | |
| ctx, | |
| false, | |
| ctx.clientReferenceManifest, | |
| requestStore | |
| ) | |
| } | |
| // For app dir, use the bundled version of Flight server renderer (renderToReadableStream) | |
| // which contains the subset React. | |
| const flightReadableStream = workUnitAsyncStorage.run( | |
| requestStore, | |
| ctx.componentMod.renderToReadableStream, | |
| RSCPayload, | |
| ctx.clientReferenceManifest.clientModules, | |
| { | |
| onError, | |
| temporaryReferences: options?.temporaryReferences, | |
| filterStackFrame, | |
| } | |
| ) | |
| return new FlightRenderResult(flightReadableStream, { | |
| fetchMetrics: ctx.workStore.fetchMetrics, | |
| }) | |
| } | |
| /** | |
| * Performs a "warmup" render of the RSC payload for a given route. This function is called by the server | |
| * prior to an actual render request in Dev mode only. It's purpose is to fill caches so the actual render | |
| * can accurately log activity in the right render context (Prerender vs Render). | |
| * | |
| * At the moment this implementation is mostly a fork of generateDynamicFlightRenderResult | |
| */ | |
| async function warmupDevRender( | |
| req: BaseNextRequest, | |
| ctx: AppRenderContext | |
| ): Promise<RenderResult> { | |
| const { | |
| clientReferenceManifest, | |
| componentMod: ComponentMod, | |
| getDynamicParamFromSegment, | |
| implicitTags, | |
| renderOpts, | |
| workStore, | |
| } = ctx | |
| const { | |
| allowEmptyStaticShell = false, | |
| dev, | |
| onInstrumentationRequestError, | |
| } = renderOpts | |
| if (!dev) { | |
| throw new InvariantError( | |
| 'generateDynamicFlightRenderResult should never be called in `next start` mode.' | |
| ) | |
| } | |
| const rootParams = getRootParams( | |
| ComponentMod.tree, | |
| getDynamicParamFromSegment | |
| ) | |
| function onFlightDataRenderError(err: DigestedError) { | |
| return onInstrumentationRequestError?.( | |
| err, | |
| req, | |
| createErrorContext(ctx, 'react-server-components-payload') | |
| ) | |
| } | |
| const onError = createFlightReactServerErrorHandler( | |
| true, | |
| onFlightDataRenderError | |
| ) | |
| // We're doing a dev warmup, so we should create a new resume data cache so | |
| // we can fill it. | |
| const prerenderResumeDataCache = createPrerenderResumeDataCache() | |
| const renderController = new AbortController() | |
| const prerenderController = new AbortController() | |
| const reactController = new AbortController() | |
| const cacheSignal = new CacheSignal() | |
| const prerenderStore: PrerenderStore = { | |
| type: 'prerender', | |
| phase: 'render', | |
| rootParams, | |
| implicitTags, | |
| renderSignal: renderController.signal, | |
| controller: prerenderController, | |
| cacheSignal, | |
| dynamicTracking: null, | |
| allowEmptyStaticShell, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [], | |
| prerenderResumeDataCache, | |
| renderResumeDataCache: null, | |
| hmrRefreshHash: req.cookies[NEXT_HMR_REFRESH_HASH_COOKIE], | |
| captureOwnerStack: ComponentMod.captureOwnerStack, | |
| // warmup is a dev only feature and no fallback params are used in the | |
| // primary render which is static. We only use a prerender store here to | |
| // allow the warmup to halt on Request data APIs and fetches. | |
| fallbackRouteParams: null, | |
| } | |
| const rscPayload = await workUnitAsyncStorage.run( | |
| prerenderStore, | |
| generateDynamicRSCPayload, | |
| ctx | |
| ) | |
| // For app dir, use the bundled version of Flight server renderer (renderToReadableStream) | |
| // which contains the subset React. | |
| workUnitAsyncStorage.run( | |
| prerenderStore, | |
| ComponentMod.renderToReadableStream, | |
| rscPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| filterStackFrame, | |
| onError, | |
| signal: renderController.signal, | |
| } | |
| ) | |
| // Wait for all caches to be finished filling and for async imports to resolve | |
| trackPendingModules(cacheSignal) | |
| await cacheSignal.cacheReady() | |
| // We unset the cache so any late over-run renders aren't able to write into this cache | |
| prerenderStore.prerenderResumeDataCache = null | |
| // Abort the render | |
| reactController.abort() | |
| renderController.abort() | |
| // We don't really want to return a result here but the stack of functions | |
| // that calls into renderToHTML... expects a result. We should refactor this to | |
| // lift the warmup pathway outside of renderToHTML... but for now this suffices | |
| return new FlightRenderResult('', { | |
| fetchMetrics: workStore.fetchMetrics, | |
| renderResumeDataCache: createRenderResumeDataCache( | |
| prerenderResumeDataCache | |
| ), | |
| }) | |
| } | |
| /** | |
| * Crawlers will inadvertently think the canonicalUrl in the RSC payload should be crawled | |
| * when our intention is to just seed the router state with the current URL. | |
| * This function splits up the pathname so that we can later join it on | |
| * when we're ready to consume the path. | |
| */ | |
| function prepareInitialCanonicalUrl(url: RequestStore['url']) { | |
| return (url.pathname + url.search).split('/') | |
| } | |
| // This is the data necessary to render <AppRouter /> when no SSR errors are encountered | |
| async function getRSCPayload( | |
| tree: LoaderTree, | |
| ctx: AppRenderContext, | |
| is404: boolean | |
| ): Promise<InitialRSCPayload & { P: React.ReactNode }> { | |
| const injectedCSS = new Set<string>() | |
| const injectedJS = new Set<string>() | |
| const injectedFontPreloadTags = new Set<string>() | |
| let missingSlots: Set<string> | undefined | |
| // We only track missing parallel slots in development | |
| if (process.env.NODE_ENV === 'development') { | |
| missingSlots = new Set<string>() | |
| } | |
| const { | |
| getDynamicParamFromSegment, | |
| query, | |
| appUsingSizeAdjustment, | |
| componentMod: { | |
| createMetadataComponents, | |
| MetadataBoundary, | |
| ViewportBoundary, | |
| }, | |
| url, | |
| workStore, | |
| } = ctx | |
| const initialTree = createFlightRouterStateFromLoaderTree( | |
| tree, | |
| getDynamicParamFromSegment, | |
| query | |
| ) | |
| const serveStreamingMetadata = !!ctx.renderOpts.serveStreamingMetadata | |
| const hasGlobalNotFound = !!tree[2]['global-not-found'] | |
| const { | |
| ViewportTree, | |
| MetadataTree, | |
| getViewportReady, | |
| getMetadataReady, | |
| StreamingMetadataOutlet, | |
| } = createMetadataComponents({ | |
| tree, | |
| // When it's using global-not-found, metadata errorType is undefined, which will retrieve the | |
| // metadata from the page. | |
| // When it's using not-found, metadata errorType is 'not-found', which will retrieve the | |
| // metadata from the not-found.js boundary. | |
| // TODO: remove this condition and keep it undefined when global-not-found is stabilized. | |
| errorType: is404 && !hasGlobalNotFound ? 'not-found' : undefined, | |
| parsedQuery: query, | |
| pathname: url.pathname, | |
| metadataContext: createMetadataContext(ctx.renderOpts), | |
| getDynamicParamFromSegment, | |
| appUsingSizeAdjustment, | |
| workStore, | |
| MetadataBoundary, | |
| ViewportBoundary, | |
| serveStreamingMetadata, | |
| }) | |
| const preloadCallbacks: PreloadCallbacks = [] | |
| const seedData = await createComponentTree({ | |
| ctx, | |
| loaderTree: tree, | |
| parentParams: {}, | |
| injectedCSS, | |
| injectedJS, | |
| injectedFontPreloadTags, | |
| rootLayoutIncluded: false, | |
| getViewportReady, | |
| getMetadataReady, | |
| missingSlots, | |
| preloadCallbacks, | |
| authInterrupts: ctx.renderOpts.experimental.authInterrupts, | |
| StreamingMetadataOutlet, | |
| }) | |
| // When the `vary` response header is present with `Next-URL`, that means there's a chance | |
| // it could respond differently if there's an interception route. We provide this information | |
| // to `AppRouter` so that it can properly seed the prefetch cache with a prefix, if needed. | |
| const varyHeader = ctx.res.getHeader('vary') | |
| const couldBeIntercepted = | |
| typeof varyHeader === 'string' && varyHeader.includes(NEXT_URL) | |
| const initialHead = ( | |
| <React.Fragment key={flightDataPathHeadKey}> | |
| <NonIndex | |
| pagePath={ctx.pagePath} | |
| statusCode={ctx.res.statusCode} | |
| isPossibleServerAction={ctx.isPossibleServerAction} | |
| /> | |
| <ViewportTree /> | |
| <MetadataTree /> | |
| </React.Fragment> | |
| ) | |
| const { GlobalError, styles: globalErrorStyles } = await getGlobalErrorStyles( | |
| tree, | |
| ctx | |
| ) | |
| // Assume the head we're rendering contains only partial data if PPR is | |
| // enabled and this is a statically generated response. This is used by the | |
| // client Segment Cache after a prefetch to determine if it can skip the | |
| // second request to fill in the dynamic data. | |
| // | |
| // See similar comment in create-component-tree.tsx for more context. | |
| const isPossiblyPartialHead = | |
| workStore.isStaticGeneration && | |
| ctx.renderOpts.experimental.isRoutePPREnabled === true | |
| return { | |
| // See the comment above the `Preloads` component (below) for why this is part of the payload | |
| P: <Preloads preloadCallbacks={preloadCallbacks} />, | |
| b: ctx.sharedContext.buildId, | |
| p: ctx.assetPrefix, | |
| c: prepareInitialCanonicalUrl(url), | |
| i: !!couldBeIntercepted, | |
| f: [ | |
| [ | |
| initialTree, | |
| seedData, | |
| initialHead, | |
| isPossiblyPartialHead, | |
| ] as FlightDataPath, | |
| ], | |
| m: missingSlots, | |
| G: [GlobalError, globalErrorStyles], | |
| s: typeof ctx.renderOpts.postponed === 'string', | |
| S: workStore.isStaticGeneration, | |
| } | |
| } | |
| /** | |
| * Preload calls (such as `ReactDOM.preloadStyle` and `ReactDOM.preloadFont`) need to be called during rendering | |
| * in order to create the appropriate preload tags in the DOM, otherwise they're a no-op. Since we invoke | |
| * renderToReadableStream with a function that returns component props rather than a component itself, we use | |
| * this component to "render " the preload calls. | |
| */ | |
| function Preloads({ preloadCallbacks }: { preloadCallbacks: Function[] }) { | |
| preloadCallbacks.forEach((preloadFn) => preloadFn()) | |
| return null | |
| } | |
| // This is the data necessary to render <AppRouter /> when an error state is triggered | |
| async function getErrorRSCPayload( | |
| tree: LoaderTree, | |
| ctx: AppRenderContext, | |
| ssrError: unknown, | |
| errorType: MetadataErrorType | 'redirect' | undefined | |
| ) { | |
| const { | |
| getDynamicParamFromSegment, | |
| query, | |
| appUsingSizeAdjustment, | |
| componentMod: { | |
| createMetadataComponents, | |
| MetadataBoundary, | |
| ViewportBoundary, | |
| }, | |
| url, | |
| workStore, | |
| } = ctx | |
| const serveStreamingMetadata = !!ctx.renderOpts.serveStreamingMetadata | |
| const { MetadataTree, ViewportTree } = createMetadataComponents({ | |
| tree, | |
| parsedQuery: query, | |
| pathname: url.pathname, | |
| metadataContext: createMetadataContext(ctx.renderOpts), | |
| errorType, | |
| getDynamicParamFromSegment, | |
| appUsingSizeAdjustment, | |
| workStore, | |
| MetadataBoundary, | |
| ViewportBoundary, | |
| serveStreamingMetadata: serveStreamingMetadata, | |
| }) | |
| const initialHead = ( | |
| <React.Fragment key={flightDataPathHeadKey}> | |
| <NonIndex | |
| pagePath={ctx.pagePath} | |
| statusCode={ctx.res.statusCode} | |
| isPossibleServerAction={ctx.isPossibleServerAction} | |
| /> | |
| <ViewportTree /> | |
| {process.env.NODE_ENV === 'development' && ( | |
| <meta name="next-error" content="not-found" /> | |
| )} | |
| <MetadataTree /> | |
| </React.Fragment> | |
| ) | |
| const initialTree = createFlightRouterStateFromLoaderTree( | |
| tree, | |
| getDynamicParamFromSegment, | |
| query | |
| ) | |
| let err: Error | undefined = undefined | |
| if (ssrError) { | |
| err = isError(ssrError) ? ssrError : new Error(ssrError + '') | |
| } | |
| // For metadata notFound error there's no global not found boundary on top | |
| // so we create a not found page with AppRouter | |
| const seedData: CacheNodeSeedData = [ | |
| initialTree[0], | |
| <html id="__next_error__"> | |
| <head></head> | |
| <body> | |
| {process.env.NODE_ENV !== 'production' && err ? ( | |
| <template | |
| data-next-error-message={err.message} | |
| data-next-error-digest={'digest' in err ? err.digest : ''} | |
| data-next-error-stack={err.stack} | |
| /> | |
| ) : null} | |
| </body> | |
| </html>, | |
| {}, | |
| null, | |
| false, | |
| ] | |
| const { GlobalError, styles: globalErrorStyles } = await getGlobalErrorStyles( | |
| tree, | |
| ctx | |
| ) | |
| const isPossiblyPartialHead = | |
| workStore.isStaticGeneration && | |
| ctx.renderOpts.experimental.isRoutePPREnabled === true | |
| return { | |
| b: ctx.sharedContext.buildId, | |
| p: ctx.assetPrefix, | |
| c: prepareInitialCanonicalUrl(url), | |
| m: undefined, | |
| i: false, | |
| f: [ | |
| [ | |
| initialTree, | |
| seedData, | |
| initialHead, | |
| isPossiblyPartialHead, | |
| ] as FlightDataPath, | |
| ], | |
| G: [GlobalError, globalErrorStyles], | |
| s: typeof ctx.renderOpts.postponed === 'string', | |
| S: workStore.isStaticGeneration, | |
| } satisfies InitialRSCPayload | |
| } | |
| function assertClientReferenceManifest( | |
| clientReferenceManifest: RenderOpts['clientReferenceManifest'] | |
| ): asserts clientReferenceManifest is NonNullable< | |
| RenderOpts['clientReferenceManifest'] | |
| > { | |
| if (!clientReferenceManifest) { | |
| throw new InvariantError('Expected clientReferenceManifest to be defined.') | |
| } | |
| } | |
| // This component must run in an SSR context. It will render the RSC root component | |
| function App<T>({ | |
| reactServerStream, | |
| preinitScripts, | |
| clientReferenceManifest, | |
| ServerInsertedHTMLProvider, | |
| gracefullyDegrade, | |
| nonce, | |
| }: { | |
| reactServerStream: BinaryStreamOf<T> | |
| preinitScripts: () => void | |
| clientReferenceManifest: NonNullable<RenderOpts['clientReferenceManifest']> | |
| ServerInsertedHTMLProvider: React.ComponentType<{ children: JSX.Element }> | |
| gracefullyDegrade: boolean | |
| nonce?: string | |
| }): JSX.Element { | |
| preinitScripts() | |
| const response = React.use( | |
| useFlightStream<InitialRSCPayload>( | |
| reactServerStream, | |
| clientReferenceManifest, | |
| nonce | |
| ) | |
| ) | |
| const initialState = createInitialRouterState({ | |
| // This is not used during hydration, so we don't have to pass a | |
| // real timestamp. | |
| navigatedAt: -1, | |
| initialFlightData: response.f, | |
| initialCanonicalUrlParts: response.c, | |
| initialParallelRoutes: new Map(), | |
| // location is not initialized in the SSR render | |
| // it's set to window.location during hydration | |
| location: null, | |
| couldBeIntercepted: response.i, | |
| postponed: response.s, | |
| prerendered: response.S, | |
| }) | |
| const actionQueue = createMutableActionQueue(initialState, null) | |
| const { HeadManagerContext } = | |
| require('../../shared/lib/head-manager-context.shared-runtime') as typeof import('../../shared/lib/head-manager-context.shared-runtime') | |
| return ( | |
| <HeadManagerContext.Provider | |
| value={{ | |
| appDir: true, | |
| nonce, | |
| }} | |
| > | |
| <ServerInsertedHTMLProvider> | |
| <AppRouter | |
| actionQueue={actionQueue} | |
| globalErrorState={response.G} | |
| assetPrefix={response.p} | |
| gracefullyDegrade={gracefullyDegrade} | |
| /> | |
| </ServerInsertedHTMLProvider> | |
| </HeadManagerContext.Provider> | |
| ) | |
| } | |
| // @TODO our error stream should be probably just use the same root component. But it was previously | |
| // different I don't want to figure out if that is meaningful at this time so just keeping the behavior | |
| // consistent for now. | |
| function ErrorApp<T>({ | |
| reactServerStream, | |
| preinitScripts, | |
| clientReferenceManifest, | |
| ServerInsertedHTMLProvider, | |
| gracefullyDegrade, | |
| nonce, | |
| }: { | |
| reactServerStream: BinaryStreamOf<T> | |
| preinitScripts: () => void | |
| clientReferenceManifest: NonNullable<RenderOpts['clientReferenceManifest']> | |
| ServerInsertedHTMLProvider: React.ComponentType<{ children: JSX.Element }> | |
| gracefullyDegrade: boolean | |
| nonce?: string | |
| }): JSX.Element { | |
| preinitScripts() | |
| const response = React.use( | |
| useFlightStream<InitialRSCPayload>( | |
| reactServerStream, | |
| clientReferenceManifest, | |
| nonce | |
| ) | |
| ) | |
| const initialState = createInitialRouterState({ | |
| // This is not used during hydration, so we don't have to pass a | |
| // real timestamp. | |
| navigatedAt: -1, | |
| initialFlightData: response.f, | |
| initialCanonicalUrlParts: response.c, | |
| initialParallelRoutes: new Map(), | |
| // location is not initialized in the SSR render | |
| // it's set to window.location during hydration | |
| location: null, | |
| couldBeIntercepted: response.i, | |
| postponed: response.s, | |
| prerendered: response.S, | |
| }) | |
| const actionQueue = createMutableActionQueue(initialState, null) | |
| return ( | |
| <ServerInsertedHTMLProvider> | |
| <AppRouter | |
| actionQueue={actionQueue} | |
| globalErrorState={response.G} | |
| assetPrefix={response.p} | |
| gracefullyDegrade={gracefullyDegrade} | |
| /> | |
| </ServerInsertedHTMLProvider> | |
| ) | |
| } | |
| // We use a trick with TS Generics to branch streams with a type so we can | |
| // consume the parsed value of a Readable Stream if it was constructed with a | |
| // certain object shape. The generic type is not used directly in the type so it | |
| // requires a disabling of the eslint rule disallowing unused vars | |
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | |
| export type BinaryStreamOf<T> = ReadableStream<Uint8Array> | |
| async function renderToHTMLOrFlightImpl( | |
| req: BaseNextRequest, | |
| res: BaseNextResponse, | |
| url: ReturnType<typeof parseRelativeUrl>, | |
| pagePath: string, | |
| query: NextParsedUrlQuery, | |
| renderOpts: RenderOpts, | |
| workStore: WorkStore, | |
| parsedRequestHeaders: ParsedRequestHeaders, | |
| requestEndedState: { ended?: boolean }, | |
| postponedState: PostponedState | null, | |
| serverComponentsHmrCache: ServerComponentsHmrCache | undefined, | |
| sharedContext: AppSharedContext, | |
| fallbackRouteParams: FallbackRouteParams | null | |
| ) { | |
| const isNotFoundPath = pagePath === '/404' | |
| if (isNotFoundPath) { | |
| res.statusCode = 404 | |
| } | |
| // A unique request timestamp used by development to ensure that it's | |
| // consistent and won't change during this request. This is important to | |
| // avoid that resources can be deduped by React Float if the same resource is | |
| // rendered or preloaded multiple times: `<link href="a.css?v={Date.now()}"/>`. | |
| const requestTimestamp = Date.now() | |
| const { | |
| clientReferenceManifest, | |
| serverActionsManifest, | |
| ComponentMod, | |
| nextFontManifest, | |
| serverActions, | |
| assetPrefix = '', | |
| enableTainting, | |
| } = renderOpts | |
| // We need to expose the bundled `require` API globally for | |
| // react-server-dom-webpack. This is a hack until we find a better way. | |
| if (ComponentMod.__next_app__) { | |
| const instrumented = wrapClientComponentLoader(ComponentMod) | |
| // When we are prerendering if there is a cacheSignal for tracking | |
| // cache reads we track calls to `loadChunk` and `require`. This allows us | |
| // to treat chunk/module loading with similar semantics as cache reads to avoid | |
| // module loading from causing a prerender to abort too early. | |
| const shouldTrackModuleLoading = () => { | |
| if (!renderOpts.experimental.cacheComponents) { | |
| return false | |
| } | |
| if (renderOpts.dev) { | |
| return true | |
| } | |
| const workUnitStore = workUnitAsyncStorage.getStore() | |
| if (!workUnitStore) { | |
| return false | |
| } | |
| switch (workUnitStore.type) { | |
| case 'prerender': | |
| case 'prerender-client': | |
| case 'cache': | |
| case 'private-cache': | |
| return true | |
| case 'prerender-ppr': | |
| case 'prerender-legacy': | |
| case 'request': | |
| case 'unstable-cache': | |
| return false | |
| default: | |
| workUnitStore satisfies never | |
| } | |
| } | |
| const __next_require__: typeof instrumented.require = (...args) => { | |
| const exportsOrPromise = instrumented.require(...args) | |
| if (shouldTrackModuleLoading()) { | |
| // requiring an async module returns a promise. | |
| trackPendingImport(exportsOrPromise) | |
| } | |
| return exportsOrPromise | |
| } | |
| // @ts-expect-error | |
| globalThis.__next_require__ = __next_require__ | |
| const __next_chunk_load__: typeof instrumented.loadChunk = (...args) => { | |
| const loadingChunk = instrumented.loadChunk(...args) | |
| if (shouldTrackModuleLoading()) { | |
| trackPendingChunkLoad(loadingChunk) | |
| } | |
| return loadingChunk | |
| } | |
| // @ts-expect-error | |
| globalThis.__next_chunk_load__ = __next_chunk_load__ | |
| } | |
| if (process.env.NODE_ENV === 'development') { | |
| // reset isr status at start of request | |
| const { pathname } = new URL(req.url || '/', 'http://n') | |
| renderOpts.setIsrStatus?.(pathname, null) | |
| } | |
| if ( | |
| // 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) | |
| ) { | |
| req.originalRequest.on('end', () => { | |
| requestEndedState.ended = true | |
| if ('performance' in globalThis) { | |
| const metrics = getClientComponentLoaderMetrics({ reset: true }) | |
| if (metrics) { | |
| getTracer() | |
| .startSpan(NextNodeServerSpan.clientComponentLoading, { | |
| startTime: metrics.clientComponentLoadStart, | |
| attributes: { | |
| 'next.clientComponentLoadCount': | |
| metrics.clientComponentLoadCount, | |
| 'next.span_type': NextNodeServerSpan.clientComponentLoading, | |
| }, | |
| }) | |
| .end( | |
| metrics.clientComponentLoadStart + | |
| metrics.clientComponentLoadTimes | |
| ) | |
| } | |
| } | |
| }) | |
| } | |
| const metadata: AppPageRenderResultMetadata = { | |
| statusCode: isNotFoundPath ? 404 : undefined, | |
| } | |
| const appUsingSizeAdjustment = !!nextFontManifest?.appUsingSizeAdjust | |
| assertClientReferenceManifest(clientReferenceManifest) | |
| const serverModuleMap = createServerModuleMap({ serverActionsManifest }) | |
| setReferenceManifestsSingleton({ | |
| page: workStore.page, | |
| clientReferenceManifest, | |
| serverActionsManifest, | |
| serverModuleMap, | |
| }) | |
| ComponentMod.patchFetch() | |
| // Pull out the hooks/references from the component. | |
| const { tree: loaderTree, taintObjectReference } = ComponentMod | |
| if (enableTainting) { | |
| taintObjectReference( | |
| 'Do not pass process.env to Client Components since it will leak sensitive data', | |
| process.env | |
| ) | |
| } | |
| workStore.fetchMetrics = [] | |
| metadata.fetchMetrics = workStore.fetchMetrics | |
| // don't modify original query object | |
| query = { ...query } | |
| stripInternalQueries(query) | |
| const { | |
| flightRouterState, | |
| isPrefetchRequest, | |
| isRSCRequest, | |
| isDevWarmupRequest, | |
| isHmrRefresh, | |
| nonce, | |
| } = parsedRequestHeaders | |
| const { isStaticGeneration } = workStore | |
| /** | |
| * The metadata items array created in next-app-loader with all relevant information | |
| * that we need to resolve the final metadata. | |
| */ | |
| let requestId: string | |
| if (isStaticGeneration) { | |
| requestId = Buffer.from( | |
| await crypto.subtle.digest('SHA-1', Buffer.from(req.url)) | |
| ).toString('hex') | |
| } else if (process.env.NEXT_RUNTIME === 'edge') { | |
| requestId = crypto.randomUUID() | |
| } else { | |
| requestId = ( | |
| require('next/dist/compiled/nanoid') as typeof import('next/dist/compiled/nanoid') | |
| ).nanoid() | |
| } | |
| /** | |
| * Dynamic parameters. E.g. when you visit `/dashboard/vercel` which is rendered by `/dashboard/[slug]` the value will be {"slug": "vercel"}. | |
| */ | |
| const params = renderOpts.params ?? {} | |
| const getDynamicParamFromSegment = makeGetDynamicParamFromSegment( | |
| params, | |
| pagePath, | |
| fallbackRouteParams | |
| ) | |
| const isPossibleActionRequest = getIsPossibleServerAction(req) | |
| const implicitTags = await getImplicitTags( | |
| workStore.page, | |
| url, | |
| fallbackRouteParams | |
| ) | |
| const ctx: AppRenderContext = { | |
| componentMod: ComponentMod, | |
| url, | |
| renderOpts, | |
| workStore, | |
| parsedRequestHeaders, | |
| getDynamicParamFromSegment, | |
| query, | |
| isPrefetch: isPrefetchRequest, | |
| isPossibleServerAction: isPossibleActionRequest, | |
| requestTimestamp, | |
| appUsingSizeAdjustment, | |
| flightRouterState, | |
| requestId, | |
| pagePath, | |
| clientReferenceManifest, | |
| assetPrefix, | |
| isNotFoundPath, | |
| nonce, | |
| res, | |
| sharedContext, | |
| implicitTags, | |
| } | |
| getTracer().setRootSpanAttribute('next.route', pagePath) | |
| if (isStaticGeneration) { | |
| // We're either building or revalidating. In either case we need to | |
| // prerender our page rather than render it. | |
| const prerenderToStreamWithTracing = getTracer().wrap( | |
| AppRenderSpan.getBodyResult, | |
| { | |
| spanName: `prerender route (app) ${pagePath}`, | |
| attributes: { | |
| 'next.route': pagePath, | |
| }, | |
| }, | |
| prerenderToStream | |
| ) | |
| const response = await prerenderToStreamWithTracing( | |
| req, | |
| res, | |
| ctx, | |
| metadata, | |
| loaderTree, | |
| fallbackRouteParams | |
| ) | |
| // If we're debugging partial prerendering, print all the dynamic API accesses | |
| // that occurred during the render. | |
| // @TODO move into renderToStream function | |
| if ( | |
| response.dynamicAccess && | |
| accessedDynamicData(response.dynamicAccess) && | |
| renderOpts.isDebugDynamicAccesses | |
| ) { | |
| warn('The following dynamic usage was detected:') | |
| for (const access of formatDynamicAPIAccesses(response.dynamicAccess)) { | |
| warn(access) | |
| } | |
| } | |
| // If we encountered any unexpected errors during build we fail the | |
| // prerendering phase and the build. | |
| if (workStore.invalidDynamicUsageError) { | |
| logDisallowedDynamicError(workStore, workStore.invalidDynamicUsageError) | |
| throw new StaticGenBailoutError() | |
| } | |
| if (response.digestErrorsMap.size) { | |
| const buildFailingError = response.digestErrorsMap.values().next().value | |
| if (buildFailingError) throw buildFailingError | |
| } | |
| // Pick first userland SSR error, which is also not a RSC error. | |
| if (response.ssrErrors.length) { | |
| const buildFailingError = response.ssrErrors.find((err) => | |
| isUserLandError(err) | |
| ) | |
| if (buildFailingError) throw buildFailingError | |
| } | |
| const options: RenderResultOptions = { | |
| metadata, | |
| contentType: HTML_CONTENT_TYPE_HEADER, | |
| } | |
| // If we have pending revalidates, wait until they are all resolved. | |
| if ( | |
| workStore.pendingRevalidates || | |
| workStore.pendingRevalidateWrites || | |
| workStore.pendingRevalidatedTags | |
| ) { | |
| const pendingPromise = executeRevalidates(workStore).finally(() => { | |
| if (process.env.NEXT_PRIVATE_DEBUG_CACHE) { | |
| console.log('pending revalidates promise finished for:', url) | |
| } | |
| }) | |
| if (renderOpts.waitUntil) { | |
| renderOpts.waitUntil(pendingPromise) | |
| } else { | |
| options.waitUntil = pendingPromise | |
| } | |
| } | |
| if (response.collectedTags) { | |
| metadata.fetchTags = response.collectedTags.join(',') | |
| } | |
| // Let the client router know how long to keep the cached entry around. | |
| const staleHeader = String(response.collectedStale) | |
| res.setHeader(NEXT_ROUTER_STALE_TIME_HEADER, staleHeader) | |
| metadata.headers ??= {} | |
| metadata.headers[NEXT_ROUTER_STALE_TIME_HEADER] = staleHeader | |
| // If force static is specifically set to false, we should not revalidate | |
| // the page. | |
| if (workStore.forceStatic === false || response.collectedRevalidate === 0) { | |
| metadata.cacheControl = { revalidate: 0, expire: undefined } | |
| } else { | |
| // Copy the cache control value onto the render result metadata. | |
| metadata.cacheControl = { | |
| revalidate: | |
| response.collectedRevalidate >= INFINITE_CACHE | |
| ? false | |
| : response.collectedRevalidate, | |
| expire: | |
| response.collectedExpire >= INFINITE_CACHE | |
| ? undefined | |
| : response.collectedExpire, | |
| } | |
| } | |
| // provide bailout info for debugging | |
| if (metadata.cacheControl?.revalidate === 0) { | |
| metadata.staticBailoutInfo = { | |
| description: workStore.dynamicUsageDescription, | |
| stack: workStore.dynamicUsageStack, | |
| } | |
| } | |
| if (response.renderResumeDataCache) { | |
| metadata.renderResumeDataCache = response.renderResumeDataCache | |
| } | |
| return new RenderResult(await streamToString(response.stream), options) | |
| } else { | |
| // We're rendering dynamically | |
| const renderResumeDataCache = | |
| renderOpts.renderResumeDataCache ?? postponedState?.renderResumeDataCache | |
| const rootParams = getRootParams(loaderTree, ctx.getDynamicParamFromSegment) | |
| const requestStore = createRequestStoreForRender( | |
| req, | |
| res, | |
| url, | |
| rootParams, | |
| implicitTags, | |
| renderOpts.onUpdateCookies, | |
| renderOpts.previewProps, | |
| isHmrRefresh, | |
| serverComponentsHmrCache, | |
| renderResumeDataCache | |
| ) | |
| if ( | |
| process.env.NODE_ENV === 'development' && | |
| renderOpts.setIsrStatus && | |
| // 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) && | |
| !isDevWarmupRequest | |
| ) { | |
| const setIsrStatus = renderOpts.setIsrStatus | |
| 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') | |
| setIsrStatus(pathname, true) | |
| } | |
| }) | |
| } | |
| if (isDevWarmupRequest) { | |
| return warmupDevRender(req, ctx) | |
| } else if (isRSCRequest) { | |
| return generateDynamicFlightRenderResult(req, ctx, requestStore) | |
| } | |
| const renderToStreamWithTracing = getTracer().wrap( | |
| AppRenderSpan.getBodyResult, | |
| { | |
| spanName: `render route (app) ${pagePath}`, | |
| attributes: { | |
| 'next.route': pagePath, | |
| }, | |
| }, | |
| renderToStream | |
| ) | |
| let formState: null | any = null | |
| if (isPossibleActionRequest) { | |
| // For action requests, we handle them differently with a special render result. | |
| const actionRequestResult = await handleAction({ | |
| req, | |
| res, | |
| ComponentMod, | |
| serverModuleMap, | |
| generateFlight: generateDynamicFlightRenderResult, | |
| workStore, | |
| requestStore, | |
| serverActions, | |
| ctx, | |
| metadata, | |
| }) | |
| if (actionRequestResult) { | |
| if (actionRequestResult.type === 'not-found') { | |
| const notFoundLoaderTree = createNotFoundLoaderTree(loaderTree) | |
| res.statusCode = 404 | |
| metadata.statusCode = 404 | |
| const stream = await renderToStreamWithTracing( | |
| requestStore, | |
| req, | |
| res, | |
| ctx, | |
| notFoundLoaderTree, | |
| formState, | |
| postponedState, | |
| metadata | |
| ) | |
| return new RenderResult(stream, { | |
| metadata, | |
| contentType: HTML_CONTENT_TYPE_HEADER, | |
| }) | |
| } else if (actionRequestResult.type === 'done') { | |
| if (actionRequestResult.result) { | |
| actionRequestResult.result.assignMetadata(metadata) | |
| return actionRequestResult.result | |
| } else if (actionRequestResult.formState) { | |
| formState = actionRequestResult.formState | |
| } | |
| } | |
| } | |
| } | |
| const options: RenderResultOptions = { | |
| metadata, | |
| contentType: HTML_CONTENT_TYPE_HEADER, | |
| } | |
| const stream = await renderToStreamWithTracing( | |
| requestStore, | |
| req, | |
| res, | |
| ctx, | |
| loaderTree, | |
| formState, | |
| postponedState, | |
| metadata | |
| ) | |
| // Invalid dynamic usages should only error the request in development. | |
| // In production, it's better to produce a result. | |
| // (the dynamic error will still be thrown inside the component tree, but it's catchable by error boundaries) | |
| if (workStore.invalidDynamicUsageError && workStore.dev) { | |
| throw workStore.invalidDynamicUsageError | |
| } | |
| // If we have pending revalidates, wait until they are all resolved. | |
| if ( | |
| workStore.pendingRevalidates || | |
| workStore.pendingRevalidateWrites || | |
| workStore.pendingRevalidatedTags | |
| ) { | |
| const pendingPromise = executeRevalidates(workStore).finally(() => { | |
| if (process.env.NEXT_PRIVATE_DEBUG_CACHE) { | |
| console.log('pending revalidates promise finished for:', url) | |
| } | |
| }) | |
| if (renderOpts.waitUntil) { | |
| renderOpts.waitUntil(pendingPromise) | |
| } else { | |
| options.waitUntil = pendingPromise | |
| } | |
| } | |
| // Create the new render result for the response. | |
| return new RenderResult(stream, options) | |
| } | |
| } | |
| export type AppPageRender = ( | |
| req: BaseNextRequest, | |
| res: BaseNextResponse, | |
| pagePath: string, | |
| query: NextParsedUrlQuery, | |
| fallbackRouteParams: FallbackRouteParams | null, | |
| renderOpts: RenderOpts, | |
| serverComponentsHmrCache: ServerComponentsHmrCache | undefined, | |
| isDevWarmup: boolean, | |
| sharedContext: AppSharedContext | |
| ) => Promise<RenderResult<AppPageRenderResultMetadata>> | |
| export const renderToHTMLOrFlight: AppPageRender = ( | |
| req, | |
| res, | |
| pagePath, | |
| query, | |
| fallbackRouteParams, | |
| renderOpts, | |
| serverComponentsHmrCache, | |
| isDevWarmup, | |
| sharedContext | |
| ) => { | |
| if (!req.url) { | |
| throw new Error('Invalid URL') | |
| } | |
| const url = parseRelativeUrl(req.url, undefined, false) | |
| // We read these values from the request object as, in certain cases, | |
| // base-server will strip them to opt into different rendering behavior. | |
| const parsedRequestHeaders = parseRequestHeaders(req.headers, { | |
| isDevWarmup, | |
| isRoutePPREnabled: renderOpts.experimental.isRoutePPREnabled === true, | |
| previewModeId: renderOpts.previewProps?.previewModeId, | |
| }) | |
| const { isPrefetchRequest, previouslyRevalidatedTags } = parsedRequestHeaders | |
| const requestEndedState = { ended: false } | |
| let postponedState: PostponedState | null = null | |
| // If provided, the postpone state should be parsed so it can be provided to | |
| // React. | |
| if (typeof renderOpts.postponed === 'string') { | |
| if (fallbackRouteParams) { | |
| throw new InvariantError( | |
| 'postponed state should not be provided when fallback params are provided' | |
| ) | |
| } | |
| postponedState = parsePostponedState( | |
| renderOpts.postponed, | |
| renderOpts.params | |
| ) | |
| } | |
| if ( | |
| postponedState?.renderResumeDataCache && | |
| renderOpts.renderResumeDataCache | |
| ) { | |
| throw new InvariantError( | |
| 'postponed state and dev warmup immutable resume data cache should not be provided together' | |
| ) | |
| } | |
| const workStore = createWorkStore({ | |
| page: renderOpts.routeModule.definition.page, | |
| renderOpts, | |
| requestEndedState, | |
| // @TODO move to workUnitStore of type Request | |
| isPrefetchRequest, | |
| buildId: sharedContext.buildId, | |
| previouslyRevalidatedTags, | |
| }) | |
| return workAsyncStorage.run( | |
| workStore, | |
| // The function to run | |
| renderToHTMLOrFlightImpl, | |
| // all of it's args | |
| req, | |
| res, | |
| url, | |
| pagePath, | |
| query, | |
| renderOpts, | |
| workStore, | |
| parsedRequestHeaders, | |
| requestEndedState, | |
| postponedState, | |
| serverComponentsHmrCache, | |
| sharedContext, | |
| fallbackRouteParams | |
| ) | |
| } | |
| async function renderToStream( | |
| requestStore: RequestStore, | |
| req: BaseNextRequest, | |
| res: BaseNextResponse, | |
| ctx: AppRenderContext, | |
| tree: LoaderTree, | |
| formState: any, | |
| postponedState: PostponedState | null, | |
| metadata: AppPageRenderResultMetadata | |
| ): Promise<ReadableStream<Uint8Array>> { | |
| const { assetPrefix, nonce, pagePath, renderOpts } = ctx | |
| const { | |
| basePath, | |
| botType, | |
| buildManifest, | |
| clientReferenceManifest, | |
| ComponentMod, | |
| crossOrigin, | |
| dev = false, | |
| experimental, | |
| nextExport = false, | |
| onInstrumentationRequestError, | |
| page, | |
| reactMaxHeadersLength, | |
| shouldWaitOnAllReady, | |
| subresourceIntegrityManifest, | |
| supportsDynamicResponse, | |
| } = renderOpts | |
| assertClientReferenceManifest(clientReferenceManifest) | |
| const { ServerInsertedHTMLProvider, renderServerInsertedHTML } = | |
| createServerInsertedHTML() | |
| const getServerInsertedMetadata = createServerInsertedMetadata(nonce) | |
| const tracingMetadata = getTracedMetadata( | |
| getTracer().getTracePropagationData(), | |
| experimental.clientTraceMetadata | |
| ) | |
| const polyfills: JSX.IntrinsicElements['script'][] = | |
| buildManifest.polyfillFiles | |
| .filter( | |
| (polyfill) => | |
| polyfill.endsWith('.js') && !polyfill.endsWith('.module.js') | |
| ) | |
| .map((polyfill) => ({ | |
| src: `${assetPrefix}/_next/${polyfill}${getAssetQueryString( | |
| ctx, | |
| false | |
| )}`, | |
| integrity: subresourceIntegrityManifest?.[polyfill], | |
| crossOrigin, | |
| noModule: true, | |
| nonce, | |
| })) | |
| const [preinitScripts, bootstrapScript] = getRequiredScripts( | |
| buildManifest, | |
| // Why is assetPrefix optional on renderOpts? | |
| // @TODO make it default empty string on renderOpts and get rid of it from ctx | |
| assetPrefix, | |
| crossOrigin, | |
| subresourceIntegrityManifest, | |
| getAssetQueryString(ctx, true), | |
| nonce, | |
| page | |
| ) | |
| const reactServerErrorsByDigest: Map<string, DigestedError> = new Map() | |
| const silenceLogger = false | |
| function onHTMLRenderRSCError(err: DigestedError) { | |
| return onInstrumentationRequestError?.( | |
| err, | |
| req, | |
| createErrorContext(ctx, 'react-server-components') | |
| ) | |
| } | |
| const serverComponentsErrorHandler = createHTMLReactServerErrorHandler( | |
| dev, | |
| nextExport, | |
| reactServerErrorsByDigest, | |
| silenceLogger, | |
| onHTMLRenderRSCError | |
| ) | |
| function onHTMLRenderSSRError(err: DigestedError) { | |
| return onInstrumentationRequestError?.( | |
| err, | |
| req, | |
| createErrorContext(ctx, 'server-rendering') | |
| ) | |
| } | |
| const allCapturedErrors: Array<unknown> = [] | |
| const htmlRendererErrorHandler = createHTMLErrorHandler( | |
| dev, | |
| nextExport, | |
| reactServerErrorsByDigest, | |
| allCapturedErrors, | |
| silenceLogger, | |
| onHTMLRenderSSRError | |
| ) | |
| let reactServerResult: null | ReactServerResult = null | |
| const setHeader = res.setHeader.bind(res) | |
| const appendHeader = res.appendHeader.bind(res) | |
| try { | |
| if ( | |
| // We only want this behavior when running `next dev` | |
| dev && | |
| // We only want this behavior when we have React's dev builds available | |
| process.env.NODE_ENV === 'development' && | |
| // Edge routes never prerender so we don't have a Prerender environment for anything in edge runtime | |
| process.env.NEXT_RUNTIME !== 'edge' && | |
| // We only have a Prerender environment for projects opted into cacheComponents | |
| experimental.cacheComponents | |
| ) { | |
| // This is a dynamic render. We don't do dynamic tracking because we're not prerendering | |
| const RSCPayload: InitialRSCPayload & { | |
| /** Only available during cacheComponents development builds. Used for logging errors. */ | |
| _validation?: Promise<React.ReactNode> | |
| } = await workUnitAsyncStorage.run( | |
| requestStore, | |
| getRSCPayload, | |
| tree, | |
| ctx, | |
| res.statusCode === 404 | |
| ) | |
| const [resolveValidation, validationOutlet] = createValidationOutlet() | |
| RSCPayload._validation = validationOutlet | |
| const reactServerStream = await workUnitAsyncStorage.run( | |
| requestStore, | |
| scheduleInSequentialTasks, | |
| () => { | |
| requestStore.prerenderPhase = true | |
| return ComponentMod.renderToReadableStream( | |
| RSCPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| onError: serverComponentsErrorHandler, | |
| environmentName: () => | |
| requestStore.prerenderPhase === true ? 'Prerender' : 'Server', | |
| filterStackFrame, | |
| } | |
| ) | |
| }, | |
| () => { | |
| requestStore.prerenderPhase = false | |
| } | |
| ) | |
| spawnDynamicValidationInDev( | |
| resolveValidation, | |
| tree, | |
| ctx, | |
| res.statusCode === 404, | |
| clientReferenceManifest, | |
| requestStore | |
| ) | |
| reactServerResult = new ReactServerResult(reactServerStream) | |
| } else { | |
| // This is a dynamic render. We don't do dynamic tracking because we're not prerendering | |
| const RSCPayload = await workUnitAsyncStorage.run( | |
| requestStore, | |
| getRSCPayload, | |
| tree, | |
| ctx, | |
| res.statusCode === 404 | |
| ) | |
| reactServerResult = new ReactServerResult( | |
| workUnitAsyncStorage.run( | |
| requestStore, | |
| ComponentMod.renderToReadableStream, | |
| RSCPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| filterStackFrame, | |
| onError: serverComponentsErrorHandler, | |
| } | |
| ) | |
| ) | |
| } | |
| // React doesn't start rendering synchronously but we want the RSC render to have a chance to start | |
| // before we begin SSR rendering because we want to capture any available preload headers so we tick | |
| // one task before continuing | |
| await waitAtLeastOneReactRenderTask() | |
| // If provided, the postpone state should be parsed as JSON so it can be | |
| // provided to React. | |
| if (typeof renderOpts.postponed === 'string') { | |
| if (postponedState?.type === DynamicState.DATA) { | |
| // We have a complete HTML Document in the prerender but we need to | |
| // still include the new server component render because it was not included | |
| // in the static prelude. | |
| const inlinedReactServerDataStream = createInlinedDataReadableStream( | |
| reactServerResult.tee(), | |
| nonce, | |
| formState | |
| ) | |
| return chainStreams( | |
| inlinedReactServerDataStream, | |
| createDocumentClosingStream() | |
| ) | |
| } else if (postponedState) { | |
| // We assume we have dynamic HTML requiring a resume render to complete | |
| const postponed = getPostponedFromState(postponedState) | |
| const resume = ( | |
| require('react-dom/server') as typeof import('react-dom/server') | |
| ).resume | |
| const htmlStream = await workUnitAsyncStorage.run( | |
| requestStore, | |
| resume, | |
| <App | |
| reactServerStream={reactServerResult.tee()} | |
| preinitScripts={preinitScripts} | |
| clientReferenceManifest={clientReferenceManifest} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| nonce={nonce} | |
| gracefullyDegrade={!!botType} | |
| />, | |
| postponed, | |
| { onError: htmlRendererErrorHandler, nonce } | |
| ) | |
| const getServerInsertedHTML = makeGetServerInsertedHTML({ | |
| polyfills, | |
| renderServerInsertedHTML, | |
| serverCapturedErrors: allCapturedErrors, | |
| basePath, | |
| tracingMetadata: tracingMetadata, | |
| }) | |
| return await continueDynamicHTMLResume(htmlStream, { | |
| inlinedDataStream: createInlinedDataReadableStream( | |
| reactServerResult.consume(), | |
| nonce, | |
| formState | |
| ), | |
| getServerInsertedHTML, | |
| getServerInsertedMetadata, | |
| }) | |
| } | |
| } | |
| // This is a regular dynamic render | |
| const renderToReadableStream = ( | |
| require('react-dom/server') as typeof import('react-dom/server') | |
| ).renderToReadableStream | |
| const htmlStream = await workUnitAsyncStorage.run( | |
| requestStore, | |
| renderToReadableStream, | |
| <App | |
| reactServerStream={reactServerResult.tee()} | |
| preinitScripts={preinitScripts} | |
| clientReferenceManifest={clientReferenceManifest} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| />, | |
| { | |
| onError: htmlRendererErrorHandler, | |
| nonce, | |
| onHeaders: (headers: Headers) => { | |
| headers.forEach((value, key) => { | |
| appendHeader(key, value) | |
| }) | |
| }, | |
| maxHeadersLength: reactMaxHeadersLength, | |
| bootstrapScripts: [bootstrapScript], | |
| formState, | |
| } | |
| ) | |
| const getServerInsertedHTML = makeGetServerInsertedHTML({ | |
| polyfills, | |
| renderServerInsertedHTML, | |
| serverCapturedErrors: allCapturedErrors, | |
| basePath, | |
| tracingMetadata: tracingMetadata, | |
| }) | |
| /** | |
| * Rules of Static & Dynamic HTML: | |
| * | |
| * 1.) We must generate static HTML unless the caller explicitly opts | |
| * in to dynamic HTML support. | |
| * | |
| * 2.) If dynamic HTML support is requested, we must honor that request | |
| * or throw an error. It is the sole responsibility of the caller to | |
| * ensure they aren't e.g. requesting dynamic HTML for an AMP page. | |
| * | |
| * 3.) If `shouldWaitOnAllReady` is true, which indicates we need to | |
| * resolve all suspenses and generate a full HTML. e.g. when it's a | |
| * html limited bot requests, we produce the full HTML content. | |
| * | |
| * These rules help ensure that other existing features like request caching, | |
| * coalescing, and ISR continue working as intended. | |
| */ | |
| const generateStaticHTML = | |
| supportsDynamicResponse !== true || !!shouldWaitOnAllReady | |
| return await continueFizzStream(htmlStream, { | |
| inlinedDataStream: createInlinedDataReadableStream( | |
| reactServerResult.consume(), | |
| nonce, | |
| formState | |
| ), | |
| isStaticGeneration: generateStaticHTML, | |
| isBuildTimePrerendering: ctx.workStore.isBuildTimePrerendering === true, | |
| buildId: ctx.workStore.buildId, | |
| getServerInsertedHTML, | |
| getServerInsertedMetadata, | |
| validateRootLayout: dev, | |
| }) | |
| } catch (err) { | |
| if ( | |
| isStaticGenBailoutError(err) || | |
| (typeof err === 'object' && | |
| err !== null && | |
| 'message' in err && | |
| typeof err.message === 'string' && | |
| err.message.includes( | |
| 'https://nextjs.org/docs/advanced-features/static-html-export' | |
| )) | |
| ) { | |
| // Ensure that "next dev" prints the red error overlay | |
| throw err | |
| } | |
| // If a bailout made it to this point, it means it wasn't wrapped inside | |
| // a suspense boundary. | |
| const shouldBailoutToCSR = isBailoutToCSRError(err) | |
| if (shouldBailoutToCSR) { | |
| const stack = getStackWithoutErrorMessage(err) | |
| error( | |
| `${err.reason} should be wrapped in a suspense boundary at page "${pagePath}". Read more: https://nextjs.org/docs/messages/missing-suspense-with-csr-bailout\n${stack}` | |
| ) | |
| throw err | |
| } | |
| let errorType: MetadataErrorType | 'redirect' | undefined | |
| if (isHTTPAccessFallbackError(err)) { | |
| res.statusCode = getAccessFallbackHTTPStatus(err) | |
| metadata.statusCode = res.statusCode | |
| errorType = getAccessFallbackErrorTypeByStatus(res.statusCode) | |
| } else if (isRedirectError(err)) { | |
| errorType = 'redirect' | |
| res.statusCode = getRedirectStatusCodeFromError(err) | |
| metadata.statusCode = res.statusCode | |
| const redirectUrl = addPathPrefix(getURLFromRedirectError(err), basePath) | |
| // If there were mutable cookies set, we need to set them on the | |
| // response. | |
| const headers = new Headers() | |
| if (appendMutableCookies(headers, requestStore.mutableCookies)) { | |
| setHeader('set-cookie', Array.from(headers.values())) | |
| } | |
| setHeader('location', redirectUrl) | |
| } else if (!shouldBailoutToCSR) { | |
| res.statusCode = 500 | |
| metadata.statusCode = res.statusCode | |
| } | |
| const [errorPreinitScripts, errorBootstrapScript] = getRequiredScripts( | |
| buildManifest, | |
| assetPrefix, | |
| crossOrigin, | |
| subresourceIntegrityManifest, | |
| getAssetQueryString(ctx, false), | |
| nonce, | |
| '/_not-found/page' | |
| ) | |
| const errorRSCPayload = await workUnitAsyncStorage.run( | |
| requestStore, | |
| getErrorRSCPayload, | |
| tree, | |
| ctx, | |
| reactServerErrorsByDigest.has((err as any).digest) ? null : err, | |
| errorType | |
| ) | |
| const errorServerStream = workUnitAsyncStorage.run( | |
| requestStore, | |
| ComponentMod.renderToReadableStream, | |
| errorRSCPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| filterStackFrame, | |
| onError: serverComponentsErrorHandler, | |
| } | |
| ) | |
| if (reactServerResult === null) { | |
| // We errored when we did not have an RSC stream to read from. This is not just a render | |
| // error, we need to throw early | |
| throw err | |
| } | |
| try { | |
| const fizzStream = await workUnitAsyncStorage.run( | |
| requestStore, | |
| renderToInitialFizzStream, | |
| { | |
| ReactDOMServer: | |
| require('react-dom/server') as typeof import('react-dom/server'), | |
| element: ( | |
| <ErrorApp | |
| reactServerStream={errorServerStream} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| preinitScripts={errorPreinitScripts} | |
| clientReferenceManifest={clientReferenceManifest} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| /> | |
| ), | |
| streamOptions: { | |
| nonce, | |
| // Include hydration scripts in the HTML | |
| bootstrapScripts: [errorBootstrapScript], | |
| formState, | |
| }, | |
| } | |
| ) | |
| /** | |
| * Rules of Static & Dynamic HTML: | |
| * | |
| * 1.) We must generate static HTML unless the caller explicitly opts | |
| * in to dynamic HTML support. | |
| * | |
| * 2.) If dynamic HTML support is requested, we must honor that request | |
| * or throw an error. It is the sole responsibility of the caller to | |
| * ensure they aren't e.g. requesting dynamic HTML for an AMP page. | |
| * 3.) If `shouldWaitOnAllReady` is true, which indicates we need to | |
| * resolve all suspenses and generate a full HTML. e.g. when it's a | |
| * html limited bot requests, we produce the full HTML content. | |
| * | |
| * These rules help ensure that other existing features like request caching, | |
| * coalescing, and ISR continue working as intended. | |
| */ | |
| const generateStaticHTML = | |
| supportsDynamicResponse !== true || !!shouldWaitOnAllReady | |
| return await continueFizzStream(fizzStream, { | |
| inlinedDataStream: createInlinedDataReadableStream( | |
| // This is intentionally using the readable datastream from the | |
| // main render rather than the flight data from the error page | |
| // render | |
| reactServerResult.consume(), | |
| nonce, | |
| formState | |
| ), | |
| isStaticGeneration: generateStaticHTML, | |
| isBuildTimePrerendering: ctx.workStore.isBuildTimePrerendering === true, | |
| buildId: ctx.workStore.buildId, | |
| getServerInsertedHTML: makeGetServerInsertedHTML({ | |
| polyfills, | |
| renderServerInsertedHTML, | |
| serverCapturedErrors: [], | |
| basePath, | |
| tracingMetadata: tracingMetadata, | |
| }), | |
| getServerInsertedMetadata, | |
| validateRootLayout: dev, | |
| }) | |
| } catch (finalErr: any) { | |
| if ( | |
| process.env.NODE_ENV === 'development' && | |
| isHTTPAccessFallbackError(finalErr) | |
| ) { | |
| const { bailOnRootNotFound } = | |
| require('../../client/components/dev-root-http-access-fallback-boundary') as typeof import('../../client/components/dev-root-http-access-fallback-boundary') | |
| bailOnRootNotFound() | |
| } | |
| throw finalErr | |
| } | |
| } | |
| } | |
| function createValidationOutlet() { | |
| let resolveValidation: (value: React.ReactNode) => void | |
| let outlet = new Promise<React.ReactNode>((resolve) => { | |
| resolveValidation = resolve | |
| }) | |
| return [resolveValidation!, outlet] as const | |
| } | |
| /** | |
| * This function is a fork of prerenderToStream cacheComponents branch. | |
| * While it doesn't return a stream we want it to have identical | |
| * prerender semantics to prerenderToStream and should update it | |
| * in conjunction with any changes to that function. | |
| */ | |
| async function spawnDynamicValidationInDev( | |
| resolveValidation: (validatingElement: React.ReactNode) => void, | |
| tree: LoaderTree, | |
| ctx: AppRenderContext, | |
| isNotFound: boolean, | |
| clientReferenceManifest: NonNullable<RenderOpts['clientReferenceManifest']>, | |
| requestStore: RequestStore | |
| ): Promise<void> { | |
| const { | |
| componentMod: ComponentMod, | |
| getDynamicParamFromSegment, | |
| implicitTags, | |
| nonce, | |
| renderOpts, | |
| workStore, | |
| } = ctx | |
| const { allowEmptyStaticShell = false, botType } = renderOpts | |
| // These values are placeholder values for this validating render | |
| // that are provided during the actual prerenderToStream. | |
| const preinitScripts = () => {} | |
| const { ServerInsertedHTMLProvider } = createServerInsertedHTML() | |
| const rootParams = getRootParams( | |
| ComponentMod.tree, | |
| getDynamicParamFromSegment | |
| ) | |
| const hmrRefreshHash = requestStore.cookies.get( | |
| NEXT_HMR_REFRESH_HASH_COOKIE | |
| )?.value | |
| // The prerender controller represents the lifetime of the prerender. It will | |
| // be aborted when a task is complete or a synchronously aborting API is | |
| // called. Notably, during prospective prerenders, this does not actually | |
| // terminate the prerender itself, which will continue until all caches are | |
| // filled. | |
| const initialServerPrerenderController = new AbortController() | |
| // This controller is used to abort the React prerender. | |
| const initialServerReactController = new AbortController() | |
| // This controller represents the lifetime of the React prerender. Its signal | |
| // can be used for any I/O operation to abort the I/O and/or to reject, when | |
| // prerendering aborts. This includes our own hanging promises for accessing | |
| // request data, and for fetch calls. It might be replaced in the future by | |
| // React.cacheSignal(). It's aborted after the React controller, so that no | |
| // pending I/O can register abort listeners that are called before React's | |
| // abort listener is called. This ensures that pending I/O is not rejected too | |
| // early when aborting the prerender. Notably, during the prospective | |
| // prerender, it is different from the prerender controller because we don't | |
| // want to end the React prerender until all caches are filled. | |
| const initialServerRenderController = new AbortController() | |
| // The cacheSignal helps us track whether caches are still filling or we are | |
| // ready to cut the render off. | |
| const cacheSignal = new CacheSignal() | |
| const captureOwnerStackClient = React.captureOwnerStack | |
| const captureOwnerStackServer = ComponentMod.captureOwnerStack | |
| // The resume data cache here should use a fresh instance as it's | |
| // performing a fresh prerender. If we get to implementing the | |
| // prerendering of an already prerendered page, we should use the passed | |
| // resume data cache instead. | |
| const prerenderResumeDataCache = createPrerenderResumeDataCache() | |
| const initialServerPrerenderStore: PrerenderStore = { | |
| type: 'prerender', | |
| phase: 'render', | |
| rootParams, | |
| fallbackRouteParams: null, | |
| implicitTags, | |
| renderSignal: initialServerRenderController.signal, | |
| controller: initialServerPrerenderController, | |
| // During the initial prerender we need to track all cache reads to ensure | |
| // we render long enough to fill every cache it is possible to visit during | |
| // the final prerender. | |
| cacheSignal, | |
| dynamicTracking: null, | |
| allowEmptyStaticShell, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| prerenderResumeDataCache, | |
| renderResumeDataCache: null, | |
| hmrRefreshHash, | |
| captureOwnerStack: captureOwnerStackServer, | |
| } | |
| // We're not going to use the result of this render because the only time it could be used | |
| // is if it completes in a microtask and that's likely very rare for any non-trivial app | |
| const initialServerPayload = await workUnitAsyncStorage.run( | |
| initialServerPrerenderStore, | |
| getRSCPayload, | |
| tree, | |
| ctx, | |
| isNotFound | |
| ) | |
| const pendingInitialServerResult = workUnitAsyncStorage.run( | |
| initialServerPrerenderStore, | |
| ComponentMod.prerender, | |
| initialServerPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| filterStackFrame, | |
| onError: (err) => { | |
| const digest = getDigestForWellKnownError(err) | |
| if (digest) { | |
| return digest | |
| } | |
| if (isReactLargeShellError(err)) { | |
| // TODO: Aggregate | |
| console.error(err) | |
| return undefined | |
| } | |
| if (initialServerPrerenderController.signal.aborted) { | |
| // The render aborted before this error was handled which indicates | |
| // the error is caused by unfinished components within the render | |
| return | |
| } else if ( | |
| process.env.NEXT_DEBUG_BUILD || | |
| process.env.__NEXT_VERBOSE_LOGGING | |
| ) { | |
| printDebugThrownValueForProspectiveRender(err, workStore.route) | |
| } | |
| }, | |
| // we don't care to track postpones during the prospective render because we need | |
| // to always do a final render anyway | |
| onPostpone: undefined, | |
| // We don't want to stop rendering until the cacheSignal is complete so we pass | |
| // a different signal to this render call than is used by dynamic APIs to signify | |
| // transitioning out of the prerender environment | |
| signal: initialServerReactController.signal, | |
| } | |
| ) | |
| // The listener to abort our own render controller must be added after React | |
| // has added its listener, to ensure that pending I/O is not aborted/rejected | |
| // too early. | |
| initialServerReactController.signal.addEventListener( | |
| 'abort', | |
| () => { | |
| initialServerRenderController.abort() | |
| }, | |
| { once: true } | |
| ) | |
| // Wait for all caches to be finished filling and for async imports to resolve | |
| trackPendingModules(cacheSignal) | |
| await cacheSignal.cacheReady() | |
| initialServerReactController.abort() | |
| // We don't need to continue the prerender process if we already | |
| // detected invalid dynamic usage in the initial prerender phase. | |
| const { invalidDynamicUsageError } = workStore | |
| if (invalidDynamicUsageError) { | |
| resolveValidation( | |
| <LogSafely | |
| fn={() => { | |
| console.error(invalidDynamicUsageError) | |
| }} | |
| /> | |
| ) | |
| return | |
| } | |
| let initialServerResult | |
| try { | |
| initialServerResult = await createReactServerPrerenderResult( | |
| pendingInitialServerResult | |
| ) | |
| } catch (err) { | |
| if ( | |
| initialServerReactController.signal.aborted || | |
| initialServerPrerenderController.signal.aborted | |
| ) { | |
| // These are expected errors that might error the prerender. we ignore them. | |
| } else if ( | |
| process.env.NEXT_DEBUG_BUILD || | |
| process.env.__NEXT_VERBOSE_LOGGING | |
| ) { | |
| // We don't normally log these errors because we are going to retry anyway but | |
| // it can be useful for debugging Next.js itself to get visibility here when needed | |
| printDebugThrownValueForProspectiveRender(err, workStore.route) | |
| } | |
| } | |
| if (initialServerResult) { | |
| const initialClientPrerenderController = new AbortController() | |
| const initialClientReactController = new AbortController() | |
| const initialClientRenderController = new AbortController() | |
| const initialClientPrerenderStore: PrerenderStore = { | |
| type: 'prerender-client', | |
| phase: 'render', | |
| rootParams, | |
| fallbackRouteParams: null, | |
| implicitTags, | |
| renderSignal: initialClientRenderController.signal, | |
| controller: initialClientPrerenderController, | |
| // For HTML Generation the only cache tracked activity | |
| // is module loading, which has it's own cache signal | |
| cacheSignal: null, | |
| dynamicTracking: null, | |
| allowEmptyStaticShell, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| prerenderResumeDataCache, | |
| renderResumeDataCache: null, | |
| hmrRefreshHash: undefined, | |
| captureOwnerStack: captureOwnerStackClient, | |
| } | |
| const prerender = ( | |
| require('react-dom/static') as typeof import('react-dom/static') | |
| ).prerender | |
| const pendingInitialClientResult = workUnitAsyncStorage.run( | |
| initialClientPrerenderStore, | |
| prerender, | |
| <App | |
| reactServerStream={initialServerResult.asUnclosingStream()} | |
| preinitScripts={preinitScripts} | |
| clientReferenceManifest={clientReferenceManifest} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| />, | |
| { | |
| signal: initialClientReactController.signal, | |
| onError: (err) => { | |
| const digest = getDigestForWellKnownError(err) | |
| if (digest) { | |
| return digest | |
| } | |
| if (isReactLargeShellError(err)) { | |
| // TODO: Aggregate | |
| console.error(err) | |
| return undefined | |
| } | |
| if (initialClientReactController.signal.aborted) { | |
| // These are expected errors that might error the prerender. we ignore them. | |
| } else if ( | |
| process.env.NEXT_DEBUG_BUILD || | |
| process.env.__NEXT_VERBOSE_LOGGING | |
| ) { | |
| // We don't normally log these errors because we are going to retry anyway but | |
| // it can be useful for debugging Next.js itself to get visibility here when needed | |
| printDebugThrownValueForProspectiveRender(err, workStore.route) | |
| } | |
| }, | |
| // We don't need bootstrap scripts in this prerender | |
| // bootstrapScripts: [bootstrapScript], | |
| } | |
| ) | |
| // The listener to abort our own render controller must be added after React | |
| // has added its listener, to ensure that pending I/O is not | |
| // aborted/rejected too early. | |
| initialClientReactController.signal.addEventListener( | |
| 'abort', | |
| () => { | |
| initialClientRenderController.abort() | |
| }, | |
| { once: true } | |
| ) | |
| pendingInitialClientResult.catch((err) => { | |
| if ( | |
| initialClientReactController.signal.aborted || | |
| isPrerenderInterruptedError(err) | |
| ) { | |
| // These are expected errors that might error the prerender. we ignore them. | |
| } else if ( | |
| process.env.NEXT_DEBUG_BUILD || | |
| process.env.__NEXT_VERBOSE_LOGGING | |
| ) { | |
| // We don't normally log these errors because we are going to retry anyway but | |
| // it can be useful for debugging Next.js itself to get visibility here when needed | |
| printDebugThrownValueForProspectiveRender(err, workStore.route) | |
| } | |
| }) | |
| // This is mostly needed for dynamic `import()`s in client components. | |
| // Promises passed to client were already awaited above (assuming that they came from cached functions) | |
| trackPendingModules(cacheSignal) | |
| await cacheSignal.cacheReady() | |
| initialClientReactController.abort() | |
| } | |
| const finalServerReactController = new AbortController() | |
| const finalServerRenderController = new AbortController() | |
| const serverDynamicTracking = createDynamicTrackingState( | |
| false // isDebugDynamicAccesses | |
| ) | |
| const finalServerPrerenderStore: PrerenderStore = { | |
| type: 'prerender', | |
| phase: 'render', | |
| rootParams, | |
| fallbackRouteParams: null, | |
| implicitTags, | |
| renderSignal: finalServerRenderController.signal, | |
| controller: finalServerReactController, | |
| // All caches we could read must already be filled so no tracking is necessary | |
| cacheSignal: null, | |
| dynamicTracking: serverDynamicTracking, | |
| allowEmptyStaticShell, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| prerenderResumeDataCache, | |
| renderResumeDataCache: null, | |
| hmrRefreshHash, | |
| captureOwnerStack: captureOwnerStackServer, | |
| } | |
| const finalAttemptRSCPayload = await workUnitAsyncStorage.run( | |
| finalServerPrerenderStore, | |
| getRSCPayload, | |
| tree, | |
| ctx, | |
| isNotFound | |
| ) | |
| const reactServerResult = await createReactServerPrerenderResult( | |
| prerenderAndAbortInSequentialTasks( | |
| async () => { | |
| const pendingPrerenderResult = workUnitAsyncStorage.run( | |
| // The store to scope | |
| finalServerPrerenderStore, | |
| // The function to run | |
| ComponentMod.prerender, | |
| // ... the arguments for the function to run | |
| finalAttemptRSCPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| filterStackFrame, | |
| onError: (err: unknown) => { | |
| if ( | |
| finalServerReactController.signal.aborted && | |
| isPrerenderInterruptedError(err) | |
| ) { | |
| return err.digest | |
| } | |
| if (isReactLargeShellError(err)) { | |
| // TODO: Aggregate | |
| console.error(err) | |
| return undefined | |
| } | |
| return getDigestForWellKnownError(err) | |
| }, | |
| signal: finalServerReactController.signal, | |
| } | |
| ) | |
| // The listener to abort our own render controller must be added after | |
| // React has added its listener, to ensure that pending I/O is not | |
| // aborted/rejected too early. | |
| finalServerReactController.signal.addEventListener( | |
| 'abort', | |
| () => { | |
| finalServerRenderController.abort() | |
| }, | |
| { once: true } | |
| ) | |
| return pendingPrerenderResult | |
| }, | |
| () => { | |
| finalServerReactController.abort() | |
| } | |
| ) | |
| ) | |
| const clientDynamicTracking = createDynamicTrackingState( | |
| false //isDebugDynamicAccesses | |
| ) | |
| const finalClientReactController = new AbortController() | |
| const finalClientRenderController = new AbortController() | |
| const finalClientPrerenderStore: PrerenderStore = { | |
| type: 'prerender-client', | |
| phase: 'render', | |
| rootParams, | |
| fallbackRouteParams: null, | |
| implicitTags, | |
| renderSignal: finalClientRenderController.signal, | |
| controller: finalClientReactController, | |
| // No APIs require a cacheSignal through the workUnitStore during the HTML prerender | |
| cacheSignal: null, | |
| dynamicTracking: clientDynamicTracking, | |
| allowEmptyStaticShell, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| prerenderResumeDataCache, | |
| renderResumeDataCache: null, | |
| hmrRefreshHash, | |
| captureOwnerStack: captureOwnerStackClient, | |
| } | |
| let dynamicValidation = createDynamicValidationState() | |
| try { | |
| const prerender = ( | |
| require('react-dom/static') as typeof import('react-dom/static') | |
| ).prerender | |
| let { prelude: unprocessedPrelude } = | |
| await prerenderAndAbortInSequentialTasks( | |
| () => { | |
| const pendingFinalClientResult = workUnitAsyncStorage.run( | |
| finalClientPrerenderStore, | |
| prerender, | |
| <App | |
| reactServerStream={reactServerResult.asUnclosingStream()} | |
| preinitScripts={preinitScripts} | |
| clientReferenceManifest={clientReferenceManifest} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| />, | |
| { | |
| signal: finalClientReactController.signal, | |
| onError: (err: unknown, errorInfo: ErrorInfo) => { | |
| if ( | |
| isPrerenderInterruptedError(err) || | |
| finalClientReactController.signal.aborted | |
| ) { | |
| const componentStack = errorInfo.componentStack | |
| if (typeof componentStack === 'string') { | |
| trackAllowedDynamicAccess( | |
| workStore, | |
| componentStack, | |
| dynamicValidation, | |
| clientDynamicTracking | |
| ) | |
| } | |
| return | |
| } | |
| if (isReactLargeShellError(err)) { | |
| // TODO: Aggregate | |
| console.error(err) | |
| return undefined | |
| } | |
| return getDigestForWellKnownError(err) | |
| }, | |
| // We don't need bootstrap scripts in this prerender | |
| // bootstrapScripts: [bootstrapScript], | |
| } | |
| ) | |
| // The listener to abort our own render controller must be added after | |
| // React has added its listener, to ensure that pending I/O is not | |
| // aborted/rejected too early. | |
| finalClientReactController.signal.addEventListener( | |
| 'abort', | |
| () => { | |
| finalClientRenderController.abort() | |
| }, | |
| { once: true } | |
| ) | |
| return pendingFinalClientResult | |
| }, | |
| () => { | |
| finalClientReactController.abort() | |
| } | |
| ) | |
| const { preludeIsEmpty } = await processPrelude(unprocessedPrelude) | |
| resolveValidation( | |
| <LogSafely | |
| fn={throwIfDisallowedDynamic.bind( | |
| null, | |
| workStore, | |
| preludeIsEmpty ? PreludeState.Empty : PreludeState.Full, | |
| dynamicValidation, | |
| serverDynamicTracking | |
| )} | |
| /> | |
| ) | |
| } catch (thrownValue) { | |
| // Even if the root errors we still want to report any cache components errors | |
| // that were discovered before the root errored. | |
| let loggingFunction = throwIfDisallowedDynamic.bind( | |
| null, | |
| workStore, | |
| PreludeState.Errored, | |
| dynamicValidation, | |
| serverDynamicTracking | |
| ) | |
| if (process.env.NEXT_DEBUG_BUILD || process.env.__NEXT_VERBOSE_LOGGING) { | |
| // We don't normally log these errors because we are going to retry anyway but | |
| // it can be useful for debugging Next.js itself to get visibility here when needed | |
| const originalLoggingFunction = loggingFunction | |
| loggingFunction = () => { | |
| console.error( | |
| 'During dynamic validation the root of the page errored. The next logged error is the thrown value. It may be a duplicate of errors reported during the normal development mode render.' | |
| ) | |
| console.error(thrownValue) | |
| originalLoggingFunction() | |
| } | |
| } | |
| resolveValidation(<LogSafely fn={loggingFunction} />) | |
| } | |
| } | |
| async function LogSafely({ fn }: { fn: () => unknown }) { | |
| try { | |
| await fn() | |
| } catch {} | |
| return null | |
| } | |
| type PrerenderToStreamResult = { | |
| stream: ReadableStream<Uint8Array> | |
| digestErrorsMap: Map<string, DigestedError> | |
| ssrErrors: Array<unknown> | |
| dynamicAccess?: null | Array<DynamicAccess> | |
| collectedRevalidate: number | |
| collectedExpire: number | |
| collectedStale: number | |
| collectedTags: null | string[] | |
| renderResumeDataCache?: RenderResumeDataCache | |
| } | |
| /** | |
| * Determines whether we should generate static flight data. | |
| */ | |
| function shouldGenerateStaticFlightData(workStore: WorkStore): boolean { | |
| const { isStaticGeneration } = workStore | |
| if (!isStaticGeneration) return false | |
| return true | |
| } | |
| async function prerenderToStream( | |
| req: BaseNextRequest, | |
| res: BaseNextResponse, | |
| ctx: AppRenderContext, | |
| metadata: AppPageRenderResultMetadata, | |
| tree: LoaderTree, | |
| fallbackRouteParams: FallbackRouteParams | null | |
| ): Promise<PrerenderToStreamResult> { | |
| // When prerendering formState is always null. We still include it | |
| // because some shared APIs expect a formState value and this is slightly | |
| // more explicit than making it an optional function argument | |
| const formState = null | |
| const { | |
| assetPrefix, | |
| getDynamicParamFromSegment, | |
| implicitTags, | |
| nonce, | |
| pagePath, | |
| renderOpts, | |
| workStore, | |
| } = ctx | |
| const { | |
| allowEmptyStaticShell = false, | |
| basePath, | |
| botType, | |
| buildManifest, | |
| clientReferenceManifest, | |
| ComponentMod, | |
| crossOrigin, | |
| dev = false, | |
| experimental, | |
| isDebugDynamicAccesses, | |
| nextExport = false, | |
| onInstrumentationRequestError, | |
| page, | |
| reactMaxHeadersLength, | |
| subresourceIntegrityManifest, | |
| } = renderOpts | |
| assertClientReferenceManifest(clientReferenceManifest) | |
| const rootParams = getRootParams(tree, getDynamicParamFromSegment) | |
| const { ServerInsertedHTMLProvider, renderServerInsertedHTML } = | |
| createServerInsertedHTML() | |
| const getServerInsertedMetadata = createServerInsertedMetadata(nonce) | |
| const tracingMetadata = getTracedMetadata( | |
| getTracer().getTracePropagationData(), | |
| experimental.clientTraceMetadata | |
| ) | |
| const polyfills: JSX.IntrinsicElements['script'][] = | |
| buildManifest.polyfillFiles | |
| .filter( | |
| (polyfill) => | |
| polyfill.endsWith('.js') && !polyfill.endsWith('.module.js') | |
| ) | |
| .map((polyfill) => ({ | |
| src: `${assetPrefix}/_next/${polyfill}${getAssetQueryString( | |
| ctx, | |
| false | |
| )}`, | |
| integrity: subresourceIntegrityManifest?.[polyfill], | |
| crossOrigin, | |
| noModule: true, | |
| nonce, | |
| })) | |
| const [preinitScripts, bootstrapScript] = getRequiredScripts( | |
| buildManifest, | |
| // Why is assetPrefix optional on renderOpts? | |
| // @TODO make it default empty string on renderOpts and get rid of it from ctx | |
| assetPrefix, | |
| crossOrigin, | |
| subresourceIntegrityManifest, | |
| getAssetQueryString(ctx, true), | |
| nonce, | |
| page | |
| ) | |
| const reactServerErrorsByDigest: Map<string, DigestedError> = new Map() | |
| // We don't report errors during prerendering through our instrumentation hooks | |
| const silenceLogger = !!experimental.isRoutePPREnabled | |
| function onHTMLRenderRSCError(err: DigestedError) { | |
| return onInstrumentationRequestError?.( | |
| err, | |
| req, | |
| createErrorContext(ctx, 'react-server-components') | |
| ) | |
| } | |
| const serverComponentsErrorHandler = createHTMLReactServerErrorHandler( | |
| dev, | |
| nextExport, | |
| reactServerErrorsByDigest, | |
| silenceLogger, | |
| onHTMLRenderRSCError | |
| ) | |
| function onHTMLRenderSSRError(err: DigestedError) { | |
| return onInstrumentationRequestError?.( | |
| err, | |
| req, | |
| createErrorContext(ctx, 'server-rendering') | |
| ) | |
| } | |
| const allCapturedErrors: Array<unknown> = [] | |
| const htmlRendererErrorHandler = createHTMLErrorHandler( | |
| dev, | |
| nextExport, | |
| reactServerErrorsByDigest, | |
| allCapturedErrors, | |
| silenceLogger, | |
| onHTMLRenderSSRError | |
| ) | |
| let reactServerPrerenderResult: null | ReactServerPrerenderResult = null | |
| const setMetadataHeader = (name: string) => { | |
| metadata.headers ??= {} | |
| metadata.headers[name] = res.getHeader(name) | |
| } | |
| const setHeader = (name: string, value: string | string[]) => { | |
| res.setHeader(name, value) | |
| setMetadataHeader(name) | |
| return res | |
| } | |
| const appendHeader = (name: string, value: string | string[]) => { | |
| if (Array.isArray(value)) { | |
| value.forEach((item) => { | |
| res.appendHeader(name, item) | |
| }) | |
| } else { | |
| res.appendHeader(name, value) | |
| } | |
| setMetadataHeader(name) | |
| } | |
| const selectStaleTime = (stale: number) => | |
| stale === INFINITE_CACHE && | |
| typeof experimental.staleTimes?.static === 'number' | |
| ? experimental.staleTimes.static | |
| : stale | |
| let prerenderStore: PrerenderStore | null = null | |
| try { | |
| if (experimental.cacheComponents) { | |
| /** | |
| * cacheComponents with PPR | |
| * | |
| * The general approach is to render the RSC stream first allowing any cache reads to resolve. | |
| * Once we have settled all cache reads we restart the render and abort after a single Task. | |
| * | |
| * Unlike with the non PPR case we can't synchronously abort the render when a dynamic API is used | |
| * during the initial render because we need to ensure all caches can be filled as part of the initial Task | |
| * and a synchronous abort might prevent us from filling all caches. | |
| * | |
| * Once the render is complete we allow the SSR render to finish and use a combination of the postponed state | |
| * and the reactServerIsDynamic value to determine how to treat the resulting render | |
| */ | |
| // The prerender controller represents the lifetime of the prerender. It | |
| // will be aborted when a task is complete or a synchronously aborting API | |
| // is called. Notably, during prospective prerenders, this does not | |
| // actually terminate the prerender itself, which will continue until all | |
| // caches are filled. | |
| const initialServerPrerenderController = new AbortController() | |
| // This controller is used to abort the React prerender. | |
| const initialServerReactController = new AbortController() | |
| // This controller represents the lifetime of the React prerender. Its | |
| // signal can be used for any I/O operation to abort the I/O and/or to | |
| // reject, when prerendering aborts. This includes our own hanging | |
| // promises for accessing request data, and for fetch calls. It might be | |
| // replaced in the future by React.cacheSignal(). It's aborted after the | |
| // React controller, so that no pending I/O can register abort listeners | |
| // that are called before React's abort listener is called. This ensures | |
| // that pending I/O is not rejected too early when aborting the prerender. | |
| // Notably, during the prospective prerender, it is different from the | |
| // prerender controller because we don't want to end the React prerender | |
| // until all caches are filled. | |
| const initialServerRenderController = new AbortController() | |
| // The cacheSignal helps us track whether caches are still filling or we are ready | |
| // to cut the render off. | |
| const cacheSignal = new CacheSignal() | |
| let resumeDataCache: RenderResumeDataCache | PrerenderResumeDataCache | |
| let renderResumeDataCache: RenderResumeDataCache | null = null | |
| let prerenderResumeDataCache: PrerenderResumeDataCache | null = null | |
| if (renderOpts.renderResumeDataCache) { | |
| // If a prefilled immutable render resume data cache is provided, e.g. | |
| // when prerendering an optional fallback shell after having prerendered | |
| // pages with defined params, we use this instead of a prerender resume | |
| // data cache. | |
| resumeDataCache = renderResumeDataCache = | |
| renderOpts.renderResumeDataCache | |
| } else { | |
| // Otherwise we create a new mutable prerender resume data cache. | |
| resumeDataCache = prerenderResumeDataCache = | |
| createPrerenderResumeDataCache() | |
| } | |
| const initialServerPrerenderStore: PrerenderStore = (prerenderStore = { | |
| type: 'prerender', | |
| phase: 'render', | |
| rootParams, | |
| fallbackRouteParams, | |
| implicitTags, | |
| renderSignal: initialServerRenderController.signal, | |
| controller: initialServerPrerenderController, | |
| // During the initial prerender we need to track all cache reads to ensure | |
| // we render long enough to fill every cache it is possible to visit during | |
| // the final prerender. | |
| cacheSignal, | |
| dynamicTracking: null, | |
| allowEmptyStaticShell, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| prerenderResumeDataCache, | |
| renderResumeDataCache, | |
| hmrRefreshHash: undefined, | |
| captureOwnerStack: undefined, // Not available in production. | |
| }) | |
| // We're not going to use the result of this render because the only time it could be used | |
| // is if it completes in a microtask and that's likely very rare for any non-trivial app | |
| const initialServerPayload = await workUnitAsyncStorage.run( | |
| initialServerPrerenderStore, | |
| getRSCPayload, | |
| tree, | |
| ctx, | |
| res.statusCode === 404 | |
| ) | |
| const pendingInitialServerResult = workUnitAsyncStorage.run( | |
| initialServerPrerenderStore, | |
| ComponentMod.prerender, | |
| initialServerPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| filterStackFrame, | |
| onError: (err) => { | |
| const digest = getDigestForWellKnownError(err) | |
| if (digest) { | |
| return digest | |
| } | |
| if (isReactLargeShellError(err)) { | |
| // TODO: Aggregate | |
| console.error(err) | |
| return undefined | |
| } | |
| if (initialServerPrerenderController.signal.aborted) { | |
| // The render aborted before this error was handled which indicates | |
| // the error is caused by unfinished components within the render | |
| return | |
| } else if ( | |
| process.env.NEXT_DEBUG_BUILD || | |
| process.env.__NEXT_VERBOSE_LOGGING | |
| ) { | |
| printDebugThrownValueForProspectiveRender(err, workStore.route) | |
| } | |
| }, | |
| // we don't care to track postpones during the prospective render because we need | |
| // to always do a final render anyway | |
| onPostpone: undefined, | |
| // We don't want to stop rendering until the cacheSignal is complete so we pass | |
| // a different signal to this render call than is used by dynamic APIs to signify | |
| // transitioning out of the prerender environment | |
| signal: initialServerReactController.signal, | |
| } | |
| ) | |
| // The listener to abort our own render controller must be added after | |
| // React has added its listener, to ensure that pending I/O is not | |
| // aborted/rejected too early. | |
| initialServerReactController.signal.addEventListener( | |
| 'abort', | |
| () => { | |
| initialServerRenderController.abort() | |
| }, | |
| { once: true } | |
| ) | |
| // Wait for all caches to be finished filling and for async imports to resolve | |
| trackPendingModules(cacheSignal) | |
| await cacheSignal.cacheReady() | |
| initialServerReactController.abort() | |
| // We don't need to continue the prerender process if we already | |
| // detected invalid dynamic usage in the initial prerender phase. | |
| if (workStore.invalidDynamicUsageError) { | |
| logDisallowedDynamicError(workStore, workStore.invalidDynamicUsageError) | |
| throw new StaticGenBailoutError() | |
| } | |
| let initialServerResult | |
| try { | |
| initialServerResult = await createReactServerPrerenderResult( | |
| pendingInitialServerResult | |
| ) | |
| } catch (err) { | |
| if ( | |
| initialServerReactController.signal.aborted || | |
| initialServerPrerenderController.signal.aborted | |
| ) { | |
| // These are expected errors that might error the prerender. we ignore them. | |
| } else if ( | |
| process.env.NEXT_DEBUG_BUILD || | |
| process.env.__NEXT_VERBOSE_LOGGING | |
| ) { | |
| // We don't normally log these errors because we are going to retry anyway but | |
| // it can be useful for debugging Next.js itself to get visibility here when needed | |
| printDebugThrownValueForProspectiveRender(err, workStore.route) | |
| } | |
| } | |
| if (initialServerResult) { | |
| const initialClientPrerenderController = new AbortController() | |
| const initialClientReactController = new AbortController() | |
| const initialClientRenderController = new AbortController() | |
| const initialClientPrerenderStore: PrerenderStore = { | |
| type: 'prerender-client', | |
| phase: 'render', | |
| rootParams, | |
| fallbackRouteParams, | |
| implicitTags, | |
| renderSignal: initialClientRenderController.signal, | |
| controller: initialClientPrerenderController, | |
| // For HTML Generation the only cache tracked activity | |
| // is module loading, which has it's own cache signal | |
| cacheSignal: null, | |
| dynamicTracking: null, | |
| allowEmptyStaticShell, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| prerenderResumeDataCache, | |
| renderResumeDataCache, | |
| hmrRefreshHash: undefined, | |
| captureOwnerStack: undefined, // Not available in production. | |
| } | |
| const prerender = ( | |
| require('react-dom/static') as typeof import('react-dom/static') | |
| ).prerender | |
| const pendingInitialClientResult = workUnitAsyncStorage.run( | |
| initialClientPrerenderStore, | |
| prerender, | |
| <App | |
| reactServerStream={initialServerResult.asUnclosingStream()} | |
| preinitScripts={preinitScripts} | |
| clientReferenceManifest={clientReferenceManifest} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| />, | |
| { | |
| signal: initialClientReactController.signal, | |
| onError: (err) => { | |
| const digest = getDigestForWellKnownError(err) | |
| if (digest) { | |
| return digest | |
| } | |
| if (isReactLargeShellError(err)) { | |
| // TODO: Aggregate | |
| console.error(err) | |
| return undefined | |
| } | |
| if (initialClientReactController.signal.aborted) { | |
| // These are expected errors that might error the prerender. we ignore them. | |
| } else if ( | |
| process.env.NEXT_DEBUG_BUILD || | |
| process.env.__NEXT_VERBOSE_LOGGING | |
| ) { | |
| // We don't normally log these errors because we are going to retry anyway but | |
| // it can be useful for debugging Next.js itself to get visibility here when needed | |
| printDebugThrownValueForProspectiveRender(err, workStore.route) | |
| } | |
| }, | |
| bootstrapScripts: [bootstrapScript], | |
| } | |
| ) | |
| // The listener to abort our own render controller must be added after | |
| // React has added its listener, to ensure that pending I/O is not | |
| // aborted/rejected too early. | |
| initialClientReactController.signal.addEventListener( | |
| 'abort', | |
| () => { | |
| initialClientRenderController.abort() | |
| }, | |
| { once: true } | |
| ) | |
| pendingInitialClientResult.catch((err) => { | |
| if ( | |
| initialClientReactController.signal.aborted || | |
| isPrerenderInterruptedError(err) | |
| ) { | |
| // These are expected errors that might error the prerender. we ignore them. | |
| } else if ( | |
| process.env.NEXT_DEBUG_BUILD || | |
| process.env.__NEXT_VERBOSE_LOGGING | |
| ) { | |
| // We don't normally log these errors because we are going to retry anyway but | |
| // it can be useful for debugging Next.js itself to get visibility here when needed | |
| printDebugThrownValueForProspectiveRender(err, workStore.route) | |
| } | |
| }) | |
| // This is mostly needed for dynamic `import()`s in client components. | |
| // Promises passed to client were already awaited above (assuming that they came from cached functions) | |
| trackPendingModules(cacheSignal) | |
| await cacheSignal.cacheReady() | |
| initialClientReactController.abort() | |
| } | |
| let serverIsDynamic = false | |
| const finalServerReactController = new AbortController() | |
| const finalServerRenderController = new AbortController() | |
| const serverDynamicTracking = createDynamicTrackingState( | |
| isDebugDynamicAccesses | |
| ) | |
| const finalServerPrerenderStore: PrerenderStore = (prerenderStore = { | |
| type: 'prerender', | |
| phase: 'render', | |
| rootParams, | |
| fallbackRouteParams, | |
| implicitTags, | |
| renderSignal: finalServerRenderController.signal, | |
| controller: finalServerReactController, | |
| // All caches we could read must already be filled so no tracking is necessary | |
| cacheSignal: null, | |
| dynamicTracking: serverDynamicTracking, | |
| allowEmptyStaticShell, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| prerenderResumeDataCache, | |
| renderResumeDataCache, | |
| hmrRefreshHash: undefined, | |
| captureOwnerStack: undefined, // Not available in production. | |
| }) | |
| const finalAttemptRSCPayload = await workUnitAsyncStorage.run( | |
| finalServerPrerenderStore, | |
| getRSCPayload, | |
| tree, | |
| ctx, | |
| res.statusCode === 404 | |
| ) | |
| let prerenderIsPending = true | |
| const reactServerResult = (reactServerPrerenderResult = | |
| await createReactServerPrerenderResult( | |
| prerenderAndAbortInSequentialTasks( | |
| async () => { | |
| const pendingPrerenderResult = workUnitAsyncStorage.run( | |
| // The store to scope | |
| finalServerPrerenderStore, | |
| // The function to run | |
| ComponentMod.prerender, | |
| // ... the arguments for the function to run | |
| finalAttemptRSCPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| filterStackFrame, | |
| onError: (err: unknown) => { | |
| return serverComponentsErrorHandler(err) | |
| }, | |
| signal: finalServerReactController.signal, | |
| } | |
| ) | |
| // The listener to abort our own render controller must be added | |
| // after React has added its listener, to ensure that pending I/O | |
| // is not aborted/rejected too early. | |
| finalServerReactController.signal.addEventListener( | |
| 'abort', | |
| () => { | |
| finalServerRenderController.abort() | |
| }, | |
| { once: true } | |
| ) | |
| const prerenderResult = await pendingPrerenderResult | |
| prerenderIsPending = false | |
| return prerenderResult | |
| }, | |
| () => { | |
| if (finalServerReactController.signal.aborted) { | |
| // If the server controller is already aborted we must have called something | |
| // that required aborting the prerender synchronously such as with new Date() | |
| serverIsDynamic = true | |
| return | |
| } | |
| if (prerenderIsPending) { | |
| // If prerenderIsPending then we have blocked for longer than a Task and we assume | |
| // there is something unfinished. | |
| serverIsDynamic = true | |
| } | |
| finalServerReactController.abort() | |
| } | |
| ) | |
| )) | |
| const clientDynamicTracking = createDynamicTrackingState( | |
| isDebugDynamicAccesses | |
| ) | |
| const finalClientReactController = new AbortController() | |
| const finalClientRenderController = new AbortController() | |
| const finalClientPrerenderStore: PrerenderStore = { | |
| type: 'prerender-client', | |
| phase: 'render', | |
| rootParams, | |
| fallbackRouteParams, | |
| implicitTags, | |
| renderSignal: finalClientRenderController.signal, | |
| controller: finalClientReactController, | |
| // No APIs require a cacheSignal through the workUnitStore during the HTML prerender | |
| cacheSignal: null, | |
| dynamicTracking: clientDynamicTracking, | |
| allowEmptyStaticShell, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| prerenderResumeDataCache, | |
| renderResumeDataCache, | |
| hmrRefreshHash: undefined, | |
| captureOwnerStack: undefined, // Not available in production. | |
| } | |
| let dynamicValidation = createDynamicValidationState() | |
| const prerender = ( | |
| require('react-dom/static') as typeof import('react-dom/static') | |
| ).prerender | |
| let { prelude: unprocessedPrelude, postponed } = | |
| await prerenderAndAbortInSequentialTasks( | |
| () => { | |
| const pendingFinalClientResult = workUnitAsyncStorage.run( | |
| finalClientPrerenderStore, | |
| prerender, | |
| <App | |
| reactServerStream={reactServerResult.asUnclosingStream()} | |
| preinitScripts={preinitScripts} | |
| clientReferenceManifest={clientReferenceManifest} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| />, | |
| { | |
| signal: finalClientReactController.signal, | |
| onError: (err: unknown, errorInfo: ErrorInfo) => { | |
| if ( | |
| isPrerenderInterruptedError(err) || | |
| finalClientReactController.signal.aborted | |
| ) { | |
| const componentStack: string | undefined = ( | |
| errorInfo as any | |
| ).componentStack | |
| if (typeof componentStack === 'string') { | |
| trackAllowedDynamicAccess( | |
| workStore, | |
| componentStack, | |
| dynamicValidation, | |
| clientDynamicTracking | |
| ) | |
| } | |
| return | |
| } | |
| return htmlRendererErrorHandler(err, errorInfo) | |
| }, | |
| onHeaders: (headers: Headers) => { | |
| headers.forEach((value, key) => { | |
| appendHeader(key, value) | |
| }) | |
| }, | |
| maxHeadersLength: reactMaxHeadersLength, | |
| bootstrapScripts: [bootstrapScript], | |
| } | |
| ) | |
| // The listener to abort our own render controller must be added | |
| // after React has added its listener, to ensure that pending I/O is | |
| // not aborted/rejected too early. | |
| finalClientReactController.signal.addEventListener( | |
| 'abort', | |
| () => { | |
| finalClientRenderController.abort() | |
| }, | |
| { once: true } | |
| ) | |
| return pendingFinalClientResult | |
| }, | |
| () => { | |
| finalClientReactController.abort() | |
| } | |
| ) | |
| const { prelude, preludeIsEmpty } = | |
| await processPrelude(unprocessedPrelude) | |
| // If we've disabled throwing on empty static shell, then we don't need to | |
| // track any dynamic access that occurs above the suspense boundary because | |
| // we'll do so in the route shell. | |
| if (!allowEmptyStaticShell) { | |
| throwIfDisallowedDynamic( | |
| workStore, | |
| preludeIsEmpty ? PreludeState.Empty : PreludeState.Full, | |
| dynamicValidation, | |
| serverDynamicTracking | |
| ) | |
| } | |
| const getServerInsertedHTML = makeGetServerInsertedHTML({ | |
| polyfills, | |
| renderServerInsertedHTML, | |
| serverCapturedErrors: allCapturedErrors, | |
| basePath, | |
| tracingMetadata: tracingMetadata, | |
| }) | |
| const flightData = await streamToBuffer(reactServerResult.asStream()) | |
| metadata.flightData = flightData | |
| metadata.segmentData = await collectSegmentData( | |
| flightData, | |
| finalServerPrerenderStore, | |
| ComponentMod, | |
| renderOpts, | |
| fallbackRouteParams | |
| ) | |
| // If there are fallback route params, the RSC data is inherently dynamic | |
| // today because it's encoded into the flight router state. Until we can | |
| // move the fallback route params out of the flight router state, we need | |
| // to always perform a dynamic resume after the static prerender. | |
| const hasFallbackRouteParams = | |
| fallbackRouteParams && fallbackRouteParams.size > 0 | |
| if (serverIsDynamic || hasFallbackRouteParams) { | |
| // Dynamic case | |
| // We will always need to perform a "resume" render of some kind when this route is accessed | |
| // because the RSC data itself is dynamic. We determine if there are any HTML holes or not | |
| // but generally this is a "partial" prerender in that there will be a per-request compute | |
| // concatenated to the static shell. | |
| if (postponed != null) { | |
| // Dynamic HTML case | |
| metadata.postponed = await getDynamicHTMLPostponedState( | |
| postponed, | |
| fallbackRouteParams, | |
| resumeDataCache | |
| ) | |
| } else { | |
| // Dynamic Data case | |
| metadata.postponed = | |
| await getDynamicDataPostponedState(resumeDataCache) | |
| } | |
| reactServerResult.consume() | |
| return { | |
| digestErrorsMap: reactServerErrorsByDigest, | |
| ssrErrors: allCapturedErrors, | |
| stream: await continueDynamicPrerender(prelude, { | |
| getServerInsertedHTML, | |
| getServerInsertedMetadata, | |
| }), | |
| dynamicAccess: consumeDynamicAccess( | |
| serverDynamicTracking, | |
| clientDynamicTracking | |
| ), | |
| // TODO: Should this include the SSR pass? | |
| collectedRevalidate: finalServerPrerenderStore.revalidate, | |
| collectedExpire: finalServerPrerenderStore.expire, | |
| collectedStale: selectStaleTime(finalServerPrerenderStore.stale), | |
| collectedTags: finalServerPrerenderStore.tags, | |
| renderResumeDataCache: createRenderResumeDataCache(resumeDataCache), | |
| } | |
| } else { | |
| // Static case | |
| // We will not perform resumption per request. The result can be served statically to the requestor | |
| // and if there was anything dynamic it will only be rendered in the browser. | |
| if (workStore.forceDynamic) { | |
| throw new StaticGenBailoutError( | |
| 'Invariant: a Page with `dynamic = "force-dynamic"` did not trigger the dynamic pathway. This is a bug in Next.js' | |
| ) | |
| } | |
| let htmlStream = prelude | |
| if (postponed != null) { | |
| // We postponed but nothing dynamic was used. We resume the render now and immediately abort it | |
| // so we can set all the postponed boundaries to client render mode before we store the HTML response | |
| const resume = ( | |
| require('react-dom/server') as typeof import('react-dom/server') | |
| ).resume | |
| // We don't actually want to render anything so we just pass a stream | |
| // that never resolves. The resume call is going to abort immediately anyway | |
| const foreverStream = new ReadableStream<Uint8Array>() | |
| const resumeStream = await resume( | |
| <App | |
| reactServerStream={foreverStream} | |
| preinitScripts={() => {}} | |
| clientReferenceManifest={clientReferenceManifest} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| />, | |
| JSON.parse(JSON.stringify(postponed)), | |
| { | |
| signal: createRenderInBrowserAbortSignal(), | |
| onError: htmlRendererErrorHandler, | |
| nonce, | |
| } | |
| ) | |
| // First we write everything from the prerender, then we write everything from the aborted resume render | |
| htmlStream = chainStreams(prelude, resumeStream) | |
| } | |
| return { | |
| digestErrorsMap: reactServerErrorsByDigest, | |
| ssrErrors: allCapturedErrors, | |
| stream: await continueStaticPrerender(htmlStream, { | |
| inlinedDataStream: createInlinedDataReadableStream( | |
| reactServerResult.consumeAsStream(), | |
| nonce, | |
| formState | |
| ), | |
| getServerInsertedHTML, | |
| getServerInsertedMetadata, | |
| isBuildTimePrerendering: | |
| ctx.workStore.isBuildTimePrerendering === true, | |
| buildId: ctx.workStore.buildId, | |
| }), | |
| dynamicAccess: consumeDynamicAccess( | |
| serverDynamicTracking, | |
| clientDynamicTracking | |
| ), | |
| // TODO: Should this include the SSR pass? | |
| collectedRevalidate: finalServerPrerenderStore.revalidate, | |
| collectedExpire: finalServerPrerenderStore.expire, | |
| collectedStale: selectStaleTime(finalServerPrerenderStore.stale), | |
| collectedTags: finalServerPrerenderStore.tags, | |
| renderResumeDataCache: createRenderResumeDataCache(resumeDataCache), | |
| } | |
| } | |
| } else if (experimental.isRoutePPREnabled) { | |
| // We're statically generating with PPR and need to do dynamic tracking | |
| let dynamicTracking = createDynamicTrackingState(isDebugDynamicAccesses) | |
| const prerenderResumeDataCache = createPrerenderResumeDataCache() | |
| const reactServerPrerenderStore: PrerenderStore = (prerenderStore = { | |
| type: 'prerender-ppr', | |
| phase: 'render', | |
| rootParams, | |
| fallbackRouteParams, | |
| implicitTags, | |
| dynamicTracking, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| prerenderResumeDataCache, | |
| }) | |
| const RSCPayload = await workUnitAsyncStorage.run( | |
| reactServerPrerenderStore, | |
| getRSCPayload, | |
| tree, | |
| ctx, | |
| res.statusCode === 404 | |
| ) | |
| const reactServerResult = (reactServerPrerenderResult = | |
| await createReactServerPrerenderResultFromRender( | |
| workUnitAsyncStorage.run( | |
| reactServerPrerenderStore, | |
| ComponentMod.renderToReadableStream, | |
| // ... the arguments for the function to run | |
| RSCPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| filterStackFrame, | |
| onError: serverComponentsErrorHandler, | |
| } | |
| ) | |
| )) | |
| const ssrPrerenderStore: PrerenderStore = { | |
| type: 'prerender-ppr', | |
| phase: 'render', | |
| rootParams, | |
| fallbackRouteParams, | |
| implicitTags, | |
| dynamicTracking, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| prerenderResumeDataCache, | |
| } | |
| const prerender = ( | |
| require('react-dom/static') as typeof import('react-dom/static') | |
| ).prerender | |
| const { prelude, postponed } = await workUnitAsyncStorage.run( | |
| ssrPrerenderStore, | |
| prerender, | |
| <App | |
| reactServerStream={reactServerResult.asUnclosingStream()} | |
| preinitScripts={preinitScripts} | |
| clientReferenceManifest={clientReferenceManifest} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| />, | |
| { | |
| onError: htmlRendererErrorHandler, | |
| onHeaders: (headers: Headers) => { | |
| headers.forEach((value, key) => { | |
| appendHeader(key, value) | |
| }) | |
| }, | |
| maxHeadersLength: reactMaxHeadersLength, | |
| bootstrapScripts: [bootstrapScript], | |
| } | |
| ) | |
| const getServerInsertedHTML = makeGetServerInsertedHTML({ | |
| polyfills, | |
| renderServerInsertedHTML, | |
| serverCapturedErrors: allCapturedErrors, | |
| basePath, | |
| tracingMetadata: tracingMetadata, | |
| }) | |
| // After awaiting here we've waited for the entire RSC render to complete. Crucially this means | |
| // that when we detect whether we've used dynamic APIs below we know we'll have picked up even | |
| // parts of the React Server render that might not be used in the SSR render. | |
| const flightData = await streamToBuffer(reactServerResult.asStream()) | |
| if (shouldGenerateStaticFlightData(workStore)) { | |
| metadata.flightData = flightData | |
| metadata.segmentData = await collectSegmentData( | |
| flightData, | |
| ssrPrerenderStore, | |
| ComponentMod, | |
| renderOpts, | |
| fallbackRouteParams | |
| ) | |
| } | |
| /** | |
| * When prerendering there are three outcomes to consider | |
| * | |
| * Dynamic HTML: The prerender has dynamic holes (caused by using Next.js Dynamic Rendering APIs) | |
| * We will need to resume this result when requests are handled and we don't include | |
| * any server inserted HTML or inlined flight data in the static HTML | |
| * | |
| * Dynamic Data: The prerender has no dynamic holes but dynamic APIs were used. We will not | |
| * resume this render when requests are handled but we will generate new inlined | |
| * flight data since it is dynamic and differences may end up reconciling on the client | |
| * | |
| * Static: The prerender has no dynamic holes and no dynamic APIs were used. We statically encode | |
| * all server inserted HTML and flight data | |
| */ | |
| // First we check if we have any dynamic holes in our HTML prerender | |
| if (accessedDynamicData(dynamicTracking.dynamicAccesses)) { | |
| if (postponed != null) { | |
| // Dynamic HTML case. | |
| metadata.postponed = await getDynamicHTMLPostponedState( | |
| postponed, | |
| fallbackRouteParams, | |
| prerenderResumeDataCache | |
| ) | |
| } else { | |
| // Dynamic Data case. | |
| metadata.postponed = await getDynamicDataPostponedState( | |
| prerenderResumeDataCache | |
| ) | |
| } | |
| // Regardless of whether this is the Dynamic HTML or Dynamic Data case we need to ensure we include | |
| // server inserted html in the static response because the html that is part of the prerender may depend on it | |
| // It is possible in the set of stream transforms for Dynamic HTML vs Dynamic Data may differ but currently both states | |
| // require the same set so we unify the code path here | |
| reactServerResult.consume() | |
| return { | |
| digestErrorsMap: reactServerErrorsByDigest, | |
| ssrErrors: allCapturedErrors, | |
| stream: await continueDynamicPrerender(prelude, { | |
| getServerInsertedHTML, | |
| getServerInsertedMetadata, | |
| }), | |
| dynamicAccess: dynamicTracking.dynamicAccesses, | |
| // TODO: Should this include the SSR pass? | |
| collectedRevalidate: reactServerPrerenderStore.revalidate, | |
| collectedExpire: reactServerPrerenderStore.expire, | |
| collectedStale: selectStaleTime(reactServerPrerenderStore.stale), | |
| collectedTags: reactServerPrerenderStore.tags, | |
| } | |
| } else if (fallbackRouteParams && fallbackRouteParams.size > 0) { | |
| // Rendering the fallback case. | |
| metadata.postponed = await getDynamicDataPostponedState( | |
| prerenderResumeDataCache | |
| ) | |
| return { | |
| digestErrorsMap: reactServerErrorsByDigest, | |
| ssrErrors: allCapturedErrors, | |
| stream: await continueDynamicPrerender(prelude, { | |
| getServerInsertedHTML, | |
| getServerInsertedMetadata, | |
| }), | |
| dynamicAccess: dynamicTracking.dynamicAccesses, | |
| // TODO: Should this include the SSR pass? | |
| collectedRevalidate: reactServerPrerenderStore.revalidate, | |
| collectedExpire: reactServerPrerenderStore.expire, | |
| collectedStale: selectStaleTime(reactServerPrerenderStore.stale), | |
| collectedTags: reactServerPrerenderStore.tags, | |
| } | |
| } else { | |
| // Static case | |
| // We still have not used any dynamic APIs. At this point we can produce an entirely static prerender response | |
| if (workStore.forceDynamic) { | |
| throw new StaticGenBailoutError( | |
| 'Invariant: a Page with `dynamic = "force-dynamic"` did not trigger the dynamic pathway. This is a bug in Next.js' | |
| ) | |
| } | |
| let htmlStream = prelude | |
| if (postponed != null) { | |
| // We postponed but nothing dynamic was used. We resume the render now and immediately abort it | |
| // so we can set all the postponed boundaries to client render mode before we store the HTML response | |
| const resume = ( | |
| require('react-dom/server') as typeof import('react-dom/server') | |
| ).resume | |
| // We don't actually want to render anything so we just pass a stream | |
| // that never resolves. The resume call is going to abort immediately anyway | |
| const foreverStream = new ReadableStream<Uint8Array>() | |
| const resumeStream = await resume( | |
| <App | |
| reactServerStream={foreverStream} | |
| preinitScripts={() => {}} | |
| clientReferenceManifest={clientReferenceManifest} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| />, | |
| JSON.parse(JSON.stringify(postponed)), | |
| { | |
| signal: createRenderInBrowserAbortSignal(), | |
| onError: htmlRendererErrorHandler, | |
| nonce, | |
| } | |
| ) | |
| // First we write everything from the prerender, then we write everything from the aborted resume render | |
| htmlStream = chainStreams(prelude, resumeStream) | |
| } | |
| return { | |
| digestErrorsMap: reactServerErrorsByDigest, | |
| ssrErrors: allCapturedErrors, | |
| stream: await continueStaticPrerender(htmlStream, { | |
| inlinedDataStream: createInlinedDataReadableStream( | |
| reactServerResult.consumeAsStream(), | |
| nonce, | |
| formState | |
| ), | |
| getServerInsertedHTML, | |
| getServerInsertedMetadata, | |
| isBuildTimePrerendering: | |
| ctx.workStore.isBuildTimePrerendering === true, | |
| buildId: ctx.workStore.buildId, | |
| }), | |
| dynamicAccess: dynamicTracking.dynamicAccesses, | |
| // TODO: Should this include the SSR pass? | |
| collectedRevalidate: reactServerPrerenderStore.revalidate, | |
| collectedExpire: reactServerPrerenderStore.expire, | |
| collectedStale: selectStaleTime(reactServerPrerenderStore.stale), | |
| collectedTags: reactServerPrerenderStore.tags, | |
| } | |
| } | |
| } else { | |
| const prerenderLegacyStore: PrerenderStore = (prerenderStore = { | |
| type: 'prerender-legacy', | |
| phase: 'render', | |
| rootParams, | |
| implicitTags, | |
| revalidate: INFINITE_CACHE, | |
| expire: INFINITE_CACHE, | |
| stale: INFINITE_CACHE, | |
| tags: [...implicitTags.tags], | |
| }) | |
| // This is a regular static generation. We don't do dynamic tracking because we rely on | |
| // the old-school dynamic error handling to bail out of static generation | |
| const RSCPayload = await workUnitAsyncStorage.run( | |
| prerenderLegacyStore, | |
| getRSCPayload, | |
| tree, | |
| ctx, | |
| res.statusCode === 404 | |
| ) | |
| const reactServerResult = (reactServerPrerenderResult = | |
| await createReactServerPrerenderResultFromRender( | |
| workUnitAsyncStorage.run( | |
| prerenderLegacyStore, | |
| ComponentMod.renderToReadableStream, | |
| RSCPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| filterStackFrame, | |
| onError: serverComponentsErrorHandler, | |
| } | |
| ) | |
| )) | |
| const renderToReadableStream = ( | |
| require('react-dom/server') as typeof import('react-dom/server') | |
| ).renderToReadableStream | |
| const htmlStream = await workUnitAsyncStorage.run( | |
| prerenderLegacyStore, | |
| renderToReadableStream, | |
| <App | |
| reactServerStream={reactServerResult.asUnclosingStream()} | |
| preinitScripts={preinitScripts} | |
| clientReferenceManifest={clientReferenceManifest} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| />, | |
| { | |
| onError: htmlRendererErrorHandler, | |
| nonce, | |
| bootstrapScripts: [bootstrapScript], | |
| } | |
| ) | |
| if (shouldGenerateStaticFlightData(workStore)) { | |
| const flightData = await streamToBuffer(reactServerResult.asStream()) | |
| metadata.flightData = flightData | |
| metadata.segmentData = await collectSegmentData( | |
| flightData, | |
| prerenderLegacyStore, | |
| ComponentMod, | |
| renderOpts, | |
| fallbackRouteParams | |
| ) | |
| } | |
| const getServerInsertedHTML = makeGetServerInsertedHTML({ | |
| polyfills, | |
| renderServerInsertedHTML, | |
| serverCapturedErrors: allCapturedErrors, | |
| basePath, | |
| tracingMetadata: tracingMetadata, | |
| }) | |
| return { | |
| digestErrorsMap: reactServerErrorsByDigest, | |
| ssrErrors: allCapturedErrors, | |
| stream: await continueFizzStream(htmlStream, { | |
| inlinedDataStream: createInlinedDataReadableStream( | |
| reactServerResult.consumeAsStream(), | |
| nonce, | |
| formState | |
| ), | |
| isStaticGeneration: true, | |
| isBuildTimePrerendering: | |
| ctx.workStore.isBuildTimePrerendering === true, | |
| buildId: ctx.workStore.buildId, | |
| getServerInsertedHTML, | |
| getServerInsertedMetadata, | |
| }), | |
| // TODO: Should this include the SSR pass? | |
| collectedRevalidate: prerenderLegacyStore.revalidate, | |
| collectedExpire: prerenderLegacyStore.expire, | |
| collectedStale: selectStaleTime(prerenderLegacyStore.stale), | |
| collectedTags: prerenderLegacyStore.tags, | |
| } | |
| } | |
| } catch (err) { | |
| if ( | |
| isStaticGenBailoutError(err) || | |
| (typeof err === 'object' && | |
| err !== null && | |
| 'message' in err && | |
| typeof err.message === 'string' && | |
| err.message.includes( | |
| 'https://nextjs.org/docs/advanced-features/static-html-export' | |
| )) | |
| ) { | |
| // Ensure that "next dev" prints the red error overlay | |
| throw err | |
| } | |
| // If this is a static generation error, we need to throw it so that it | |
| // can be handled by the caller if we're in static generation mode. | |
| if (isDynamicServerError(err)) { | |
| throw err | |
| } | |
| // If a bailout made it to this point, it means it wasn't wrapped inside | |
| // a suspense boundary. | |
| const shouldBailoutToCSR = isBailoutToCSRError(err) | |
| if (shouldBailoutToCSR) { | |
| const stack = getStackWithoutErrorMessage(err) | |
| error( | |
| `${err.reason} should be wrapped in a suspense boundary at page "${pagePath}". Read more: https://nextjs.org/docs/messages/missing-suspense-with-csr-bailout\n${stack}` | |
| ) | |
| throw err | |
| } | |
| // If we errored when we did not have an RSC stream to read from. This is | |
| // not just a render error, we need to throw early. | |
| if (reactServerPrerenderResult === null) { | |
| throw err | |
| } | |
| let errorType: MetadataErrorType | 'redirect' | undefined | |
| if (isHTTPAccessFallbackError(err)) { | |
| res.statusCode = getAccessFallbackHTTPStatus(err) | |
| metadata.statusCode = res.statusCode | |
| errorType = getAccessFallbackErrorTypeByStatus(res.statusCode) | |
| } else if (isRedirectError(err)) { | |
| errorType = 'redirect' | |
| res.statusCode = getRedirectStatusCodeFromError(err) | |
| metadata.statusCode = res.statusCode | |
| const redirectUrl = addPathPrefix(getURLFromRedirectError(err), basePath) | |
| setHeader('location', redirectUrl) | |
| } else if (!shouldBailoutToCSR) { | |
| res.statusCode = 500 | |
| metadata.statusCode = res.statusCode | |
| } | |
| const [errorPreinitScripts, errorBootstrapScript] = getRequiredScripts( | |
| buildManifest, | |
| assetPrefix, | |
| crossOrigin, | |
| subresourceIntegrityManifest, | |
| getAssetQueryString(ctx, false), | |
| nonce, | |
| '/_not-found/page' | |
| ) | |
| const prerenderLegacyStore: PrerenderStore = (prerenderStore = { | |
| type: 'prerender-legacy', | |
| phase: 'render', | |
| rootParams, | |
| implicitTags: implicitTags, | |
| revalidate: | |
| typeof prerenderStore?.revalidate !== 'undefined' | |
| ? prerenderStore.revalidate | |
| : INFINITE_CACHE, | |
| expire: | |
| typeof prerenderStore?.expire !== 'undefined' | |
| ? prerenderStore.expire | |
| : INFINITE_CACHE, | |
| stale: | |
| typeof prerenderStore?.stale !== 'undefined' | |
| ? prerenderStore.stale | |
| : INFINITE_CACHE, | |
| tags: [...(prerenderStore?.tags || implicitTags.tags)], | |
| }) | |
| const errorRSCPayload = await workUnitAsyncStorage.run( | |
| prerenderLegacyStore, | |
| getErrorRSCPayload, | |
| tree, | |
| ctx, | |
| reactServerErrorsByDigest.has((err as any).digest) ? undefined : err, | |
| errorType | |
| ) | |
| const errorServerStream = workUnitAsyncStorage.run( | |
| prerenderLegacyStore, | |
| ComponentMod.renderToReadableStream, | |
| errorRSCPayload, | |
| clientReferenceManifest.clientModules, | |
| { | |
| filterStackFrame, | |
| onError: serverComponentsErrorHandler, | |
| } | |
| ) | |
| try { | |
| // TODO we should use the same prerender semantics that we initially rendered | |
| // with in this case too. The only reason why this is ok atm is because it's essentially | |
| // an empty page and no user code runs. | |
| const fizzStream = await workUnitAsyncStorage.run( | |
| prerenderLegacyStore, | |
| renderToInitialFizzStream, | |
| { | |
| ReactDOMServer: | |
| require('react-dom/server') as typeof import('react-dom/server'), | |
| element: ( | |
| <ErrorApp | |
| reactServerStream={errorServerStream} | |
| ServerInsertedHTMLProvider={ServerInsertedHTMLProvider} | |
| preinitScripts={errorPreinitScripts} | |
| clientReferenceManifest={clientReferenceManifest} | |
| gracefullyDegrade={!!botType} | |
| nonce={nonce} | |
| /> | |
| ), | |
| streamOptions: { | |
| nonce, | |
| // Include hydration scripts in the HTML | |
| bootstrapScripts: [errorBootstrapScript], | |
| formState, | |
| }, | |
| } | |
| ) | |
| if (shouldGenerateStaticFlightData(workStore)) { | |
| const flightData = await streamToBuffer( | |
| reactServerPrerenderResult.asStream() | |
| ) | |
| metadata.flightData = flightData | |
| metadata.segmentData = await collectSegmentData( | |
| flightData, | |
| prerenderLegacyStore, | |
| ComponentMod, | |
| renderOpts, | |
| fallbackRouteParams | |
| ) | |
| } | |
| // This is intentionally using the readable datastream from the main | |
| // render rather than the flight data from the error page render | |
| const flightStream = reactServerPrerenderResult.consumeAsStream() | |
| return { | |
| // Returning the error that was thrown so it can be used to handle | |
| // the response in the caller. | |
| digestErrorsMap: reactServerErrorsByDigest, | |
| ssrErrors: allCapturedErrors, | |
| stream: await continueFizzStream(fizzStream, { | |
| inlinedDataStream: createInlinedDataReadableStream( | |
| flightStream, | |
| nonce, | |
| formState | |
| ), | |
| isStaticGeneration: true, | |
| isBuildTimePrerendering: | |
| ctx.workStore.isBuildTimePrerendering === true, | |
| buildId: ctx.workStore.buildId, | |
| getServerInsertedHTML: makeGetServerInsertedHTML({ | |
| polyfills, | |
| renderServerInsertedHTML, | |
| serverCapturedErrors: [], | |
| basePath, | |
| tracingMetadata: tracingMetadata, | |
| }), | |
| getServerInsertedMetadata, | |
| validateRootLayout: dev, | |
| }), | |
| dynamicAccess: null, | |
| collectedRevalidate: | |
| prerenderStore !== null ? prerenderStore.revalidate : INFINITE_CACHE, | |
| collectedExpire: | |
| prerenderStore !== null ? prerenderStore.expire : INFINITE_CACHE, | |
| collectedStale: selectStaleTime( | |
| prerenderStore !== null ? prerenderStore.stale : INFINITE_CACHE | |
| ), | |
| collectedTags: prerenderStore !== null ? prerenderStore.tags : null, | |
| } | |
| } catch (finalErr: any) { | |
| if ( | |
| process.env.NODE_ENV === 'development' && | |
| isHTTPAccessFallbackError(finalErr) | |
| ) { | |
| const { bailOnRootNotFound } = | |
| require('../../client/components/dev-root-http-access-fallback-boundary') as typeof import('../../client/components/dev-root-http-access-fallback-boundary') | |
| bailOnRootNotFound() | |
| } | |
| throw finalErr | |
| } | |
| } | |
| } | |
| const getGlobalErrorStyles = async ( | |
| tree: LoaderTree, | |
| ctx: AppRenderContext | |
| ): Promise<{ | |
| GlobalError: GlobalErrorComponent | |
| styles: React.ReactNode | undefined | |
| }> => { | |
| const { | |
| modules: { 'global-error': globalErrorModule }, | |
| } = parseLoaderTree(tree) | |
| const GlobalErrorComponent: GlobalErrorComponent = | |
| ctx.componentMod.GlobalError | |
| let globalErrorStyles | |
| if (globalErrorModule) { | |
| const [, styles] = await createComponentStylesAndScripts({ | |
| ctx, | |
| filePath: globalErrorModule[1], | |
| getComponent: globalErrorModule[0], | |
| injectedCSS: new Set(), | |
| injectedJS: new Set(), | |
| }) | |
| globalErrorStyles = styles | |
| } | |
| if (ctx.renderOpts.dev) { | |
| const dir = | |
| process.env.NEXT_RUNTIME === 'edge' | |
| ? process.env.__NEXT_EDGE_PROJECT_DIR! | |
| : ctx.renderOpts.dir || '' | |
| const globalErrorModulePath = normalizeConventionFilePath( | |
| dir, | |
| globalErrorModule?.[1] | |
| ) | |
| if (ctx.renderOpts.devtoolSegmentExplorer && globalErrorModulePath) { | |
| const SegmentViewNode = ctx.componentMod.SegmentViewNode | |
| globalErrorStyles = ( | |
| // This will be rendered next to GlobalError component under ErrorBoundary, | |
| // it requires a key to avoid React warning about duplicate keys. | |
| <SegmentViewNode | |
| key="ge-svn" | |
| type="global-error" | |
| pagePath={globalErrorModulePath} | |
| > | |
| {globalErrorStyles} | |
| </SegmentViewNode> | |
| ) | |
| } | |
| } | |
| return { | |
| GlobalError: GlobalErrorComponent, | |
| styles: globalErrorStyles, | |
| } | |
| } | |
| async function collectSegmentData( | |
| fullPageDataBuffer: Buffer, | |
| prerenderStore: PrerenderStore, | |
| ComponentMod: AppPageModule, | |
| renderOpts: RenderOpts, | |
| fallbackRouteParams: FallbackRouteParams | null | |
| ): Promise<Map<string, Buffer> | undefined> { | |
| // Per-segment prefetch data | |
| // | |
| // All of the segments for a page are generated simultaneously, including | |
| // during revalidations. This is to ensure consistency, because it's | |
| // possible for a mismatch between a layout and page segment can cause the | |
| // client to error during rendering. We want to preserve the ability of the | |
| // client to recover from such a mismatch by re-requesting all the segments | |
| // to get a consistent view of the page. | |
| // | |
| // For performance, we reuse the Flight output that was created when | |
| // generating the initial page HTML. The Flight stream for the whole page is | |
| // decomposed into a separate stream per segment. | |
| const clientReferenceManifest = renderOpts.clientReferenceManifest | |
| if ( | |
| !clientReferenceManifest || | |
| // Do not generate per-segment data unless the experimental Segment Cache | |
| // flag is enabled. | |
| // | |
| // We also skip generating segment data if flag is set to "client-only", | |
| // rather than true. (The "client-only" option only affects the behavior of | |
| // the client-side implementation; per-segment prefetches are intentionally | |
| // disabled in that configuration). | |
| renderOpts.experimental.clientSegmentCache !== true | |
| ) { | |
| return | |
| } | |
| // Manifest passed to the Flight client for reading the full-page Flight | |
| // stream. Based off similar code in use-cache-wrapper.ts. | |
| const isEdgeRuntime = process.env.NEXT_RUNTIME === 'edge' | |
| const serverConsumerManifest = { | |
| // moduleLoading must be null because we don't want to trigger preloads of ClientReferences | |
| // to be added to the consumer. Instead, we'll wait for any ClientReference to be emitted | |
| // which themselves will handle the preloading. | |
| moduleLoading: null, | |
| moduleMap: isEdgeRuntime | |
| ? clientReferenceManifest.edgeRscModuleMapping | |
| : clientReferenceManifest.rscModuleMapping, | |
| serverModuleMap: getServerModuleMap(), | |
| } | |
| const staleTime = prerenderStore.stale | |
| return await ComponentMod.collectSegmentData( | |
| fullPageDataBuffer, | |
| staleTime, | |
| clientReferenceManifest.clientModules as ManifestNode, | |
| serverConsumerManifest, | |
| fallbackRouteParams | |
| ) | |
| } | |