refactor: Add recursive scrubbing to EventScrubber with tests #2755
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
sentrivana
requested changes
Feb 22, 2024
There was a problem hiding this comment.
Heya @Cheapshot003, thanks for this PR! Implementation-wise LGTM, see my comments regarding the test.
sentrivana
approved these changes
Feb 26, 2024
There was a problem hiding this comment.
Thanks @Cheapshot003! LGTM now. Nothing more needed from your side, I'll merge this in the next couple days.
3 tasks
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.
Should fix #2743
I added a "recursive" flag (default: False) to the EventScrubber that will scrub sensitive PII in dicts and lists recursively if set to True. Also added a test which uses a EventScrubber with recursive=True to scrub an event and check if it finds the sensitive stuff in deeply nested dicts/lists. Hope this is how you wanted it :)
General Notes
Thank you for contributing to
sentry-python!Please add tests to validate your changes, and lint your code using
tox -e linters.Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.
For maintainers
Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.
Before running sensitive test suites, please carefully check the PR. Then, apply the
Trigger: tests using secretslabel. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.