node/test/parallel/test-compile-cache-api-permission.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

57 lines
1.8 KiB
JavaScript

'use strict';
// This tests module.enableCompileCache() works with the permission model.
require('../common');
const { spawnSyncAndAssert } = require('../common/child_process');
const assert = require('assert');
const fixtures = require('../common/fixtures');
const tmpdir = require('../common/tmpdir');
const fs = require('fs');
{
tmpdir.refresh();
const cacheDir = tmpdir.resolve('compile-cache');
const scriptDir = tmpdir.resolve('scripts');
// If the directory doesn't exist, permission will just be disallowed.
fs.mkdirSync(cacheDir);
fs.mkdirSync(scriptDir);
const empty = tmpdir.resolve('scripts', 'empty.js');
const wrapper = tmpdir.resolve('scripts', 'compile-cache-wrapper.js');
fs.copyFileSync(fixtures.path('empty.js'), empty);
fs.copyFileSync(fixtures.path('compile-cache-wrapper.js'), wrapper);
spawnSyncAndAssert(
process.execPath,
[
'--experimental-permission', `--allow-fs-read=${scriptDir}`, `--allow-fs-write=${scriptDir}`,
'-r', wrapper, empty,
],
{
env: {
...process.env,
NODE_DEBUG_NATIVE: 'COMPILE_CACHE',
NODE_COMPILE_CACHE: undefined,
NODE_TEST_COMPILE_CACHE_DIR: cacheDir,
},
cwd: tmpdir.path
},
{
stdout(output) {
console.log(output); // Logging for debugging.
assert.match(output, /dir before enableCompileCache: undefined/);
assert.match(output, /Compile cache failed/);
assert.match(output, /Skipping compile cache because write permission for .* is not granted/);
assert.match(output, /dir after enableCompileCache: undefined/);
return true;
},
stderr(output) {
console.log(output); // Logging for debugging.
assert.match(output, /Skipping compile cache because write permission for .* is not granted/);
return true;
}
});
}