Unverified Commit 54adb71a authored by Tim Neutkens's avatar Tim Neutkens Committed by GitHub

Ensure undefined values end up being replaced (#63138)

## What?

Follow-up to #63128

`JSON.stringify(undefined)` ends up with the value `undefined`. However
for Webpack/Turbopack to correctly inject `undefined` into the code it
has to be the string `'undefined'`. This change ensures the
serialization takes into account that case.

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->


Closes NEXT-2773
parent 7de0f478
...@@ -1351,15 +1351,14 @@ export default async function build( ...@@ -1351,15 +1351,14 @@ export default async function build(
env: process.env as Record<string, string>, env: process.env as Record<string, string>,
defineEnv: createDefineEnv({ defineEnv: createDefineEnv({
isTurbopack: true, isTurbopack: true,
allowedRevalidateHeaderKeys: undefined, clientRouterFilters: NextBuildContext.clientRouterFilters,
clientRouterFilters: undefined,
config, config,
dev, dev,
distDir, distDir,
fetchCacheKeyPrefix: undefined, fetchCacheKeyPrefix: config.experimental.fetchCacheKeyPrefix,
hasRewrites, hasRewrites,
// TODO: Implement
middlewareMatchers: undefined, middlewareMatchers: undefined,
previewModeId: undefined,
}), }),
}) })
......
...@@ -435,7 +435,6 @@ export interface DefineEnv { ...@@ -435,7 +435,6 @@ export interface DefineEnv {
export function createDefineEnv({ export function createDefineEnv({
isTurbopack, isTurbopack,
allowedRevalidateHeaderKeys,
clientRouterFilters, clientRouterFilters,
config, config,
dev, dev,
...@@ -443,7 +442,6 @@ export function createDefineEnv({ ...@@ -443,7 +442,6 @@ export function createDefineEnv({
fetchCacheKeyPrefix, fetchCacheKeyPrefix,
hasRewrites, hasRewrites,
middlewareMatchers, middlewareMatchers,
previewModeId,
}: Omit< }: Omit<
DefineEnvPluginOptions, DefineEnvPluginOptions,
'isClient' | 'isNodeOrEdgeCompilation' | 'isEdgeServer' | 'isNodeServer' 'isClient' | 'isNodeOrEdgeCompilation' | 'isEdgeServer' | 'isNodeServer'
...@@ -458,7 +456,6 @@ export function createDefineEnv({ ...@@ -458,7 +456,6 @@ export function createDefineEnv({
defineEnv[variant] = rustifyEnv( defineEnv[variant] = rustifyEnv(
getDefineEnv({ getDefineEnv({
isTurbopack, isTurbopack,
allowedRevalidateHeaderKeys,
clientRouterFilters, clientRouterFilters,
config, config,
dev, dev,
...@@ -470,7 +467,6 @@ export function createDefineEnv({ ...@@ -470,7 +467,6 @@ export function createDefineEnv({
isNodeOrEdgeCompilation: variant === 'nodejs' || variant === 'edge', isNodeOrEdgeCompilation: variant === 'nodejs' || variant === 'edge',
isNodeServer: variant === 'nodejs', isNodeServer: variant === 'nodejs',
middlewareMatchers, middlewareMatchers,
previewModeId,
}) })
) )
} }
......
...@@ -318,9 +318,7 @@ export default async function getBaseWebpackConfig( ...@@ -318,9 +318,7 @@ export default async function getBaseWebpackConfig(
resolvedBaseUrl, resolvedBaseUrl,
supportedBrowsers, supportedBrowsers,
clientRouterFilters, clientRouterFilters,
previewModeId,
fetchCacheKeyPrefix, fetchCacheKeyPrefix,
allowedRevalidateHeaderKeys,
}: { }: {
buildId: string buildId: string
config: NextConfigComplete config: NextConfigComplete
...@@ -348,9 +346,7 @@ export default async function getBaseWebpackConfig( ...@@ -348,9 +346,7 @@ export default async function getBaseWebpackConfig(
import('../shared/lib/bloom-filter').BloomFilter['export'] import('../shared/lib/bloom-filter').BloomFilter['export']
> >
} }
previewModeId?: string
fetchCacheKeyPrefix?: string fetchCacheKeyPrefix?: string
allowedRevalidateHeaderKeys?: string[]
} }
): Promise<webpack.Configuration> { ): Promise<webpack.Configuration> {
const isClient = compilerType === COMPILER_NAMES.client const isClient = compilerType === COMPILER_NAMES.client
...@@ -1741,7 +1737,6 @@ export default async function getBaseWebpackConfig( ...@@ -1741,7 +1737,6 @@ export default async function getBaseWebpackConfig(
}), }),
getDefineEnvPlugin({ getDefineEnvPlugin({
isTurbopack: false, isTurbopack: false,
allowedRevalidateHeaderKeys,
clientRouterFilters, clientRouterFilters,
config, config,
dev, dev,
...@@ -1753,7 +1748,6 @@ export default async function getBaseWebpackConfig( ...@@ -1753,7 +1748,6 @@ export default async function getBaseWebpackConfig(
isNodeOrEdgeCompilation, isNodeOrEdgeCompilation,
isNodeServer, isNodeServer,
middlewareMatchers, middlewareMatchers,
previewModeId,
}), }),
isClient && isClient &&
new ReactLoadablePlugin({ new ReactLoadablePlugin({
......
...@@ -23,7 +23,6 @@ type BloomFilter = ReturnType< ...@@ -23,7 +23,6 @@ type BloomFilter = ReturnType<
export interface DefineEnvPluginOptions { export interface DefineEnvPluginOptions {
isTurbopack: boolean isTurbopack: boolean
allowedRevalidateHeaderKeys: string[] | undefined
clientRouterFilters?: { clientRouterFilters?: {
staticFilter: BloomFilter staticFilter: BloomFilter
dynamicFilter: BloomFilter dynamicFilter: BloomFilter
...@@ -38,7 +37,6 @@ export interface DefineEnvPluginOptions { ...@@ -38,7 +37,6 @@ export interface DefineEnvPluginOptions {
isNodeOrEdgeCompilation: boolean isNodeOrEdgeCompilation: boolean
isNodeServer: boolean isNodeServer: boolean
middlewareMatchers: MiddlewareMatcher[] | undefined middlewareMatchers: MiddlewareMatcher[] | undefined
previewModeId: string | undefined
} }
interface DefineEnv { interface DefineEnv {
...@@ -46,7 +44,6 @@ interface DefineEnv { ...@@ -46,7 +44,6 @@ interface DefineEnv {
| string | string
| string[] | string[]
| boolean | boolean
| undefined
| MiddlewareMatcher[] | MiddlewareMatcher[]
| BloomFilter | BloomFilter
| Partial<NextConfigComplete['images']> | Partial<NextConfigComplete['images']>
...@@ -129,7 +126,6 @@ function getImageConfig( ...@@ -129,7 +126,6 @@ function getImageConfig(
export function getDefineEnv({ export function getDefineEnv({
isTurbopack, isTurbopack,
allowedRevalidateHeaderKeys,
clientRouterFilters, clientRouterFilters,
config, config,
dev, dev,
...@@ -141,7 +137,6 @@ export function getDefineEnv({ ...@@ -141,7 +137,6 @@ export function getDefineEnv({
isNodeOrEdgeCompilation, isNodeOrEdgeCompilation,
isNodeServer, isNodeServer,
middlewareMatchers, middlewareMatchers,
previewModeId,
}: DefineEnvPluginOptions): SerializedDefineEnv { }: DefineEnvPluginOptions): SerializedDefineEnv {
const defineEnv: DefineEnv = { const defineEnv: DefineEnv = {
// internal field to identify the plugin config // internal field to identify the plugin config
...@@ -158,7 +153,7 @@ export function getDefineEnv({ ...@@ -158,7 +153,7 @@ export function getDefineEnv({
* and library authors to have different implementations based on * and library authors to have different implementations based on
* the runtime they are running with, if it's not using `edge-runtime` * the runtime they are running with, if it's not using `edge-runtime`
*/ */
process.env.NEXT_EDGE_RUNTIME_PROVIDER || 'edge-runtime', process.env.NEXT_EDGE_RUNTIME_PROVIDER ?? 'edge-runtime',
}), }),
'process.turbopack': isTurbopack, 'process.turbopack': isTurbopack,
'process.env.TURBOPACK': isTurbopack, 'process.env.TURBOPACK': isTurbopack,
...@@ -172,70 +167,71 @@ export function getDefineEnv({ ...@@ -172,70 +167,71 @@ export function getDefineEnv({
'process.env.NEXT_MINIMAL': '', 'process.env.NEXT_MINIMAL': '',
'process.env.__NEXT_PPR': config.experimental.ppr === true, 'process.env.__NEXT_PPR': config.experimental.ppr === true,
'process.env.__NEXT_ACTIONS_DEPLOYMENT_ID': 'process.env.__NEXT_ACTIONS_DEPLOYMENT_ID':
config.experimental.useDeploymentIdServerActions, config.experimental.useDeploymentIdServerActions ?? false,
'process.env.NEXT_DEPLOYMENT_ID': config.experimental.deploymentId || false, 'process.env.NEXT_DEPLOYMENT_ID': config.experimental.deploymentId ?? false,
'process.env.__NEXT_FETCH_CACHE_KEY_PREFIX': fetchCacheKeyPrefix, 'process.env.__NEXT_FETCH_CACHE_KEY_PREFIX': fetchCacheKeyPrefix ?? '',
'process.env.__NEXT_PREVIEW_MODE_ID': previewModeId, 'process.env.__NEXT_MIDDLEWARE_MATCHERS': middlewareMatchers ?? [],
'process.env.__NEXT_ALLOWED_REVALIDATE_HEADERS':
allowedRevalidateHeaderKeys,
'process.env.__NEXT_MIDDLEWARE_MATCHERS': middlewareMatchers || [],
'process.env.__NEXT_MANUAL_CLIENT_BASE_PATH': 'process.env.__NEXT_MANUAL_CLIENT_BASE_PATH':
config.experimental.manualClientBasePath, config.experimental.manualClientBasePath ?? false,
'process.env.__NEXT_CLIENT_ROUTER_FILTER_ENABLED': 'process.env.__NEXT_CLIENT_ROUTER_FILTER_ENABLED':
config.experimental.clientRouterFilter, config.experimental.clientRouterFilter ?? true,
'process.env.__NEXT_CLIENT_ROUTER_S_FILTER': 'process.env.__NEXT_CLIENT_ROUTER_S_FILTER':
clientRouterFilters?.staticFilter, clientRouterFilters?.staticFilter ?? false,
'process.env.__NEXT_CLIENT_ROUTER_D_FILTER': 'process.env.__NEXT_CLIENT_ROUTER_D_FILTER':
clientRouterFilters?.dynamicFilter, clientRouterFilters?.dynamicFilter ?? false,
'process.env.__NEXT_OPTIMISTIC_CLIENT_CACHE': 'process.env.__NEXT_OPTIMISTIC_CLIENT_CACHE':
config.experimental.optimisticClientCache, config.experimental.optimisticClientCache ?? true,
'process.env.__NEXT_MIDDLEWARE_PREFETCH': 'process.env.__NEXT_MIDDLEWARE_PREFETCH':
config.experimental.middlewarePrefetch, config.experimental.middlewarePrefetch ?? 'flexible',
'process.env.__NEXT_CROSS_ORIGIN': config.crossOrigin, 'process.env.__NEXT_CROSS_ORIGIN': config.crossOrigin,
'process.browser': isClient, 'process.browser': isClient,
'process.env.__NEXT_TEST_MODE': process.env.__NEXT_TEST_MODE, 'process.env.__NEXT_TEST_MODE': process.env.__NEXT_TEST_MODE ?? false,
// This is used in client/dev-error-overlay/hot-dev-client.js to replace the dist directory // This is used in client/dev-error-overlay/hot-dev-client.js to replace the dist directory
...(dev && (isClient || isEdgeServer) ...(dev && (isClient ?? isEdgeServer)
? { ? {
'process.env.__NEXT_DIST_DIR': distDir, 'process.env.__NEXT_DIST_DIR': distDir,
} }
: {}), : {}),
'process.env.__NEXT_TRAILING_SLASH': config.trailingSlash, 'process.env.__NEXT_TRAILING_SLASH': config.trailingSlash,
'process.env.__NEXT_BUILD_INDICATOR': config.devIndicators.buildActivity, 'process.env.__NEXT_BUILD_INDICATOR':
config.devIndicators.buildActivity ?? true,
'process.env.__NEXT_BUILD_INDICATOR_POSITION': 'process.env.__NEXT_BUILD_INDICATOR_POSITION':
config.devIndicators.buildActivityPosition, config.devIndicators.buildActivityPosition ?? 'bottom-right',
'process.env.__NEXT_STRICT_MODE': 'process.env.__NEXT_STRICT_MODE':
config.reactStrictMode === null ? false : config.reactStrictMode, config.reactStrictMode === null ? false : config.reactStrictMode,
'process.env.__NEXT_STRICT_MODE_APP': 'process.env.__NEXT_STRICT_MODE_APP':
// When next.config.js does not have reactStrictMode it's enabled by default. // When next.config.js does not have reactStrictMode it's enabled by default.
config.reactStrictMode === null ? true : config.reactStrictMode, config.reactStrictMode === null ? true : config.reactStrictMode,
'process.env.__NEXT_OPTIMIZE_FONTS': !dev && config.optimizeFonts, 'process.env.__NEXT_OPTIMIZE_FONTS': !dev && config.optimizeFonts,
'process.env.__NEXT_OPTIMIZE_CSS': config.experimental.optimizeCss && !dev, 'process.env.__NEXT_OPTIMIZE_CSS':
(config.experimental.optimizeCss && !dev) ?? false,
'process.env.__NEXT_SCRIPT_WORKERS': 'process.env.__NEXT_SCRIPT_WORKERS':
config.experimental.nextScriptWorkers && !dev, (config.experimental.nextScriptWorkers && !dev) ?? false,
'process.env.__NEXT_SCROLL_RESTORATION': 'process.env.__NEXT_SCROLL_RESTORATION':
config.experimental.scrollRestoration, config.experimental.scrollRestoration ?? false,
...getImageConfig(config, dev), ...getImageConfig(config, dev),
'process.env.__NEXT_ROUTER_BASEPATH': config.basePath, 'process.env.__NEXT_ROUTER_BASEPATH': config.basePath,
'process.env.__NEXT_STRICT_NEXT_HEAD': config.experimental.strictNextHead, 'process.env.__NEXT_STRICT_NEXT_HEAD':
config.experimental.strictNextHead ?? false,
'process.env.__NEXT_HAS_REWRITES': hasRewrites, 'process.env.__NEXT_HAS_REWRITES': hasRewrites,
'process.env.__NEXT_CONFIG_OUTPUT': config.output, 'process.env.__NEXT_CONFIG_OUTPUT': config.output,
'process.env.__NEXT_I18N_SUPPORT': !!config.i18n, 'process.env.__NEXT_I18N_SUPPORT': !!config.i18n,
'process.env.__NEXT_I18N_DOMAINS': config.i18n?.domains, 'process.env.__NEXT_I18N_DOMAINS': config.i18n?.domains ?? false,
'process.env.__NEXT_ANALYTICS_ID': config.analyticsId, // TODO: remove in the next major version 'process.env.__NEXT_ANALYTICS_ID': config.analyticsId, // TODO: remove in the next major version
'process.env.__NEXT_NO_MIDDLEWARE_URL_NORMALIZE': 'process.env.__NEXT_NO_MIDDLEWARE_URL_NORMALIZE':
config.skipMiddlewareUrlNormalize, config.skipMiddlewareUrlNormalize,
'process.env.__NEXT_EXTERNAL_MIDDLEWARE_REWRITE_RESOLVE': 'process.env.__NEXT_EXTERNAL_MIDDLEWARE_REWRITE_RESOLVE':
config.experimental.externalMiddlewareRewritesResolve, config.experimental.externalMiddlewareRewritesResolve ?? false,
'process.env.__NEXT_MANUAL_TRAILING_SLASH': 'process.env.__NEXT_MANUAL_TRAILING_SLASH':
config.skipTrailingSlashRedirect, config.skipTrailingSlashRedirect,
'process.env.__NEXT_HAS_WEB_VITALS_ATTRIBUTION': 'process.env.__NEXT_HAS_WEB_VITALS_ATTRIBUTION':
config.experimental.webVitalsAttribution && (config.experimental.webVitalsAttribution &&
config.experimental.webVitalsAttribution.length > 0, config.experimental.webVitalsAttribution.length > 0) ??
false,
'process.env.__NEXT_WEB_VITALS_ATTRIBUTION': 'process.env.__NEXT_WEB_VITALS_ATTRIBUTION':
config.experimental.webVitalsAttribution, config.experimental.webVitalsAttribution ?? false,
'process.env.__NEXT_LINK_NO_TOUCH_START': 'process.env.__NEXT_LINK_NO_TOUCH_START':
config.experimental.linkNoTouchStart, config.experimental.linkNoTouchStart ?? false,
'process.env.__NEXT_ASSET_PREFIX': config.assetPrefix, 'process.env.__NEXT_ASSET_PREFIX': config.assetPrefix,
...(isNodeOrEdgeCompilation ...(isNodeOrEdgeCompilation
? { ? {
......
...@@ -129,15 +129,15 @@ export async function createHotReloaderTurbopack( ...@@ -129,15 +129,15 @@ export async function createHotReloaderTurbopack(
env: process.env as Record<string, string>, env: process.env as Record<string, string>,
defineEnv: createDefineEnv({ defineEnv: createDefineEnv({
isTurbopack: true, isTurbopack: true,
allowedRevalidateHeaderKeys: undefined, // TODO: Implement
clientRouterFilters: undefined, clientRouterFilters: undefined,
config: nextConfig, config: nextConfig,
dev: true, dev: true,
distDir, distDir,
fetchCacheKeyPrefix: undefined, fetchCacheKeyPrefix: opts.nextConfig.experimental.fetchCacheKeyPrefix,
hasRewrites, hasRewrites,
// TODO: Implement
middlewareMatchers: undefined, middlewareMatchers: undefined,
previewModeId: undefined,
}), }),
}) })
const entrypointsSubscription = project.entrypointsSubscribe() const entrypointsSubscription = project.entrypointsSubscribe()
......
...@@ -553,15 +553,15 @@ async function startWatcher(opts: SetupOpts) { ...@@ -553,15 +553,15 @@ async function startWatcher(opts: SetupOpts) {
await hotReloader.turbopackProject.update({ await hotReloader.turbopackProject.update({
defineEnv: createDefineEnv({ defineEnv: createDefineEnv({
isTurbopack: true, isTurbopack: true,
allowedRevalidateHeaderKeys: undefined,
clientRouterFilters, clientRouterFilters,
config: nextConfig, config: nextConfig,
dev: true, dev: true,
distDir, distDir,
fetchCacheKeyPrefix: undefined, fetchCacheKeyPrefix:
opts.nextConfig.experimental.fetchCacheKeyPrefix,
hasRewrites, hasRewrites,
// TODO: Implement
middlewareMatchers: undefined, middlewareMatchers: undefined,
previewModeId: undefined,
}), }),
}) })
} }
...@@ -625,19 +625,18 @@ async function startWatcher(opts: SetupOpts) { ...@@ -625,19 +625,18 @@ async function startWatcher(opts: SetupOpts) {
) { ) {
const newDefine = getDefineEnv({ const newDefine = getDefineEnv({
isTurbopack: false, isTurbopack: false,
allowedRevalidateHeaderKeys: undefined,
clientRouterFilters, clientRouterFilters,
config: nextConfig, config: nextConfig,
dev: true, dev: true,
distDir, distDir,
fetchCacheKeyPrefix: undefined, fetchCacheKeyPrefix:
opts.nextConfig.experimental.fetchCacheKeyPrefix,
hasRewrites, hasRewrites,
isClient, isClient,
isEdgeServer, isEdgeServer,
isNodeOrEdgeCompilation: isNodeServer || isEdgeServer, isNodeOrEdgeCompilation: isNodeServer || isEdgeServer,
isNodeServer, isNodeServer,
middlewareMatchers: undefined, middlewareMatchers: undefined,
previewModeId: undefined,
}) })
Object.keys(plugin.definitions).forEach((key) => { Object.keys(plugin.definitions).forEach((key) => {
......
...@@ -765,13 +765,24 @@ export default class Router implements BaseRouter { ...@@ -765,13 +765,24 @@ export default class Router implements BaseRouter {
const { BloomFilter } = const { BloomFilter } =
require('../../lib/bloom-filter') as typeof import('../../lib/bloom-filter') require('../../lib/bloom-filter') as typeof import('../../lib/bloom-filter')
const staticFilterData: type Filter = ReturnType<
| ReturnType<import('../../lib/bloom-filter').BloomFilter['export']> import('../../lib/bloom-filter').BloomFilter['export']
| undefined = process.env.__NEXT_CLIENT_ROUTER_S_FILTER as any >
const dynamicFilterData: typeof staticFilterData = process.env const routerFilterSValue: Filter | false = process.env
.__NEXT_CLIENT_ROUTER_S_FILTER as any
const staticFilterData: Filter | undefined = routerFilterSValue
? routerFilterSValue
: undefined
const routerFilterDValue: Filter | false = process.env
.__NEXT_CLIENT_ROUTER_D_FILTER as any .__NEXT_CLIENT_ROUTER_D_FILTER as any
const dynamicFilterData: Filter | undefined = routerFilterDValue
? routerFilterDValue
: undefined
if (staticFilterData?.numHashes) { if (staticFilterData?.numHashes) {
this._bfl_s = new BloomFilter( this._bfl_s = new BloomFilter(
staticFilterData.numItems, staticFilterData.numItems,
......
...@@ -205,7 +205,6 @@ describe('next.rs api', () => { ...@@ -205,7 +205,6 @@ describe('next.rs api', () => {
dev: true, dev: true,
defineEnv: createDefineEnv({ defineEnv: createDefineEnv({
isTurbopack: true, isTurbopack: true,
allowedRevalidateHeaderKeys: undefined,
clientRouterFilters: undefined, clientRouterFilters: undefined,
config: nextConfig, config: nextConfig,
dev: true, dev: true,
...@@ -218,7 +217,6 @@ describe('next.rs api', () => { ...@@ -218,7 +217,6 @@ describe('next.rs api', () => {
fetchCacheKeyPrefix: undefined, fetchCacheKeyPrefix: undefined,
hasRewrites: false, hasRewrites: false,
middlewareMatchers: undefined, middlewareMatchers: undefined,
previewModeId: undefined,
}), }),
}) })
projectUpdateSubscription = filterMapAsyncIterator( projectUpdateSubscription = filterMapAsyncIterator(
......
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