[heft] Add options to only resolve symlinks that are within node_modules #5011
Conversation
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
dmichon-msft
requested review from
iclanton,
octogonz,
apostolisms,
D4N14L and
patmill
as code owners
iclanton
reviewed
Nov 20, 2024
common/changes/@rushstack/real-node-module-path/fast-realpath_2024-11-20-03-42.json
Outdated
Show resolved
Hide resolved
heft-plugins/heft-jest-plugin/src/exports/jest-node-modules-symlink-resolver.ts
Show resolved
Hide resolved
D4N14L
reviewed
Nov 20, 2024
common/changes/@rushstack/real-node-module-path/fast-realpath_2024-11-20-03-42.json
Outdated
Show resolved
Hide resolved
For webpack I'd rather use |
dmichon-msft
force-pushed
the
real-node-module-path
branch
from
5f2cacd to
dee68ad
Compare
D4N14L
approved these changes
Nov 20, 2024
dmichon-msft
force-pushed
the
real-node-module-path
branch
from
dee68ad to
99caf58
Compare
D4N14L
reviewed
Nov 20, 2024
iclanton
reviewed
Nov 20, 2024
D4N14L
approved these changes
Nov 21, 2024
|
To clarify, motivation was based on this: Raw execution
Execution with access tracing enabled
Note the 10 seconds of realpath, which these changes work to mostly eliminate. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
TypeScript and Jest spend a lot of CPU cycles invoking
realpathon inputs that don't contain any symbolic links. This PR adds a new package@rushstack/real-node-module-paththat has similar semantics torealpath, but only performs file system calls if the path is undernode_modules.Details
Adds an option
onlyResolveSymlinksInNodeModulestoconfig/typescript.jsonthat will replace the builtinrealpathwith the new package to accelerate initial file system crawling.Adds a custom resolver
@rushstack/heft-jest-plugin/lib/exports/jest-node-modules-symlink-resolver.jsthat replaces therealpathSyncmethod within Jest's default resolver with the new package.How it was tested
Unit tests for the behavior of the function.
Invoked from TypeScript and Jest in heft-webpack5-everything-test.
Enabled both options in local-node-rig so that projects in rushstack build with them.
Impacted documentation
Readmes, schema for typescript.json.