Unverified Commit 1b45163b authored by Josh Story's avatar Josh Story Committed by GitHub

Exclude `next-js` condition from middleware, proxy, and instrumentation (#85321)

These scopes aren't fully Next.js environments and can't access many
Next.js APIs. In the future this might change but for now we will
exclude the `next-js` condition when bundling for these entrypoints so
that 3rd parties that target Next.js can do so with the expectation that
regardless of what environment they are running in the full suite of
Next.js libraries they support will work.
parent db19303f
...@@ -153,9 +153,9 @@ pub async fn get_edge_resolve_options_context( ...@@ -153,9 +153,9 @@ pub async fn get_edge_resolve_options_context(
custom_conditions.push(rcstr!("react-server")); custom_conditions.push(rcstr!("react-server"));
}; };
if *next_config.enable_cache_components().await? { // Edge runtime is disabled for projects with Cache Components enabled except for Middleware
custom_conditions.push(rcstr!("next-js")); // but Middleware doesn't have all Next.js APIs so we omit the "next-js" condition for all edge
}; // entrypoints
let resolve_options_context = ResolveOptionsContext { let resolve_options_context = ResolveOptionsContext {
enable_node_modules: Some(project_path.root().owned().await?), enable_node_modules: Some(project_path.root().owned().await?),
......
...@@ -214,7 +214,10 @@ pub async fn get_server_resolve_options_context( ...@@ -214,7 +214,10 @@ pub async fn get_server_resolve_options_context(
custom_conditions.push(rcstr!("react-server")); custom_conditions.push(rcstr!("react-server"));
}; };
if *next_config.enable_cache_components().await? { if *next_config.enable_cache_components().await?
// Middleware shouldn't use the "next-js" condition because it doesn't have all Next.js APIs available
&& !matches!(ty, ServerContextType::Middleware { .. } | ServerContextType::Instrumentation { .. })
{
custom_conditions.push(rcstr!("next-js")); custom_conditions.push(rcstr!("next-js"));
}; };
......
...@@ -687,7 +687,6 @@ export default async function getBaseWebpackConfig( ...@@ -687,7 +687,6 @@ export default async function getBaseWebpackConfig(
: distDir : distDir
const conditionNames = [ const conditionNames = [
...(config.cacheComponents === true ? ['next-js'] : []),
...(isEdgeServer ? [edgeConditionName] : []), ...(isEdgeServer ? [edgeConditionName] : []),
// inherits Webpack's default conditions // inherits Webpack's default conditions
'...', '...',
...@@ -1389,6 +1388,17 @@ export default async function getBaseWebpackConfig( ...@@ -1389,6 +1388,17 @@ export default async function getBaseWebpackConfig(
}, },
module: { module: {
rules: [ rules: [
{
issuerLayer: {
not: [WEBPACK_LAYERS.middleware, WEBPACK_LAYERS.instrument],
},
resolve: {
conditionNames: [
config.cacheComponents ? 'next-js' : '',
'...',
].filter(Boolean) as string[],
},
},
// Alias server-only and client-only to proper exports based on bundling layers // Alias server-only and client-only to proper exports based on bundling layers
{ {
issuerLayer: { issuerLayer: {
......
export default function Page() {
return <div>Hello World</div>
}
import CJSExportsDefault from 'my-cjs-package/exports'
import ExternalCJSExportsDefault from 'my-external-cjs-package/exports'
import ESMExportsDefault from 'my-esm-package/exports'
import ExternalESMExportsDefault from 'my-external-esm-package/exports'
export function register() {
console.log('==== REGISTER START ====')
console.log('CJSExportsDefault:', CJSExportsDefault)
console.log('ExternalCJSExportsDefault:', ExternalCJSExportsDefault)
console.log('ESMExportsDefault:', ESMExportsDefault)
console.log('ExternalESMExportsDefault:', ExternalESMExportsDefault)
console.log('==== REGISTER END ====')
}
{
"dependencies": {
"my-cjs-package": "file:./sym-linked-packages/my-cjs-package",
"my-esm-package": "file:./sym-linked-packages/my-esm-package",
"my-external-cjs-package": "file:./sym-linked-packages/my-external-cjs-package",
"my-external-esm-package": "file:./sym-linked-packages/my-external-esm-package"
}
}
export default function Root({ children }: { children: React.ReactNode }) {
return (
<html>
<body>
<main>{children}</main>
</body>
</html>
)
}
export default function Page() {
return <div>Hello World</div>
}
import CJSExportsDefault from 'my-cjs-package/exports'
import ExternalCJSExportsDefault from 'my-external-cjs-package/exports'
import ESMExportsDefault from 'my-esm-package/exports'
import ExternalESMExportsDefault from 'my-external-esm-package/exports'
export default async function proxy(req: Request) {
if (!req.url.includes('/_next/')) {
console.log('==== MIDDLEWARE START ====')
console.log('CJSExportsDefault:', CJSExportsDefault)
console.log('ExternalCJSExportsDefault:', ExternalCJSExportsDefault)
console.log('ESMExportsDefault:', ESMExportsDefault)
console.log('ExternalESMExportsDefault:', ExternalESMExportsDefault)
console.log('==== MIDDLEWARE END ====')
}
}
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {
serverExternalPackages: [
'my-external-esm-package',
'my-external-cjs-package',
],
}
module.exports = nextConfig
{
"dependencies": {
"my-cjs-package": "file:./sym-linked-packages/my-cjs-package",
"my-esm-package": "file:./sym-linked-packages/my-esm-package",
"my-external-cjs-package": "file:./sym-linked-packages/my-external-cjs-package",
"my-external-esm-package": "file:./sym-linked-packages/my-external-esm-package"
}
}
declare module 'my-cjs-package/exports'
declare module 'my-cjs-package/imports'
declare module 'my-esm-package/exports'
declare module 'my-esm-package/imports'
declare module 'my-external-cjs-package/exports'
declare module 'my-external-cjs-package/imports'
declare module 'my-external-esm-package/exports'
declare module 'my-external-esm-package/imports'
node_modules
\ No newline at end of file
export default function Root({ children }: { children: React.ReactNode }) {
return (
<html>
<body>
<main>{children}</main>
</body>
</html>
)
}
export default function Page() {
return <div>Hello World</div>
}
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {
serverExternalPackages: [
'my-external-esm-package',
'my-external-cjs-package',
],
}
module.exports = nextConfig
{
"dependencies": {
"my-cjs-package": "file:./sym-linked-packages/my-cjs-package",
"my-esm-package": "file:./sym-linked-packages/my-esm-package",
"my-external-cjs-package": "file:./sym-linked-packages/my-external-cjs-package",
"my-external-esm-package": "file:./sym-linked-packages/my-external-esm-package"
}
}
declare module 'my-cjs-package/exports'
declare module 'my-cjs-package/imports'
declare module 'my-esm-package/exports'
declare module 'my-esm-package/imports'
declare module 'my-external-cjs-package/exports'
declare module 'my-external-cjs-package/imports'
declare module 'my-external-esm-package/exports'
declare module 'my-external-esm-package/imports'
import CJSExportsDefault from 'my-cjs-package/exports'
import ExternalCJSExportsDefault from 'my-external-cjs-package/exports'
import ESMExportsDefault from 'my-esm-package/exports'
import ExternalESMExportsDefault from 'my-external-esm-package/exports'
export default async function proxy(req: Request) {
if (!req.url.includes('/_next/')) {
console.log('==== MIDDLEWARE START ====')
console.log('CJSExportsDefault:', CJSExportsDefault)
console.log('ExternalCJSExportsDefault:', ExternalCJSExportsDefault)
console.log('ESMExportsDefault:', ESMExportsDefault)
console.log('ExternalESMExportsDefault:', ExternalESMExportsDefault)
console.log('==== MIDDLEWARE END ====')
}
}
node_modules
\ No newline at end of file
export default function Root({ children }: { children: React.ReactNode }) {
return (
<html>
<body>
<main>{children}</main>
</body>
</html>
)
}
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {
serverExternalPackages: [
'my-external-esm-package',
'my-external-cjs-package',
],
}
module.exports = nextConfig
{
"dependencies": {
"my-cjs-package": "file:./sym-linked-packages/my-cjs-package",
"my-esm-package": "file:./sym-linked-packages/my-esm-package",
"my-external-cjs-package": "file:./sym-linked-packages/my-external-cjs-package",
"my-external-esm-package": "file:./sym-linked-packages/my-external-esm-package"
}
}
declare module 'my-cjs-package/exports'
declare module 'my-cjs-package/imports'
declare module 'my-esm-package/exports'
declare module 'my-esm-package/imports'
declare module 'my-external-cjs-package/exports'
declare module 'my-external-cjs-package/imports'
declare module 'my-external-esm-package/exports'
declare module 'my-external-esm-package/imports'
import { nextTestSetup } from 'e2e-utils' import { FileRef, nextTestSetup } from 'e2e-utils'
describe('`next-js` Condition', () => { describe('`next-js` Condition - Rendering', () => {
const { next, isTurbopack, skipped } = nextTestSetup({ const { next, isTurbopack, skipped } = nextTestSetup({
files: __dirname, files: __dirname + '/fixtures/render',
dependencies: require('./package.json').dependencies, // copy shared packages over to the test folder. This will override the symlink that currently
// exists in the fixture with relative paths
overrideFiles: {
'sym-linked-packages': new FileRef(__dirname + '/packages'),
},
dependencies: require('./fixtures/render/package.json').dependencies,
// Deploy tests are broken with `config.serverExternalPackages` // Deploy tests are broken with `config.serverExternalPackages`
skipDeployment: true, skipDeployment: true,
}) })
...@@ -618,6 +623,136 @@ describe('`next-js` Condition', () => { ...@@ -618,6 +623,136 @@ describe('`next-js` Condition', () => {
} }
}) })
describe('`next-js` Condition - middleware (legacy)', () => {
const { next, skipped } = nextTestSetup({
files: __dirname + '/fixtures/middleware',
// copy shared packages over to the test folder. This will override the symlink that currently
// exists in the fixture with relative paths
overrideFiles: {
'sym-linked-packages': new FileRef(__dirname + '/packages'),
},
dependencies: require('./fixtures/middleware/package.json').dependencies,
// Deploy tests are broken with `config.serverExternalPackages`
skipDeployment: true,
})
if (skipped) {
return
}
// Recommended for tests that check HTML. Cheerio is a HTML parser that has a jQuery like API.
describe('With or Without Cache Components', () => {
it('should follow the next-js condition from a bundled commonjs package', async () => {
let cliIndex = next.cliOutput.length
const $ = await next.render$('/')
const middlewareOutput = formatMiddlewareOutput(
next.cliOutput.slice(cliIndex)
)
expect(middlewareOutput).toMatchInlineSnapshot(`
"CJSExportsDefault: {
default: 'EXPORTS DEFAULT SERVER - Default Export',
named: 'EXPORTS DEFAULT SERVER - Named Export'
}
ExternalCJSExportsDefault: {
default: 'EXPORTS DEFAULT SERVER - Default Export',
named: 'EXPORTS DEFAULT SERVER - Named Export'
}
ESMExportsDefault: EXPORTS DEFAULT SERVER - Default Export
ExternalESMExportsDefault: EXPORTS DEFAULT SERVER - Default Export"
`)
const text = formatHtmlText($('main').html())
expect(text).toMatchInlineSnapshot(`"Hello World"`)
})
})
})
describe('`next-js` Condition - proxy', () => {
const { next, skipped } = nextTestSetup({
files: __dirname + '/fixtures/proxy',
// copy shared packages over to the test folder. This will override the symlink that currently
// exists in the fixture with relative paths
overrideFiles: {
'sym-linked-packages': new FileRef(__dirname + '/packages'),
},
dependencies: require('./fixtures/proxy/package.json').dependencies,
// Deploy tests are broken with `config.serverExternalPackages`
skipDeployment: true,
})
if (skipped) {
return
}
// Recommended for tests that check HTML. Cheerio is a HTML parser that has a jQuery like API.
describe('With or Without Cache Components', () => {
it('should follow the next-js condition from a bundled commonjs package', async () => {
let cliIndex = next.cliOutput.length
const $ = await next.render$('/')
const middlewareOutput = formatMiddlewareOutput(
next.cliOutput.slice(cliIndex)
)
expect(middlewareOutput).toMatchInlineSnapshot(`
"CJSExportsDefault: {
default: 'EXPORTS DEFAULT SERVER - Default Export',
named: 'EXPORTS DEFAULT SERVER - Named Export'
}
ExternalCJSExportsDefault: {
default: 'EXPORTS DEFAULT CLIENT - Default Export',
named: 'EXPORTS DEFAULT CLIENT - Named Export'
}
ESMExportsDefault: EXPORTS DEFAULT SERVER - Default Export
ExternalESMExportsDefault: EXPORTS DEFAULT CLIENT - Default Export"
`)
const text = formatHtmlText($('main').html())
expect(text).toMatchInlineSnapshot(`"Hello World"`)
})
})
})
describe('`next-js` Condition - instrumentation', () => {
const { next, skipped } = nextTestSetup({
files: __dirname + '/fixtures/instrumentation',
// copy shared packages over to the test folder. This will override the symlink that currently
// exists in the fixture with relative paths
overrideFiles: {
'sym-linked-packages': new FileRef(__dirname + '/packages'),
},
dependencies: require('./fixtures/instrumentation/package.json')
.dependencies,
// Deploy tests are broken with `config.serverExternalPackages`
skipDeployment: true,
})
if (skipped) {
return
}
// Recommended for tests that check HTML. Cheerio is a HTML parser that has a jQuery like API.
describe('With or Without Cache Components', () => {
it('should not follow the next-js condition inside instrumentation', async () => {
// We need a request to trigger the server start in start tests
await next.render$('/')
const registerOutput = formatRegisterOutput(next.cliOutput)
expect(registerOutput).toMatchInlineSnapshot(`
"CJSExportsDefault: {
default: 'EXPORTS DEFAULT SERVER - Default Export',
named: 'EXPORTS DEFAULT SERVER - Named Export'
}
ExternalCJSExportsDefault: {
default: 'EXPORTS DEFAULT CLIENT - Default Export',
named: 'EXPORTS DEFAULT CLIENT - Named Export'
}
ESMExportsDefault: EXPORTS DEFAULT SERVER - Default Export
ExternalESMExportsDefault: EXPORTS DEFAULT CLIENT - Default Export"
`)
})
})
})
/** /**
* produces more readable snapshots by stripping tags and auto formatting * produces more readable snapshots by stripping tags and auto formatting
*/ */
...@@ -645,3 +780,19 @@ function formatHtmlText(html) { ...@@ -645,3 +780,19 @@ function formatHtmlText(html) {
.filter(Boolean) .filter(Boolean)
.join('\n') .join('\n')
} }
function formatMiddlewareOutput(cliOutput) {
return (
cliOutput.match(
/==== MIDDLEWARE START ====(.*?)==== MIDDLEWARE END ====/s
)?.[1] ?? ''
).trim()
}
function formatRegisterOutput(cliOutput) {
return (
cliOutput.match(
/==== REGISTER START ====(.*?)==== REGISTER END ====/s
)?.[1] ?? ''
).trim()
}
hoistPattern:
- '*'
hoistedDependencies: {}
included:
dependencies: true
devDependencies: true
optionalDependencies: true
injectedDeps: {}
layoutVersion: 5
nodeLinker: isolated
packageManager: pnpm@9.6.0
pendingBuilds: []
prunedAt: Thu, 23 Oct 2025 19:32:10 GMT
publicHoistPattern:
- '*eslint*'
- '*prettier*'
registries:
'@vercel-private': https://vercel-private-registry.vercel.sh/registry
default: https://registry.npmjs.org/
skipped: []
storeDir: /Users/joshstory/Library/pnpm/store/v3
virtualStoreDir: .pnpm
virtualStoreDirMaxLength: 120
lockfileVersion: '9.0'
settings:
autoInstallPeers: true
excludeLinksFromLockfile: false
importers:
.:
dependencies:
my-cjs-package:
specifier: file:./packages/my-cjs-package
version: file:packages/my-cjs-package
my-esm-package:
specifier: file:./packages/my-esm-package
version: file:packages/my-esm-package
my-external-cjs-package:
specifier: file:./packages/my-external-cjs-package
version: file:packages/my-external-cjs-package
my-external-esm-package:
specifier: file:./packages/my-external-esm-package
version: file:packages/my-external-esm-package
packages:
my-cjs-package@file:packages/my-cjs-package:
resolution: { directory: packages/my-cjs-package, type: directory }
my-esm-package@file:packages/my-esm-package:
resolution: { directory: packages/my-esm-package, type: directory }
my-external-cjs-package@file:packages/my-external-cjs-package:
resolution: { directory: packages/my-external-cjs-package, type: directory }
my-external-esm-package@file:packages/my-external-esm-package:
resolution: { directory: packages/my-external-esm-package, type: directory }
snapshots:
my-cjs-package@file:packages/my-cjs-package: {}
my-esm-package@file:packages/my-esm-package: {}
my-external-cjs-package@file:packages/my-external-cjs-package: {}
my-external-esm-package@file:packages/my-external-esm-package: {}
{
"name": "my-cjs-package",
"version": "0.0.0",
"type": "commonjs",
"files": [
"src"
],
"exports": {
"./exports": {
"next-js": {
"react-server": "./src/exports.next.server.cjs",
"default": "./src/exports.next.default.cjs"
},
"default": {
"react-server": "./src/exports.default.server.cjs",
"default": "./src/exports.default.default.cjs"
}
},
"./imports": "./src/imports.cjs"
},
"imports": {
"#imports": {
"next-js": {
"react-server": "./src/imports/imports.next.server.cjs",
"default": "./src/imports/imports.next.default.cjs"
},
"default": {
"react-server": "./src/imports/imports.default.server.cjs",
"default": "./src/imports/imports.default.default.cjs"
}
}
}
}
module.exports = {
default: 'EXPORTS DEFAULT CLIENT - Default Export',
named: 'EXPORTS DEFAULT CLIENT - Named Export',
}
module.exports = {
default: 'EXPORTS DEFAULT SERVER - Default Export',
named: 'EXPORTS DEFAULT SERVER - Named Export',
}
module.exports = {
default: 'EXPORTS NEXT CLIENT - Default Export',
named: 'EXPORTS NEXT CLIENT - Named Export',
}
module.exports = {
default: 'EXPORTS NEXT SERVER - Default Export',
named: 'EXPORTS NEXT SERVER - Named Export',
}
module.exports = {
default: 'IMPORTS DEFAULT CLIENT - Default Export',
named: 'IMPORTS DEFAULT CLIENT - Named Export',
}
module.exports = {
default: 'IMPORTS DEFAULT SERVER - Default Export',
named: 'IMPORTS DEFAULT SERVER - Named Export',
}
module.exports = {
default: 'IMPORTS NEXT CLIENT - Default Export',
named: 'IMPORTS NEXT CLIENT - Named Export',
}
module.exports = {
default: 'IMPORTS NEXT SERVER - Default Export',
named: 'IMPORTS NEXT SERVER - Named Export',
}
{
"name": "my-esm-package",
"version": "0.0.0",
"type": "module",
"files": [
"src"
],
"exports": {
"./exports": {
"next-js": {
"react-server": "./src/exports.next.server.mjs",
"default": "./src/exports.next.default.mjs"
},
"default": {
"react-server": "./src/exports.default.server.mjs",
"default": "./src/exports.default.default.mjs"
}
},
"./imports": "./src/imports.mjs"
},
"imports": {
"#imports": {
"next-js": {
"react-server": "./src/imports/imports.next.server.mjs",
"default": "./src/imports/imports.next.default.mjs"
},
"default": {
"react-server": "./src/imports/imports.default.server.mjs",
"default": "./src/imports/imports.default.default.mjs"
}
}
}
}
export default 'EXPORTS DEFAULT CLIENT - Default Export'
export const named = 'EXPORTS DEFAULT CLIENT - Named Export'
export default 'EXPORTS DEFAULT SERVER - Default Export'
export const named = 'EXPORTS DEFAULT SERVER - Named Export'
export default 'EXPORTS NEXT CLIENT - Default Export'
export const named = 'EXPORTS NEXT CLIENT - Named Export'
export default 'EXPORTS NEXT SERVER - Default Export'
export const named = 'EXPORTS NEXT SERVER - Named Export'
export default 'IMPORTS DEFAULT CLIENT - Default Export'
export const named = 'IMPORTS DEFAULT CLIENT - Named Export'
export default 'IMPORTS DEFAULT SERVER - Default Export'
export const named = 'IMPORTS DEFAULT SERVER - Named Export'
export default 'IMPORTS NEXT CLIENT - Default Export'
export const named = 'IMPORTS NEXT CLIENT - Named Export'
export default 'IMPORTS NEXT SERVER - Default Export'
export const named = 'IMPORTS NEXT SERVER - Named Export'
{
"name": "my-external-cjs-package",
"version": "0.0.0",
"type": "commonjs",
"files": [
"src"
],
"exports": {
"./exports": {
"next-js": {
"react-server": "./src/exports.next.server.cjs",
"default": "./src/exports.next.default.cjs"
},
"default": {
"react-server": "./src/exports.default.server.cjs",
"default": "./src/exports.default.default.cjs"
}
},
"./imports": "./src/imports.cjs"
},
"imports": {
"#imports": {
"next-js": {
"react-server": "./src/imports/imports.next.server.cjs",
"default": "./src/imports/imports.next.default.cjs"
},
"default": {
"react-server": "./src/imports/imports.default.server.cjs",
"default": "./src/imports/imports.default.default.cjs"
}
}
}
}
{
"name": "my-external-esm-package",
"version": "0.0.0",
"type": "module",
"files": [
"src"
],
"exports": {
"./exports": {
"next-js": {
"react-server": "./src/exports.next.server.mjs",
"default": "./src/exports.next.default.mjs"
},
"default": {
"react-server": "./src/exports.default.server.mjs",
"default": "./src/exports.default.default.mjs"
}
},
"./imports": "./src/imports.mjs"
},
"imports": {
"#imports": {
"next-js": {
"react-server": "./src/imports/imports.next.server.mjs",
"default": "./src/imports/imports.next.default.mjs"
},
"default": {
"react-server": "./src/imports/imports.default.server.mjs",
"default": "./src/imports/imports.default.default.mjs"
}
}
}
}
.pnpm/my-cjs-package@file+packages+my-cjs-package/node_modules/my-cjs-package
\ No newline at end of file
.pnpm/my-esm-package@file+packages+my-esm-package/node_modules/my-esm-package
\ No newline at end of file
.pnpm/my-external-cjs-package@file+packages+my-external-cjs-package/node_modules/my-external-cjs-package
\ No newline at end of file
.pnpm/my-external-esm-package@file+packages+my-external-esm-package/node_modules/my-external-esm-package
\ No newline at end of file
{
"dependencies": {
"my-cjs-package": "file:./packages/my-cjs-package",
"my-esm-package": "file:./packages/my-esm-package",
"my-external-cjs-package": "file:./packages/my-external-cjs-package",
"my-external-esm-package": "file:./packages/my-external-esm-package"
}
}
...@@ -156,6 +156,15 @@ export class NextInstance { ...@@ -156,6 +156,15 @@ export class NextInstance {
await fs.mkdir(path.dirname(outputFilename), { recursive: true }) await fs.mkdir(path.dirname(outputFilename), { recursive: true })
await fs.writeFile(outputFilename, item) await fs.writeFile(outputFilename, item)
} else { } else {
try {
const existingStat = await fs.lstat(outputFilename)
if (existingStat.isFile() || existingStat.isSymbolicLink()) {
await fs.unlink(outputFilename)
}
} catch {
// file might not exist or can't be unliked. carry on
}
await fs.cp(item.fsPath, outputFilename, { recursive: true }) await fs.cp(item.fsPath, outputFilename, { recursive: true })
} }
} }
......
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