FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

src: allow to negate boolean CLI flags · nodejs/node@f793380 · GitHub

/ node Public

Commit f793380

Browse files
targos
committed
src: allow to negate boolean CLI flags
This change allows all boolean flags to be negated using the `--no-` prefix. Flags that are `true` by default (for example `--deprecation`) are still documented as negations. With this change, it becomes possible to easily flip the default value of a boolean flag and to override the value of a flag passed in the NODE_OPTIONS environment variable. `process.allowedNodeEnvironmentFlags` contains both the negated and non-negated versions of boolean flags. Co-authored-by: Anna Henningsen <anna@addaleax.net> PR-URL: #39023 Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent 14fc4dd commit f793380

12 files changed

Lines changed: 152 additions & 34 deletions

‎lib/internal/bootstrap/pre_execution.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ function setupWarningHandler() {
128128
const {
129129
onWarning
130130
} = require('internal/process/warning');
131-
if (!getOptionValue('--no-warnings') &&
131+
if (getOptionValue('--warnings') &&
132132
process.env.NODE_NO_WARNINGS !== '1') {
133133
process.on('warning', onWarning);
134134
}

‎lib/internal/main/print_help.js‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ const {
88
MathMax,
99
ObjectKeys,
1010
RegExp,
11+
StringPrototypeLocaleCompare,
12+
StringPrototypeSlice,
1113
StringPrototypeTrimLeft,
1214
StringPrototypeRepeat,
1315
StringPrototypeReplace,
@@ -110,12 +112,30 @@ function format(
110112
let text = '';
111113
let maxFirstColumnUsed = 0;
112114

115+
const sortedOptions = ArrayPrototypeSort(
116+
[...options.entries()],
117+
({ 0: name1, 1: option1 }, { 0: name2, 1: option2 }) => {
118+
if (option1.defaultIsTrue) {
119+
name1 = `--no-${StringPrototypeSlice(name1, 2)}`;
120+
}
121+
if (option2.defaultIsTrue) {
122+
name2 = `--no-${StringPrototypeSlice(name2, 2)}`;
123+
}
124+
return StringPrototypeLocaleCompare(name1, name2);
125+
},
126+
);
127+
113128
for (const {
114-
0: name, 1: { helpText, type, value }
115-
} of ArrayPrototypeSort([...options.entries()])) {
129+
0: name, 1: { helpText, type, value, defaultIsTrue }
130+
} of sortedOptions) {
116131
if (!helpText) continue;
117132

118133
let displayName = name;
134+
135+
if (defaultIsTrue) {
136+
displayName = `--no-${StringPrototypeSlice(displayName, 2)}`;
137+
}
138+
119139
const argDescription = getArgDescription(type);
120140
if (argDescription)
121141
displayName += `=${argDescription}`;
@@ -138,7 +158,7 @@ function format(
138158
}
139159

140160
let displayHelpText = helpText;
141-
if (value === true) {
161+
if (value === !defaultIsTrue) {
142162
// Mark boolean options we currently have enabled.
143163
// In particular, it indicates whether --use-openssl-ca
144164
// or --use-bundled-ca is the (current) default.

‎lib/internal/options.js‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,13 @@ function getAliasesFromBinding() {
2525
return aliasesMap;
2626
}
2727

28-
function getOptionValue(option) {
29-
return getOptionsFromBinding().get(option)?.value;
28+
function getOptionValue(optionName) {
29+
const options = getOptionsFromBinding();
30+
if (optionName.startsWith('--no-')) {
31+
const option = options.get('--' + optionName.slice(5));
32+
return option && !option.value;
33+
}
34+
return options.get(optionName)?.value;
3035
}
3136

3237
function getAllowUnauthorized() {

‎lib/internal/process/per_thread.js‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
const {
88
ArrayIsArray,
9+
ArrayPrototypePush,
910
BigUint64Array,
1011
Float64Array,
1112
NumberMAX_SAFE_INTEGER,
@@ -249,14 +250,19 @@ const trailingValuesRegex = /=.*$/;
249250
// from data in the config binding.
250251
function buildAllowedFlags() {
251252
const {
252-
envSettings: { kAllowedInEnvironment }
253+
envSettings: { kAllowedInEnvironment },
254+
types: { kBoolean },
253255
} = internalBinding('options');
254256
const { options, aliases } = require('internal/options');
255257

256258
const allowedNodeEnvironmentFlags = [];
257259
for (const [name, info] of options) {
258260
if (info.envVarSettings === kAllowedInEnvironment) {
259-
allowedNodeEnvironmentFlags.push(name);
261+
ArrayPrototypePush(allowedNodeEnvironmentFlags, name);
262+
if (info.type === kBoolean) {
263+
const negatedName = `--no-${name.slice(2)}`;
264+
ArrayPrototypePush(allowedNodeEnvironmentFlags, negatedName);
265+
}
260266
}
261267
}
262268

‎src/env.cc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ Environment::Environment(IsolateData* isolate_data,
425425
// By default, always abort when --abort-on-uncaught-exception was passed.
426426
should_abort_on_uncaught_toggle_[0] = 1;
427427

428-
if (options_->no_force_async_hooks_checks) {
428+
if (!options_->force_async_hooks_checks) {
429429
async_hooks_.no_force_checks();
430430
}
431431

‎src/env.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@ constexpr size_t kFsStatsBufferLength =
207207
V(crypto_rsa_pss_string, "rsa-pss") \
208208
V(cwd_string, "cwd") \
209209
V(data_string, "data") \
210+
V(default_is_true_string, "defaultIsTrue") \
210211
V(deserialize_info_string, "deserializeInfo") \
211212
V(dest_string, "dest") \
212213
V(destroyed_string, "destroyed") \

‎src/node.cc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1082,9 +1082,9 @@ int Start(int argc, char** argv) {
10821082
const std::vector<size_t>* indexes = nullptr;
10831083
std::vector<intptr_t> external_references;
10841084

1085-
bool force_no_snapshot =
1086-
per_process::cli_options->per_isolate->no_node_snapshot;
1087-
if (!force_no_snapshot) {
1085+
bool use_no_snapshot =
1086+
per_process::cli_options->per_isolate->node_snapshot;
1087+
if (use_no_snapshot) {
10881088
v8::StartupData* blob = NodeMainInstance::GetEmbeddedSnapshotBlob();
10891089
if (blob != nullptr) {
10901090
// TODO(joyeecheung): collect external references and set it in

‎src/node_options-inl.h‎

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@ template <typename Options>
2323
void OptionsParser<Options>::AddOption(const char* name,
2424
const char* help_text,
2525
bool Options::* field,
26-
OptionEnvvarSettings env_setting) {
26+
OptionEnvvarSettings env_setting,
27+
bool default_is_true) {
2728
options_.emplace(name,
2829
OptionInfo{kBoolean,
2930
std::make_shared<SimpleOptionField<bool>>(field),
3031
env_setting,
31-
help_text});
32+
help_text,
33+
default_is_true});
3234
}
3335

3436
template <typename Options>
@@ -186,7 +188,8 @@ auto OptionsParser<Options>::Convert(
186188
return OptionInfo{original.type,
187189
Convert(original.field, get_child),
188190
original.env_setting,
189-
original.help_text};
191+
original.help_text,
192+
original.default_is_true};
190193
}
191194

192195
template <typename Options>
@@ -225,6 +228,10 @@ inline std::string RequiresArgumentErr(const std::string& arg) {
225228
return arg + " requires an argument";
226229
}
227230

231+
inline std::string NegationImpliesBooleanError(const std::string& arg) {
232+
return arg + " is an invalid negation because it is not a boolean option";
233+
}
234+
228235
// We store some of the basic information around a single Parse call inside
229236
// this struct, to separate storage of command line arguments and their
230237
// handling. In particular, this makes it easier to introduce 'synthetic'
@@ -325,6 +332,13 @@ void OptionsParser<Options>::Parse(
325332
name[i] = '-';
326333
}
327334

335+
// Convert --no-foo to --foo and keep in mind that we're negating.
336+
bool is_negation = false;
337+
if (name.find("--no-") == 0) {
338+
name.erase(2, 3); // remove no-
339+
is_negation = true;
340+
}
341+
328342
{
329343
auto it = aliases_.end();
330344
// Expand aliases:
@@ -367,7 +381,12 @@ void OptionsParser<Options>::Parse(
367381
}
368382

369383
{
370-
auto implications = implications_.equal_range(name);
384+
std::string implied_name = name;
385+
if (is_negation) {
386+
// Implications for negated options are defined with "--no-".
387+
implied_name.insert(2, "no-");
388+
}
389+
auto implications = implications_.equal_range(implied_name);
371390
for (auto it = implications.first; it != implications.second; ++it) {
372391
if (it->second.type == kV8Option) {
373392
v8_args->push_back(it->second.name);
@@ -384,6 +403,13 @@ void OptionsParser<Options>::Parse(
384403
}
385404

386405
const OptionInfo& info = it->second;
406+
407+
// Some V8 options can be negated and they are validated by V8 later.
408+
if (is_negation && info.type != kBoolean && info.type != kV8Option) {
409+
errors->push_back(NegationImpliesBooleanError(arg));
410+
break;
411+
}
412+
387413
std::string value;
388414
if (info.type != kBoolean && info.type != kNoOp && info.type != kV8Option) {
389415
if (equals_index != std::string::npos) {
@@ -412,7 +438,7 @@ void OptionsParser<Options>::Parse(
412438

413439
switch (info.type) {
414440
case kBoolean:
415-
*Lookup<bool>(info.field, options) = true;
441+
*Lookup<bool>(info.field, options) = !is_negation;
416442
break;
417443
case kInteger:
418444
*Lookup<int64_t>(info.field, options) = std::atoll(value.c_str());

‎src/node_options.cc‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -377,18 +377,21 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
377377
kAllowedInEnvironment);
378378
AddAlias("--es-module-specifier-resolution",
379379
"--experimental-specifier-resolution");
380-
AddOption("--no-deprecation",
380+
AddOption("--deprecation",
381381
"silence deprecation warnings",
382-
&EnvironmentOptions::no_deprecation,
383-
kAllowedInEnvironment);
384-
AddOption("--no-force-async-hooks-checks",
382+
&EnvironmentOptions::deprecation,
383+
kAllowedInEnvironment,
384+
true);
385+
AddOption("--force-async-hooks-checks",
385386
"disable checks for async_hooks",
386-
&EnvironmentOptions::no_force_async_hooks_checks,
387-
kAllowedInEnvironment);
388-
AddOption("--no-warnings",
387+
&EnvironmentOptions::force_async_hooks_checks,
388+
kAllowedInEnvironment,
389+
true);
390+
AddOption("--warnings",
389391
"silence all process warnings",
390-
&EnvironmentOptions::no_warnings,
391-
kAllowedInEnvironment);
392+
&EnvironmentOptions::warnings,
393+
kAllowedInEnvironment,
394+
true);
392395
AddOption("--force-context-aware",
393396
"disable loading non-context-aware addons",
394397
&EnvironmentOptions::force_context_aware,
@@ -579,9 +582,9 @@ PerIsolateOptionsParser::PerIsolateOptionsParser(
579582
"track heap object allocations for heap snapshots",
580583
&PerIsolateOptions::track_heap_objects,
581584
kAllowedInEnvironment);
582-
AddOption("--no-node-snapshot",
585+
AddOption("--node-snapshot",
583586
"", // It's a debug-only option.
584-
&PerIsolateOptions::no_node_snapshot,
587+
&PerIsolateOptions::node_snapshot,
585588
kAllowedInEnvironment);
586589

587590
// Explicitly add some V8 flags to mark them as allowed in NODE_OPTIONS.
@@ -991,6 +994,10 @@ void GetOptions(const FunctionCallbackInfo<Value>& args) {
991994
env->type_string(),
992995
Integer::New(isolate, static_cast<int>(option_info.type)))
993996
.FromMaybe(false) ||
997+
!info->Set(context,
998+
env->default_is_true_string(),
999+
Boolean::New(isolate, option_info.default_is_true))
1000+
.FromMaybe(false) ||
9941001
info->Set(context, env->value_string(), value).IsNothing() ||
9951002
options->Set(context, name, info).IsEmpty()) {
9961003
return;

‎src/node_options.h‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ class EnvironmentOptions : public Options {
120120
int64_t heap_snapshot_near_heap_limit = 0;
121121
std::string heap_snapshot_signal;
122122
uint64_t max_http_header_size = 16 * 1024;
123-
bool no_deprecation = false;
124-
bool no_force_async_hooks_checks = false;
125-
bool no_warnings = false;
123+
bool deprecation = true;
124+
bool force_async_hooks_checks = true;
125+
bool warnings = true;
126126
bool force_context_aware = false;
127127
bool pending_deprecation = false;
128128
bool preserve_symlinks = false;
@@ -194,7 +194,7 @@ class PerIsolateOptions : public Options {
194194
public:
195195
std::shared_ptr<EnvironmentOptions> per_env { new EnvironmentOptions() };
196196
bool track_heap_objects = false;
197-
bool no_node_snapshot = false;
197+
bool node_snapshot = true;
198198
bool report_uncaught_exception = false;
199199
bool report_on_signal = false;
200200
bool experimental_top_level_await = true;
@@ -302,7 +302,8 @@ class OptionsParser {
302302
void AddOption(const char* name,
303303
const char* help_text,
304304
bool Options::* field,
305-
OptionEnvvarSettings env_setting = kDisallowedInEnvironment);
305+
OptionEnvvarSettings env_setting = kDisallowedInEnvironment,
306+
bool default_is_true = false);
306307
void AddOption(const char* name,
307308
const char* help_text,
308309
uint64_t Options::* field,
@@ -425,6 +426,7 @@ class OptionsParser {
425426
std::shared_ptr<BaseOptionField> field;
426427
OptionEnvvarSettings env_setting;
427428
std::string help_text;
429+
bool default_is_true = false;
428430
};
429431

430432
// An implied option is composed of the information on where to store a

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL