MPP-3932: Add flag 'developer_mode', use to simulate complaint and log notifications #5090
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
groovecoder
approved these changes
Oct 14, 2024
emails/views.py
Outdated
Comment on lines
1001
to
1003
| notification_gza85 = base64.a85encode( | ||
| zlib.compress(json.dumps(notification).encode()), wrapcol=1024, pad=True | ||
| ).decode("ascii") |
There was a problem hiding this comment.
quesgestion (non-blocking): can this sequence of base64, zlib, and json calls be moved into a helper function format_notification_for_log that can help with re-using it exactly the same way each time? E.g., in the test code?
|
Added |
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.
Add a new waffle flag 'developer_mode', that enables additional logging for the user. This logging goes beyond our user privacy policy, so it should only be enabled for Relay staff with consent. In addition, special mask labels are used to limit logging for forwarded emails.
For forwarded mail, the mask label is used to determine developer actions. If the mask contains
DEV:simulate_complaint(no spaces), then the mail is forwarded to the AWS complaint simulator address instead of the user's real address. If the mask containsDEV:(which includes (DEV:simulate_complaint)), the received notification itself is logged, using zlib.compress and base64.a85encode to reduce the size. If the encoded notification is more than 1024 bytes, the message is split over several log lines.For complaints, any complaint notification for the user is logged. When we can reliably detect the mask, we may change this to use the mask label to further limit logging.
How to test:
I wrote tests for the new functionality in handling forwards and complaints.
I refactored the
ComplaintHandlingTestto add themailelement to all test complaint notifications, and to use the forwarded "russian spam" fixture instead of the incoming version. This required some other changes to mock aDateheader, added by SES when forwarding the email.I did not manually test this code. I plan to test it on the dev server, where we can set flags and debug the results.