Add new option "libReplacement", disable by default #60829

jakebailey · 2024-12-19T23:42:26Z

Lib replacement (https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#supporting-lib-from-node_modules) allows specially-named packages in node_modules to replace TypeScript's bundled lib.d.ts files. This feature is always on, so we always perform resolution to look for it in case it exists. This can have a negative perf impact; it's extra watchers, extra CPU time, extra IO, etc.

This PR adds a new compiler option libReplacement to control the feature; by default, it's disabled.

This is certainly a breaking change, but I'd like to run the extended tests / perf on this to see what happens.

The diff shows how much stuff we don't do when this option isn't enabled.

jakebailey · 2024-12-19T23:42:41Z

@typescript-bot test it

typescript-bot · 2024-12-19T23:42:45Z

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 · 2024-12-19T23:42:47Z

Looks like you're introducing a change to the public API surface area. If this includes breaking changes, please document them on our wiki's API Breaking Changes page.

Also, please make sure @DanielRosenwasser and @RyanCavanaugh are aware of the changes, just as a heads up.

typescript-bot · 2024-12-20T00:03:43Z

@jakebailey Here are the results of running the user tests with tsc comparing main and refs/pull/60829/merge:

Everything looks good!

typescript-bot · 2024-12-20T00:05:24Z

Hey @jakebailey, the results of running the DT tests are ready.

Everything looks the same!

You can check the log here.

typescript-bot · 2024-12-20T00:24:39Z

@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
_{Compiler-Unions - node (v18.15.0, x64)}
_Errors	₃₄	₃₄	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_62,363	_62,363	_~	_~	_~	_{p=1.000 n=6}
_Types	_50,395	_50,395	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{193,620k (± 0.76%)}	_{193,000k (± 0.10%)}	_~	_192,861k	_193,244k	_{p=0.230 n=6}
_{Parse Time}	_{1.32s (± 0.42%)}	_{1.30s (± 0.93%)}	_~	_1.29s	_1.32s	_{p=0.090 n=6}
_{Bind Time}	_0.72s	_0.71s	_{-0.01s (- 1.39%)}	_~	_~	_{p=0.001 n=6}
_{Check Time}	_{9.76s (± 0.34%)}	_{9.79s (± 0.20%)}	_{+0.04s (+ 0.36%)}	_9.76s	_9.81s	_{p=0.043 n=6}
_{Emit Time}	_{2.73s (± 0.73%)}	_{2.73s (± 0.28%)}	_~	_2.72s	_2.74s	_{p=0.869 n=6}
_{Total Time}	_{14.52s (± 0.36%)}	_{14.54s (± 0.17%)}	_~	_14.50s	_14.56s	_{p=0.628 n=6}
_{angular-1 - node (v18.15.0, x64)}
_Errors	₃₇	₃₇	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_947,936	_947,936	_~	_~	_~	_{p=1.000 n=6}
_Types	_410,955	_410,955	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{1,225,783k (± 0.00%)}	_{1,224,782k (± 0.00%)}	_{-1,001k (- 0.08%)}	_1,224,709k	_1,224,835k	_{p=0.005 n=6}
_{Parse Time}	_{6.65s (± 0.62%)}	_{6.55s (± 0.56%)}	_{-0.10s (- 1.48%)}	_6.51s	_6.60s	_{p=0.006 n=6}
_{Bind Time}	_{1.89s (± 0.29%)}	_{1.88s (± 1.28%)}	_~	_1.86s	_1.93s	_{p=0.228 n=6}
_{Check Time}	_{31.99s (± 0.37%)}	_{31.96s (± 0.41%)}	_~	_31.80s	_32.13s	_{p=0.810 n=6}
_{Emit Time}	_{15.19s (± 0.25%)}	_{15.12s (± 0.65%)}	_~	_14.93s	_15.21s	_{p=0.126 n=6}
_{Total Time}	_{55.71s (± 0.17%)}	_{55.52s (± 0.35%)}	_{-0.19s (- 0.34%)}	_55.21s	_55.75s	_{p=0.045 n=6}
_{mui-docs - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_2,449,172	_2,449,172	_~	_~	_~	_{p=1.000 n=6}
_Types	_896,410	_896,410	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{2,320,766k (± 0.00%)}	_{2,319,699k (± 0.00%)}	_{-1,067k (- 0.05%)}	_2,319,654k	_2,319,791k	_{p=0.005 n=6}
_{Parse Time}	_{9.40s (± 0.20%)}	_{9.39s (± 0.13%)}	_~	_9.37s	_9.40s	_{p=0.406 n=6}
_{Bind Time}	_{2.24s (± 0.18%)}	_{2.24s (± 0.37%)}	_~	_2.23s	_2.25s	_{p=0.285 n=6}
_{Check Time}	_{73.51s (± 0.49%)}	_{73.73s (± 0.64%)}	_~	_72.92s	_74.18s	_{p=0.298 n=6}
_{Emit Time}	_{0.27s (± 1.89%)}	_0.28s	_{+0.01s (+ 2.44%)}	_~	_~	_{p=0.025 n=6}
_{Total Time}	_{85.42s (± 0.43%)}	_{85.63s (± 0.54%)}	_~	_84.83s	_86.08s	_{p=0.298 n=6}
_{self-build-src - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_1,226,880	_1,226,965	_{+85 (+ 0.01%)}	_~	_~	_{p=0.001 n=6}
_Types	_266,745	_266,768	_{+23 (+ 0.01%)}	_~	_~	_{p=0.001 n=6}
_{Memory used}	_{2,357,644k (± 0.02%)}	_{2,457,134k (± 7.64%)}	_~	_2,335,833k	_2,699,767k	_{p=0.378 n=6}
_{Parse Time}	_{5.22s (± 1.19%)}	_{5.21s (± 1.33%)}	_~	_5.16s	_5.34s	_{p=0.689 n=6}
_{Bind Time}	_{1.75s (± 0.86%)}	_{1.76s (± 1.04%)}	_~	_1.73s	_1.78s	_{p=0.510 n=6}
_{Check Time}	_{35.23s (± 0.15%)}	_{35.03s (± 0.65%)}	_~	_34.76s	_35.39s	_{p=0.066 n=6}
_{Emit Time}	_{2.96s (± 1.03%)}	_{3.01s (± 0.98%)}	_{+0.05s (+ 1.63%)}	_2.96s	_3.04s	_{p=0.043 n=6}
_{Total Time}	_{45.18s (± 0.25%)}	_{45.01s (± 0.42%)}	_~	_44.81s	_45.37s	_{p=0.066 n=6}
_{self-build-src-public-api - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_1,226,880	_1,226,965	_{+85 (+ 0.01%)}	_~	_~	_{p=0.001 n=6}
_Types	_266,745	_266,768	_{+23 (+ 0.01%)}	_~	_~	_{p=0.001 n=6}
_{Memory used}	_{2,911,942k (±12.86%)}	_{3,131,439k (± 0.02%)}	_~	_3,130,166k	_3,132,105k	_{p=0.378 n=6}
_{Parse Time}	_{6.96s (± 1.31%)}	_{6.91s (± 0.77%)}	_~	_6.84s	_6.99s	_{p=0.336 n=6}
_{Bind Time}	_{2.17s (± 1.65%)}	_{2.18s (± 0.69%)}	_~	_2.16s	_2.19s	_{p=0.747 n=6}
_{Check Time}	_{42.81s (± 0.71%)}	_{42.86s (± 0.50%)}	_~	_42.54s	_43.08s	_{p=0.936 n=6}
_{Emit Time}	_{3.52s (± 2.51%)}	_{3.53s (± 1.36%)}	_~	_3.46s	_3.59s	_{p=1.000 n=6}
_{Total Time}	_{55.46s (± 0.54%)}	_{55.50s (± 0.43%)}	_~	_55.14s	_55.84s	_{p=1.000 n=6}
_{self-compiler - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_262,439	_262,468	_{+29 (+ 0.01%)}	_~	_~	_{p=0.001 n=6}
_Types	_106,628	_106,646	_{+18 (+ 0.02%)}	_~	_~	_{p=0.001 n=6}
_{Memory used}	_{440,204k (± 0.01%)}	_{439,119k (± 0.01%)}	_{-1,085k (- 0.25%)}	_439,031k	_439,167k	_{p=0.005 n=6}
_{Parse Time}	_{3.53s (± 1.33%)}	_{3.44s (± 0.65%)}	_{-0.09s (- 2.41%)}	_3.41s	_3.48s	_{p=0.005 n=6}
_{Bind Time}	_{1.31s (± 1.63%)}	_{1.29s (± 1.30%)}	_~	_1.27s	_1.32s	_{p=0.106 n=6}
_{Check Time}	_{18.94s (± 0.25%)}	_{18.94s (± 0.30%)}	_~	_18.87s	_19.02s	_{p=0.872 n=6}
_{Emit Time}	_{1.53s (± 0.76%)}	_{1.54s (± 1.27%)}	_~	_1.51s	_1.56s	_{p=0.222 n=6}
_{Total Time}	_{25.31s (± 0.30%)}	_{25.22s (± 0.14%)}	_~	_25.16s	_25.26s	_{p=0.065 n=6}
_{ts-pre-modules - node (v18.15.0, x64)}
_Errors	₇₀	₇₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_226,062	_226,062	_~	_~	_~	_{p=1.000 n=6}
_Types	_94,488	_94,488	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{371,627k (± 0.01%)}	_{370,508k (± 0.03%)}	_{-1,119k (- 0.30%)}	_370,451k	_370,717k	_{p=0.005 n=6}
_{Parse Time}	_{2.90s (± 1.17%)}	_{2.87s (± 1.64%)}	_~	_2.78s	_2.92s	_{p=0.227 n=6}
_{Bind Time}	_{1.59s (± 0.97%)}	_{1.58s (± 1.35%)}	_~	_1.56s	_1.61s	_{p=0.465 n=6}
_{Check Time}	_{16.44s (± 0.20%)}	_{16.48s (± 0.34%)}	_~	_16.40s	_16.55s	_{p=0.261 n=6}
_{Emit Time}	_{0.00s (±244.70%)}	_{0.00s (±244.70%)}	_~	_0.00s	_0.01s	_{p=1.000 n=6}
_{Total Time}	_{20.93s (± 0.21%)}	_{20.93s (± 0.41%)}	_~	_20.79s	_21.00s	_{p=0.687 n=6}
_{vscode - node (v18.15.0, x64)}
_Errors	₃	₃	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_3,224,468	_3,224,468	_~	_~	_~	_{p=1.000 n=6}
_Types	_1,109,187	_1,109,187	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{3,290,008k (± 0.01%)}	_{3,288,983k (± 0.01%)}	_{-1,026k (- 0.03%)}	_3,288,586k	_3,289,252k	_{p=0.005 n=6}
_{Parse Time}	_{14.14s (± 0.38%)}	_{14.19s (± 0.62%)}	_~	_14.09s	_14.34s	_{p=0.227 n=6}
_{Bind Time}	_{4.56s (± 0.42%)}	_{4.52s (± 0.23%)}	_{-0.04s (- 0.80%)}	_4.51s	_4.54s	_{p=0.007 n=6}
_{Check Time}	_{88.49s (± 3.32%)}	_{89.01s (± 1.88%)}	_~	_86.76s	_90.41s	_{p=0.748 n=6}
_{Emit Time}	_{27.80s (± 8.64%)}	_{28.00s (± 2.67%)}	_~	_27.40s	_29.00s	_{p=0.298 n=6}
_{Total Time}	_{134.98s (± 0.73%)}	_{135.73s (± 0.71%)}	_~	_134.37s	_136.56s	_{p=0.230 n=6}
_{webpack - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_291,562	_291,562	_~	_~	_~	_{p=1.000 n=6}
_Types	_118,971	_118,971	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{445,402k (± 0.01%)}	_{444,426k (± 0.03%)}	_{-977k (- 0.22%)}	_444,239k	_444,607k	_{p=0.005 n=6}
_{Parse Time}	_{4.08s (± 0.65%)}	_{4.04s (± 1.05%)}	_~	_3.99s	_4.09s	_{p=0.106 n=6}
_{Bind Time}	_{1.79s (± 0.55%)}	_{1.78s (± 1.26%)}	_~	_1.76s	_1.82s	_{p=0.391 n=6}
_{Check Time}	_{18.81s (± 0.33%)}	_{18.84s (± 0.63%)}	_~	_18.64s	_18.96s	_{p=0.225 n=6}
_{Emit Time}	_0.00s	_0.00s	_~	_~	_~	_{p=1.000 n=6}
_{Total Time}	_{24.70s (± 0.35%)}	_{24.66s (± 0.64%)}	_~	_24.41s	_24.84s	_{p=1.000 n=6}
_{xstate-main - node (v18.15.0, x64)}
_Errors	₅	₅	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_552,233	_552,233	_~	_~	_~	_{p=1.000 n=6}
_Types	_184,971	_184,971	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{492,410k (± 0.01%)}	_{491,348k (± 0.03%)}	_{-1,062k (- 0.22%)}	_491,069k	_491,470k	_{p=0.005 n=6}
_{Parse Time}	_{4.25s (± 0.24%)}	_{4.20s (± 0.28%)}	_{-0.05s (- 1.14%)}	_4.18s	_4.21s	_{p=0.005 n=6}
_{Bind Time}	_{1.46s (± 0.35%)}	_{1.47s (± 1.43%)}	_~	_1.44s	_1.49s	_{p=0.459 n=6}
_{Check Time}	_{24.11s (± 0.40%)}	_{24.16s (± 0.95%)}	_~	_24.00s	_24.61s	_{p=1.000 n=6}
_{Emit Time}	_0.00s	_0.00s	_~	_~	_~	_{p=1.000 n=6}
_{Total Time}	_{29.81s (± 0.35%)}	_{29.83s (± 0.76%)}	_~	_29.67s	_30.28s	_{p=0.471 n=6}

System info unknown

Hosts

node (v18.15.0, x64)

Scenarios

Compiler-Unions - node (v18.15.0, x64)
angular-1 - node (v18.15.0, x64)
mui-docs - node (v18.15.0, x64)
self-build-src - node (v18.15.0, x64)
self-build-src-public-api - node (v18.15.0, x64)
self-compiler - node (v18.15.0, x64)
ts-pre-modules - node (v18.15.0, x64)
vscode - node (v18.15.0, x64)
webpack - node (v18.15.0, x64)
xstate-main - node (v18.15.0, x64)

_Benchmark	_Name	_Iterations
_Current	_pr	₆
_Baseline	_baseline	₆

Developer Information:

Download Benchmarks

typescript-bot · 2024-12-20T01:13:42Z

@jakebailey Here are the results of running the top 400 repos with tsc comparing main and refs/pull/60829/merge:

Everything looks good!

jakebailey added 3 commits December 19, 2024 15:16

Add libReplacment option

9d9387f

Lock lib replacement behind option

a8eff82

Update baselines

bd74a31

typescript-bot assigned jakebailey Dec 19, 2024

typescript-bot added Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Dec 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new option "libReplacement", disable by default #60829

Add new option "libReplacement", disable by default #60829

jakebailey commented Dec 19, 2024

jakebailey commented Dec 19, 2024

typescript-bot commented Dec 19, 2024 •

edited

Loading

typescript-bot commented Dec 19, 2024

typescript-bot commented Dec 20, 2024

typescript-bot commented Dec 20, 2024

typescript-bot commented Dec 20, 2024

tsc

typescript-bot commented Dec 20, 2024

Add new option "libReplacement", disable by default #60829

Are you sure you want to change the base?

Add new option "libReplacement", disable by default #60829

Conversation

jakebailey commented Dec 19, 2024

jakebailey commented Dec 19, 2024

typescript-bot commented Dec 19, 2024 • edited Loading

typescript-bot commented Dec 19, 2024

typescript-bot commented Dec 20, 2024

typescript-bot commented Dec 20, 2024

typescript-bot commented Dec 20, 2024

tsc

typescript-bot commented Dec 20, 2024

typescript-bot commented Dec 19, 2024 •

edited

Loading