src: add JS APIs for compile cache and NODE_DISABLE_COMPILE_CACHE by joyeecheung · Pull Request #54501 · nodejs/node

joyeecheung · 2024-08-22T16:45:56Z

Text for releasers:

This adds a new API module.enableCompileCache() that can be used to enable on-disk code caching of all modules loaded after this API is called. Previously this could only be enabled by the NODE_COMPILE_CACHE environment variable, so it could only set by end-users. This API allows tooling and library authors to enable caching of their own code. This is a built-in alternative to the v8-compile-cache/v8-compile-cache-lib packages, but have better performance and supports ESM.

In addition this adds module.getCompileCacheDir() to query the status of the compile cache, and a NODE_DISABLE_COMPILE_CACHE environment variable to disable the code cache. This serves as an escape hatch for end users to avoid unexpected/undesired effects of the compile cache (e.g. less precise test coverage).

When the module.enableCompileCache() method is invoked without a specified directory, Node.js will use the value of the NODE_COMPILE_CACHE environment variable if it's set, or defaults to path.join(os.tmpdir(), 'node-compile-cache') otherwise. Therefore it's recommended for tools to call this method without a directory argument to allow overrides.

Fixes: #53639

This patch adds the following API for tools to enable compile cache dynamically and query its status. - module.enableCompileCache(cacheDir) - module.getCompileCacheDir() In addition this adds a NODE_DISABLE_COMPILE_CACHE environment variable to disable the code cache enabled by the APIs as an escape hatch to avoid unexpected/undesired effects of the compile cache (e.g. less precise test coverage). When the module.enableCompileCache() method is invoked without a specified directory, Node.js will use the value of the NODE_COMPILE_CACHE environment variable if it's set, or defaults to `path.join(os.tmpdir(), 'node-compile-cache')` otherwise. Therefore it's recommended for tools to call this method without specifying the directory to allow overrides.

nodejs-github-bot · 2024-08-22T16:46:01Z

Review requested:

@nodejs/loaders

benjamingr

LGTM

jakebailey · 2024-08-22T17:44:35Z

I put together microsoft/TypeScript#59720 to enable this in TypeScript; the results are as expected:

Benchmark 1: ~/work/node/out/Release/node ./built/local/_tsc.js --version
  Time (mean ± σ):     120.5 ms ±   1.7 ms    [User: 108.6 ms, System: 11.2 ms]
  Range (min … max):   117.5 ms … 129.1 ms    100 runs
 
Benchmark 2: ~/work/node/out/Release/node ./built/local/tsc.js --version
  Time (mean ± σ):      51.8 ms ±   1.0 ms    [User: 42.3 ms, System: 9.0 ms]
  Range (min … max):    50.4 ms …  56.6 ms    100 runs
 
Summary
  '~/work/node/out/Release/node ./built/local/tsc.js --version' ran
    2.33 ± 0.06 times faster than '~/work/node/out/Release/node ./built/local/_tsc.js --version'

Benchmark 1: echo '{"seq": 1, "command": "status"}' | ~/work/node/out/Release/node ./built/local/_tsserver.js --disableAutomaticTypingAcquisition
  Time (mean ± σ):     192.3 ms ±   2.5 ms    [User: 178.3 ms, System: 19.8 ms]
  Range (min … max):   188.1 ms … 201.1 ms    100 runs
 
Benchmark 2: echo '{"seq": 1, "command": "status"}' | ~/work/node/out/Release/node ./built/local/tsserver.js --disableAutomaticTypingAcquisition
  Time (mean ± σ):      84.6 ms ±   1.1 ms    [User: 76.5 ms, System: 14.5 ms]
  Range (min … max):    82.6 ms …  88.6 ms    100 runs
 
Summary
  'echo '{"seq": 1, "command": "status"}' | ~/work/node/out/Release/node ./built/local/tsserver.js --disableAutomaticTypingAcquisition' ran
    2.27 ± 0.04 times faster than 'echo '{"seq": 1, "command": "status"}' | ~/work/node/out/Release/node ./built/local/_tsserver.js --disableAutomaticTypingAcquisition'

codecov · 2024-08-22T18:05:41Z

Codecov Report

Attention: Patch coverage is 98.18182% with 2 lines in your changes missing coverage. Please review.

Project coverage is 87.34%. Comparing base (cc26951) to head (73c03b1).
Report is 354 commits behind head on main.

Files with missing lines	Patch %	Lines
src/compile_cache.cc	75.00%	1 Missing ⚠️
src/node_modules.cc	97.22%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##             main   #54501    +/-   ##
========================================
  Coverage   87.34%   87.34%            
========================================
  Files         649      649            
  Lines      182544   182666   +122     
  Branches    35030    35042    +12     
========================================
+ Hits       159445   159555   +110     
- Misses      16372    16387    +15     
+ Partials     6727     6724     -3

