Skip to content
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

fix: entries in ssr.external #9286

Merged
merged 2 commits into from
Jul 22, 2022
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
19 changes: 16 additions & 3 deletions packages/vite/src/node/ssr/ssrExternal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,22 @@ export function createIsConfiguredAsSsrExternal(
if (!pkgName) {
return undefined
}
if (ssr.external?.includes(pkgName)) {
if (
// If this id is defined as external, force it as external
// Note that individual package entries are allowed in ssr.external
ssr.external?.includes(id)
) {
return true
}
if (
// A package name in ssr.external externalizes every entry
ssr.external?.includes(pkgName)
) {
// Return undefined here to avoid short-circuiting the isExternalizable check,
// that will filter this id out if it is not externalizable (e.g. a CSS file)
// We return here to make ssr.external take precedence over noExternal
return undefined
}
if (typeof noExternal === 'boolean') {
return !noExternal
}
Expand Down Expand Up @@ -154,7 +167,7 @@ function createIsSsrExternal(
isBuild: true
}

const isValidPackageEntry = (id: string) => {
const isExternalizable = (id: string) => {
if (!bareImportRE.test(id) || id.includes('\0')) {
return false
}
Expand All @@ -176,7 +189,7 @@ function createIsSsrExternal(
let external = false
if (!id.startsWith('.') && !path.isAbsolute(id)) {
external =
isBuiltin(id) || (isConfiguredAsExternal(id) ?? isValidPackageEntry(id))
isBuiltin(id) || (isConfiguredAsExternal(id) ?? isExternalizable(id))
}
processedIds.set(id, external)
return external
Expand Down
7 changes: 7 additions & 0 deletions playground/ssr-deps/__tests__/ssr-deps.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,10 @@ test('msg from optimized cjs with nested external', async () => {
'Hello World!'
)
})

test('msg from external using external entry', async () => {
await page.goto(url)
expect(await page.textContent('.external-using-external-entry')).toMatch(
'Hello World!'
)
})
9 changes: 9 additions & 0 deletions playground/ssr-deps/external-entry/entry.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Module with state, to check that it is properly externalized and
// not bundled in the optimized deps
let msg
export function setMessage(externalMsg) {
msg = externalMsg
}
export default function getMessage() {
return msg
}
1 change: 1 addition & 0 deletions playground/ssr-deps/external-entry/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export default undefined
10 changes: 10 additions & 0 deletions playground/ssr-deps/external-entry/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"name": "external-entry",
"private": true,
"version": "0.0.0",
"exports": {
".": "./index.js",
"./entry": "./entry.js"
},
"type": "module"
}
7 changes: 7 additions & 0 deletions playground/ssr-deps/external-using-external-entry/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import getMessage from 'external-entry/entry'

export default {
hello() {
return getMessage()
}
}
10 changes: 10 additions & 0 deletions playground/ssr-deps/external-using-external-entry/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"name": "external-using-external-entry",
"private": true,
"version": "0.0.0",
"type": "module",
"main": "index.js",
"dependencies": {
"external-entry": "file:../external-entry"
}
}
4 changes: 3 additions & 1 deletion playground/ssr-deps/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@
"no-external-css": "file:./no-external-css",
"non-optimized-with-nested-external": "file:./non-optimized-with-nested-external",
"optimized-with-nested-external": "file:./optimized-with-nested-external",
"optimized-cjs-with-nested-external": "file:./optimized-with-nested-external"
"optimized-cjs-with-nested-external": "file:./optimized-with-nested-external",
"external-using-external-entry": "file:./external-using-external-entry",
"external-entry": "file:./external-entry"
},
"devDependencies": {
"cross-env": "^7.0.3",
Expand Down
9 changes: 7 additions & 2 deletions playground/ssr-deps/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,13 @@ export async function createServer(root = process.cwd(), hmrPort) {
},
appType: 'custom',
ssr: {
noExternal: ['no-external-cjs', 'import-builtin-cjs', 'no-external-css'],
external: ['nested-external'],
noExternal: [
'no-external-cjs',
'import-builtin-cjs',
'no-external-css',
'external-entry'
],
external: ['nested-external', 'external-entry/entry'],
optimizeDeps: {
disabled: 'build'
}
Expand Down
7 changes: 7 additions & 0 deletions playground/ssr-deps/src/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ import 'non-optimized-with-nested-external'
import optimizedWithNestedExternal from 'optimized-with-nested-external'
import optimizedCjsWithNestedExternal from 'optimized-cjs-with-nested-external'

import { setMessage } from 'external-entry/entry'
setMessage('Hello World!')
import externalUsingExternalEntry from 'external-using-external-entry'

export async function render(url, rootDir) {
let html = ''

Expand Down Expand Up @@ -68,5 +72,8 @@ export async function render(url, rootDir) {
optimizedCjsWithNestedExternal.hello()
html += `\n<p class="optimized-cjs-with-nested-external">message from optimized-cjs-with-nested-external: ${optimizedCjsWithNestedExternalMessage}</p>`

const externalUsingExternalEntryMessage = externalUsingExternalEntry.hello()
html += `\n<p class="external-using-external-entry">message from external-using-external-entry: ${externalUsingExternalEntryMessage}</p>`

return html + '\n'
}
27 changes: 27 additions & 0 deletions pnpm-lock.yaml

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