Fix redaction regex reuse: avoid mutating patterns and keep allowlist working across calls#19
Merged
Merged
Conversation
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
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.
This PR fixes a subtle statefulness bug in the redactor caused by cloning regexes and forcibly adding the global (
g) flag.What changed
cloneRegex, which was creating newRegExpinstances withgappended.replaceAllMatchesWithContextandreplaceBip39MnemonicMatchesWithContextto use the providedpatterndirectly inString.prototype.replace."g"flags from the internal HEX / BASE64 / BASE64URL / BASE58 regexes and adjusted the mnemonic regex from"gi"to"i"to avoid unnecessary global state.Why
Cloning and forcing
gcan make matching behavior unexpectedly stateful (vialastIndex) and can also change how callers’ patterns behave. In practice, this could cause allowlist rules to stop matching reliably after repeated invocations, depending on how the regex is reused.Tests
allows whitelist each time) that calls the redactor repeatedly with a hex allow rule and asserts the allowlist continues to apply on every run.Impact