Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

module: skip NODE_COMPILE_CACHE when policy is enabled #52577

Merged
merged 3 commits into from
Apr 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/env.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1096,6 +1096,12 @@ void Environment::InitializeCompileCache() {
dir_from_env.empty()) {
return;
}
if (!options()->experimental_policy.empty()) {
Debug(this,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this be a warning instead?

Copy link
Member Author

@joyeecheung joyeecheung Apr 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The environment variable is designed to be as silent as possible. I don't think there's anything to warn - you don't get a speed up and that is all, your code will still work as intended. If you are using policy it's likely that you are already aware this is already leading to a slowdown for every module loaded due to all the checks required.

DebugCategory::COMPILE_CACHE,
"[compile cache] skipping cache because policy is enabled");
return;
}
auto handler = std::make_unique<CompileCacheHandler>(this);
if (handler->InitializeDirectory(this, dir_from_env)) {
compile_cache_handler_ = std::move(handler);
Expand Down
38 changes: 38 additions & 0 deletions test/parallel/test-compile-cache-policy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
'use strict';

// This tests NODE_COMPILE_CACHE is disabled when policy is used.

const common = require('../common');
if (!common.hasCrypto)
common.skip('missing crypto');

const { spawnSyncAndAssert } = require('../common/child_process');
const assert = require('assert');
const fs = require('fs');
const tmpdir = require('../common/tmpdir');
const fixtures = require('../common/fixtures');

{
tmpdir.refresh();
const dir = tmpdir.resolve('.compile_cache_dir');
const script = fixtures.path('policy', 'parent.js');
const policy = fixtures.path(
'policy',
'dependencies',
'dependencies-redirect-policy.json');
spawnSyncAndAssert(
process.execPath,
['--experimental-policy', policy, script],
{
env: {
...process.env,
NODE_DEBUG_NATIVE: 'COMPILE_CACHE',
NODE_COMPILE_CACHE: dir
},
cwd: tmpdir.path
},
{
stderr: /skipping cache because policy is enabled/
});
assert(!fs.existsSync(dir));
}
Loading