fix: Drop domain name in mentions if chat members are on the same domain

[tienifr]

Details

Fixed Issues

$ #32534
PROPOSAL: #32534 (comment)

Tests

1. Create a room with 4 members: 2 on the same private domain, 1 on another private domain, and 1 on a public domain
2. As each member, send a message mentioning each other member
3. Verify that:

For email-based mentions:

1. Look at the email address in the mention
2. If it's on the same private domain as mine, render as @person. Otherwise render as @[email protected]
3. Verify the tooltips(web/desktop) are correct
4. Click on the mention to go the profile page, verify the informations are correct

For accountID-based mentions:

1. Look at the personalDetails object for the accountID
2. If we don't have a personalDetail for that accountID, render as @hidden
3. If we have a personalDetail, but we don't have a display name or login in there, render as @hidden
4. If we have a personalDetail with display name, but no login, render as @display Name
5. If we have a personalDetail with login, render the same way as email-based mentions
6. Verify the tooltips(web/desktop) are correct
7. Click on the mention to go the profile page, verify the informations are correct

• Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

1. Create a room with 4 members: 2 on the same private domain, 1 on another private domain, and 1 on a public domain
2. As each member, send a message mentioning each other member
3. Verify that:

For email-based mentions:

1. Look at the email address in the mention
2. If it's on the same private domain as mine, render as @person. Otherwise render as @[email protected]
3. Verify the tooltips(web/desktop) are correct
4. Click on the mention to go the profile page, verify the informations are correct

For accountID-based mentions:

1. Look at the personalDetails object for the accountID
2. If we don't have a personalDetail for that accountID, render as @hidden
3. If we have a personalDetail, but we don't have a display name or login in there, render as @hidden
4. If we have a personalDetail with display name, but no login, render as @display Name
5. If we have a personalDetail with login, render the same way as email-based mentions
6. Verify the tooltips(web/desktop) are correct
7. Click on the mention to go the profile page, verify the informations are correct

• Verify that no errors appear in the JS console

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • MacOS / Chrome / Safari
  • MacOS / Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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
    • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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 followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• 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.js or at the top of the file that uses the constant) are defined as such
• I verified that if a function's arguments changed that all usages have also been updated correctly
• 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
    • 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(themeColors.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 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.
• 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2024-01-08.at.15.24.31-compressed.mov

Android: mWeb Chrome

Screen.Recording.2024-01-08.at.15.22.15-compressed.mov

iOS: Native

Screen.Recording.2024-01-08.at.15.07.10.mov

iOS: mWeb Safari

Screen.Recording.2024-01-05.at.16.15.57.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-05.at.16.10.36.mp4

Screen.Recording.2024-01-09.at.17.05.22.mov

MacOS: Desktop

Screen.Recording.2024-01-05.at.16.19.51.mov

[melvin-bot]

@sobitneupane 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]

[sobitneupane]

@tienifr Some of the screen recordings are missing.

[tienifr]

@sobitneupane Thanks for pointing that out. I just added

[sobitneupane]

@tienifr Let's make sure to test tooltip and navigation to display name page/ profile page.

We should also add those steps in Test and QA.

[sobitneupane]

This change will probably cause issue. We are passing displayNameOrLogin to tooltip and and is also used in navigationRoute. As mentioned in the comment above, we need to remove the LTR unicode and leading @ from data as it is not part of the login.

[tienifr]

Thanks for pointing that out. I updated the PR

[sobitneupane]

@tienifr 1) Even email section is Details page is not showing domain name. 2) Also, there is some issue in the own mention, the highlight color should be green. These issues were reproducible for newly created account. I cannot consistently reproduce the issue.

Screen.Recording.2024-01-10.at.13.31.03.mov

I am not sure if we want to remove the domain name while mentioning own user account, can you please confirm it in the issue?

[sobitneupane]

@tienifr Can you please help me test different cases in Email-based Mention and Account ID-based Mention. I could only test accountID-based mention with email address. I am not sure how to test other cases.

[tienifr]

@sobitneupane You can create the room, then invite users to this room though mention (new email based action is created). BE will return the account-id based action

[sobitneupane]

@tienifr Were you able to reproduce these issues? Are they resolved?

[sobitneupane]

@tienifr Were you able to reproduce these issues? Are they resolved?

Bump on this @tienifr

[tienifr]

I'm checking

[tienifr]

@sobitneupane I see the issue. The RCA is that I didn't clone the tnode object so when I update tnode.data to tienifr032022+123, props.tnode.data will be changed too (it should be [email protected])

Here's the result

Screen.Recording.2024-01-19.at.18.27.21.mov

[sobitneupane]

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[sobitneupane]

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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.js 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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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.
• 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.

[NikkiWines]

Couple of small things but looks good overall and works well.

A nice v2 could be to show the truncated login when searching & mentioning but still show the full login as secondary text during search. Would need to run it by our design team first though. Something like this:

[tienifr]

@NikkiWines Thanks for your suggestion. I updated my PR

[NikkiWines]

Couple very small stylistic updates, otherwise looks great

[tienifr]

@NikkiWines updated

[NikkiWines]

Got some linter errors, otherwise this looks good!

[tienifr]

fixed @NikkiWines

[NikkiWines]

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[OSBotify]

🚀 Deployed to staging by https://github.com/NikkiWines in version: 1.4.33-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	success ✅

[mvtglobally]

@NikkiWines @francoisl Would you be able to run this internally? This PR required multiple domains and we seem to be limited to Expensifail.com only at this point.

[NikkiWines]

Looks like it works 🎊

@mvtglobally if this comes up in the future we should be able to use the applausecard.expensifail.com and expensifail.com accounts are different private domains and then any public domain email for the public domain test.

[m-natarajan]

@NikkiWines Sure we will keep in mind regarding private domains. Just to be sure, it this tested internally?

[NikkiWines]

Yep, this is all good! Though i'm not sure how to test the @hidden portion of the testing steps.

[OSBotify]

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

[m-natarajan]

@NikkiWines Thanks! I was also not sure how to test. I used the account which does not have display name, but not showing as hidden in the chat.

[NikkiWines]

Hmm yeah, I tried with a random account on a test domain and the behavior is quite weird - sometimes the tooltip doesn't match the (e.g. in the video below it shows [email protected] as the tooltip for both users) and the intro blurb isn't correct. However, I'd be surprised if that behavior is tied to this since the mention seems to work fine (albeit I never got it to show @Hidden).

Screen.Recording.2024-01-30.at.18.59.51.mov

@tienifr can you confirm the steps to mention a @hidden user please?