Skip to content

fix(optimizer): non object module.exports for Node builtin modules in CJS external facade #20048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions packages/vite/src/node/optimizer/esbuildDepPlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
isBuiltin,
isCSSRequest,
isExternalUrl,
isNodeBuiltin,
moduleListContains,
normalizePath,
} from '../utils'
Expand Down Expand Up @@ -337,10 +338,10 @@ export function esbuildCjsExternalPlugin(
build.onLoad(
{ filter: /.*/, namespace: cjsExternalFacadeNamespace },
(args) => ({
contents:
`import * as m from ${JSON.stringify(
nonFacadePrefix + args.path,
)};` + `module.exports = { ...m };`,
contents: `\
import * as m from ${JSON.stringify(nonFacadePrefix + args.path)};
module.exports = ${isNodeBuiltin(args.path) ? 'm.default' : '{ ...m }'};
`,
}),
)
},
Expand Down
7 changes: 5 additions & 2 deletions playground/optimize-deps/__tests__/optimize-deps.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -365,8 +365,11 @@ test('external package name with asset extension', async () => {
).toBe(String(isServe))
})

test('dependency with external sub-dependency', async () => {
test('dependency with external sub-dependencies', async () => {
await expectWithRetry(() =>
page.textContent('.dep-cjs-with-external-dep'),
page.textContent('.dep-cjs-with-external-deps-object'),
).toBe('ok')
await expectWithRetry(() =>
page.textContent('.dep-cjs-with-external-deps-node-builtin'),
).toBe('foo bar')
})
4 changes: 0 additions & 4 deletions playground/optimize-deps/dep-cjs-with-external-dep/index.js

This file was deleted.

This file was deleted.

8 changes: 8 additions & 0 deletions playground/optimize-deps/dep-cjs-with-external-deps/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// `stream` is used as the package name for `@vitejs/test-dep-esm-dummy-node-builtin` so that it is treated like a Node builtin
// eslint-disable-next-line import-x/no-nodejs-modules
const externalDummyNodeBuiltin = require('stream')
const external = require('@vitejs/test-dep-esm-external')
// eslint-disable-next-line no-prototype-builtins
const externalResult = external.hasOwnProperty('foo') ? 'ok' : 'error'
const externalDummyNodeBuiltinResult = `${externalDummyNodeBuiltin()} ${externalDummyNodeBuiltin.bar}`
module.exports = { externalResult, externalDummyNodeBuiltinResult }
10 changes: 10 additions & 0 deletions playground/optimize-deps/dep-cjs-with-external-deps/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"name": "@vitejs/test-dep-cjs-with-external-deps",
"private": true,
"version": "0.0.0",
"main": "index.js",
"dependencies": {
"@vitejs/test-dep-esm-external": "file:../dep-esm-external",
"stream": "file:../dep-esm-dummy-node-builtin"
}
}
9 changes: 9 additions & 0 deletions playground/optimize-deps/dep-esm-dummy-node-builtin/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
function foo() {
return 'foo'
}

foo.bar = 'bar'

export const bar = 'bar'

export default foo
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"name": "@vitejs/test-dep-esm-dummy-node-builtin",
"private": true,
"version": "0.0.0",
"main": "index.js",
"type": "module"
}
20 changes: 15 additions & 5 deletions playground/optimize-deps/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -310,12 +310,22 @@ <h2>Pre-bundle transitive dependency 'some-package.pdf'</h2>
import * as all from '@vitejs/test-dep-source-map-no-sources/all.js'
</script>

<h2>Pre-bundle dependency with external sub-dependency</h2>
<h2>Pre-bundle dependency with external sub-dependencies</h2>
<div>
require('some-external-sub-dependency') returns a plain object:
<span class="dep-cjs-with-external-dep">???</span>
require('some-external-sub-dependency') returns a plain object rather than a
module namespace object:
<span class="dep-cjs-with-external-deps-object">???</span>
</div>
<div>
require('some-external-sub-dependency') returns the default export if the
dependency is a Node builtin:
<span class="dep-cjs-with-external-deps-node-builtin">???</span>
</div>
<script type="module">
import * as optimized from '@vitejs/test-dep-cjs-with-external-dep'
text('.dep-cjs-with-external-dep', optimized.result)
import * as optimized from '@vitejs/test-dep-cjs-with-external-deps'
text('.dep-cjs-with-external-deps-object', optimized.externalResult)
text(
'.dep-cjs-with-external-deps-node-builtin',
optimized.externalDummyNodeBuiltinResult,
)
</script>
2 changes: 1 addition & 1 deletion playground/optimize-deps/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"@vitejs/test-dep-cjs-compiled-from-cjs": "file:./dep-cjs-compiled-from-cjs",
"@vitejs/test-dep-cjs-compiled-from-esm": "file:./dep-cjs-compiled-from-esm",
"@vitejs/test-dep-cjs-with-assets": "file:./dep-cjs-with-assets",
"@vitejs/test-dep-cjs-with-external-dep": "file:./dep-cjs-with-external-dep",
"@vitejs/test-dep-cjs-with-external-deps": "file:./dep-cjs-with-external-deps",
"@vitejs/test-dep-css-require": "file:./dep-css-require",
"@vitejs/test-dep-esbuild-plugin-transform": "file:./dep-esbuild-plugin-transform",
"@vitejs/test-dep-incompatible": "file:./dep-incompatible",
Expand Down
3 changes: 2 additions & 1 deletion playground/optimize-deps/vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,13 @@ export default defineConfig({
'@vitejs/test-dep-optimize-exports-with-glob/**/*',
'@vitejs/test-dep-optimize-exports-with-root-glob/**/*.js',
'@vitejs/test-dep-optimize-with-glob/**/*.js',
'@vitejs/test-dep-cjs-with-external-dep',
'@vitejs/test-dep-cjs-with-external-deps',
],
exclude: [
'@vitejs/test-nested-exclude',
'@vitejs/test-dep-non-optimized',
'@vitejs/test-dep-esm-external',
'stream',
],
esbuildOptions: {
plugins: [
Expand Down
25 changes: 18 additions & 7 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.