Ex4 chat masking #51790

LCOleksii · 2024-10-31T14:07:41Z

Explanation of Change

UNMASK:
Chats between Non-Expensify users and Expensify users (e.g. Concierge)

MASK:
Chats between Expensify users and other Expensify users

Chats between non-Expensify users that do NOT include any Expensify users

Exposed PersonalDetailsProvider from OnyxProvider
Added CONST that represents email domain for support team:

EXPENSIFY_TEAM_EMAIL_DOMAIN

Updated @lib/Fullstory to evaluate MASK/UNMASK based on provided report context

Added isExpensifyAndCustomerChat exported function to ReportUtils
to handle report type evaluation.

Fixed Issues

$ #52271
PROPOSAL:
Improve MASK/UNMASK process based on report context.
No visual changes. Component attributes added.

Tests

Verify that no errors appear in the JS console
Verify components have appropriate "Fullstory" properties set
QA:
Navigate using the fullstory@applause email
Send a message on a Concierge chat
Send a message on a chat with an expensify user
create a policy, and add expenses to a policy expense chat
Check on Fullstory if your session and confirm that you can only see the full data in the policy expense chat

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

$https://drive.google.com/file/d/1KoI9jJIAkUD80-na2Xzf35iFoI1wuLER/view?usp=drive_link

iOS: Native

$https://drive.google.com/file/d/10QZ6PG__dkNqF5RbQVFbSbhc4yzbi8Dv/view?usp=drive_link

iOS: mWeb Safari

MacOS: Chrome / Safari

$https://drive.google.com/file/d/1ZP5xIH7hcxV_LS_iA2PpbZDUgNRVaNjg/view?usp=sharing

MacOS: Desktop

melvin-bot · 2024-10-31T14:08:14Z

@srikarparsi Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

srikarparsi · 2024-10-31T15:56:35Z

Hi @LCOleksii, is this for a specific issue? Please let me know and I can reopen this PR

danieldoglas · 2024-10-31T16:39:04Z

hm @srikarparsi why did you close this PR?

srikarparsi · 2024-10-31T16:44:05Z

Oh sorry, I didn't know if it was a legit one because I didn't see a linked issue and there was a bunch of lint errors when it was ready for review. But re-opening since you seem to suggest it's legit?

danieldoglas · 2024-10-31T17:13:04Z

Yep, it is legit.

srikarparsi · 2024-11-05T09:20:19Z

Re-assigning you @danieldoglas if that's okay

danieldoglas · 2024-11-05T14:17:54Z

src/libs/ReportUtils.ts

+        const baseRegexp = new RegExp(`${CONST.EMAIL.EXPENSIFY_EMAIL_DOMAIN}$`);
+        const teamRegexp = new RegExp(`${CONST.EMAIL.EXPENSIFY_TEAM_EMAIL_DOMAIN}$`);


I think you can remove the regex testing and change this to use endsWith()

UNMASK: Chats between Non-Expensify users and Expensify users (e.g. Concierge) MASK: Chats between Expensify users and other Expensify users Chats between non-Expensify users that do NOT include any Expensify users Exposed PersonalDetailsProvider from OnyxProvider Added CONST that represents email domain for support team: - EXPENSIFY_TEAM_EMAIL_DOMAIN Updated @lib/Fullstory to evaluate MASK/UNMASK based on provided report context Added isExpensifyAndCustomerChat exported function to ReportUtils to handle report type evaluation.

Clean perfcheck passed.

Removed unused imports

Refactoring, context evaluation moved to component level. Changed function args usage in related functions.

ESLINT fixes

ESLINT fixes Prefer an early return to a conditionally-wrapped function body rulesdir/prefer-early-return

Prettier fixes

ESlint double neg check fixes

gedu · 2024-11-06T18:08:09Z

src/libs/Fullstory/index.ts

