node/test/fixtures/compile-cache-wrapper.js
Joyee Cheung ff5ef7083d
src: add JS APIs for compile cache and NODE_DISABLE_COMPILE_CACHE
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: https://github.com/nodejs/node/pull/54501
Fixes: https://github.com/nodejs/node/issues/53639
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2024-08-28 23:22:57 +00:00

22 lines
795 B
JavaScript

'use strict';
const { enableCompileCache, getCompileCacheDir, constants } = require('module');
console.log('dir before enableCompileCache:', getCompileCacheDir());
const result = enableCompileCache(process.env.NODE_TEST_COMPILE_CACHE_DIR);
switch (result.status) {
case constants.compileCacheStatus.FAILED:
console.log('Compile cache failed. ' + result.message);
break;
case constants.compileCacheStatus.ENABLED:
console.log('Compile cache enabled. ' + result.directory);
break;
case constants.compileCacheStatus.ALREADY_ENABLED:
console.log('Compile cache already enabled.');
break;
case constants.compileCacheStatus.DISABLED:
console.log('Compile cache already disabled.');
break;
}
console.log('dir after enableCompileCache:', getCompileCacheDir());