Files with missing lines	Coverage Δ
lib/internal/modules/helpers.js	`97.85% <100.00%> (+0.28%)`	⬆️
lib/module.js	`100.00% <100.00%> (ø)`
src/compile_cache.h	`100.00% <ø> (+25.00%)`	⬆️
src/env.cc	`85.48% <100.00%> (+0.32%)`	⬆️
src/compile_cache.cc	`80.00% <75.00%> (ø)`
src/node_modules.cc	`76.97% <97.22%> (+2.07%)`	⬆️

... and 57 files with indirect coverage changes

jakebailey · 2024-08-22T18:41:29Z

For fun, this is eslint (with enablecompileCache added to bin/eslint.js:

Benchmark 1: NODE_DISABLE_COMPILE_CACHE=true ~/work/node/out/Release/node ./node_modules/eslint/bin/eslint.js --version
  Time (mean ± σ):     129.9 ms ±   7.8 ms    [User: 128.6 ms, System: 17.4 ms]
  Range (min … max):   126.1 ms … 204.6 ms    100 runs
 
  Warning: Statistical outliers were detected. Consider re-running this benchmark on a quiet PC without any interferences from other programs. It might help to use the '--warmup' or '--prepare' options.
 
Benchmark 2: ~/work/node/out/Release/node ./node_modules/eslint/bin/eslint.js --version
  Time (mean ± σ):     105.5 ms ±   1.8 ms    [User: 103.3 ms, System: 18.6 ms]
  Range (min … max):   101.7 ms … 114.5 ms    100 runs
 
Summary
  '~/work/node/out/Release/node ./node_modules/eslint/bin/eslint.js --version' ran
    1.23 ± 0.08 times faster than 'NODE_DISABLE_COMPILE_CACHE=true ~/work/node/out/Release/node ./node_modules/eslint/bin/eslint.js --version'

Benchmark 1: NODE_DISABLE_COMPILE_CACHE=true ~/work/node/out/Release/node ./node_modules/eslint/bin/eslint.js --print-config ./src/compiler/debug.ts
  Time (mean ± σ):     791.6 ms ±   6.2 ms    [User: 987.2 ms, System: 86.3 ms]
  Range (min … max):   779.1 ms … 811.3 ms    100 runs
 
Benchmark 2: ~/work/node/out/Release/node ./node_modules/eslint/bin/eslint.js --print-config ./src/compiler/debug.ts
  Time (mean ± σ):     595.0 ms ±   6.4 ms    [User: 786.4 ms, System: 89.5 ms]
  Range (min … max):   583.7 ms … 621.3 ms    100 runs
 
Summary
  '~/work/node/out/Release/node ./node_modules/eslint/bin/eslint.js --print-config ./src/compiler/debug.ts' ran
    1.33 ± 0.02 times faster than 'NODE_DISABLE_COMPILE_CACHE=true ~/work/node/out/Release/node ./node_modules/eslint/bin/eslint.js --print-config ./src/compiler/debug.ts'

…PILE_CACHE

nodejs-github-bot · 2024-08-25T10:49:06Z

CI: https://ci.nodejs.org/job/node-test-pull-request/61445/

nodejs-github-bot · 2024-08-26T16:16:07Z

CI: https://ci.nodejs.org/job/node-test-pull-request/61502/

This patch adds the following API for tools to enable compile cache dynamically and query its status. - module.enableCompileCache(cacheDir) - module.getCompileCacheDir() In addition this adds a NODE_DISABLE_COMPILE_CACHE environment variable to disable the code cache enabled by the APIs as an escape hatch to avoid unexpected/undesired effects of the compile cache (e.g. less precise test coverage). When the module.enableCompileCache() method is invoked without a specified directory, Node.js will use the value of the NODE_COMPILE_CACHE environment variable if it's set, or defaults to `path.join(os.tmpdir(), 'node-compile-cache')` otherwise. Therefore it's recommended for tools to call this method without specifying the directory to allow overrides. PR-URL: #54501 Fixes: #53639 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>

Notable changes: net: * (SEMVER-MINOR) exclude ipv6 loopback addresses from server.listen (Giovanni Bucci) #54264 src: * (SEMVER-MINOR) add JS APIs for compile cache and NODE_DISABLE_COMPILE_CACHE (Joyee Cheung) #54501 src,lib: * (SEMVER-MINOR) add performance.uvMetricsInfo (Rafael Gonzaga) #54413 test_runner: * (SEMVER-MINOR) add support for coverage thresholds (Aviv Keller) #54429 * (SEMVER-MINOR) support running tests in process (Colin Ihrig) #53927 * (SEMVER-MINOR) defer inheriting hooks until run() (Colin Ihrig) #53927 vm: * (SEMVER-MINOR) introduce vanilla contexts via vm.constants.DONT_CONTEXTIFY (Joyee Cheung) #54394 PR-URL: #54560

CharlesCowan

🔥

This patch adds the following API for tools to enable compile cache dynamically and query its status. - module.enableCompileCache(cacheDir) - module.getCompileCacheDir() In addition this adds a NODE_DISABLE_COMPILE_CACHE environment variable to disable the code cache enabled by the APIs as an escape hatch to avoid unexpected/undesired effects of the compile cache (e.g. less precise test coverage). When the module.enableCompileCache() method is invoked without a specified directory, Node.js will use the value of the NODE_COMPILE_CACHE environment variable if it's set, or defaults to `path.join(os.tmpdir(), 'node-compile-cache')` otherwise. Therefore it's recommended for tools to call this method without specifying the directory to allow overrides. PR-URL: nodejs#54501 Fixes: nodejs#53639 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>

Notable changes: net: * (SEMVER-MINOR) exclude ipv6 loopback addresses from server.listen (Giovanni Bucci) nodejs#54264 src: * (SEMVER-MINOR) add JS APIs for compile cache and NODE_DISABLE_COMPILE_CACHE (Joyee Cheung) nodejs#54501 src,lib: * (SEMVER-MINOR) add performance.uvMetricsInfo (Rafael Gonzaga) nodejs#54413 test_runner: * (SEMVER-MINOR) add support for coverage thresholds (Aviv Keller) nodejs#54429 * (SEMVER-MINOR) support running tests in process (Colin Ihrig) nodejs#53927 * (SEMVER-MINOR) defer inheriting hooks until run() (Colin Ihrig) nodejs#53927 vm: * (SEMVER-MINOR) introduce vanilla contexts via vm.constants.DONT_CONTEXTIFY (Joyee Cheung) nodejs#54394 PR-URL: nodejs#54560

Adding support to [module.enableCompileCache](https://nodejs.org/docs/v22.11.0/api/module.html#moduleenablecompilecachecachedir), added by nodejs/node#54501, Typescript got [2.5x perf on tsc](https://devblogs.microsoft.com/typescript/announcing-typescript-5-7-beta/#support-for-v8-compile-caching-in-node.js). On my machine, for the command `--version`, I got the following results: ```bash Benchmark 1: node bin/npm-cli.js --version Time (mean ± σ): 58.0 ms ± 1.1 ms [User: 51.8 ms, System: 16.8 ms] Range (min … max): 56.5 ms … 62.6 ms 51 runs Benchmark 2: node bin/npm-cli-with-cache.js --version Time (mean ± σ): 52.9 ms ± 1.0 ms [User: 46.5 ms, System: 16.8 ms] Range (min … max): 51.4 ms … 55.5 ms 56 runs Summary 'node bin/npm-cli-with-cache.js --version' ran 1.10 ± 0.03 times faster than 'node bin/npm-cli.js --version' ``` I run the same test with `npm run empty` and I got the same 10% improvement.

Notable changes: net: * (SEMVER-MINOR) exclude ipv6 loopback addresses from server.listen (Giovanni Bucci) nodejs#54264 src: * (SEMVER-MINOR) add JS APIs for compile cache and NODE_DISABLE_COMPILE_CACHE (Joyee Cheung) nodejs#54501 src,lib: * (SEMVER-MINOR) add performance.uvMetricsInfo (Rafael Gonzaga) nodejs#54413 test_runner: * (SEMVER-MINOR) add support for coverage thresholds (Aviv Keller) nodejs#54429 * (SEMVER-MINOR) support running tests in process (Colin Ihrig) nodejs#53927 * (SEMVER-MINOR) defer inheriting hooks until run() (Colin Ihrig) nodejs#53927 vm: * (SEMVER-MINOR) introduce vanilla contexts via vm.constants.DONT_CONTEXTIFY (Joyee Cheung) nodejs#54394 PR-URL: nodejs#54560

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Aug 22, 2024

joyeecheung mentioned this pull request Aug 22, 2024

APIs for libraries/frameworks/tools to control on-disk compilation cache (NODE_COMPILE_CACHE) #53639

Closed

avivkeller reviewed Aug 22, 2024

View reviewed changes

Comment thread doc/api/module.md

benjamingr reviewed Aug 22, 2024

View reviewed changes

Comment thread doc/api/module.md

benjamingr reviewed Aug 22, 2024

View reviewed changes

Comment thread lib/internal/modules/helpers.js

benjamingr reviewed Aug 22, 2024

View reviewed changes

Comment thread lib/internal/modules/helpers.js Outdated

jakebailey mentioned this pull request Aug 22, 2024

Enable Node.js/v8 compile caching via entrypoint shims microsoft/TypeScript#59720

Merged

benjamingr approved these changes Aug 22, 2024

View reviewed changes

richardlau added the semver-minor PRs that contain new features and should be released in the next minor version. label Aug 22, 2024