+function getChatFSAttributes(context: OnyxEntry<PersonalDetailsList>, name: string, report: OnyxInputOrEntry<Report>, prefix: boolean): string {
+    let componentPrefix = prefix ? `${name},` : '';
+    let componentSuffix = name ? `,fs-${name}` : '';
+    let fsAttrValue = '';
+
+    if (isConciergeChatReport(report)) {
+        componentPrefix = prefix ? `${CONCIERGE}-${name},` : '';
+        componentSuffix = name ? `,fs-${name}` : '';
+        /*
+        concierge-chatMessage,fs-unmask,fs-chatMessage
+        */
+        fsAttrValue = `${componentPrefix}${UNMASK}${componentSuffix}`;
+    } else if (isExpensifyAndCustomerChat(context, report)) {
+        componentPrefix = prefix ? `${CUSTOMER}-${name},` : '';
+        componentSuffix = name ? `,fs-${name}` : '';
+        /*
+        customer-chatMessage,fs-unmask,fs-chatMessage
+        */
+        fsAttrValue = `${componentPrefix}${UNMASK}${componentSuffix}`;
+    } else {
+        componentPrefix = prefix ? `${OTHER}-${name},` : '';
+        componentSuffix = name ? `,fs-${name}` : '';
+        /*
+        other-chatMessage,fs-mask,fs-chatMessage
+        */
+        fsAttrValue = `${componentPrefix}${MASK}${componentSuffix}`;
+    }
+
+    return fsAttrValue;
+}


I think this logic can be simplified as

Suggested change

function getChatFSAttributes(context: OnyxEntry<PersonalDetailsList>, name: string, report: OnyxInputOrEntry<Report>, prefix: boolean): string {

let componentPrefix = prefix ? `${name},` : '';

let componentSuffix = name ? `,fs-${name}` : '';

let fsAttrValue = '';

if (isConciergeChatReport(report)) {

componentPrefix = prefix ? `${CONCIERGE}-${name},` : '';

componentSuffix = name ? `,fs-${name}` : '';

/*

concierge-chatMessage,fs-unmask,fs-chatMessage

*/

fsAttrValue = `${componentPrefix}${UNMASK}${componentSuffix}`;

} else if (isExpensifyAndCustomerChat(context, report)) {

componentPrefix = prefix ? `${CUSTOMER}-${name},` : '';

componentSuffix = name ? `,fs-${name}` : '';

/*

customer-chatMessage,fs-unmask,fs-chatMessage

*/

fsAttrValue = `${componentPrefix}${UNMASK}${componentSuffix}`;

} else {

componentPrefix = prefix ? `${OTHER}-${name},` : '';

componentSuffix = name ? `,fs-${name}` : '';

/*

other-chatMessage,fs-mask,fs-chatMessage

*/

fsAttrValue = `${componentPrefix}${MASK}${componentSuffix}`;

}

return fsAttrValue;

}

function getChatFSAttributes(context: OnyxEntry<PersonalDetailsList>, name: string, report: OnyxInputOrEntry<Report>, prefix: boolean): string {

const baseName = name ? `,fs-${name}` : '';

let componentPrefix = '';

let maskType = MASK;

if (isConciergeChatReport(report)) {

componentPrefix = CONCIERGE;

maskType = UNMASK;

} else if (isExpensifyAndCustomerChat(context, report)) {

componentPrefix = CUSTOMER;

maskType = UNMASK;

} else {

componentPrefix = OTHER;

}

const prefixPart = prefix ? `${componentPrefix}-${name},` : '';

return `${prefixPart}${maskType}${baseName}`;

}

gedu · 2024-11-06T18:09:12Z

src/libs/Fullstory/index.ts

