refactor: mask emails with random strings instead of *** #53527
Merged
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
Reviewer Checklist
Screenshots/VideosAndroid: Native
Android: mWeb Chrome
iOS: Native0-ios.mp4iOS: mWeb Safari
MacOS: Chrome / Safari0-web.mp4MacOS: Desktop0-desktop.mp4 |
eh2077
reviewed
Dec 5, 2024
src/libs/ExportOnyxState/common.ts
Outdated
Comment on lines
62
to
70
| let maskedEmail = ''; | ||
| if (!emailMap.has(item)) { | ||
| maskedEmail = randomizeEmail(item); | ||
| emailMap.set(item, maskedEmail); | ||
| } else { | ||
| // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style | ||
| maskedEmail = emailMap.get(item) as string; | ||
| } | ||
| return maskedEmail; |
There was a problem hiding this comment.
I think we can wrap these lines in a new method getMarkedEmail and reuse it, like
const getMarkedEmail = (email: string): string => {
let maskedEmail = '';
if (!emailMap.has(email)) {
maskedEmail = randomizeEmail(email);
emailMap.set(email, maskedEmail);
} else {
// eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
maskedEmail = emailMap.get(email) as string;
}
return maskedEmail;
};
src/libs/ExportOnyxState/common.ts
Outdated
| // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style | ||
| propertyName = emailMap.get(key) as string; | ||
| } else { | ||
| const maskedEmail = randomizeEmail(key); |
There was a problem hiding this comment.
We should save it to emailMap right?
| @@ -3,6 +3,35 @@ import ONYXKEYS from '@src/ONYXKEYS'; | |||
| import type {Session} from '@src/types/onyx'; | |||
|
|
|||
| const MASKING_PATTERN = '***'; | |||
| const emailRegex = /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/; | |||
|
|
|||
| const emailMap = new Map<string, string>(); | |||
There was a problem hiding this comment.
Do we need to do cleanup before the return of method maskOnyxState?
|
@eh2077 thanks, addressed all your comments 👍 |
eh2077
reviewed
Dec 6, 2024
src/libs/ExportOnyxState/common.ts
Outdated
Comment on lines
90
to
96
| if (emailMap.has(key)) { | ||
| // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style | ||
| propertyName = emailMap.get(key) as string; | ||
| } else { | ||
| const maskedEmail = maskEmail(key); | ||
| propertyName = maskedEmail; | ||
| } |
There was a problem hiding this comment.
Suggested change
| if (emailMap.has(key)) { | |
| // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style | |
| propertyName = emailMap.get(key) as string; | |
| } else { | |
| const maskedEmail = maskEmail(key); | |
| propertyName = maskedEmail; | |
| } | |
| propertyName = maskEmail(key); |
src/libs/ExportOnyxState/common.ts
Outdated
Comment on lines
104
to
105
| const maskedEmail = maskEmail(value); | ||
| maskedData[propertyName] = maskedEmail; |
There was a problem hiding this comment.
Suggested change
| const maskedEmail = maskEmail(value); | |
| maskedData[propertyName] = maskedEmail; | |
| maskedData[propertyName] = maskEmail(value); |
src/libs/ExportOnyxState/common.ts
Outdated
Comment on lines
107
to
118
| let maskedEmailString = value; | ||
| const email = extractEmail(value) ?? ''; | ||
|
|
||
| if (!emailMap.has(email)) { | ||
| const randomEmail = randomizeEmail(email); | ||
| emailMap.set(email, randomEmail); | ||
| maskedEmailString = replaceEmailInString(value, randomEmail); | ||
| } else { | ||
| // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style | ||
| maskedEmailString = replaceEmailInString(value, emailMap.get(email) as string); | ||
| } | ||
| maskedData[propertyName] = maskedEmailString; |
There was a problem hiding this comment.
Suggested change
| let maskedEmailString = value; | |
| const email = extractEmail(value) ?? ''; | |
| if (!emailMap.has(email)) { | |
| const randomEmail = randomizeEmail(email); | |
| emailMap.set(email, randomEmail); | |
| maskedEmailString = replaceEmailInString(value, randomEmail); | |
| } else { | |
| // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style | |
| maskedEmailString = replaceEmailInString(value, emailMap.get(email) as string); | |
| } | |
| maskedData[propertyName] = maskedEmailString; | |
| maskedData[propertyName] = replaceEmailInString(value, maskEmail(extractEmail(value) ?? '')); |
|
thanks for catching it, updated 👍 |
Gonals
approved these changes
Dec 10, 2024
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
52 tasks
|
🚀 Deployed to staging by https://github.com/Gonals in version: 9.0.74-0 🚀
|
|
🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.74-8 🚀
|
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.
Explanation of Change
When exporting Onyx state with masking option enabled, every email address and message is replaced with
***. While this ensures data anonymity, it also makes it difficult to analyze and reproduce bugs related to participants-related features and possibly impacts reliability when measuring performance. This PR generates random email address instead of***.Fixed Issues
$ #53060
PROPOSAL:
Tests
Offline tests
n/a
QA Steps
// TODO: These must be filled out, or the issue title must include "[No QA]."
Same as Tests
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
android.mov
Android: mWeb Chrome
android-web.mov
iOS: Native
ios.mp4
iOS: mWeb Safari
ios-web.mp4
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov