node/test/parallel/test-compile-cache-api-flush.js
Joyee Cheung 62383cd113 module: implement flushCompileCache()
This implements an API for users to intentionally flush the
accumulated compile cache instead of waiting until process
shutdown. It may be useful for application that loads dependencies
first and then either reload itself in other instances, or spawning
other instances that load an overlapping set of its dependencies -
in this case its useful to flush the cache early instead of waiting
until the shutdown of itself.

Currently flushing is triggered by either process
shutdown or user requests. In the future we should simply start the
writes right after module loading on a separate thread, and this method
only blocks until all the pending writes (if any) on the other thread
are finished. In that case, the off-thread writes should finish long
before any attempt of flushing is made so the method would then only
incur a negligible overhead from thread synchronization.

PR-URL: https://github.com/nodejs/node/pull/54971
Fixes: https://github.com/nodejs/node/issues/54770
Fixes: https://github.com/nodejs/node/issues/54465
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2024-09-20 19:05:07 +00:00

48 lines
1.8 KiB
JavaScript

'use strict';
// This tests module.flushCompileCache() works as expected.
require('../common');
const { spawnSyncAndAssert } = require('../common/child_process');
const assert = require('assert');
const tmpdir = require('../common/tmpdir');
const fixtures = require('../common/fixtures');
{
// Test that it works with non-existent directory.
tmpdir.refresh();
const cacheDir = tmpdir.resolve('compile_cache');
spawnSyncAndAssert(
process.execPath,
[fixtures.path('compile-cache-flush.js')],
{
env: {
...process.env,
NODE_DEBUG_NATIVE: 'COMPILE_CACHE',
NODE_COMPILE_CACHE: cacheDir,
},
cwd: tmpdir.path
},
{
stdout(output) {
// This contains output from the nested spawnings of compile-cache-flush.js.
assert.match(output, /child1.* cache for .*compile-cache-flush\.js was accepted, keeping the in-memory entry/);
assert.match(output, /child2.* cache for .*compile-cache-flush\.js was accepted, keeping the in-memory entry/);
return true;
},
stderr(output) {
// This contains output from the top-level spawning of compile-cache-flush.js.
assert.match(output, /reading cache from .*compile_cache.* for CommonJS .*compile-cache-flush\.js/);
assert.match(output, /compile-cache-flush\.js was not initialized, initializing the in-memory entry/);
const writeRE = /writing cache for .*compile-cache-flush\.js.*success/;
const flushRE = /module\.flushCompileCache\(\) finished/;
assert.match(output, writeRE);
assert.match(output, flushRE);
// The cache writing should happen before flushing finishes i.e. it's not delayed until process shutdown.
assert(output.match(writeRE).index < output.match(flushRE).index);
return true;
}
});
}