Change out the triple-dot sequence in third-party invites to an ellipsis character #324
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
Besides a slightly nicer presentation, this can be useful when email addresses that contain period characters are obfuscated. Consider the address: `[email protected]`. If this address ends up being obfuscated to `firstname....@exa...`, we end up with a slightly odd-looking sequence of four periods on the left-hand side. With an ellipsis character, we'd instead get `firstname.…@exa…`, which is still a little odd, but is clearer with regards to what exactly was obfuscated.
This allows processing the ellipsis character in Python 2
clokep
approved these changes
Nov 30, 2020
| :type characters_to_reveal: int | ||
|
|
||
| :return: The redacted string. | ||
| :rtype: unicode | ||
| """ | ||
| ellipsis_character = u"…" |
There was a problem hiding this comment.
This could probably just be inlined in each place it is used? Unless there's a plan to make this configurable. If you want to keep it, I might call this obfuscation_string or something like that.
There was a problem hiding this comment.
Not really a plan, no. I think I did it out of habit, but it indeed doesn't bring much value.
I'm not entirely sure. I know that clients regularly handle them in usernames, and I know that Sydent's database can handle them. Synapse presumably accepts them. This will be tested on DINUM's preprod beforehand at least. cc @giomfo |
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.
Besides a slightly nicer presentation, this can be useful when email addresses that contain period characters are obfuscated. Consider the address:
[email protected].If this address is obfuscated to
firstname....@exa..., we end up with a slightly odd-looking sequence of four periods on the left-hand side.With an ellipsis character, we'd instead get
firstname.…@exa…, which is still a little odd, but is clearer with regards to what exactly was obfuscated.Applying this to the
dinsicbranch as it grew out of a dinsic PR conversation, but will be ported to mainline with the rest of the obfuscated code it touches.Not sponsored as this was not a paid-for request.