node icon indicating copy to clipboard operation
node copied to clipboard

src: add JS APIs for compile cache and NODE_DISABLE_COMPILE_CACHE

Open joyeecheung opened this issue 6 months ago • 9 comments

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.

Fixes: https://github.com/nodejs/node/issues/53639

joyeecheung avatar Aug 22 '24 16:08 joyeecheung