Commit a81ecd38 authored by Josh Story's avatar Josh Story

Centralize node environment setup and config-dependent global behaviors

Node environment extensions (AsyncLocalStorage polyfill, console patching, error formatting, etc.) were imported inconsistently — some entry points loaded them explicitly, others relied on transitive imports through downstream modules. This makes it unclear which processes have the environment set up and creates fragile ordering dependencies.

This adds `import node-environment` to every process entry point that runs Next.js server, rendering, or build code. The import is idempotent so redundancy with existing transitive imports is harmless.

`loadConfig` is renamed to `loadConfigFromFile` and now calls `installGlobalBehaviors` internally via lazy require, so consumers don't need to call it separately. `loadConfigForBuildWorker` does the same for workers that receive config via IPC. Direct `installGlobalBehaviors` calls are removed from `NextNodeServer` and `export/worker.ts`.

Process entry points with `import node-environment`:
  - `bin/next.ts` — CLI dispatcher, entry for all `next` commands
  - `server/lib/start-server.ts` — forked child process for `next dev`
  - `server/lib/router-server.ts` — router server (was already there)
  - `server/dev/static-paths-worker.ts` — runs `generateStaticParams` in isolated process (was already there)
  - `export/worker.ts` — renders pages for static export (was already there)
  - `build/worker.ts` — build worker, re-exports rendering from export/worker
  - `build/collect-build-traces.ts` — file dependency tracing worker
  - `build/webpack-build/impl.ts` — webpack compilation worker
  - `build/turbopack-build/impl.ts` — turbopack compilation worker
  - `telemetry/detached-flush.ts` — detached telemetry flush process

Process entry points without `import node-environment`:
  - `trace/trace-uploader.ts` — uploads trace files, doesn't load config or run server code
  - `lib/verify-typescript-setup.ts` — runs tsc, doesn't load config or run server code
