Unverified Commit cd7419e9 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Hoist the desired ReactDOM import expression (#36552)

* hoist `react-dom/server` imports to reduce module load time in nodejs
* simplify `reactRoot` detection condition by checking the streaming rendering API we're using. (if it doesn't existed, like react 17, then we won't enable `reactRoot`)
* Merge `__NEXT_CONCURRENT_FEATURES` into `__NEXT_REACT_ROOT` env var since they're identical now
parent 24445693
...@@ -42,6 +42,10 @@ const args = arg( ...@@ -42,6 +42,10 @@ const args = arg(
} }
) )
// Detect if react-dom is enabled streaming rendering mode
const shouldUseReactRoot = !!require('react-dom/server.browser')
.renderToReadableStream
// Version is inlined into the file using taskr build pipeline // Version is inlined into the file using taskr build pipeline
if (args['--version']) { if (args['--version']) {
console.log(`Next.js v${process.env.__NEXT_VERSION}`) console.log(`Next.js v${process.env.__NEXT_VERSION}`)
...@@ -105,6 +109,9 @@ if (process.env.NODE_ENV) { ...@@ -105,6 +109,9 @@ if (process.env.NODE_ENV) {
;(process.env as any).NODE_ENV = process.env.NODE_ENV || defaultEnv ;(process.env as any).NODE_ENV = process.env.NODE_ENV || defaultEnv
;(process.env as any).NEXT_RUNTIME = 'nodejs' ;(process.env as any).NEXT_RUNTIME = 'nodejs'
if (shouldUseReactRoot) {
;(process.env as any).__NEXT_REACT_ROOT = 'true'
}
// x-ref: https://github.com/vercel/next.js/pull/34688#issuecomment-1047994505 // x-ref: https://github.com/vercel/next.js/pull/34688#issuecomment-1047994505
if (process.versions.pnp === '3') { if (process.versions.pnp === '3') {
......
import type { webpack5 as webpack } from 'next/dist/compiled/webpack/webpack'
import { loadEnvConfig } from '@next/env' import { loadEnvConfig } from '@next/env'
import chalk from 'next/dist/compiled/chalk' import chalk from 'next/dist/compiled/chalk'
import crypto from 'crypto' import crypto from 'crypto'
...@@ -109,9 +110,7 @@ import { NextConfigComplete } from '../server/config-shared' ...@@ -109,9 +110,7 @@ import { NextConfigComplete } from '../server/config-shared'
import isError, { NextError } from '../lib/is-error' import isError, { NextError } from '../lib/is-error'
import { TelemetryPlugin } from './webpack/plugins/telemetry-plugin' import { TelemetryPlugin } from './webpack/plugins/telemetry-plugin'
import { MiddlewareManifest } from './webpack/plugins/middleware-plugin' import { MiddlewareManifest } from './webpack/plugins/middleware-plugin'
import type { webpack5 as webpack } from 'next/dist/compiled/webpack/webpack'
import { recursiveCopy } from '../lib/recursive-copy' import { recursiveCopy } from '../lib/recursive-copy'
import { shouldUseReactRoot } from '../server/config'
import { recursiveReadDir } from '../lib/recursive-readdir' import { recursiveReadDir } from '../lib/recursive-readdir'
import { lockfilePatchPromise } from './swc' import { lockfilePatchPromise } from './swc'
...@@ -164,7 +163,7 @@ export default async function build( ...@@ -164,7 +163,7 @@ export default async function build(
// We enable concurrent features (Fizz-related rendering architecture) when // We enable concurrent features (Fizz-related rendering architecture) when
// using React 18 or experimental. // using React 18 or experimental.
const hasReactRoot = shouldUseReactRoot() const hasReactRoot = !!process.env.__NEXT_REACT_ROOT
const hasConcurrentFeatures = hasReactRoot const hasConcurrentFeatures = hasReactRoot
const hasServerComponents = const hasServerComponents =
hasReactRoot && !!config.experimental.serverComponents hasReactRoot && !!config.experimental.serverComponents
......
...@@ -1399,9 +1399,6 @@ export default async function getBaseWebpackConfig( ...@@ -1399,9 +1399,6 @@ export default async function getBaseWebpackConfig(
config.reactStrictMode config.reactStrictMode
), ),
'process.env.__NEXT_REACT_ROOT': JSON.stringify(hasReactRoot), 'process.env.__NEXT_REACT_ROOT': JSON.stringify(hasReactRoot),
'process.env.__NEXT_CONCURRENT_FEATURES': JSON.stringify(
hasConcurrentFeatures
),
'process.env.__NEXT_RSC': JSON.stringify(hasServerComponents), 'process.env.__NEXT_RSC': JSON.stringify(hasServerComponents),
'process.env.__NEXT_OPTIMIZE_FONTS': JSON.stringify( 'process.env.__NEXT_OPTIMIZE_FONTS': JSON.stringify(
config.optimizeFonts && !dev config.optimizeFonts && !dev
......
...@@ -2,7 +2,6 @@ import { basename, extname, relative, isAbsolute, resolve } from 'path' ...@@ -2,7 +2,6 @@ import { basename, extname, relative, isAbsolute, resolve } from 'path'
import { pathToFileURL } from 'url' import { pathToFileURL } from 'url'
import { Agent as HttpAgent } from 'http' import { Agent as HttpAgent } from 'http'
import { Agent as HttpsAgent } from 'https' import { Agent as HttpsAgent } from 'https'
import semver from 'next/dist/compiled/semver'
import findUp from 'next/dist/compiled/find-up' import findUp from 'next/dist/compiled/find-up'
import chalk from '../lib/chalk' import chalk from '../lib/chalk'
import * as Log from '../build/output/log' import * as Log from '../build/output/log'
...@@ -188,7 +187,7 @@ function assignDefaults(userConfig: { [key: string]: any }) { ...@@ -188,7 +187,7 @@ function assignDefaults(userConfig: { [key: string]: any }) {
} }
} }
const hasReactRoot = shouldUseReactRoot() const hasReactRoot = process.env.__NEXT_REACT_ROOT
if (hasReactRoot) { if (hasReactRoot) {
// users might not have the `experimental` key in their config // users might not have the `experimental` key in their config
result.experimental = result.experimental || {} result.experimental = result.experimental || {}
...@@ -753,19 +752,6 @@ export default async function loadConfig( ...@@ -753,19 +752,6 @@ export default async function loadConfig(
return completeConfig return completeConfig
} }
export const shouldUseReactRoot = execOnce(() => {
const reactDomVersion = require('react-dom').version
const isReactExperimental = Boolean(
reactDomVersion && /0\.0\.0-experimental/.test(reactDomVersion)
)
const hasReact18: boolean =
Boolean(reactDomVersion) &&
(semver.gte(reactDomVersion!, '18.0.0') ||
semver.coerce(reactDomVersion)?.version === '18.0.0')
return hasReact18 || isReactExperimental
})
export function setHttpAgentOptions( export function setHttpAgentOptions(
options: NextConfigComplete['httpAgentOptions'] options: NextConfigComplete['httpAgentOptions']
) { ) {
......
...@@ -38,7 +38,6 @@ import { getProperError } from '../../lib/is-error' ...@@ -38,7 +38,6 @@ import { getProperError } from '../../lib/is-error'
import ws from 'next/dist/compiled/ws' import ws from 'next/dist/compiled/ws'
import { promises as fs } from 'fs' import { promises as fs } from 'fs'
import { getPageRuntime } from '../../build/entries' import { getPageRuntime } from '../../build/entries'
import { shouldUseReactRoot } from '../config'
const wsServer = new ws.Server({ noServer: true }) const wsServer = new ws.Server({ noServer: true })
...@@ -199,7 +198,7 @@ export default class HotReloader { ...@@ -199,7 +198,7 @@ export default class HotReloader {
this.config = config this.config = config
this.runtime = config.experimental.runtime this.runtime = config.experimental.runtime
this.hasReactRoot = shouldUseReactRoot() this.hasReactRoot = !!process.env.__NEXT_REACT_ROOT
this.hasServerComponents = this.hasServerComponents =
this.hasReactRoot && !!config.experimental.serverComponents this.hasReactRoot && !!config.experimental.serverComponents
this.previewProps = previewProps this.previewProps = previewProps
......
...@@ -132,18 +132,18 @@ export function createFlushEffectStream( ...@@ -132,18 +132,18 @@ export function createFlushEffectStream(
}) })
} }
export async function renderToInitialStream({ export function renderToInitialStream({
ReactDOMServer, ReactDOMServer,
element, element,
}: { }: {
ReactDOMServer: typeof import('react-dom/server') ReactDOMServer: any
element: React.ReactElement element: React.ReactElement
}): Promise< }): Promise<
ReadableStream<Uint8Array> & { ReadableStream<Uint8Array> & {
allReady?: Promise<void> allReady?: Promise<void>
} }
> { > {
return await (ReactDOMServer as any).renderToReadableStream(element) return ReactDOMServer.renderToReadableStream(element)
} }
export async function continueFromInitialStream({ export async function continueFromInitialStream({
......
...@@ -88,6 +88,9 @@ let warn: typeof import('../build/output/log').warn ...@@ -88,6 +88,9 @@ let warn: typeof import('../build/output/log').warn
let postProcess: typeof import('../shared/lib/post-process').default let postProcess: typeof import('../shared/lib/post-process').default
const DOCTYPE = '<!DOCTYPE html>' const DOCTYPE = '<!DOCTYPE html>'
const ReactDOMServer = process.env.__NEXT_REACT_ROOT
? require('react-dom/server.browser')
: require('react-dom/server')
if (process.env.NEXT_RUNTIME !== 'edge') { if (process.env.NEXT_RUNTIME !== 'edge') {
require('./node-polyfill-web-streams') require('./node-polyfill-web-streams')
...@@ -486,20 +489,17 @@ export async function renderToHTML( ...@@ -486,20 +489,17 @@ export async function renderToHTML(
devOnlyCacheBusterQueryString, devOnlyCacheBusterQueryString,
supportsDynamicHTML, supportsDynamicHTML,
images, images,
reactRoot,
runtime: globalRuntime, runtime: globalRuntime,
ComponentMod, ComponentMod,
AppMod, AppMod,
AppServerMod, AppServerMod,
} = renderOpts } = renderOpts
const hasConcurrentFeatures = reactRoot
let Document = renderOpts.Document let Document = renderOpts.Document
// We don't need to opt-into the flight inlining logic if the page isn't a RSC. // We don't need to opt-into the flight inlining logic if the page isn't a RSC.
const isServerComponent = const isServerComponent =
hasConcurrentFeatures && !!process.env.__NEXT_REACT_ROOT &&
!!serverComponentManifest && !!serverComponentManifest &&
!!ComponentMod.__next_rsc__?.server !!ComponentMod.__next_rsc__?.server
...@@ -1292,10 +1292,6 @@ export async function renderToHTML( ...@@ -1292,10 +1292,6 @@ export async function renderToHTML(
return inAmpMode ? children : <div id="__next">{children}</div> return inAmpMode ? children : <div id="__next">{children}</div>
} }
const ReactDOMServer = hasConcurrentFeatures
? require('react-dom/server.browser')
: require('react-dom/server')
/** /**
* Rules of Static & Dynamic HTML: * Rules of Static & Dynamic HTML:
* *
...@@ -1436,7 +1432,7 @@ export async function renderToHTML( ...@@ -1436,7 +1432,7 @@ export async function renderToHTML(
) )
} }
if (!hasConcurrentFeatures) { if (!process.env.__NEXT_REACT_ROOT) {
if (Document.getInitialProps) { if (Document.getInitialProps) {
const documentInitialPropsRes = await documentInitialProps() const documentInitialPropsRes = await documentInitialProps()
if (documentInitialPropsRes === null) return null if (documentInitialPropsRes === null) return null
...@@ -1543,7 +1539,8 @@ export async function renderToHTML( ...@@ -1543,7 +1539,8 @@ export async function renderToHTML(
renderStream, renderStream,
suffix, suffix,
dataStream: serverComponentsInlinedTransformStream?.readable, dataStream: serverComponentsInlinedTransformStream?.readable,
generateStaticHTML: generateStaticHTML || !hasConcurrentFeatures, generateStaticHTML:
generateStaticHTML || !process.env.__NEXT_REACT_ROOT,
flushEffectHandler, flushEffectHandler,
}) })
} }
......
...@@ -118,7 +118,7 @@ export default function dynamic<P = {}>( ...@@ -118,7 +118,7 @@ export default function dynamic<P = {}>(
loader: Loader<P> loader: Loader<P>
} }
// Error if Fizz rendering is not enabled and `suspense` option is set to true // Error if Fizz rendering is not enabled and `suspense` option is set to true
if (!process.env.__NEXT_CONCURRENT_FEATURES && suspenseOptions.suspense) { if (!process.env.__NEXT_REACT_ROOT && suspenseOptions.suspense) {
throw new Error( throw new Error(
`Invalid suspense option usage in next/dynamic. Read more: https://nextjs.org/docs/messages/invalid-dynamic-suspense` `Invalid suspense option usage in next/dynamic. Read more: https://nextjs.org/docs/messages/invalid-dynamic-suspense`
) )
......
...@@ -164,7 +164,7 @@ function reduceComponents( ...@@ -164,7 +164,7 @@ function reduceComponents(
} }
if ( if (
process.env.NODE_ENV === 'development' && process.env.NODE_ENV === 'development' &&
process.env.__NEXT_CONCURRENT_FEATURES process.env.__NEXT_REACT_ROOT
) { ) {
// omit JSON-LD structured data snippets from the warning // omit JSON-LD structured data snippets from the warning
if (c.type === 'script' && c.props['type'] !== 'application/ld+json') { if (c.type === 'script' && c.props['type'] !== 'application/ld+json') {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment