Skip to content

src: improve node::Dotenv trimming #56983

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

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
24 changes: 19 additions & 5 deletions src/node_dotenv.cc
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,22 @@ Local<Object> Dotenv::ToObject(Environment* env) const {
return result;
}

// Removes space characters (spaces, tabs and newlines) from
// the start and end of a given input string
std::string_view trim_spaces(std::string_view input) {
if (input.empty()) return "";
if (input.front() == ' ') {
input.remove_prefix(input.find_first_not_of(' '));

auto pos_start = input.find_first_not_of(" \t\n");
Copy link
Member

Choose a reason for hiding this comment

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

should this also include \r and \f?

Copy link
Member Author

Choose a reason for hiding this comment

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

sounds good to me 🙂, but I'm not sure how to test that, would you be ok with addition without dedicated tests for it?

if (pos_start == std::string_view::npos) {
return "";
}
if (!input.empty() && input.back() == ' ') {
input = input.substr(0, input.find_last_not_of(' ') + 1);

auto pos_end = input.find_last_not_of(" \t\n");
if (pos_end == std::string_view::npos) {
return input.substr(pos_start);
}
return input;

return input.substr(pos_start, pos_end - pos_start + 1);
}

void Dotenv::ParseContent(const std::string_view input) {
Expand Down Expand Up @@ -147,6 +154,13 @@ void Dotenv::ParseContent(const std::string_view input) {
key = content.substr(0, equal);
content.remove_prefix(equal + 1);
key = trim_spaces(key);

// If the value is not present (e.g. KEY=) set is to an empty string
if (content.front() == '\n') {
store_.insert_or_assign(std::string(key), "");
continue;
}

content = trim_spaces(content);

if (key.empty()) {
Expand Down
8 changes: 8 additions & 0 deletions test/fixtures/dotenv/lines-with-only-spaces.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

EMPTY_LINE='value after an empty line'

SPACES_LINE='value after a line with just some spaces'

TABS_LINE='value after a line with just some tabs'

SPACES_TABS_LINE='value after a line with just some spaces and tabs'
19 changes: 19 additions & 0 deletions test/parallel/test-dotenv-edge-cases.js
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,25 @@ describe('.env supports edge cases', () => {
assert.strictEqual(child.code, 0);
});

it('should handle lines that come after lines with only spaces (and tabs)', async () => {
// Ref: https://github.com/nodejs/node/issues/56686
const code = `
process.loadEnvFile('./lines-with-only-spaces.env');
assert.strictEqual(process.env.EMPTY_LINE, 'value after an empty line');
assert.strictEqual(process.env.SPACES_LINE, 'value after a line with just some spaces');
assert.strictEqual(process.env.TABS_LINE, 'value after a line with just some tabs');
assert.strictEqual(process.env.SPACES_TABS_LINE, 'value after a line with just some spaces and tabs');
`.trim();
const child = await common.spawnPromisified(
process.execPath,
[ '--eval', code ],
{ cwd: fixtures.path('dotenv') },
);
assert.strictEqual(child.stdout, '');
assert.strictEqual(child.stderr, '');
assert.strictEqual(child.code, 0);
});

it('should handle when --env-file is passed along with --', async () => {
const child = await common.spawnPromisified(
process.execPath,
Expand Down
Loading