Compare package.json paths with correct sensitivity in getLocalModuleSpecifier by jakebailey · Pull Request #57973 · microsoft/TypeScript

Jake Bailey (jakebailey) · 2024-03-27T22:17:57Z

Fixes#57956
Fixes#57926
Fixes#57802
Closes#57961

Thanks Hang Liang (@xlianghang) for the test.

See the second commit for the change.

Jake Bailey (jakebailey) · 2024-03-27T22:18:05Z

TypeScript Bot (@typescript-bot) pack this

TypeScript Bot (typescript-bot) · 2024-03-27T22:18:07Z

Starting jobs; this comment will be updated as builds start and complete.

Command	Status	Results
`pack this`	✅ Started	✅ Results

Jake Bailey (jakebailey) · 2024-03-27T22:19:04Z

+ nearestTargetPackageJson &&= toPath(nearestTargetPackageJson, projectDirectory, getCanonicalFileName);
+ nearestSourcePackageJson &&= toPath(nearestSourcePackageJson, projectDirectory, getCanonicalFileName);


Not clear if getNearestAncestorDirectoryWithPackageJson should just always return Path.

Or if i should just comparePaths?

This is used elsewhere and a toPath might have other negative affects at those use sites.

If you mean my Path comment, it's only used when reading a file so shouldn't actually affect anything, but it sounds like the comparison one may just be better.

I'd say just use comparePaths. We use it throughout tryGetModuleNameFromExportsOrImports against a path that comes from getNearestAncestorDirectoryWithPackageJson as well, so it would be consistent.

Updated to use a helper; slightly different than the one you suggested but I was having trouble understanding what I was reading...

TypeScript Bot (typescript-bot) · 2024-03-27T22:22:57Z

Hey Jake Bailey (@jakebailey), I've packed this into an installable tgz. You can install it for testing by referencing it in your package.json like so:

{
"devDependencies": {
"typescript": "https://typescript.visualstudio.com/cf7ac146-d525-443c-b23c-0d58337efebc/_apis/build/builds/160790/artifacts?artifactName=tgz&fileId=2ECF6F93582C4D4C0D57F671D7B6546C54FCF3418117B22E972D91463EAC789C02&fileName=/typescript-5.5.0-insiders.20240327.tgz"
}
}

and then running npm install.

There is also a playground for this build and an npm module you can use via "typescript": "npm:@typescript-deploys/pr-build@5.5.0-pr-57973-2".;

Jake Bailey (jakebailey) · 2024-03-27T22:56:52Z

TypeScript Bot (@typescript-bot) test it

TypeScript Bot (typescript-bot) · 2024-03-27T22:56:55Z

Starting jobs; this comment will be updated as builds start and complete.

Command	Status	Results
`test top400`	✅ Started	✅ Results
`user test this`	✅ Started	✅ Results
`run dt`	✅ Started	✅ Results
`perf test this faster`	✅ Started	👀 Results

TypeScript Bot (typescript-bot) · 2024-03-27T23:25:34Z

Jake Bailey (@jakebailey)
The results of the perf run you requested are in!

Here they are:

tsc

Comparison Report - baseline..pr

