Skip to content

Commit

Permalink
src: clarify OptionEnvvarSettings member names
Browse files Browse the repository at this point in the history
The term `Environment` in `kAllowedInEnvironment` and
`kDisallowedInEnvironment` has nothing to do with the commonly used
term `node::Environment`. Rename the member to `kAllowedInNodeOptions`
and `kDisallowedInNodeOptions` respectively to reflect they are options
of `OptionEnvvarSettings`.

As `OptionEnvvarSettings` is part of the public embedder APIs, the
legacy names are still preserved.
  • Loading branch information
legendecas committed Oct 23, 2022
1 parent 6bdc101 commit 8dfba84
Show file tree
Hide file tree
Showing 7 changed files with 165 additions and 161 deletions.
6 changes: 3 additions & 3 deletions lib/internal/process/per_thread.js
Expand Up @@ -267,14 +267,14 @@ const trailingValuesRegex = /=.*$/;
// from data in the config binding.
function buildAllowedFlags() {
const {
envSettings: { kAllowedInEnvironment },
envSettings: { kAllowedInNodeOptions },
types: { kBoolean },
} = internalBinding('options');
const { options, aliases } = require('internal/options');

const allowedNodeEnvironmentFlags = [];
for (const { 0: name, 1: info } of options) {
if (info.envVarSettings === kAllowedInEnvironment) {
if (info.envVarSettings === kAllowedInNodeOptions) {
ArrayPrototypePush(allowedNodeEnvironmentFlags, name);
if (info.type === kBoolean) {
const negatedName = `--no-${name.slice(2)}`;
Expand All @@ -291,7 +291,7 @@ function buildAllowedFlags() {
ArrayPrototypeSplice(recursiveExpansion, 0, 1);
return ArrayPrototypeEvery(recursiveExpansion, isAccepted);
}
return options.get(to).envVarSettings === kAllowedInEnvironment;
return options.get(to).envVarSettings === kAllowedInNodeOptions;
}
for (const { 0: from, 1: expansion } of aliases) {
if (ArrayPrototypeEvery(expansion, isAccepted)) {
Expand Down
4 changes: 2 additions & 2 deletions src/node.cc
Expand Up @@ -769,15 +769,15 @@ static ExitCode InitializeNodeWithArgsInternal(
env_argv.insert(env_argv.begin(), argv->at(0));

const ExitCode exit_code = ProcessGlobalArgsInternal(
&env_argv, nullptr, errors, kAllowedInEnvironment);
&env_argv, nullptr, errors, kAllowedInNodeOptions);
if (exit_code != ExitCode::kNoFailure) return exit_code;
}
}
#endif

if (!(flags & ProcessInitializationFlags::kDisableCLIOptions)) {
const ExitCode exit_code = ProcessGlobalArgsInternal(
argv, exec_argv, errors, kDisallowedInEnvironment);
argv, exec_argv, errors, kDisallowedInNodeOptions);
if (exit_code != ExitCode::kNoFailure) return exit_code;
}

Expand Down
8 changes: 6 additions & 2 deletions src/node.h
Expand Up @@ -349,8 +349,12 @@ inline std::unique_ptr<InitializationResult> InitializeOncePerProcess(
}

enum OptionEnvvarSettings {
kAllowedInEnvironment,
kDisallowedInEnvironment
kAllowedInNodeOptions = 0,
kDisallowedInNodeOptions = 1,
// Deprecated, use kAllowedInNodeOptions instead.
kAllowedInEnvironment = kAllowedInNodeOptions,
// Deprecated, use kDisallowedInNodeOptions instead.
kDisallowedInEnvironment = kDisallowedInNodeOptions,
};

NODE_EXTERN int ProcessGlobalArgs(std::vector<std::string>* args,
Expand Down
6 changes: 3 additions & 3 deletions src/node_options-inl.h
Expand Up @@ -302,7 +302,7 @@ void OptionsParser<Options>::Parse(
const std::string arg = args.pop_first();

if (arg == "--") {
if (required_env_settings == kAllowedInEnvironment)
if (required_env_settings == kAllowedInNodeOptions)
errors->push_back(NotAllowedInEnvErr("--"));
break;
}
Expand Down Expand Up @@ -374,8 +374,8 @@ void OptionsParser<Options>::Parse(
auto it = options_.find(name);

if ((it == options_.end() ||
it->second.env_setting == kDisallowedInEnvironment) &&
required_env_settings == kAllowedInEnvironment) {
it->second.env_setting == kDisallowedInNodeOptions) &&
required_env_settings == kAllowedInNodeOptions) {
errors->push_back(NotAllowedInEnvErr(original_name));
break;
}
Expand Down

0 comments on commit 8dfba84

Please sign in to comment.