Skip to content

fix(optimizer): return plain object when using require to import externals in optimized dependencies #19940

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 1 commit into from
Apr 28, 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
2 changes: 1 addition & 1 deletion packages/vite/src/node/optimizer/esbuildDepPlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ export function esbuildCjsExternalPlugin(
contents:
`import * as m from ${JSON.stringify(
nonFacadePrefix + args.path,
)};` + `module.exports = m;`,
)};` + `module.exports = { ...m };`,
}),
)
},
Expand Down
6 changes: 6 additions & 0 deletions playground/optimize-deps/__tests__/optimize-deps.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -352,3 +352,9 @@ test('external package name with asset extension', async () => {
page.textContent('.dep-with-asset-ext-prebundled'),
).toBe(String(isServe))
})

test('dependency with external sub-dependency', async () => {
await expectWithRetry(() =>
page.textContent('.dep-cjs-with-external-dep'),
).toBe('ok')
})
4 changes: 4 additions & 0 deletions playground/optimize-deps/dep-cjs-with-external-dep/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
const external = require('@vitejs/test-dep-esm-external')
// eslint-disable-next-line no-prototype-builtins
const result = external.hasOwnProperty('foo') ? 'ok' : 'error'
module.exports = { result }
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "@vitejs/test-dep-cjs-with-external-dep",
"private": true,
"version": "0.0.0",
"main": "index.js",
"dependencies": {
"@vitejs/test-dep-esm-external": "file:../dep-esm-external"
}
}
3 changes: 3 additions & 0 deletions playground/optimize-deps/dep-esm-external/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export function foo() {
return 'foo'
}
7 changes: 7 additions & 0 deletions playground/optimize-deps/dep-esm-external/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"name": "@vitejs/test-dep-esm-external",
"private": true,
"version": "0.0.0",
"main": "index.js",
"type": "module"
}
10 changes: 10 additions & 0 deletions playground/optimize-deps/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -305,3 +305,13 @@ <h2>Pre-bundle transitive dependency 'some-package.pdf'</h2>
import * as sub from '@vitejs/test-dep-source-map-no-sources/sub.js'
import * as all from '@vitejs/test-dep-source-map-no-sources/all.js'
</script>

<h2>Pre-bundle dependency with external sub-dependency</h2>
<div>
require('some-external-sub-dependency') returns a plain object:
<span class="dep-cjs-with-external-dep">???</span>
</div>
<script type="module">
import * as optimized from '@vitejs/test-dep-cjs-with-external-dep'
text('.dep-cjs-with-external-dep', optimized.result)
</script>
1 change: 1 addition & 0 deletions playground/optimize-deps/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +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-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
7 changes: 6 additions & 1 deletion playground/optimize-deps/vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +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',
],
exclude: [
'@vitejs/test-nested-exclude',
'@vitejs/test-dep-non-optimized',
'@vitejs/test-dep-esm-external',
],
exclude: ['@vitejs/test-nested-exclude', '@vitejs/test-dep-non-optimized'],
esbuildOptions: {
plugins: [
{
Expand Down
23 changes: 23 additions & 0 deletions pnpm-lock.yaml

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

Loading