Skip to content

fix(ssr): avoid resolving ESM for CJS dependencies #5693

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.

Sign up for GitHub

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
patak-cat merged 2 commits into from
Nov 16, 2021
Merged

fix(ssr): avoid resolving ESM for CJS dependencies #5693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89f43cb
fix(ssr): avoid resolving ESM for CJS dependencies
aleclarson Nov 15, 2021
e3e6ed1
chore: remove unnecessary `preserveSymlinks` arguments
aleclarson Nov 15, 2021
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
119 changes: 39 additions & 80 deletions packages/vite/src/node/plugins/resolve.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ export interface InternalResolveOptions extends ResolveOptions {
// if the specifier requests a non-existent `.js/jsx/mjs/cjs` file,
// should also try import from `.ts/tsx/mts/cts` source file as fallback.
isFromTsImporter?: boolean
tryEsmOnly?: boolean
}

export function resolvePlugin(baseOptions: InternalResolveOptions): Plugin {
Expand Down Expand Up @@ -118,14 +119,12 @@ export function resolvePlugin(baseOptions: InternalResolveOptions): Plugin {
isFromTsImporter: isTsRequest(importer ?? '')
}

const preserveSymlinks = !!server?.config.resolve.preserveSymlinks

let res: string | PartialResolvedId | undefined

// explicit fs paths that starts with /@fs/*
if (asSrc && id.startsWith(FS_PREFIX)) {
const fsPath = fsPathFromId(id)
res = tryFsResolve(fsPath, options, preserveSymlinks)
res = tryFsResolve(fsPath, options)
isDebug && debug(`[@fs] ${chalk.cyan(id)} -> ${chalk.dim(res)}`)
// always return here even if res doesn't exist since /@fs/ is explicit
// if the file doesn't exist it should be a 404
Expand All @@ -136,7 +135,7 @@ export function resolvePlugin(baseOptions: InternalResolveOptions): Plugin {
// /foo -> /fs-root/foo
if (asSrc && id.startsWith('/')) {
const fsPath = path.resolve(root, id.slice(1))
if ((res = tryFsResolve(fsPath, options, preserveSymlinks))) {
if ((res = tryFsResolve(fsPath, options))) {
isDebug && debug(`[url] ${chalk.cyan(id)} -> ${chalk.dim(res)}`)
return res
}
Expand Down Expand Up @@ -171,18 +170,12 @@ export function resolvePlugin(baseOptions: InternalResolveOptions): Plugin {

if (
targetWeb &&
(res = tryResolveBrowserMapping(
fsPath,
importer,
options,
true,
preserveSymlinks
))
(res = tryResolveBrowserMapping(fsPath, importer, options, true))
) {
return res
}

if ((res = tryFsResolve(fsPath, options, preserveSymlinks))) {
if ((res = tryFsResolve(fsPath, options))) {
isDebug && debug(`[relative] ${chalk.cyan(id)} -> ${chalk.dim(res)}`)
const pkg = importer != null && idToPkgMap.get(importer)
if (pkg) {
Expand All @@ -197,10 +190,7 @@ export function resolvePlugin(baseOptions: InternalResolveOptions): Plugin {
}

// absolute fs paths
if (
path.isAbsolute(id) &&
(res = tryFsResolve(id, options, preserveSymlinks))
) {
if (path.isAbsolute(id) && (res = tryFsResolve(id, options))) {
isDebug && debug(`[fs] ${chalk.cyan(id)} -> ${chalk.dim(res)}`)
return res
}
Expand Down Expand Up @@ -232,13 +222,7 @@ export function resolvePlugin(baseOptions: InternalResolveOptions): Plugin {

if (
targetWeb &&
(res = tryResolveBrowserMapping(
id,
importer,
options,
false,
preserveSymlinks
))
(res = tryResolveBrowserMapping(id, importer, options, false))
) {
return res
}
Expand Down Expand Up @@ -305,7 +289,6 @@ export function resolvePlugin(baseOptions: InternalResolveOptions): Plugin {
function tryFsResolve(
fsPath: string,
options: InternalResolveOptions,
preserveSymlinks?: boolean,
tryIndex = true,
targetWeb = true
): string | undefined {
Expand All @@ -332,7 +315,6 @@ function tryFsResolve(
options,
false,
targetWeb,
preserveSymlinks,
options.tryPrefix,
options.skipPackageJson
))
Expand All @@ -347,7 +329,6 @@ function tryFsResolve(
options,
false,
targetWeb,
preserveSymlinks,
options.tryPrefix,
options.skipPackageJson
))
Expand All @@ -364,7 +345,6 @@ function tryFsResolve(
options,
false,
targetWeb,
preserveSymlinks,
options.tryPrefix,
options.skipPackageJson
))
Expand All @@ -379,7 +359,6 @@ function tryFsResolve(
options,
false,
targetWeb,
preserveSymlinks,
options.tryPrefix,
options.skipPackageJson
))
Expand All @@ -396,7 +375,6 @@ function tryFsResolve(
options,
tryIndex,
targetWeb,
preserveSymlinks,
options.tryPrefix,
options.skipPackageJson
))
Expand All @@ -411,7 +389,6 @@ function tryFsResolve(
options,
tryIndex,
targetWeb,
preserveSymlinks,
options.tryPrefix,
options.skipPackageJson
))
Expand All @@ -426,7 +403,6 @@ function tryResolveFile(
options: InternalResolveOptions,
tryIndex: boolean,
targetWeb: boolean,
preserveSymlinks?: boolean,
tryPrefix?: string,
skipPackageJson?: boolean
): string | undefined {
Expand All @@ -435,24 +411,18 @@ function tryResolveFile(
// unnecessary in the first place)
if (isFileReadable(file)) {
if (!fs.statSync(file).isDirectory()) {
return getRealPath(file, preserveSymlinks) + postfix
return getRealPath(file, options.preserveSymlinks) + postfix
} else if (tryIndex) {
if (!skipPackageJson) {
const pkgPath = file + '/package.json'
if (fs.existsSync(pkgPath)) {
// path points to a node package
const pkg = loadPackageData(pkgPath)
const resolved = resolvePackageEntry(
file,
pkg,
options,
targetWeb,
preserveSymlinks
)
const resolved = resolvePackageEntry(file, pkg, targetWeb, options)
return resolved
}
}
const index = tryFsResolve(file + '/index', options, preserveSymlinks)
const index = tryFsResolve(file + '/index', options)
if (index) return index + postfix
}
}
Expand All @@ -466,22 +436,14 @@ function tryResolveFile(
options,
tryIndex,
targetWeb,
preserveSymlinks,
tryPrefix,
skipPackageJson
)
}

if (tryPrefix) {
const prefixed = `${path.dirname(file)}/${tryPrefix}${path.basename(file)}`
return tryResolveFile(
prefixed,
postfix,
options,
tryIndex,
targetWeb,
preserveSymlinks
)
return tryResolveFile(prefixed, postfix, options, tryIndex, targetWeb)
}
}

Expand Down Expand Up @@ -559,23 +521,29 @@ export function tryNodeResolve(
return
}

let resolved =
nestedPath !== pkgId
? resolveDeepImport(
'.' + nestedPath.slice(pkgId.length),
pkg,
options,
targetWeb,
options.preserveSymlinks
)
: resolvePackageEntry(
nestedPath,
pkg,
options,
targetWeb,
options.preserveSymlinks
)
let resolveId = resolvePackageEntry
let unresolvedId = pkgId
if (unresolvedId !== nestedPath) {
resolveId = resolveDeepImport
unresolvedId = '.' + nestedPath.slice(pkgId.length)
}

let resolved: string | undefined
try {
resolved = resolveId(unresolvedId, pkg, targetWeb, options)
} catch (err) {
if (!options.tryEsmOnly) {
throw err
}
}
if (!resolved && options.tryEsmOnly) {
resolved = resolveId(unresolvedId, pkg, targetWeb, {
...options,
isRequire: false,
mainFields: DEFAULT_MAIN_FIELDS,
extensions: DEFAULT_EXTENSIONS
})
}
if (!resolved) {
return
}
Expand Down Expand Up @@ -760,9 +728,8 @@ function loadPackageData(pkgPath: string, cacheKey = pkgPath) {
export function resolvePackageEntry(
id: string,
{ dir, data, setResolvedCache, getResolvedCache }: PackageData,
options: InternalResolveOptions,
targetWeb: boolean,
preserveSymlinks = false
options: InternalResolveOptions
): string | undefined {
const cached = getResolvedCache('.', targetWeb)
if (cached) {
Expand Down Expand Up @@ -799,8 +766,7 @@ export function resolvePackageEntry(
// instead; Otherwise, assume it's ESM and use it.
const resolvedBrowserEntry = tryFsResolve(
path.join(dir, browserEntry),
options,
preserveSymlinks
options
)
if (resolvedBrowserEntry) {
const content = fs.readFileSync(resolvedBrowserEntry, 'utf-8')
Expand Down Expand Up @@ -846,11 +812,7 @@ export function resolvePackageEntry(
}

entryPoint = path.join(dir, entryPoint)
const resolvedEntryPoint = tryFsResolve(
entryPoint,
options,
preserveSymlinks
)
const resolvedEntryPoint = tryFsResolve(entryPoint, options)

if (resolvedEntryPoint) {
isDebug &&
Expand Down Expand Up @@ -906,9 +868,8 @@ function resolveDeepImport(
dir,
data
}: PackageData,
options: InternalResolveOptions,
targetWeb: boolean,
preserveSymlinks?: boolean
options: InternalResolveOptions
): string | undefined {
const cache = getResolvedCache(id, targetWeb)
if (cache) {
Expand Down Expand Up @@ -945,7 +906,6 @@ function resolveDeepImport(
const resolved = tryFsResolve(
path.join(dir, relativeId),
options,
preserveSymlinks,
!exportsField, // try index only if no exports field
targetWeb
)
Expand All @@ -962,8 +922,7 @@ function tryResolveBrowserMapping(
id: string,
importer: string | undefined,
options: InternalResolveOptions,
isFilePath: boolean,
preserveSymlinks: boolean
isFilePath: boolean
) {
let res: string | undefined
const pkg = importer && idToPkgMap.get(importer)
Expand All @@ -972,7 +931,7 @@ function tryResolveBrowserMapping(
const browserMappedPath = mapWithBrowserField(mapId, pkg.data.browser)
if (browserMappedPath) {
const fsPath = path.join(pkg.dir, browserMappedPath)
if ((res = tryFsResolve(fsPath, options, preserveSymlinks))) {
if ((res = tryFsResolve(fsPath, options))) {
isDebug &&
debug(`[browser mapped] ${chalk.cyan(id)} -> ${chalk.dim(res)}`)
idToPkgMap.set(res, pkg)
Expand Down
Loading