_Metric	_baseline	_pr	_Delta	_Best	_Worst	_p-value
_{Angular - node (v18.15.0, x64)}
_{Memory used}	_{295,686k (± 0.01%)}	_{295,686k (± 0.01%)}	_~	_295,658k	_295,714k	_{p=0.936 n=6}
_{Parse Time}	_{2.66s (± 0.31%)}	_{2.66s (± 0.28%)}	_~	_2.65s	_2.67s	_{p=0.306 n=6}
_{Bind Time}	_{0.84s (± 0.97%)}	_{0.84s (± 1.06%)}	_~	_0.83s	_0.85s	_{p=0.550 n=6}
_{Check Time}	_{8.26s (± 0.15%)}	_{8.22s (± 0.20%)}	_{-0.04s (- 0.42%)}	_8.19s	_8.24s	_{p=0.003 n=6}
_{Emit Time}	_{7.04s (± 0.18%)}	_{7.05s (± 0.25%)}	_~	_7.02s	_7.07s	_{p=0.565 n=6}
_{Total Time}	_{18.79s (± 0.09%)}	_{18.77s (± 0.05%)}	_{-0.02s (- 0.11%)}	_18.75s	_18.78s	_{p=0.046 n=6}
_{Compiler-Unions - node (v18.15.0, x64)}
_{Memory used}	_{194,461k (± 0.95%)}	_{193,352k (± 0.96%)}	_~	_192,061k	_195,773k	_{p=0.936 n=6}
_{Parse Time}	_{1.65s (± 0.77%)}	_{1.66s (± 0.82%)}	_~	_1.64s	_1.68s	_{p=0.615 n=6}
_{Bind Time}	_{0.87s (± 0.59%)}	_{0.88s (± 0.96%)}	_~	_0.86s	_0.88s	_{p=0.533 n=6}
_{Check Time}	_{11.26s (± 0.41%)}	_{11.27s (± 0.35%)}	_~	_11.22s	_11.31s	_{p=0.629 n=6}
_{Emit Time}	_{3.15s (± 0.71%)}	_{3.14s (± 0.79%)}	_~	_3.11s	_3.17s	_{p=0.571 n=6}
_{Total Time}	_{16.93s (± 0.39%)}	_{16.94s (± 0.23%)}	_~	_16.88s	_16.98s	_{p=0.418 n=6}
_{Monaco - node (v18.15.0, x64)}
_{Memory used}	_{347,407k (± 0.01%)}	_{347,418k (± 0.01%)}	_~	_347,385k	_347,480k	_{p=0.689 n=6}
_{Parse Time}	_{3.70s (± 0.97%)}	_{3.69s (± 1.31%)}	_~	_3.61s	_3.76s	_{p=1.000 n=6}
_{Bind Time}	_{1.38s (± 1.86%)}	_{1.38s (± 0.54%)}	_~	_1.37s	_1.39s	_{p=0.548 n=6}
_{Check Time}	_{10.24s (± 0.44%)}	_{10.23s (± 0.41%)}	_~	_10.17s	_10.28s	_{p=0.808 n=6}
_{Emit Time}	_{6.04s (± 0.52%)}	_{6.00s (± 0.25%)}	_{-0.04s (- 0.61%)}	_5.98s	_6.02s	_{p=0.035 n=6}
_{Total Time}	_{21.35s (± 0.36%)}	_{21.30s (± 0.10%)}	_~	_21.28s	_21.33s	_{p=0.173 n=6}
_{TFS - node (v18.15.0, x64)}
_{Memory used}	_{302,779k (± 0.01%)}	_{302,780k (± 0.01%)}	_~	_302,749k	_302,810k	_{p=1.000 n=6}
_{Parse Time}	_{2.40s (± 1.34%)}	_{2.42s (± 0.76%)}	_~	_2.39s	_2.44s	_{p=0.169 n=6}
_{Bind Time}	_{1.19s (± 0.86%)}	_{1.22s (± 0.52%)}	_{+0.03s (+ 2.23%)}	_1.21s	_1.23s	_{p=0.005 n=6}
_{Check Time}	_{7.51s (± 0.11%)}	_{7.50s (± 0.33%)}	_~	_7.46s	_7.53s	_{p=0.163 n=6}
_{Emit Time}	_{4.26s (± 0.44%)}	_{4.27s (± 0.75%)}	_~	_4.23s	_4.32s	_{p=0.686 n=6}
_{Total Time}	_{15.36s (± 0.13%)}	_{15.40s (± 0.39%)}	_~	_15.34s	_15.50s	_{p=0.295 n=6}
_{material-ui - node (v18.15.0, x64)}
_{Memory used}	_{510,144k (± 0.01%)}	_{510,085k (± 0.01%)}	_~	_510,038k	_510,201k	_{p=0.093 n=6}
_{Parse Time}	_{3.18s (± 0.47%)}	_{3.20s (± 0.55%)}	_~	_3.17s	_3.22s	_{p=0.217 n=6}
_{Bind Time}	_{1.18s (± 1.07%)}	_{1.18s (± 0.44%)}	_~	_1.18s	_1.19s	_{p=0.931 n=6}
_{Check Time}	_{20.56s (± 0.25%)}	_{20.55s (± 0.21%)}	_~	_20.50s	_20.62s	_{p=0.630 n=6}
_{Emit Time}	_{0.00s (± 0.00%)}	_{0.00s (± 0.00%)}	_~	_0.00s	_0.00s	_{p=1.000 n=6}
_{Total Time}	_{24.92s (± 0.26%)}	_{24.93s (± 0.23%)}	_~	_24.87s	_25.01s	_{p=0.936 n=6}
_{mui-docs - node (v18.15.0, x64)}
_{Memory used}	_{1,744,452k (± 0.00%)}	_{1,744,451k (± 0.00%)}	_~	_1,744,399k	_1,744,519k	_{p=0.936 n=6}
_{Parse Time}	_{9.59s (± 0.60%)}	_{9.63s (± 0.64%)}	_~	_9.53s	_9.69s	_{p=0.376 n=6}
_{Bind Time}	_{3.45s (± 0.91%)}	_{3.46s (± 0.93%)}	_~	_3.41s	_3.51s	_{p=0.626 n=6}
_{Check Time}	_{81.72s (± 0.34%)}	_{81.66s (± 0.52%)}	_~	_81.05s	_82.28s	_{p=0.936 n=6}
_{Emit Time}	_{0.19s (± 2.13%)}	_{0.19s (± 0.00%)}	_~	_0.19s	_0.19s	_{p=0.405 n=6}
_{Total Time}	_{94.96s (± 0.27%)}	_{94.94s (± 0.46%)}	_~	_94.30s	_95.64s	_{p=0.936 n=6}
_{self-build-src - node (v18.15.0, x64)}
_{Memory used}	_{2,396,078k (± 0.03%)}	_{2,395,862k (± 0.02%)}	_~	_2,395,030k	_2,396,842k	_{p=0.689 n=6}
_{Parse Time}	_{6.00s (± 0.91%)}	_{6.00s (± 1.08%)}	_~	_5.93s	_6.09s	_{p=1.000 n=6}
_{Bind Time}	_{2.26s (± 1.23%)}	_{2.29s (± 1.12%)}	_~	_2.27s	_2.34s	_{p=0.127 n=6}
_{Check Time}	_{39.89s (± 0.22%)}	_{39.90s (± 0.31%)}	_~	_39.76s	_40.06s	_{p=0.936 n=6}
_{Emit Time}	_{3.14s (± 1.68%)}	_{3.15s (± 1.19%)}	_~	_3.11s	_3.22s	_{p=0.936 n=6}
_{Total Time}	_{51.31s (± 0.28%)}	_{51.38s (± 0.20%)}	_~	_51.23s	_51.48s	_{p=0.810 n=6}
_{self-compiler - node (v18.15.0, x64)}
_{Memory used}	_{415,839k (± 0.01%)}	_{415,882k (± 0.02%)}	_~	_415,803k	_416,049k	_{p=0.378 n=6}
_{Parse Time}	_{4.10s (± 0.33%)}	_{4.12s (± 0.94%)}	_~	_4.06s	_4.17s	_{p=0.371 n=6}
_{Bind Time}	_{1.59s (± 0.62%)}	_{1.58s (± 1.11%)}	_~	_1.55s	_1.60s	_{p=0.117 n=6}
_{Check Time}	_{22.54s (± 0.16%)}	_{22.53s (± 0.35%)}	_~	_22.43s	_22.61s	_{p=0.872 n=6}
_{Emit Time}	_{1.72s (± 1.80%)}	_{1.69s (± 1.59%)}	_~	_1.67s	_1.74s	_{p=0.107 n=6}
_{Total Time}	_{29.96s (± 0.11%)}	_{29.92s (± 0.37%)}	_~	_29.80s	_30.05s	_{p=0.689 n=6}
_{vscode - node (v18.15.0, x64)}
_{Memory used}	_{2,896,201k (± 0.00%)}	_{2,896,256k (± 0.00%)}	_{+56k (+ 0.00%)}	_2,896,149k	_2,896,322k	_{p=0.045 n=6}
_{Parse Time}	_{12.94s (± 0.32%)}	_{13.42s (± 8.52%)}	_~	_12.89s	_15.76s	_{p=0.255 n=6}
_{Bind Time}	_{4.14s (± 0.33%)}	_{4.15s (± 0.10%)}	_~	_4.14s	_4.15s	_{p=0.078 n=6}
_{Check Time}	_{72.03s (± 0.29%)}	_{71.93s (± 0.34%)}	_~	_71.65s	_72.20s	_{p=0.689 n=6}
_{Emit Time}	_{19.37s (± 0.47%)}	_{19.42s (± 0.76%)}	_~	_19.29s	_19.62s	_{p=1.000 n=6}
_{Total Time}	_{108.48s (± 0.16%)}	_{108.92s (± 1.18%)}	_~	_108.02s	_111.48s	_{p=0.873 n=6}
_{webpack - node (v18.15.0, x64)}
_{Memory used}	_{408,874k (± 0.02%)}	_{408,918k (± 0.04%)}	_~	_408,774k	_409,181k	_{p=0.936 n=6}
_{Parse Time}	_{3.89s (± 0.68%)}	_{3.88s (± 0.55%)}	_~	_3.86s	_3.92s	_{p=0.468 n=6}
_{Bind Time}	_{1.69s (± 0.81%)}	_{1.69s (± 1.06%)}	_~	_1.67s	_1.72s	_{p=0.935 n=6}
_{Check Time}	_{16.85s (± 0.18%)}	_{16.88s (± 0.38%)}	_~	_16.80s	_16.96s	_{p=0.575 n=6}
_{Emit Time}	_{0.00s (± 0.00%)}	_{0.00s (± 0.00%)}	_~	_0.00s	_0.00s	_{p=1.000 n=6}
_{Total Time}	_{22.43s (± 0.10%)}	_{22.45s (± 0.35%)}	_~	_22.35s	_22.55s	_{p=0.627 n=6}
_{xstate - node (v18.15.0, x64)}
_{Memory used}	_{513,400k (± 0.02%)}	_{513,364k (± 0.01%)}	_~	_513,276k	_513,458k	_{p=0.936 n=6}
_{Parse Time}	_{3.28s (± 0.23%)}	_{3.28s (± 0.33%)}	_~	_3.27s	_3.30s	_{p=0.604 n=6}
_{Bind Time}	_{1.57s (± 0.00%)}	_{1.57s (± 0.26%)}	_~	_1.57s	_1.58s	_{p=0.405 n=6}
_{Check Time}	_{2.90s (± 0.56%)}	_{2.90s (± 0.49%)}	_~	_2.88s	_2.92s	_{p=0.745 n=6}
_{Emit Time}	_{0.07s (± 7.03%)}	_{0.07s (± 5.69%)}	_~	_0.07s	_0.08s	_{p=0.595 n=6}
_{Total Time}	_{7.82s (± 0.15%)}	_{7.82s (± 0.21%)}	_~	_7.80s	_7.85s	_{p=0.806 n=6}

