Skip to content

refactor(native): Fail on empty or non-existent config environment variable #26741

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.

Sign up for GitHub

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

Open
nmahadevuni wants to merge 1 commit into
base: master
Choose a base branch
from
Open

refactor(native): Fail on empty or non-existent config environment variable #26741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 5 additions & 7 deletions presto-native-execution/presto_cpp/main/common/ConfigReader.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,13 @@ namespace {
void extractValueIfEnvironmentVariable(std::string& value) {
if (value.size() > 3 && value.substr(0, 2) == "${" && value.back() == '}') {
auto envName = value.substr(2, value.size() - 3);

const char* envVal = std::getenv(envName.c_str());
if (envVal != nullptr) {
if (strlen(envVal) == 0) {
LOG(WARNING) << fmt::format(
"Config environment variable {} is empty.", envName);
}
value = std::string(envVal);

if (envVal == nullptr || strlen(envVal) == 0) {
Copy link
Contributor

@aditi-pandit aditi-pandit Dec 8, 2025

Choose a reason for hiding this comment

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

@nmahadevuni : This does have the side effect that we were allowing empty values in the past, but will not going forth.

Can you give more information about the context in which you encountered the errors ? That would give us more understanding of how to change this logic.

Copy link
Member Author

@nmahadevuni nmahadevuni Dec 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This is only for configs that are set using the env vars. In recent internal issues, due to dynamic catalog loading, we have seen issues where env vars were not set correctly and logs didn't give any clue as to what went wrong. We want to catch such issues while loading catalog.

VELOX_USER_FAIL(
"Config environment variable {} doesn't exist or is empty.", envName);
}
value = std::string(envVal);
}
}
} // namespace
Expand Down
32 changes: 27 additions & 5 deletions presto-native-execution/presto_cpp/main/common/tests/ConfigTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,8 @@ TEST_F(ConfigTest, optionalNodeId) {
TEST_F(ConfigTest, readConfigEnvVarTest) {
const std::string kEnvVarName = "PRESTO_READ_CONFIG_TEST_VAR";
const std::string kEmptyEnvVarName = "PRESTO_READ_CONFIG_TEST_EMPTY_VAR";
const std::string kNonExistEnvVarName =
"PRESTO_READ_CONFIG_TEST_NON_EXIST_VAR";

const std::string kPlainTextKey = "plain-text";
const std::string kPlainTextValue = "plain-text-value";
Expand All @@ -337,22 +339,42 @@ TEST_F(ConfigTest, readConfigEnvVarTest) {
fmt::format("{}=${{{}}}\n", kEnvVarKey, kEnvVarName) +
fmt::format("{}=${{{}\n", kEnvVarKey2, kEnvVarName) +
fmt::format("{}={}}}\n", kEnvVarKey3, kEnvVarName) +
fmt::format("{}=${{}}\n", kNoEnvVarKey) +
fmt::format("{}=${{{}}}\n", kEmptyEnvVarKey, kEmptyEnvVarName));
fmt::format("{}=${{}}\n", kNoEnvVarKey));

setenv(kEnvVarName.c_str(), kEnvVarValue.c_str(), 1);
setenv(kEmptyEnvVarName.c_str(), "", 1);

auto properties = presto::util::readConfig(configFilePath_);
std::unordered_map<std::string, std::string> expected{
{kPlainTextKey, kPlainTextValue},
{kEnvVarKey, kEnvVarValue},
{kEnvVarKey2, "${PRESTO_READ_CONFIG_TEST_VAR"},
{kEnvVarKey3, "PRESTO_READ_CONFIG_TEST_VAR}"},
{kNoEnvVarKey, "${}"},
{kEmptyEnvVarKey, ""}};
{kNoEnvVarKey, "${}"}};
ASSERT_EQ(properties, expected);

// Empty env var
auto testInvalidEnvVar = [this](
const std::string& fileContent,
const std::string& expectedErrorMsg) {
cleanupConfigFilePath();
setUpConfigFilePath();
writeConfigFile(fileContent);
VELOX_ASSERT_THROW(
presto::util::readConfig(configFilePath_), expectedErrorMsg);
};

setenv(kEmptyEnvVarName.c_str(), "", 1);
testInvalidEnvVar(
fmt::format("{}=${{{}}}\n", kEmptyEnvVarKey, kEmptyEnvVarName),
fmt::format(
"Config environment variable {} doesn't exist or is empty",
kEmptyEnvVarName));
testInvalidEnvVar(
fmt::format("{}=${{{}}}\n", kEmptyEnvVarKey, kNonExistEnvVarName),
fmt::format(
"Config environment variable {} doesn't exist or is empty",
kNonExistEnvVarName));

unsetenv(kEnvVarName.c_str());
unsetenv(kEmptyEnvVarName.c_str());
}
Expand Down
Loading