Skip to content

src: add support for escaping quotes with escape slash in --env-file #50814

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

Closed
pluris wants to merge 3 commits into from
Closed

src: add support for escaping quotes with escape slash in --env-file #50814

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09f8165
src: add support for escaping quotes with escape slash in `--env-file`
Nov 19, 2023
690fa43
fixup! src: add support for escaping quotes with escape slash in `--e…
Nov 19, 2023
94ada51
fixup! src: add support for escaping quotes with escape slash in `--e…
Nov 20, 2023
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 src/node_dotenv.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ void Dotenv::SetEnvironment(node::Environment* env) {
auto existing = env->env_vars()->Get(key.data());

if (existing.IsNothing()) {
// Remove all '\' characters from value
value.erase(std::remove(value.begin(), value.end(), '\\'), value.end());
Copy link
Copy Markdown
Contributor

@meyfa meyfa Nov 19, 2023

Choose a reason for hiding this comment

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

What about escaping backslashes?

Copy link
Copy Markdown
Contributor Author

@pluris pluris Nov 19, 2023

Choose a reason for hiding this comment

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

I received comments and changed the implementation to apply only to \".

Copy link
Copy Markdown
Contributor

@shubham9411 shubham9411 Nov 19, 2023

Choose a reason for hiding this comment

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

Should this be moved to Dotenv::ParseLine ? 🤔

Copy link
Copy Markdown
Contributor Author

@pluris pluris Nov 19, 2023

Choose a reason for hiding this comment

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

Thank you for your comment.
IMO, Dotenv::ParseLine() is used in Dotenv::ParsePath(), and the current issue does not seem to be about Path.

Copy link
Copy Markdown
Contributor Author

@pluris pluris Nov 20, 2023

Choose a reason for hiding this comment

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

Sorry, I checked further and found what you said was correct. I applied it.

env->env_vars()->Set(
isolate,
v8::String::NewFromUtf8(
Expand Down
1 change: 1 addition & 0 deletions test/fixtures/dotenv/valid.env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ EQUAL_SIGNS=equals==
RETAIN_INNER_QUOTES={"foo": "bar"}
RETAIN_INNER_QUOTES_AS_STRING='{"foo": "bar"}'
RETAIN_INNER_QUOTES_AS_BACKTICKS=`{"foo": "bar's"}`
RETAIN_INNER_QUOTES_AS_ESCAPE_SLASH=`{\"foo\": \"bar\"}`
Copy link
Copy Markdown
Contributor

@meyfa meyfa Nov 19, 2023

Choose a reason for hiding this comment

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

Maybe add e.g. C:\\Windows\\system32 as a test case?

Copy link
Copy Markdown
Member

@anonrig anonrig Nov 19, 2023

Choose a reason for hiding this comment

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

What's the default behavior of dotenv?

Copy link
Copy Markdown
Contributor Author

@pluris pluris Nov 19, 2023

Choose a reason for hiding this comment

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

There was a problem with the current implementation, so I modified it and added the test you commented on.

Copy link
Copy Markdown
Contributor

@meyfa meyfa Nov 19, 2023

Choose a reason for hiding this comment

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

@pluris Thanks for the quick fix! I think there is still an issue. I would expect the test to read:

assert.strictEqual(process.env.PATH_WINDOWS, 'C:\\Windows\\system32');

instead of the current

assert.strictEqual(process.env.PATH_WINDOWS, 'C:\\\\Windows\\\\system32');

That is, escaping a backslash should result in just one backslash... This is also what dotenv does, @anonrig.

Copy link
Copy Markdown
Member

@anonrig anonrig Nov 19, 2023

Choose a reason for hiding this comment

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

Suggested change
RETAIN_INNER_QUOTES_AS_ESCAPE_SLASH=`{\"foo\": \"bar\"}`
RETAIN_INNER_QUOTES_AS_ESCAPE_SLASH="{\"foo\": \"bar\"}"

TRIM_SPACE_FROM_UNQUOTED= some spaced out string
EMAIL=therealnerdybeast@example.tld
SPACED_KEY = parsed
1 change: 1 addition & 0 deletions test/parallel/test-dotenv.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ assert.strictEqual(process.env.EQUAL_SIGNS, 'equals==');
assert.strictEqual(process.env.RETAIN_INNER_QUOTES, '{"foo": "bar"}');
assert.strictEqual(process.env.RETAIN_INNER_QUOTES_AS_STRING, '{"foo": "bar"}');
assert.strictEqual(process.env.RETAIN_INNER_QUOTES_AS_BACKTICKS, '{"foo": "bar\'s"}');
assert.strictEqual(process.env.RETAIN_INNER_QUOTES_AS_ESCAPE_SLASH, '{"foo": "bar"}');
// Retains spaces in string
assert.strictEqual(process.env.TRIM_SPACE_FROM_UNQUOTED, 'some spaced out string');
// Parses email addresses completely
Expand Down