Skip to content

util: fix parseEnv incorrectly splitting multiple ‘=‘ in value #57421

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

Merged
merged 6 commits into from
Apr 6, 2025
Merged

util: fix parseEnv incorrectly splitting multiple ‘=‘ in value #57421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
be4ee4d
util: fix parseEnv incorrectly splitting multiple ‘=‘ in value
rayark1 Mar 11, 2025
b0680d8
Update test/fixtures/dotenv/valid.env
rayark1 Mar 13, 2025
8a094b7
Update benchmark/fixtures/valid.env
rayark1 Mar 13, 2025
12105d9
refactor: apply comment
rayark1 Mar 14, 2025
af80652
test: add test case
rayark1 Mar 14, 2025
1ac38ad
add: test case for DOUBLE_QUOTES
rayark1 Mar 17, 2025
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
2 changes: 2 additions & 0 deletions benchmark/fixtures/valid.env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ BASIC=basic

# previous line intentionally left blank
AFTER_LINE=after_line
A="B=C"
B=C=D
EMPTY=
EMPTY_SINGLE_QUOTES=''
EMPTY_DOUBLE_QUOTES=""
Expand Down
38 changes: 30 additions & 8 deletions src/node_dotenv.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,16 @@ void Dotenv::ParseContent(const std::string_view input) {
// If there is no equal character, then ignore everything
auto equal = content.find('=');
if (equal == std::string_view::npos) {
break;
auto newline = content.find('\n');
if (newline != std::string_view::npos) {
// If we used `newline` only,
// the '\n' might remain and cause an empty-line parse
content.remove_prefix(newline + 1);
} else {
content = {};
}
// No valid data here, skip to next line
continue;
}

key = content.substr(0, equal);
Expand Down Expand Up @@ -195,7 +204,9 @@ void Dotenv::ParseContent(const std::string_view input) {
store_.insert_or_assign(std::string(key), multi_line_value);
auto newline = content.find('\n', closing_quote + 1);
if (newline != std::string_view::npos) {
content.remove_prefix(newline);
content.remove_prefix(newline + 1);
} else {
content = {};
}
continue;
}
Expand All @@ -216,7 +227,7 @@ void Dotenv::ParseContent(const std::string_view input) {
if (newline != std::string_view::npos) {
value = content.substr(0, newline);
store_.insert_or_assign(std::string(key), value);
content.remove_prefix(newline);
content.remove_prefix(newline + 1);
}
} else {
// Example: KEY="value"
Expand All @@ -226,8 +237,13 @@ void Dotenv::ParseContent(const std::string_view input) {
// since there could be newline characters inside the value.
auto newline = content.find('\n', closing_quote + 1);
if (newline != std::string_view::npos) {
content.remove_prefix(newline);
// Use +1 to discard the '\n' itself => next line
content.remove_prefix(newline + 1);
} else {
content = {};
}
// No valid data here, skip to next line
continue;
}
} else {
// Regular key value pair.
Expand All @@ -243,15 +259,21 @@ void Dotenv::ParseContent(const std::string_view input) {
if (hash_character != std::string_view::npos) {
value = content.substr(0, hash_character);
}
content.remove_prefix(newline);
store_.insert_or_assign(std::string(key), trim_spaces(value));
content.remove_prefix(newline + 1);
} else {
// In case the last line is a single key/value pair
// Example: KEY=VALUE (without a newline at the EOF)
value = content.substr(0);
value = content;
auto hash_char = value.find('#');
if (hash_char != std::string_view::npos) {
value = content.substr(0, hash_char);
}
store_.insert_or_assign(std::string(key), trim_spaces(value));
content = {};
}

value = trim_spaces(value);
store_.insert_or_assign(std::string(key), value);
store_.insert_or_assign(std::string(key), trim_spaces(value));
}
}
}
Expand Down
2 changes: 2 additions & 0 deletions test/fixtures/dotenv/valid.env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ BASIC=basic

# previous line intentionally left blank
AFTER_LINE=after_line
A="B=C"
B=C=D
EMPTY=
EMPTY_SINGLE_QUOTES=''
EMPTY_DOUBLE_QUOTES=""
Expand Down
2 changes: 2 additions & 0 deletions test/parallel/test-dotenv.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,5 @@ assert.strictEqual(process.env.DONT_EXPAND_SQUOTED, 'dontexpand\\nnewlines');
assert.strictEqual(process.env.EXPORT_EXAMPLE, 'ignore export');
// Ignore spaces before double quotes to avoid quoted strings as value
assert.strictEqual(process.env.SPACE_BEFORE_DOUBLE_QUOTES, 'space before double quotes');
assert.strictEqual(process.env.A, 'B=C');
assert.strictEqual(process.env.B, 'C=D');
2 changes: 2 additions & 0 deletions test/parallel/test-util-parse-env.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ const fs = require('node:fs');
const validContent = fs.readFileSync(validEnvFilePath, 'utf8');

assert.deepStrictEqual(util.parseEnv(validContent), {
A: 'B=C',
B: 'C=D',
AFTER_LINE: 'after_line',
BACKTICKS: 'backticks',
BACKTICKS_INSIDE_DOUBLE: '`backticks` work inside double quotes',
Expand Down
Loading