Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drop domain names when searching for users and auto-filling mentions #36697

Merged
merged 10 commits into from
Mar 1, 2024

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Feb 16, 2024

Details

Fixed Issues

$ #35532
PROPOSAL: #35532 (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. Draft a message that includes mentions for each user.
  3. Verify that when mentioning a user on the same private domain, the search result for the mention should not include the domain for the user's email
  4. Verify that when mentioning a user on a public domain or on a different private domain, the behavior should remain largely as it is, though we will now prepend an @ to the front of the login details when showing the mention options in search.
  • 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. Draft a message that includes mentions for each user.
  3. Verify that when mentioning a user on the same private domain, the search result for the mention should not include the domain for the user's email
  4. Verify that when mentioning a user on a public domain or on a different private domain, the behavior should remain largely as it is, though we will now prepend an @ to the front of the login details when showing the mention options in search.
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-02-16.at.21.11.33.mov
Android: mWeb Chrome
Screen.Recording.2024-02-16.at.21.16.12.mov
iOS: Native
Screen.Recording.2024-02-16.at.21.06.08.mov
iOS: mWeb Safari
Screen.Recording.2024-02-16.at.21.12.44.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-16.at.15.10.29.mov
MacOS: Desktop
Screen.Recording.2024-02-16.at.16.25.17.mov

@tienifr tienifr marked this pull request as ready for review February 16, 2024 14:17
@tienifr tienifr requested a review from a team as a code owner February 16, 2024 14:17
@melvin-bot melvin-bot bot removed the request for review from a team February 16, 2024 14:18
Copy link

melvin-bot bot commented Feb 16, 2024

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

@allroundexperts
Copy link
Contributor

Hi @tienifr!
Can you please resolve conflicts?

@allroundexperts
Copy link
Contributor

BUG

The name mention is not highlighted on Android.

Screenshot 2024-02-21 at 3 40 06 PM

@allroundexperts
Copy link
Contributor

BUG

Email not getting shortened after a message is sent.

Screenshot 2024-02-21 at 3 41 07 PM

@allroundexperts
Copy link
Contributor

allroundexperts commented Feb 21, 2024

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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-02-21.at.3.37.50.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-02-21.at.3.35.50.PM.mov
iOS: Native
Screen.Recording.2024-02-21.at.3.34.05.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-02-21.at.3.31.35.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-21.at.3.27.29.PM.mov
MacOS: Desktop
Screen.Recording.2024-02-21.at.3.29.22.PM.mov

@tienifr
Copy link
Contributor Author

tienifr commented Feb 22, 2024

Email not getting shortened after a message is sent.

@allroundexperts This should be fixed in #36347

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@melvin-bot melvin-bot bot requested a review from NikkiWines February 23, 2024 08:05
Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good but the auto-complete for phone number accounts still includes the @expensify.sms suffix.

Screen.Recording.2024-02-23.at.23.57.31.mov

@tienifr
Copy link
Contributor Author

tienifr commented Feb 24, 2024

@NikkiWines As I see the phone number domain is expensify.sms, and it's not the private domain, I think all phone numbers have this domain. Beside it's different from test.com so I think we should preserve expensify.sms as it is in staging/production. Please correct me if I misunderstand sth. Thanks

@NikkiWines
Copy link
Contributor

Yes, all phone numbers have the expensify.sms domain attached to them, but we don't want to display it.

Ideally, we'd be consistent in showing it or not showing it, and right now we've got kind of a mix (it's not shown in the room description or mention suggestions list, but it is shown in the auto-complete and the actual mention itself - the latter of which I think should also be resolved when the regression for domains showing up in mentions is fixed)

@tienifr
Copy link
Contributor Author

tienifr commented Feb 27, 2024

@NikkiWines I fixed your case above. Please check the video below

Screen.Recording.2024-02-27.at.11.08.09.mov

@tienifr
Copy link
Contributor Author

tienifr commented Feb 28, 2024

@allroundexperts Seems like @NikkiWines agrees with my fix above ^. Can you help review and test again? Thanks

Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One very small suggestion but otherwise looks good 👍

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
@tienifr
Copy link
Contributor Author

tienifr commented Feb 28, 2024

Fixed

@allroundexperts
Copy link
Contributor

Will re-review today!

@allroundexperts
Copy link
Contributor

@tienifr Conflicts!

NikkiWines
NikkiWines previously approved these changes Feb 28, 2024
Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit: oh whoops sorry I thought this had been updated.

@tienifr
Copy link
Contributor Author

tienifr commented Feb 29, 2024

@allroundexperts fixed conflicts

@tienifr
Copy link
Contributor Author

tienifr commented Mar 1, 2024

@allroundexperts This is almost done, can you please review soon? Thanks

@allroundexperts
Copy link
Contributor

Working good. Tested with private & public domains. For phone numbers however, @expensify.sms is added after sending the message. I think that is related to the backend, but its showing up as @expensify.sms even when offline. @tienifr is this a bug?

Screen.Recording.2024-03-01.at.11.07.26.AM.mov
Screenshot 2024-03-01 at 11 17 56 AM

@NikkiWines
Copy link
Contributor

Ah yeah, that's known and I commented on it recently here since that PR was intended to fix the actual mentions. I think we can handle it separately from this PR

@NikkiWines NikkiWines merged commit 0c09803 into Expensify:main Mar 1, 2024
16 checks passed
Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@melvin-bot melvin-bot bot requested a review from NikkiWines March 1, 2024 07:47
@OSBotify
Copy link
Contributor

OSBotify commented Mar 1, 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.

@OSBotify
Copy link
Contributor

OSBotify commented Mar 4, 2024

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

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.47-10 🚀

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

@NikkiWines
Copy link
Contributor

Noticed a bug tied to this where you can't dismiss the mentions search bar if you're selecting a mention that's shorter than other mentions with the same first set of characters

Screen.Recording.2024-03-08.at.10.29.11.mov

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants