feat: new redaction methodology for Python metrics client #266
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
RyanGWU82
force-pushed
the
python-rm-1407
branch
from
b02c670 to
3e9cd8a
Compare
|
@domharrington @emilyskuo @ilias-t Gentle nudge on this PR too, thanks! |
ilias-t
reviewed
Jul 2, 2021
|
code LGTM, but I'm not a python expert, so not comfortable ✅ 'ing |
emilyskuo
approved these changes
Jul 6, 2021
Co-authored-by: Emily Kuo <[email protected]>
domharrington
pushed a commit
that referenced
this pull request
Apr 19, 2022
* feat: new redaction methodology for Python metrics client * release: bump version number to 1.2.0 due to changes with redaction * fix: redacted strings should have a space between REDACTED and their length * fix: remove outdated TODO * Update packages/python/readme_metrics/PayloadBuilder.py Co-authored-by: Emily Kuo <[email protected]> Co-authored-by: Emily Kuo <[email protected]>
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.
🧰 What's being changed?
Updated the redaction logic so that redacted fields will be replaced by
[REDACTED], or in the case of strings,[REDACTEDn]where n is the length of the string.Wrote new tests that test redaction in isolation, but kept the old tests around for extra safety. The old tests would test redaction only in the context of serializing an entire HTTP request. They're kinda weird — they just check for the presence of substrings like
passwordinside a serialized JSON result.I also wound up making some pretty significant changes to the PayloadBuilder's code for parsing the request/response body, because that code was tightly coupled to the old
util_exclude_keysandutil_filter_keysfunctions. The tests here are not very thorough and don't cover all cases but I'm pretty confident it's still generating the correct output. It would probably be smart to review the HAR spec and write more comprehensive test cases, but how valuable that would be for ReadMe, I can't say.🧪 Testing
Tested locally in the Python test server. Also ran
pytest, all tests pass.