System info unknown

Hosts

node (v18.15.0, x64)

Scenarios

Angular - node (v18.15.0, x64)
Compiler-Unions - node (v18.15.0, x64)
Monaco - node (v18.15.0, x64)
TFS - node (v18.15.0, x64)
material-ui - node (v18.15.0, x64)
mui-docs - node (v18.15.0, x64)
self-build-src - node (v18.15.0, x64)
self-compiler - node (v18.15.0, x64)
vscode - node (v18.15.0, x64)
webpack - node (v18.15.0, x64)
xstate - node (v18.15.0, x64)

_Benchmark	_Name	_Iterations
_Current	_pr	₆
_Baseline	_baseline	₆

Developer Information:

Download Benchmarks

TypeScript Bot (typescript-bot) · 2024-03-27T23:27:11Z

Hey Jake Bailey (@jakebailey), the results of running the DT tests are ready.

Everything looks the same!

You can check the log here.

Jake Bailey (jakebailey) · 2024-03-27T23:34:33Z

TypeScript Bot (@typescript-bot) cherry-pick this to release-5.4

TypeScript Bot (typescript-bot) · 2024-03-27T23:34:35Z

Starting jobs; this comment will be updated as builds start and complete.

Command	Status	Results
`cherry-pick this to release-5.4`	✅ Started	✅ Results

