-
-
Notifications
You must be signed in to change notification settings - Fork 6.2k
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(ssr): use tryNodeResolve
instead of resolveFrom
#3951
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
import MagicString from 'magic-string' | ||
import { ResolvedConfig } from '..' | ||
import { Plugin } from '../plugin' | ||
|
||
/** | ||
* This plugin hooks into Node's module resolution algorithm at runtime, | ||
* so that SSR builds can benefit from `resolve.dedupe` like they do | ||
* in development. | ||
*/ | ||
export function ssrRequireHookPlugin(config: ResolvedConfig): Plugin | null { | ||
if (config.command !== 'build' || !config.resolve.dedupe?.length) { | ||
return null | ||
} | ||
return { | ||
name: 'vite:ssr-require-hook', | ||
transform(code, id) { | ||
const moduleInfo = this.getModuleInfo(id) | ||
if (moduleInfo?.isEntry) { | ||
const s = new MagicString(code) | ||
s.prepend( | ||
`;(${dedupeRequire.toString()})(${JSON.stringify( | ||
config.resolve.dedupe | ||
)});\n` | ||
) | ||
return { | ||
code: s.toString(), | ||
map: s.generateMap({ | ||
source: id | ||
}) | ||
} | ||
} | ||
} | ||
} | ||
} | ||
|
||
type NodeResolveFilename = ( | ||
request: string, | ||
parent: NodeModule, | ||
isMain: boolean, | ||
options?: Record<string, any> | ||
) => string | ||
|
||
/** Respect the `resolve.dedupe` option in production SSR. */ | ||
function dedupeRequire(dedupe: string[]) { | ||
const Module = require('module') as { _resolveFilename: NodeResolveFilename } | ||
const resolveFilename = Module._resolveFilename | ||
Module._resolveFilename = function (request, parent, isMain, options) { | ||
if (request[0] !== '.' && request[0] !== '/') { | ||
const parts = request.split('/') | ||
const pkgName = parts[0][0] === '@' ? parts[0] + '/' + parts[1] : parts[0] | ||
if (dedupe.includes(pkgName)) { | ||
// Use this module as the parent. | ||
parent = module | ||
} | ||
} | ||
return resolveFilename!(request, parent, isMain, options) | ||
} | ||
} | ||
|
||
export function hookNodeResolve( | ||
getResolver: (resolveFilename: NodeResolveFilename) => NodeResolveFilename | ||
): () => void { | ||
const Module = require('module') as { _resolveFilename: NodeResolveFilename } | ||
const prevResolver = Module._resolveFilename | ||
Module._resolveFilename = getResolver(prevResolver) | ||
return () => { | ||
Module._resolveFilename = prevResolver | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To further elaborate Ben's comment about
nestedResolveFrom
, which would be on this line in themain
branch. It's currently used to resolveoptimiseDeps.include
with syntax likemy-lib > some-other-lib
. It's probably fine to not updatenestedResolveFrom
as it's currently used to resolve CJS dependencies only, but yeah ideally we want to move away from it too.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for clarifying. The change to
nestedResolveFrom
can be done in a future PR 👍