Commit dcaf43a167f for nodejs
commit dcaf43a167f14bd8209361ec7f2179f0ac71e7a9
Author: Shelley Vohr <shelley.vohr@gmail.com>
Date: Fri Nov 20 15:59:50 2026 +0100
module: disable the compile cache while V8 coverage is collected
V8 cannot collect block coverage for functions that are deserialized
from the code cache, so it only reports how many times each of them
ran. With a warm compile cache, branches that never ran inside those
functions are reported as covered, and tools that merge reports from
several processes can report functions that ran as never run.
The documentation recommended turning the cache off by hand. Do it
automatically when coverage collection starts with the process, through
NODE_V8_COVERAGE or --experimental-test-coverage.
The compile cache tests stop propagating NODE_V8_COVERAGE to the
processes they spawn, so that they keep working when the test suite
itself runs with coverage.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/67120
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day>
diff --git a/doc/api/module.md b/doc/api/module.md
index 6af6b3d8a7c..c8ad7818a52 100644
--- a/doc/api/module.md
+++ b/doc/api/module.md
@@ -414,10 +414,12 @@ no-op, and the directory is not created if it is missing.
### Limitations of the compile cache
-Currently when using the compile cache with [V8 JavaScript code coverage][], the
-coverage being collected by V8 may be less precise in functions that are
-deserialized from the code cache. It's recommended to turn this off when
-running tests to generate precise coverage.
+V8 cannot collect block-level [V8 JavaScript code coverage][] for functions that
+are deserialized from the code cache. The compile cache is therefore disabled
+when coverage collection starts with the process, through
+[`NODE_V8_COVERAGE=dir`][] or [`--experimental-test-coverage`][]. Coverage that
+is started later, for example through the inspector, may be less precise in
+functions that were already deserialized from the code cache.
Compilation cache generated by one version of Node.js can not be reused by a different
version of Node.js. Cache generated by different versions of Node.js will be stored
@@ -475,7 +477,8 @@ The following constants are returned as the `status` field in the object returne
<td><code>DISABLED</code></td>
<td>
Node.js cannot enable the compile cache because the environment variable
- <code>NODE_DISABLE_COMPILE_CACHE=1</code> has been set.
+ <code>NODE_DISABLE_COMPILE_CACHE=1</code> has been set, or because V8
+ coverage is being collected.
</td>
</tr>
</table>
@@ -1404,6 +1407,7 @@ returned object contains the following keys:
[V8 code cache]: https://v8.dev/blog/code-caching-for-devs
[`"exports"`]: packages.md#exports
[`--enable-source-maps`]: cli.md#--enable-source-maps
+[`--experimental-test-coverage`]: cli.md#--experimental-test-coverage
[`--import`]: cli.md#--importmodule
[`--require`]: cli.md#-r---require-module
[`NODE_COMPILE_CACHE=dir`]: cli.md#node_compile_cachedir
diff --git a/src/compile_cache.h b/src/compile_cache.h
index ec405cf55b8..1bd2ca08286 100644
--- a/src/compile_cache.h
+++ b/src/compile_cache.h
@@ -49,7 +49,7 @@ struct CompileCacheEntry {
V(FAILED) /* Failed to enable the cache */ \
V(ENABLED) /* Was not enabled before, and now enabled. */ \
V(ALREADY_ENABLED) /* Was already enabled. */ \
- V(DISABLED) /* Has been disabled by NODE_DISABLE_COMPILE_CACHE. */
+ V(DISABLED) /* Disabled by the environment or by V8 coverage. */
enum class CompileCacheEnableStatus : uint8_t {
#define V(status) status,
diff --git a/src/env.cc b/src/env.cc
index b55c7c46b69..5ef04d11fec 100644
--- a/src/env.cc
+++ b/src/env.cc
@@ -1423,10 +1423,20 @@ CompileCacheEnableResult Environment::EnableCompileCache(
const std::string& key_root) {
CompileCacheEnableResult result;
std::string disable_env;
+ const char* disabled_reason = nullptr;
if (credentials::SafeGetenv(
"NODE_DISABLE_COMPILE_CACHE", &disable_env, this)) {
+ disabled_reason = "Disabled by NODE_DISABLE_COMPILE_CACHE";
+#if HAVE_INSPECTOR
+ } else if (coverage_connection() != nullptr) {
+ // V8 cannot collect block coverage for functions deserialized from the
+ // cache.
+ disabled_reason = "Disabled because V8 coverage is being collected";
+#endif // HAVE_INSPECTOR
+ }
+ if (disabled_reason != nullptr) {
result.status = CompileCacheEnableStatus::DISABLED;
- result.message = "Disabled by NODE_DISABLE_COMPILE_CACHE";
+ result.message = disabled_reason;
Debug(this,
DebugCategory::COMPILE_CACHE,
"[compile cache] %s.\n",
diff --git a/test/common/compile-cache.js b/test/common/compile-cache.js
new file mode 100644
index 00000000000..4a96856b2fd
--- /dev/null
+++ b/test/common/compile-cache.js
@@ -0,0 +1,24 @@
+'use strict';
+
+const common = require('./');
+const childProcess = require('./child_process');
+
+// The compile cache is disabled while V8 coverage is being collected. In that
+// case, check that the first child says so and skip the rest of the test.
+function withCompileCache(spawn) {
+ return (...args) => {
+ if (!process.env.NODE_V8_COVERAGE) {
+ return spawn(...args);
+ }
+ args.pop();
+ childProcess.spawnSyncAndExit(...args, {
+ stderr: /Disabled because V8 coverage is being collected/,
+ });
+ common.skip('the compile cache is disabled by V8 coverage');
+ };
+}
+
+module.exports = {
+ spawnSyncAndAssert: withCompileCache(childProcess.spawnSyncAndAssert),
+ spawnSyncAndExit: withCompileCache(childProcess.spawnSyncAndExit),
+};
diff --git a/test/parallel/test-compile-cache-api-env.js b/test/parallel/test-compile-cache-api-env.js
index 197f1495a88..7504d7a1fd6 100644
--- a/test/parallel/test-compile-cache-api-env.js
+++ b/test/parallel/test-compile-cache-api-env.js
@@ -4,7 +4,7 @@
// with a NODE_COMPILE_CACHE environment variable override.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const fixtures = require('../common/fixtures');
const tmpdir = require('../common/tmpdir');
diff --git a/test/parallel/test-compile-cache-api-flush.js b/test/parallel/test-compile-cache-api-flush.js
index 7e66b1fee10..fb4c26ba1bb 100644
--- a/test/parallel/test-compile-cache-api-flush.js
+++ b/test/parallel/test-compile-cache-api-flush.js
@@ -3,7 +3,7 @@
// This tests module.flushCompileCache() works as expected.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const tmpdir = require('../common/tmpdir');
const fixtures = require('../common/fixtures');
diff --git a/test/parallel/test-compile-cache-api-options-portable-env.js b/test/parallel/test-compile-cache-api-options-portable-env.js
index 5586e3e8404..d9f196d3304 100644
--- a/test/parallel/test-compile-cache-api-options-portable-env.js
+++ b/test/parallel/test-compile-cache-api-options-portable-env.js
@@ -4,7 +4,7 @@
// variable NODE_COMPILE_CACHE overrides.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const fixtures = require('../common/fixtures');
const tmpdir = require('../common/tmpdir');
diff --git a/test/parallel/test-compile-cache-api-portable.js b/test/parallel/test-compile-cache-api-portable.js
index 620b3bdce87..3ba390503c4 100644
--- a/test/parallel/test-compile-cache-api-portable.js
+++ b/test/parallel/test-compile-cache-api-portable.js
@@ -4,7 +4,7 @@
// and supports portable paths across directory relocations.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const fs = require('fs');
const tmpdir = require('../common/tmpdir');
diff --git a/test/parallel/test-compile-cache-api-readonly.js b/test/parallel/test-compile-cache-api-readonly.js
index 8ac0248a4d5..df91ee45e4b 100644
--- a/test/parallel/test-compile-cache-api-readonly.js
+++ b/test/parallel/test-compile-cache-api-readonly.js
@@ -4,7 +4,7 @@
// entries are read, nothing is written, and a missing directory is not created.
const common = require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const fs = require('fs');
const path = require('path');
diff --git a/test/parallel/test-compile-cache-api-success.js b/test/parallel/test-compile-cache-api-success.js
index 2d4d94fd6e9..e8a5226f7b5 100644
--- a/test/parallel/test-compile-cache-api-success.js
+++ b/test/parallel/test-compile-cache-api-success.js
@@ -3,7 +3,7 @@
// This tests module.enableCompileCache() and module.getCompileCacheDir() work.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const fixtures = require('../common/fixtures');
const tmpdir = require('../common/tmpdir');
diff --git a/test/parallel/test-compile-cache-api-tmpdir.js b/test/parallel/test-compile-cache-api-tmpdir.js
index e676893b01f..1d4cdbb242c 100644
--- a/test/parallel/test-compile-cache-api-tmpdir.js
+++ b/test/parallel/test-compile-cache-api-tmpdir.js
@@ -4,7 +4,7 @@
// the TMPDIR environment variable override.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const fixtures = require('../common/fixtures');
const tmpdir = require('../common/tmpdir');
diff --git a/test/parallel/test-compile-cache-bad-syntax.js b/test/parallel/test-compile-cache-bad-syntax.js
index 63f6374b2c3..b868ad385e9 100644
--- a/test/parallel/test-compile-cache-bad-syntax.js
+++ b/test/parallel/test-compile-cache-bad-syntax.js
@@ -3,7 +3,7 @@
// This tests NODE_COMPILE_CACHE works.
require('../common');
-const { spawnSyncAndExit } = require('../common/child_process');
+const { spawnSyncAndExit } = require('../common/compile-cache');
const fixtures = require('../common/fixtures');
const tmpdir = require('../common/tmpdir');
const assert = require('assert');
diff --git a/test/parallel/test-compile-cache-coverage.js b/test/parallel/test-compile-cache-coverage.js
new file mode 100644
index 00000000000..f2f5e9e2f77
--- /dev/null
+++ b/test/parallel/test-compile-cache-coverage.js
@@ -0,0 +1,45 @@
+'use strict';
+
+const common = require('../common');
+common.skipIfInspectorDisabled();
+
+const { spawnSyncAndAssert } = require('../common/child_process');
+const assert = require('assert');
+const fixtures = require('../common/fixtures');
+const fs = require('fs');
+const tmpdir = require('../common/tmpdir');
+
+tmpdir.refresh();
+const cacheDir = tmpdir.resolve('compile_cache');
+const env = {
+ ...process.env,
+ NODE_DEBUG_NATIVE: 'COMPILE_CACHE',
+ NODE_V8_COVERAGE: tmpdir.resolve('coverage'),
+};
+
+spawnSyncAndAssert(
+ process.execPath,
+ [fixtures.path('empty.js')],
+ { env: { ...env, NODE_COMPILE_CACHE: cacheDir }, cwd: tmpdir.path },
+ { stderr: /Disabled because V8 coverage is being collected/ });
+assert(!fs.existsSync(cacheDir));
+
+spawnSyncAndAssert(
+ process.execPath,
+ ['-r', fixtures.path('compile-cache-wrapper.js'), fixtures.path('empty.js')],
+ {
+ env: {
+ ...env,
+ NODE_COMPILE_CACHE: undefined,
+ NODE_TEST_COMPILE_CACHE_DIR: cacheDir,
+ },
+ cwd: tmpdir.path,
+ },
+ {
+ stdout(output) {
+ assert.match(output, /Compile cache already disabled/);
+ assert.match(output, /dir after enableCompileCache: undefined/);
+ },
+ stderr: /Disabled because V8 coverage is being collected/,
+ });
+assert(!fs.existsSync(cacheDir));
diff --git a/test/parallel/test-compile-cache-dynamic-import.js b/test/parallel/test-compile-cache-dynamic-import.js
index 01731dc6822..757e992eaa8 100644
--- a/test/parallel/test-compile-cache-dynamic-import.js
+++ b/test/parallel/test-compile-cache-dynamic-import.js
@@ -3,7 +3,7 @@
// This tests NODE_COMPILE_CACHE works in existing directory.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const tmpdir = require('../common/tmpdir');
const fixtures = require('../common/fixtures');
diff --git a/test/parallel/test-compile-cache-esm.js b/test/parallel/test-compile-cache-esm.js
index 963de8bcaba..9bddc23424c 100644
--- a/test/parallel/test-compile-cache-esm.js
+++ b/test/parallel/test-compile-cache-esm.js
@@ -3,7 +3,7 @@
// This tests NODE_COMPILE_CACHE works in existing directory.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const tmpdir = require('../common/tmpdir');
const fixtures = require('../common/fixtures');
diff --git a/test/parallel/test-compile-cache-existing-directory.js b/test/parallel/test-compile-cache-existing-directory.js
index 0fc60f9544d..d9c7e690fd5 100644
--- a/test/parallel/test-compile-cache-existing-directory.js
+++ b/test/parallel/test-compile-cache-existing-directory.js
@@ -3,7 +3,7 @@
// This tests NODE_COMPILE_CACHE works in existing directory.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const fs = require('fs');
const fixtures = require('../common/fixtures');
diff --git a/test/parallel/test-compile-cache-portable-esm.js b/test/parallel/test-compile-cache-portable-esm.js
index 18766b6810e..bfcb6f9e2da 100644
--- a/test/parallel/test-compile-cache-portable-esm.js
+++ b/test/parallel/test-compile-cache-portable-esm.js
@@ -3,7 +3,7 @@
// This tests NODE_COMPILE_CACHE works after moving directory and unusual characters in path are handled correctly.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const tmpdir = require('../common/tmpdir');
const fs = require('fs');
diff --git a/test/parallel/test-compile-cache-portable.js b/test/parallel/test-compile-cache-portable.js
index b5978b5b0c6..04b7360833c 100644
--- a/test/parallel/test-compile-cache-portable.js
+++ b/test/parallel/test-compile-cache-portable.js
@@ -4,7 +4,7 @@
// environment variable.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const fs = require('fs');
const tmpdir = require('../common/tmpdir');
diff --git a/test/parallel/test-compile-cache-success.js b/test/parallel/test-compile-cache-success.js
index c02a6243286..4d5d7a67214 100644
--- a/test/parallel/test-compile-cache-success.js
+++ b/test/parallel/test-compile-cache-success.js
@@ -3,7 +3,7 @@
// This tests NODE_COMPILE_CACHE works.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const fixtures = require('../common/fixtures');
const tmpdir = require('../common/tmpdir');
diff --git a/test/parallel/test-compile-cache-typescript-commonjs.js b/test/parallel/test-compile-cache-typescript-commonjs.js
index 60e86c3c0f9..5ee65a806e6 100644
--- a/test/parallel/test-compile-cache-typescript-commonjs.js
+++ b/test/parallel/test-compile-cache-typescript-commonjs.js
@@ -6,7 +6,7 @@ const common = require('../common');
if (!process.config.variables.node_use_amaro) {
common.skip('Requires Amaro');
}
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const tmpdir = require('../common/tmpdir');
const fixtures = require('../common/fixtures');
diff --git a/test/parallel/test-compile-cache-typescript-esm.js b/test/parallel/test-compile-cache-typescript-esm.js
index 98473dbb2a5..e85f442e5ac 100644
--- a/test/parallel/test-compile-cache-typescript-esm.js
+++ b/test/parallel/test-compile-cache-typescript-esm.js
@@ -6,7 +6,7 @@ const common = require('../common');
if (!process.config.variables.node_use_amaro) {
common.skip('Requires Amaro');
}
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const tmpdir = require('../common/tmpdir');
const fixtures = require('../common/fixtures');
diff --git a/test/parallel/test-compile-cache-typescript-strip-sourcemaps.js b/test/parallel/test-compile-cache-typescript-strip-sourcemaps.js
index a6c95e432b7..f229587c1f2 100644
--- a/test/parallel/test-compile-cache-typescript-strip-sourcemaps.js
+++ b/test/parallel/test-compile-cache-typescript-strip-sourcemaps.js
@@ -7,7 +7,7 @@ const common = require('../common');
if (!process.config.variables.node_use_amaro) {
common.skip('Requires Amaro');
}
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const tmpdir = require('../common/tmpdir');
const fixtures = require('../common/fixtures');
diff --git a/test/parallel/test-compile-cache-updated-file.js b/test/parallel/test-compile-cache-updated-file.js
index 68f20a6990c..c3fecae97f0 100644
--- a/test/parallel/test-compile-cache-updated-file.js
+++ b/test/parallel/test-compile-cache-updated-file.js
@@ -3,7 +3,7 @@
// This tests NODE_COMPILE_CACHE works in existing directory.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const fs = require('fs');
const tmpdir = require('../common/tmpdir');
diff --git a/test/parallel/test-compile-cache-wasm.js b/test/parallel/test-compile-cache-wasm.js
index 278198378dd..31019b33892 100644
--- a/test/parallel/test-compile-cache-wasm.js
+++ b/test/parallel/test-compile-cache-wasm.js
@@ -3,7 +3,7 @@
// This tests NODE_COMPILE_CACHE works for WebAssembly modules imported as ESM.
require('../common');
-const { spawnSyncAndAssert } = require('../common/child_process');
+const { spawnSyncAndAssert } = require('../common/compile-cache');
const assert = require('assert');
const tmpdir = require('../common/tmpdir');
const fixtures = require('../common/fixtures');