refactor(dotenv): mirror motdotla/dotenv parser rewrite#501
Merged
Conversation
Replace the polynomial-time line-by-line regex with the upstream single multiline LINE regex used since dotenv v16. Eliminates the ReDoS-style code scanning alert and brings parity for export prefix, backtick quotes, inline comments, and \r escape expansion. Also adds override and processEnv config options, and a __proto__/constructor/prototype guard in parse().
Brings branch coverage on packages/dotenv/src/index.ts back to 100%.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Mirror the parser rewrite that upstream
motdotla/dotenvshipped in v16, in a compact form. Replaces the old line-by-line^\s*([\w.-]+)\s*=\s*(.*)?\s*$regex — flagged by CodeQL as a polynomial-time / ReDoS-prone pattern — with the upstream single multilineLINEregex.Changes
packages/dotenv/src/index.tsLINEregex handlesexportprefix,KEY=andKEY:separators, quoted (',\",`) and unquoted values, and trailing inline#comments — all in one pass with no catastrophic backtracking.\r\n?→\nonce, then loop withLINE.exec().\nand\rescapes only inside double quotes (parity with upstream).__proto__/constructor/prototypeguard so a malicious.envcannot pollute the prototype chain (small extra hardening on top of upstream).config()gainedoverrideandprocessEnvoptions, matching upstream's API surface.packages/dotenv/src/types.tsoverrideandprocessEnvtoDotenvConfigOptions.DotenvParseOptions.debugdeprecated — the new parser has no concept of an "unmatched line" so per-line debug warnings are gone.tests/modules/dotenv.test.tsdebugtest with coverage for the rewrite: ignored non-pair lines, inline comments,exportprefix, backtick quotes,__proto__pollution safety,override, and customprocessEnv.Verification
Notes
Existing behavior is preserved for every case covered by the previous test suite. The `debug` option on `parse()` is now a no-op but kept for backwards compatibility.