Unverified Commit c5972721 authored by Tim Neutkens's avatar Tim Neutkens Committed by GitHub

feat(node-streams): add config flag, define-env, and env precedence test (#90427)

## What?

Split out these changes from #89859. Only adds more plumbing for future
Node.js streams feature.
parent 58fb9635
......@@ -123,6 +123,7 @@ export function getDefineEnv({
const isPPREnabled = checkIsAppPPREnabled(config.experimental.ppr)
const isCacheComponentsEnabled = !!config.cacheComponents
const isUseCacheEnabled = !!config.experimental.useCache
const isUseNodeStreamsEnabled = !!config.experimental.useNodeStreams
const defineEnv: DefineEnv = {
// internal field to identify the plugin config
......@@ -178,6 +179,9 @@ export function getDefineEnv({
'process.env.__NEXT_INSTANT_NAV_TOGGLE':
!!config.experimental.instantNavigationDevToolsToggle,
'process.env.__NEXT_USE_CACHE': isUseCacheEnabled,
'process.env.__NEXT_USE_NODE_STREAMS': isEdgeServer
? false
: isUseNodeStreamsEnabled,
'process.env.NEXT_IMMUTABLE_ASSET_TOKEN':
config.experimental.immutableAssetToken || '',
......
......@@ -60,6 +60,7 @@ export interface ExportPageInput {
debugOutput?: boolean
nextConfigOutput?: NextConfigComplete['output']
enableExperimentalReact?: boolean
enableNodeStreams?: boolean
sriEnabled: boolean
renderResumeDataCache: RenderResumeDataCache | undefined
}
......
......@@ -82,6 +82,7 @@ async function exportPageImpl(
disableOptimizedLoading,
debugOutput = false,
enableExperimentalReact,
enableNodeStreams,
trailingSlash,
sriEnabled,
renderOpts: commonRenderOpts,
......@@ -95,6 +96,9 @@ async function exportPageImpl(
if (enableExperimentalReact) {
process.env.__NEXT_EXPERIMENTAL_REACT = 'true'
}
if (enableNodeStreams) {
process.env.__NEXT_USE_NODE_STREAMS = 'true'
}
const {
path,
......@@ -432,6 +436,7 @@ export async function exportPages(
httpAgentOptions: nextConfig.httpAgentOptions,
debugOutput: options.debugOutput,
enableExperimentalReact: needsExperimentalReact(nextConfig),
enableNodeStreams: !!nextConfig.experimental.useNodeStreams,
sriEnabled: Boolean(nextConfig.experimental.sri?.algorithm),
buildId: input.buildId,
deploymentId: input.deploymentId,
......
......@@ -10,6 +10,34 @@ export {
// eslint-disable-next-line import/no-extraneous-dependencies
export { prerender } from 'react-server-dom-webpack/static'
// Node.js-specific Flight APIs, needed by stream-ops.node.ts via ComponentMod.
// These must be exported from entry-base (react-server layer) because direct
// imports from react-server-dom-webpack/* fail outside this layer.
type FlightRenderToPipeableStream = (...args: any[]) => {
pipe<Writable extends NodeJS.WritableStream>(destination: Writable): Writable
abort: (reason?: unknown) => void
}
type FlightPrerenderToNodeStream = (...args: any[]) => Promise<{
prelude: import('node:stream').Readable
}>
/* eslint-disable import/no-extraneous-dependencies */
export let renderToPipeableStream: FlightRenderToPipeableStream | undefined
export let prerenderToNodeStream: FlightPrerenderToNodeStream | undefined
if (process.env.__NEXT_USE_NODE_STREAMS) {
renderToPipeableStream = (
require('react-server-dom-webpack/server.node') as typeof import('react-server-dom-webpack/server.node')
).renderToPipeableStream
prerenderToNodeStream = (
require('react-server-dom-webpack/static') as typeof import('react-server-dom-webpack/static')
).prerenderToNodeStream
} else {
renderToPipeableStream = undefined
prerenderToNodeStream = undefined
}
/* eslint-enable import/no-extraneous-dependencies */
// TODO: Just re-export `* as ReactServer`
export { captureOwnerStack, createElement, Fragment } from 'react'
......
......@@ -381,6 +381,7 @@ export const experimentalSchema = {
serverComponentsHmrCache: z.boolean().optional(),
authInterrupts: z.boolean().optional(),
useCache: z.boolean().optional(),
useNodeStreams: z.boolean().optional(),
slowModuleDetection: z
.object({
buildTimeThresholdMs: z.number().int(),
......
......@@ -916,6 +916,13 @@ export interface ExperimentalConfig {
*/
useCache?: boolean
/**
* Use Node.js native streams instead of web streams for the App Router
* rendering pipeline on the Node.js runtime. This can improve performance
* by avoiding the overhead of web stream wrappers.
*/
useNodeStreams?: boolean
/**
* Enables detection and reporting of slow modules during development builds.
* Enabling this may impact build performance to ensure accurate measurements.
......@@ -1907,6 +1914,7 @@ export interface NextConfigRuntime {
| 'partialFallbacks'
| 'exposeTestingApiInProductionBuild'
| 'immutableAssetToken'
| 'useNodeStreams'
> & {
// Pick on @internal fields generates invalid .d.ts files
/** @internal */
......@@ -1973,6 +1981,7 @@ export function getNextConfigRuntime(
partialFallbacks: ex.partialFallbacks,
exposeTestingApiInProductionBuild: ex.exposeTestingApiInProductionBuild,
immutableAssetToken: ex.immutableAssetToken,
useNodeStreams: ex.useNodeStreams,
trustHostHeader: ex.trustHostHeader,
isExperimentalCompile: ex.isExperimentalCompile,
......
......@@ -2020,6 +2020,25 @@ function enforceExperimentalFeatures(
}
}
// Enable node streams via env var (for CI testing).
if (
process.env.__NEXT_USE_NODE_STREAMS === 'true' &&
(config.experimental.useNodeStreams === undefined ||
(isDefaultConfig && !config.experimental.useNodeStreams))
) {
config.experimental.useNodeStreams = true
}
// Keep runtime bundle selection env in sync with the resolved config.
// Explicit user config (e.g. useNodeStreams: false) should win over an
// inherited shell env var to avoid selecting nodestream runtime bundles
// while define-env compiled user bundles with node streams disabled.
if (config.experimental.useNodeStreams) {
process.env.__NEXT_USE_NODE_STREAMS = 'true'
} else {
delete process.env.__NEXT_USE_NODE_STREAMS
}
// TODO: Remove this once strictRouteTypes is the default.
if (
process.env.__NEXT_EXPERIMENTAL_STRICT_ROUTE_TYPES === 'true' &&
......
......@@ -222,6 +222,9 @@ export default class NextNodeServer extends BaseServer<
if (this.renderOpts.nextScriptWorkers) {
process.env.__NEXT_SCRIPT_WORKERS = JSON.stringify(true)
}
if (this.nextConfig.experimental.useNodeStreams) {
process.env.__NEXT_USE_NODE_STREAMS = 'true'
}
if (!this.minimalMode) {
this.imageResponseCache = new ResponseCache(this.minimalMode)
......
......@@ -225,6 +225,35 @@ declare module 'react-server-dom-webpack/server.node' {
renderToReadableStream,
} from 'react-server-dom-webpack/server.edge'
export function renderToPipeableStream(
model: any,
webpackMap: import('react-server-dom-webpack/server.edge').ClientManifest,
options?: {
temporaryReferences?: import('react-server-dom-webpack/server.edge').TemporaryReferenceSet
environmentName?: string | (() => string)
filterStackFrame:
| ((
url: string,
functionName: string,
lineNumber: number,
columnNumber: number
) => boolean)
| undefined
onError?: (error: unknown) => void
signal?: AbortSignal
// React's Node API expects debugChannel to be a Node.js Writable
// (has .write()), Duplex (has .read()), or WebSocket (has .send()).
// This differs from the web API which expects { readable?, writable? }.
debugChannel?: import('node:stream').Writable
startTime?: number
}
): {
pipe<Writable extends NodeJS.WritableStream>(
destination: Writable
): Writable
abort(reason?: unknown): void
}
export type TemporaryReferenceSet = WeakMap<any, string>
export type ImportManifestEntry = {
......@@ -307,6 +336,35 @@ declare module 'react-server-dom-webpack/static' {
): Promise<{
prelude: ReadableStream<Uint8Array>
}>
export function prerenderToNodeStream(
children: any,
webpackMap: {
readonly [id: string]: {
readonly id: string | number
readonly chunks: ReadonlyArray<string>
readonly name: string
readonly async?: boolean
}
},
options?: {
environmentName?: string | (() => string)
filterStackFrame:
| ((
url: string,
functionName: string,
lineNumber: number,
columnNumber: number
) => boolean)
| undefined
identifierPrefix?: string
signal?: AbortSignal
temporaryReferences?: TemporaryReferenceSet
onError?: (error: unknown) => void
}
): Promise<{
prelude: import('node:stream').Readable
}>
}
declare module 'react-server-dom-webpack/client.edge' {
export interface Options {
......
export default function RootLayout({ children }) {
return (
<html>
<body>{children}</body>
</html>
)
}
export default function Page() {
return <p>env precedence fixture</p>
}
/** @type {import('next').NextConfig} */
const nextConfig = {
experimental: {
useNodeStreams: false,
},
}
module.exports = nextConfig
import { nextTestSetup } from 'e2e-utils'
describe('use-node-streams env precedence', () => {
const { next, isNextDev, skipped } = nextTestSetup({
files: __dirname,
skipDeployment: true,
skipStart: true,
env: {
__NEXT_USE_NODE_STREAMS: 'true',
},
})
if (isNextDev || skipped) {
it.skip('only testable in start mode', () => {})
return
}
it('should respect explicit useNodeStreams=false even when env flag is true', async () => {
const { exitCode, cliOutput } = await next.build()
expect(exitCode).toBe(0)
expect(cliOutput).toContain('useNodeStreams')
}, 30_000)
})
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