TypeScript Bot (typescript-bot) · 2024-03-27T23:36:54Z

Hey, Jake Bailey (@jakebailey)! I've created #57976 for you.

TypeScript Bot (typescript-bot) · 2024-03-27T23:38:16Z

Jake Bailey (@jakebailey) Here are the results of running the user tests comparing main and refs/pull/57973/merge:

Everything looks good!

Sheetal Nandi (sheetalkamat) · 2024-03-28T00:15:12Z

+function packageJsonPathsAreEqual(a: string | undefined, b: string | undefined, ignoreCase?: boolean) {
+ if (a === b) return true;
+ if (a === undefined || b === undefined) return false;
+ return comparePaths(a, b, ignoreCase) === Comparison.EqualTo;


dont you need to pass current directory for this to work correctly

These paths are already absolute, it seems, so nothing broke...

Checked the other use in this file and they don't pass in the working dir either (also for paths from this host method)

TypeScript Bot (typescript-bot) · 2024-03-28T00:47:10Z

Jake Bailey (@jakebailey) Here are the results of running the top 400 repos comparing main and refs/pull/57973/merge:

Everything looks good!

Andrew Branch (andrewbranch) · 2024-03-28T17:13:06Z

Fixes #57802

…e-5.4 (#57976) Co-authored-by: Jake Bailey <5341706+jakebailey@users.noreply.github.com>

Jake Bailey (jakebailey) added 2 commits March 27, 2024 15:16

Add test
2392574

Ensure package.json dir is compared after being toPath'd
36f39fb

TypeScript Bot (typescript-bot) assigned Jake Bailey (jakebailey)Mar 27, 2024

TypeScript Bot (typescript-bot) added the Author: Team label Mar 27, 2024

TypeScript Bot (typescript-bot) assigned Ron Buckton (rbuckton)Mar 27, 2024

TypeScript Bot (typescript-bot) added the For Uncommitted Bug PR for untriaged, rejected, closed or missing bug label Mar 27, 2024

Andrew Branch (andrewbranch) approved these changes Mar 27, 2024
View reviewed changes

Jake Bailey (jakebailey) commented Mar 27, 2024
View reviewed changes

Jake Bailey (jakebailey) mentioned this pull request Mar 27, 2024
Compilation fails with TS6059 under Windows 10 but passes under Windows 11 or Linux #57926
Closed

Use comparePaths via helper
19ca8eb

Jake Bailey (jakebailey) changed the title ~~Ensure package.json dir is compared after being toPath'd~~Compare package.json paths with correct sensitivityMar 27, 2024

Jake Bailey (jakebailey) changed the title ~~Compare package.json paths with correct sensitivity~~Compare package.json paths with correct sensitivity in getLocalModuleSpecifierMar 27, 2024

Mark Brodziak (brodziakm) mentioned this pull request Mar 27, 2024
'rootDir' is expected to contain all source files. Bundle failed: test-icons nrwl/nx#11289
Closed

Ryan Cavanaugh (RyanCavanaugh) approved these changes Mar 27, 2024
View reviewed changes

TypeScript Bot (typescript-bot) mentioned this pull request Mar 27, 2024
🤖 Pick PR #57973 (Compare package.json paths with cor...) into release-5.4 #57976
Merged

Ron Buckton (rbuckton) approved these changes Mar 28, 2024
View reviewed changes

Sheetal Nandi (sheetalkamat) reviewed Mar 28, 2024
View reviewed changes

TypeScript Bot (typescript-bot) added For Milestone Bug PRs that fix a bug with a specific milestone and removed For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Mar 28, 2024

Jake Bailey (jakebailey) merged commit 35f4f03 into microsoft:mainMar 28, 2024

Jake Bailey (jakebailey) deleted the weird-case-thing branch March 28, 2024 17:33

Daniel Rosenwasser (DanielRosenwasser) pushed a commit that referenced this pull request Mar 28, 2024
🤖 Pick PR#57973(Compare package.json paths with cor...) into releas…
06aae98
…e-5.4 (#57976) Co-authored-by: Jake Bailey <5341706+jakebailey@users.noreply.github.com>

Daniel Rosenwasser (DanielRosenwasser) added this to the TypeScript 5.4.32 milestone Mar 28, 2024

Jake Bailey (jakebailey) mentioned this pull request Apr 2, 2024
TypeScript 5.4 import path completion results in unintended paths #58034
Closed

Microsoft (microsoft) locked as resolved and limited conversation to collaborators Oct 16, 2025

		nearestTargetPackageJson &&= toPath(nearestTargetPackageJson, projectDirectory, getCanonicalFileName);
		nearestSourcePackageJson &&= toPath(nearestSourcePackageJson, projectDirectory, getCanonicalFileName);

Uh oh!

Conversation

Jake Bailey (jakebailey) commented Mar 27, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Jake Bailey (jakebailey) commented Mar 27, 2024

Uh oh!

TypeScript Bot (typescript-bot) commented Mar 27, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TypeScript Bot (typescript-bot) commented Mar 27, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Jake Bailey (jakebailey) commented Mar 27, 2024

Uh oh!

TypeScript Bot (typescript-bot) commented Mar 27, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TypeScript Bot (typescript-bot) commented Mar 27, 2024

tsc

Uh oh!

TypeScript Bot (typescript-bot) commented Mar 27, 2024

Uh oh!

Jake Bailey (jakebailey) commented Mar 27, 2024

Uh oh!

TypeScript Bot (typescript-bot) commented Mar 27, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TypeScript Bot (typescript-bot) commented Mar 27, 2024

Uh oh!

TypeScript Bot (typescript-bot) commented Mar 27, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TypeScript Bot (typescript-bot) commented Mar 28, 2024

Uh oh!

Andrew Branch (andrewbranch) commented Mar 28, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Jake Bailey (jakebailey) commented Mar 27, 2024•
edited
Loading

TypeScript Bot (typescript-bot) commented Mar 27, 2024•
edited
Loading

TypeScript Bot (typescript-bot) commented Mar 27, 2024•
edited
Loading

TypeScript Bot (typescript-bot) commented Mar 27, 2024•
edited
Loading

TypeScript Bot (typescript-bot) commented Mar 27, 2024•
edited
Loading