parent ccee817b
#!/usr/bin/env node #!/usr/bin/env node
import '../server/node-environment'
import '../server/require-hook' import '../server/require-hook'
import { import {
......
import '../server/node-environment'
// Import cpu-profile to start profiling early if enabled // Import cpu-profile to start profiling early if enabled
import '../server/lib/cpu-profile' import '../server/lib/cpu-profile'
import { Span } from '../trace' import { Span } from '../trace'
......
import '../../server/node-environment'
// Import cpu-profile first to start profiling early if enabled // Import cpu-profile first to start profiling early if enabled
import { saveCpuProfile } from '../../server/lib/cpu-profile' import { saveCpuProfile } from '../../server/lib/cpu-profile'
import path from 'path' import path from 'path'
......
import '../../server/node-environment'
// Import cpu-profile first to start profiling early if enabled // Import cpu-profile first to start profiling early if enabled
import { saveCpuProfile } from '../../server/lib/cpu-profile' import { saveCpuProfile } from '../../server/lib/cpu-profile'
import type { webpack } from 'next/dist/compiled/webpack/webpack' import type { webpack } from 'next/dist/compiled/webpack/webpack'
......
import '../server/node-environment'
import '../server/require-hook' import '../server/require-hook'
// Import cpu-profile to start profiling early if enabled // Import cpu-profile to start profiling early if enabled
import '../server/lib/cpu-profile' import '../server/lib/cpu-profile'
......
...@@ -53,7 +53,7 @@ import type { PagesRenderContext, PagesSharedContext } from '../server/render' ...@@ -53,7 +53,7 @@ import type { PagesRenderContext, PagesSharedContext } from '../server/render'
import type { AppSharedContext } from '../server/app-render/app-render' import type { AppSharedContext } from '../server/app-render/app-render'
import { MultiFileWriter } from '../lib/multi-file-writer' import { MultiFileWriter } from '../lib/multi-file-writer'
import { createRenderResumeDataCache } from '../server/resume-data-cache/resume-data-cache' import { createRenderResumeDataCache } from '../server/resume-data-cache/resume-data-cache'
import { installGlobalBehaviors } from '../server/node-environment-extensions/global-behaviors' import { loadConfigForBuildWorker } from '../server/config'
;(globalThis as any).__NEXT_DATA__ = { ;(globalThis as any).__NEXT_DATA__ = {
nextExport: true, nextExport: true,
} }
...@@ -345,7 +345,7 @@ export async function exportPages( ...@@ -345,7 +345,7 @@ export async function exportPages(
renderResumeDataCachesByPage = {}, renderResumeDataCachesByPage = {},
} = input } = input
installGlobalBehaviors(nextConfig) loadConfigForBuildWorker(nextConfig)
if (nextConfig.enablePrerenderSourceMaps) { if (nextConfig.enablePrerenderSourceMaps) {
try { try {
......
...@@ -1480,23 +1480,49 @@ type LoadConfigOptions = { ...@@ -1480,23 +1480,49 @@ type LoadConfigOptions = {
debugPrerender?: boolean debugPrerender?: boolean
} }
export default async function loadConfig( export default async function loadConfigFromFile(
phase: typeof PHASE_DEVELOPMENT_SERVER, phase: typeof PHASE_DEVELOPMENT_SERVER,
dir: string, dir: string,
opts?: LoadConfigOptions opts?: LoadConfigOptions
): Promise<NextConfigComplete> ): Promise<NextConfigComplete>
export default async function loadConfig( export default async function loadConfigFromFile(
phase: typeof PHASE_PRODUCTION_SERVER | typeof PHASE_DEVELOPMENT_SERVER, phase: typeof PHASE_PRODUCTION_SERVER | typeof PHASE_DEVELOPMENT_SERVER,
dir: string, dir: string,
opts?: LoadConfigOptions opts?: LoadConfigOptions
): Promise<NextConfigRuntime | NextConfigComplete> ): Promise<NextConfigRuntime | NextConfigComplete>
export default async function loadConfig( export default async function loadConfigFromFile(
phase: PHASE_TYPE, phase: PHASE_TYPE,
dir: string, dir: string,
opts?: LoadConfigOptions opts?: LoadConfigOptions
): Promise<NextConfigComplete> ): Promise<NextConfigComplete>
export default async function loadConfig( export default async function loadConfigFromFile(
phase: PHASE_TYPE,
dir: string,
opts: LoadConfigOptions = {}
): Promise<NextConfigComplete> {
const config = await loadConfigImpl(phase, dir, opts)
const { installGlobalBehaviors } =
require('./node-environment-extensions/global-behaviors') as typeof import('./node-environment-extensions/global-behaviors')
installGlobalBehaviors(config)
return config
}
/**
* Initialize global behaviors from a pre-resolved config received via IPC
* in a build worker process. The parent process already loaded and serialized
* the config — this sets up the worker's globals.
*/
export function loadConfigForBuildWorker(
config: NextConfigComplete
): NextConfigComplete {
const { installGlobalBehaviors } =
require('./node-environment-extensions/global-behaviors') as typeof import('./node-environment-extensions/global-behaviors')
installGlobalBehaviors(config)
return config
}
async function loadConfigImpl(
phase: PHASE_TYPE, phase: PHASE_TYPE,
dir: string, dir: string,
{ {
......
import '../node-environment'
// Start CPU profile if it wasn't already started. // Start CPU profile if it wasn't already started.
import './cpu-profile' import './cpu-profile'
import { getNetworkHost } from '../../lib/get-network-host' import { getNetworkHost } from '../../lib/get-network-host'
......
import './node-environment'
import './require-hook' import './require-hook'
import './node-polyfill-crypto' import './node-polyfill-crypto'
...@@ -128,7 +127,6 @@ import { ...@@ -128,7 +127,6 @@ import {
RouterServerContextSymbol, RouterServerContextSymbol,
routerServerGlobal, routerServerGlobal,
} from './lib/router-utils/router-server-context' } from './lib/router-utils/router-server-context'
import { installGlobalBehaviors } from './node-environment-extensions/global-behaviors'
import { installProcessErrorHandlers } from './node-environment-extensions/process-error-handlers' import { installProcessErrorHandlers } from './node-environment-extensions/process-error-handlers'
export * from './base-server' export * from './base-server'
...@@ -199,8 +197,6 @@ export default class NextNodeServer extends BaseServer< ...@@ -199,8 +197,6 @@ export default class NextNodeServer extends BaseServer<
// Initialize super class // Initialize super class
super(options) super(options)
installGlobalBehaviors(this.nextConfig)
const isDev = options.dev ?? false const isDev = options.dev ?? false
this.isDev = isDev this.isDev = isDev
this.sriEnabled = Boolean(options.conf.experimental?.sri?.algorithm) this.sriEnabled = Boolean(options.conf.experimental?.sri?.algorithm)
......
import '../server/node-environment'
import fs from 'fs' import fs from 'fs'
import path from 'path' import path from 'path'
import type { TelemetryEvent } from './storage' import type { TelemetryEvent } from './storage'
......
...@@ -444,12 +444,7 @@ async function readNormalizedNFT(next, name) { ...@@ -444,12 +444,7 @@ async function readNormalizedNFT(next, name) {
"/node_modules/client-only/index.js", "/node_modules/client-only/index.js",
"/node_modules/next/dist/client/components/app-router-headers.js", "/node_modules/next/dist/client/components/app-router-headers.js",
"/node_modules/next/dist/compiled/@opentelemetry/api/index.js", "/node_modules/next/dist/compiled/@opentelemetry/api/index.js",
"/node_modules/next/dist/compiled/babel-code-frame/index.js",
"/node_modules/next/dist/compiled/babel/code-frame.js",
"/node_modules/next/dist/compiled/next-server/server.runtime.prod.js", "/node_modules/next/dist/compiled/next-server/server.runtime.prod.js",
"/node_modules/next/dist/compiled/source-map/source-map.js",
"/node_modules/next/dist/compiled/stacktrace-parser/stack-trace-parser.cjs.js",
"/node_modules/next/dist/compiled/ws/index.js",
"/node_modules/next/dist/experimental/testmode/context.js", "/node_modules/next/dist/experimental/testmode/context.js",
"/node_modules/next/dist/experimental/testmode/fetch.js", "/node_modules/next/dist/experimental/testmode/fetch.js",
"/node_modules/next/dist/experimental/testmode/server-edge.js", "/node_modules/next/dist/experimental/testmode/server-edge.js",
...@@ -457,12 +452,9 @@ async function readNormalizedNFT(next, name) { ...@@ -457,12 +452,9 @@ async function readNormalizedNFT(next, name) {
"/node_modules/next/dist/lib/constants.js", "/node_modules/next/dist/lib/constants.js",
"/node_modules/next/dist/lib/interop-default.js", "/node_modules/next/dist/lib/interop-default.js",
"/node_modules/next/dist/lib/is-error.js", "/node_modules/next/dist/lib/is-error.js",
"/node_modules/next/dist/lib/picocolors.js",
"/node_modules/next/dist/server/app-render/after-task-async-storage-instance.js", "/node_modules/next/dist/server/app-render/after-task-async-storage-instance.js",
"/node_modules/next/dist/server/app-render/after-task-async-storage.external.js", "/node_modules/next/dist/server/app-render/after-task-async-storage.external.js",
"/node_modules/next/dist/server/app-render/async-local-storage.js", "/node_modules/next/dist/server/app-render/async-local-storage.js",
"/node_modules/next/dist/server/app-render/console-async-storage-instance.js",
"/node_modules/next/dist/server/app-render/console-async-storage.external.js",
"/node_modules/next/dist/server/app-render/staged-rendering.js", "/node_modules/next/dist/server/app-render/staged-rendering.js",
"/node_modules/next/dist/server/app-render/work-async-storage-instance.js", "/node_modules/next/dist/server/app-render/work-async-storage-instance.js",
"/node_modules/next/dist/server/app-render/work-async-storage.external.js", "/node_modules/next/dist/server/app-render/work-async-storage.external.js",
...@@ -477,9 +469,6 @@ async function readNormalizedNFT(next, name) { ...@@ -477,9 +469,6 @@ async function readNormalizedNFT(next, name) {
"/node_modules/next/dist/server/lib/trace/constants.js", "/node_modules/next/dist/server/lib/trace/constants.js",
"/node_modules/next/dist/server/lib/trace/tracer.js", "/node_modules/next/dist/server/lib/trace/tracer.js",
"/node_modules/next/dist/server/load-manifest.external.js", "/node_modules/next/dist/server/load-manifest.external.js",
"/node_modules/next/dist/server/node-environment-extensions/console-dim.external.js",
"/node_modules/next/dist/server/node-environment-extensions/fast-set-immediate.external.js",
"/node_modules/next/dist/server/node-environment-extensions/unhandled-rejection.external.js",
"/node_modules/next/dist/server/response-cache/types.js", "/node_modules/next/dist/server/response-cache/types.js",
"/node_modules/next/dist/server/route-modules/app-page/module.compiled.js", "/node_modules/next/dist/server/route-modules/app-page/module.compiled.js",
"/node_modules/next/dist/server/route-modules/app-page/vendored/contexts/app-router-context.js", "/node_modules/next/dist/server/route-modules/app-page/vendored/contexts/app-router-context.js",
...@@ -500,7 +489,6 @@ async function readNormalizedNFT(next, name) { ...@@ -500,7 +489,6 @@ async function readNormalizedNFT(next, name) {
"/node_modules/next/dist/server/route-modules/pages/vendored/contexts/loadable.js", "/node_modules/next/dist/server/route-modules/pages/vendored/contexts/loadable.js",
"/node_modules/next/dist/server/route-modules/pages/vendored/contexts/router-context.js", "/node_modules/next/dist/server/route-modules/pages/vendored/contexts/router-context.js",
"/node_modules/next/dist/server/route-modules/pages/vendored/contexts/server-inserted-html.js", "/node_modules/next/dist/server/route-modules/pages/vendored/contexts/server-inserted-html.js",
"/node_modules/next/dist/server/runtime-reacts.external.js",
"/node_modules/next/dist/shared/lib/deep-freeze.js", "/node_modules/next/dist/shared/lib/deep-freeze.js",
"/node_modules/next/dist/shared/lib/invariant-error.js", "/node_modules/next/dist/shared/lib/invariant-error.js",
"/node_modules/next/dist/shared/lib/is-plain-object.js", "/node_modules/next/dist/shared/lib/is-plain-object.js",
......
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