+    return fsAttrValue;
+}
+
+function getChatFSAttributes(context: OnyxEntry<PersonalDetailsList>, name: string, report: OnyxInputOrEntry<Report>, prefix: boolean): string {


Would be great to add test on all this functions

src/libs/Fullstory/index.ts

Performance review fixes, Cleanup.

gedu · 2024-11-13T10:14:22Z

src/libs/ReportUtils.ts

+            if (contextAccountData) {
+                const login = contextAccountData.login ?? '';
+
+                if (login.endsWith(CONST.EMAIL.EXPENSIFY_EMAIL_DOMAIN) ?? login.endsWith(CONST.EMAIL.EXPENSIFY_TEAM_EMAIL_DOMAIN)) {


What it means here the use of ??? shouldn't be the OR operator? ||?

I think this case could be caught with tests, we should add some

src/libs/ReportUtils.ts

src/libs/Fullstory/index.ts

src/pages/home/report/ReportActionsList.tsx

clean unnecessary type coercion

danieldoglas · 2024-11-14T15:19:26Z

@LCOleksii please merge main into this

# Conflicts: # src/libs/ReportUtils.ts # src/pages/home/report/ReportActionsList.tsx

Error fix: Prettier diff detected

gedu · 2024-11-15T17:38:04Z

There is a failing test

gedu · 2024-11-21T08:33:06Z

Any news here?

danieldoglas · 2024-11-21T17:27:28Z

@LCOleksii bump on te test fix

Error fix: Perf-test missing mocked library fix.

Eslint check fix.

danieldoglas · 2024-12-02T18:58:59Z

@gedu ready for your eyes again

gedu · 2024-12-04T17:37:23Z

Cool, I will take a look tomorrow

danielrvidal · 2024-12-09T22:23:02Z

@gedu this is still being worked on, correct? Who are you waiting on?

gedu · 2024-12-10T18:55:37Z

Sorry, something with more priority shows up, tomorrow first thing in the morning I will check it

gedu · 2024-12-11T14:19:58Z

LGTM

allgandalf · 2024-12-11T19:36:04Z

please assign me for review

allgandalf · 2024-12-11T20:10:16Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

allgandalf · 2024-12-11T20:14:04Z

src/libs/Fullstory/index.ts

+const WEB_PROP_ATTR = 'data-testid';
+const MASK = 'fs-mask';
+const UNMASK = 'fs-unmask';
+const CUSTOMER = 'customer';


I see these values repeated again from native and web files, this breaks the checklist checkbox which wants our code to be DRY, can you define these values in CONST.ts and use here and in native file ?

src/libs/ReportUtils.ts

src/pages/home/report/ReportActionsList.tsx

allgandalf · 2024-12-25T13:35:44Z

Lets close this PR in favour of #54535

allgandalf · 2024-12-30T20:35:07Z

Please close this one

LCOleksii requested a review from a team as a code owner October 31, 2024 14:07

melvin-bot bot requested review from srikarparsi and removed request for a team October 31, 2024 14:08

srikarparsi closed this Oct 31, 2024

srikarparsi reopened this Oct 31, 2024

srikarparsi requested review from danieldoglas and removed request for srikarparsi November 5, 2024 09:20

LCOleksii force-pushed the ex4-chat-masking branch from edf55ae to ad88466 Compare November 5, 2024 11:09

danieldoglas reviewed Nov 5, 2024

View reviewed changes

LCOleksii added 10 commits November 5, 2024 20:39

#EX-4

7d20ce8

Clean perfcheck passed.

#EX-4

cd31436

Removed unused imports

#EX-4

74f0354

Refactoring, context evaluation moved to component level. Changed function args usage in related functions.

#EX-4

41f0c6a

ESLINT fixes

#EX-4

d8282a6

ESLINT fixes

#EX-4

08b15e5

ESLINT fixes Prefer an early return to a conditionally-wrapped function body rulesdir/prefer-early-return

#EX-4

0894527

Prettier fixes

#EX-4

f6e387f

Prettier fixes

#EX-4

46d994d

ESlint double neg check fixes

gedu reviewed Nov 6, 2024

View reviewed changes

src/libs/Fullstory/index.ts Show resolved Hide resolved

#EX-4

85e7858

Performance review fixes, Cleanup.

LCOleksii force-pushed the ex4-chat-masking branch from e4717a5 to 85e7858 Compare November 7, 2024 18:13

gedu reviewed Nov 13, 2024

View reviewed changes

src/libs/ReportUtils.ts Show resolved Hide resolved

gedu reviewed Nov 13, 2024

View reviewed changes

src/libs/Fullstory/index.ts Show resolved Hide resolved

gedu reviewed Nov 13, 2024

View reviewed changes

src/pages/home/report/ReportActionsList.tsx Show resolved Hide resolved

#EX-4

f905148

clean unnecessary type coercion

LCOleksii added 2 commits November 14, 2024 16:26

Merge remote-tracking branch 'upstream/main' into ex4-chat-masking

2cfb212

# Conflicts: # src/libs/ReportUtils.ts # src/pages/home/report/ReportActionsList.tsx

#EX-4

58ee1b9

Error fix: Prettier diff detected

LCOleksii added 2 commits December 1, 2024 21:49

#EX-4

c955f0d

Error fix: Perf-test missing mocked library fix.

#EX-4

ffe1c8a

Eslint check fix.

danieldoglas requested a review from gedu December 2, 2024 18:58

Merge branch 'main' into ex4-chat-masking

b8618bc

danieldoglas requested review from allgandalf and removed request for gedu December 11, 2024 19:38

allgandalf suggested changes Dec 11, 2024

View reviewed changes

allgandalf mentioned this pull request Dec 24, 2024

[No QA]: Ex4 chat masking #54535

Merged

50 tasks

Expensify deleted a comment from allgandalf Dec 25, 2024

danieldoglas closed this Jan 2, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ex4 chat masking #51790

Ex4 chat masking #51790

LCOleksii commented Oct 31, 2024 •

edited by danieldoglas

Loading

melvin-bot bot commented Oct 31, 2024

srikarparsi commented Oct 31, 2024

danieldoglas commented Oct 31, 2024

srikarparsi commented Oct 31, 2024

danieldoglas commented Oct 31, 2024

srikarparsi commented Nov 5, 2024

danieldoglas Nov 5, 2024

gedu Nov 6, 2024

gedu Nov 6, 2024

gedu Nov 13, 2024

gedu Nov 14, 2024

danieldoglas commented Nov 14, 2024

gedu commented Nov 15, 2024

gedu commented Nov 21, 2024

danieldoglas commented Nov 21, 2024

danieldoglas commented Dec 2, 2024

gedu commented Dec 4, 2024

danielrvidal commented Dec 9, 2024

gedu commented Dec 10, 2024

gedu commented Dec 11, 2024

allgandalf commented Dec 11, 2024

allgandalf commented Dec 11, 2024

allgandalf Dec 11, 2024

allgandalf commented Dec 25, 2024

allgandalf commented Dec 30, 2024

		const baseRegexp = new RegExp(`${CONST.EMAIL.EXPENSIFY_EMAIL_DOMAIN}$`);
		const teamRegexp = new RegExp(`${CONST.EMAIL.EXPENSIFY_TEAM_EMAIL_DOMAIN}$`);

Ex4 chat masking #51790

Ex4 chat masking #51790

Conversation

LCOleksii commented Oct 31, 2024 • edited by danieldoglas Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 31, 2024

srikarparsi commented Oct 31, 2024

danieldoglas commented Oct 31, 2024

srikarparsi commented Oct 31, 2024

danieldoglas commented Oct 31, 2024

srikarparsi commented Nov 5, 2024

danieldoglas Nov 5, 2024

Choose a reason for hiding this comment

gedu Nov 6, 2024

Choose a reason for hiding this comment

gedu Nov 6, 2024

Choose a reason for hiding this comment

gedu Nov 13, 2024

Choose a reason for hiding this comment

gedu Nov 14, 2024

Choose a reason for hiding this comment

danieldoglas commented Nov 14, 2024

gedu commented Nov 15, 2024

gedu commented Nov 21, 2024

danieldoglas commented Nov 21, 2024

danieldoglas commented Dec 2, 2024

gedu commented Dec 4, 2024

danielrvidal commented Dec 9, 2024

gedu commented Dec 10, 2024

gedu commented Dec 11, 2024

allgandalf commented Dec 11, 2024

allgandalf commented Dec 11, 2024

Reviewer Checklist

Screenshots/Videos

allgandalf Dec 11, 2024

Choose a reason for hiding this comment

allgandalf commented Dec 25, 2024

allgandalf commented Dec 30, 2024

LCOleksii commented Oct 31, 2024 •

edited by danieldoglas

Loading