JS: Overhaul import resolution #19391
Open
Conversation
This file contains hidden or 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
Comment on lines
+4
to
+6
| /** | ||
| * Extension of `PackageJson` with some internal path-resolution predicates. | ||
| */ |
Check warning
Code scanning / CodeQL
Class QLDoc style. Warning
82b8d58 to
56deae6
Compare
56deae6 to
7a81e48
Compare
7a81e48 to
c008ba4
Compare
The new class 'FilePath' has bindingset[this] so one just has to cast a string to that type and you can use its methods.
c008ba4 to
9ae6d8b
Compare
This moves the test for the babel `root-import` plugin into the new unit test for import resolution, so we only have one set of tests to maintain. The actual implementation is added in the next commit.
To avoid negative recursion in some upcoming changes, we want to make sure the modeling of createRequire does not depend on getImportedPath().
9ae6d8b to
620ce66
Compare
path.resolve() and template expressions are now working. Previously they could not be resolved because Import.getImportedPath() returned a PathExpr, and these were not instances of PathExpr.
… name clash 'getTargetFile' was originally named to avoid the clash with 'getImportedFile' from a subclass. But we now just merge the two predicates.
We don't extract node_modules folders by default so these tests aren't that relevant anymore, and we no longer follow node_modules resolution rules directly. Instead, these imports are resolved based on the monorepo support which simply requires a package.json file to exist. There is not a good enough reason to support node_modules directly, so we're accepting some minor regression in these tests.
620ce66 to
b0f73f1
Compare
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.
Updates JS import resolution to avoid depending on the TypeScript compiler, which ultimately led to a completely rewrite of import resolution.
Deprecating PathExpr
This PR deprecates
PathExpr,PathString, andPath, in favor of the parameterised modulesFolder::ResolveandResolveExprand extended models of tsconfig.json and package.json files.PathExprtried to represent multiple things simultaneously:The new implementation has a clear separation between these and can do more powerful constant folding as a result.
The old abstraction also could not properly support path mapping. It had a concept of "search root" but assumed that the value to resolve did not depend on the search root, which is not true for mappings like
@/* -> src/*, where the@/prefix must be chopped off.It also forced all path-resolution logic to happen within a single layer, which complicated library models that need import resolution (Angular). Attempts to refactor things often led to negative recursion due to the Angular model. Parameterised modules don't have this problem as any model can resolve whatever paths they need in the layer they need it.
Evaluation
Evaluation shows neutral performance and about 5k new import edges, and about 30k new call edges, and a few lost imports and call as well.
The alert changes aren't so interesting. Some results were gained in a copy of jQuery, and two alerts were lost as we lost a library input, but not one that seemed likely to be user-controlled.
Review notes
Commit-by-commit view is strongly recommended.
A bunch of unit tests are added in a single commit. The annotations initially represent what we resolve using the baseline implementation (relying on the TypeScript compiler) and you may not want to worry too much about whether those initial annotation are correct; they just represent the baseline.