Fix bug where dotenv file using quotes greedily consumes values. #3703
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joehan
reviewed
Aug 25, 2021
joehan
approved these changes
Aug 25, 2021
inlined
reviewed
Aug 25, 2021
| "\\s*" + // leading whitespaces | ||
| "(\\w+)" + // key | ||
| "\\s*=\\s*" + // separator (=) | ||
| "(" + // begin optional value |
There was a problem hiding this comment.
I think it still is? The relevant test case still passes:
https://github.com/firebase/firebase-tools/blob/master/src/test/functions/env.spec.ts#L83
There was a problem hiding this comment.
I thought the backend didn't support it?
There was a problem hiding this comment.
Oh that's what I thought too but just checked deploying empty env var and confirmed that it's a valid value.
| "(" + // begin optional value | ||
| "\\s*'(?:\\\\'|[^'])*'|" + // single quoted or | ||
| '\\s*"(?:\\\\"|[^"])*"|' + // double quoted or | ||
| "[^\\#\\r\\n]+" + // unquoted |
There was a problem hiding this comment.
I thought we decided that the # character doesn't need escaping?
There was a problem hiding this comment.
Yes. It looks like regex implementation ignores wrongly escaped characters, so I got lucky here:
> "#".match(RegExp("#"))
[ '#', index: 0, input: '#', groups: undefined ]
> "#".match(RegExp("\\#"))
[ '#', index: 0, input: '#', groups: undefined ]
devpeerapong
pushed a commit
to devpeerapong/firebase-tools
that referenced
this pull request
Dec 14, 2021
…ebase#3703) Our parser for dotenv file format allows values to be wrapped inside single or double quotes. The regex we have for parsing these value is too greedy as implemented: ``` # .env A="abc" B="efg" ``` ``` parse(readFileSync(".env")) => { A: 'abc\nB="efg"' } ``` The change in regex correctly parses the dotenv file: ``` parse(readFileSync(".env")) => { A: "abc", B: "efg" } ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our parser for dotenv file format allows values to be wrapped inside single or double quotes.
The regex we have for parsing these value is too greedy as implemented:
The change in regex correctly parses the dotenv file: