Include yourself and @here options in mentions auto-suggestion list #19221

allroundexperts · 2023-05-18T21:57:26Z

Details

This PR adds option to mention oneself or all the room members using @here text.

Fixed Issues

$ #18746
PROPOSAL: #18746 (comment)

Tests

Open ND and go to any chat.
Type @h and verify that here option shows up.
Type @your email and verify that the option shows up.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Open ND and go to any chat.
Type @h and verify that here option shows up.
Type @your email and verify that the option shows up.

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 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 correct English and 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
- 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(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

Web

Screen.Recording.2023-05-19.at.2.23.18.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-05-19.at.2.26.03.AM.mov

Mobile Web - Safari

Screen.Recording.2023-05-19.at.2.24.24.AM.mov

Desktop

Screen.Recording.2023-05-19.at.2.23.46.AM.mov

iOS

Screen.Recording.2023-05-19.at.2.44.47.AM.mov

Android

Screen.Recording.2023-05-19.at.2.26.34.AM.mov

…ReportActionCompose

melvin-bot · 2023-05-18T21:57:32Z

@puneetlath @eVoloshchak One of you needs to 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]

src/pages/home/report/ReportActionCompose.js

eVoloshchak · 2023-05-22T16:38:12Z

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 / Chrome
- iOS / native
- iOS / 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(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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-05-23.at.17.08.35.mov

Mobile Web - Chrome

Screen_Recording_20230523-171305_Chrome.mp4

Mobile Web - Safari

Screen.Recording.2023-05-23.at.17.09.35.mov

Desktop

Screen.Recording.2023-05-23.at.17.11.33.mov

iOS

Screen.Recording.2023-05-23.at.17.10.27.mov

Android

Screen_Recording_20230523-173115_New.Expensify.mp4

eVoloshchak · 2023-05-22T16:58:51Z

src/pages/home/report/ReportActionCompose.js

+        }
+        const sortedPersonalDetails = _.sortBy(_.values(personalDetails), (detail) => detail.displayName || detail.login);
+        _.each(sortedPersonalDetails, (detail) => {
+            if (searchValue && !`${detail.displayName} ${detail.login}`.trim().includes(searchValue)) {


Suggested change

if (searchValue && !`${detail.displayName} ${detail.login}`.trim().includes(searchValue)) {

if (searchValue && !`${detail.displayName} ${detail.login}`.trim().includes(searchValue) || suggestions.length >= CONST.AUTO_COMPLETE_SUGGESTER.MAX_AMOUNT_OF_ITEMS) {

I think we can do something like this to avoid calling .includes for all the participants we're not displaying

There's also a bug with search being case-sensitive. I think this can be resolved by calling .toLocaleLowerCase() for both searchValue and ${detail.displayName} ${detail.login}

@eVoloshchak This makes sense but I'm struggling to understand the reason for the condition that you suggested above ie
suggestions.length >= CONST.AUTO_COMPLETE_SUGGESTER.MAX_AMOUNT_OF_ITEMS

I think adding it will cause the search results to be incorrect.

I've fixed the bug related to the casing of the search value.

I think what he is saying is to only sort the matches, instead of sorting the whole personalDetails object. Since the results will always be a subset.

@puneetlath Handled.

I think adding it will cause the search results to be incorrect.

I think I'm missing something, could you explain how? Essentially what I was trying to achieve is to stop iterating over personalDetails once we already have 5 items in suggestions array

Hm... I get you now. But we had to sort all of the records. Can you check the new approach which I did? It allows us to sort and loop over only the filtered records.

src/pages/home/report/ReportActionCompose.js

Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>

puneetlath · 2023-05-22T23:00:42Z

src/pages/home/report/ReportActionCompose.js

+            return true;
+        });
+
+        const sortedPersonalDetails = _.sortBy(filteredPersonalDetails, (detail) => detail.displayName || detail.login);


You could use _.first(sortedPersonalDetails, 5) to get the first 5 of these, then do the _.each. That way you wouldn't be wasting time pushing suggestions that are just going to get sliced. I think that would resolve @eVoloshchak's concern.

@puneetlath Pushed with suggested changes.

eVoloshchak · 2023-05-23T14:27:03Z

src/pages/home/report/ReportActionCompose.js

+    getMentionOptions(personalDetails, searchValue = '') {
+        const suggestions = [];
+
+        if (CONST.MENTION_SUGGESTER.HERE_TEXT.includes(searchValue)) {


Should be CONST.AUTO_COMPLETE_SUGGESTER.HERE_TEXT, just realized it already exists

@eVoloshchak Are you sure? I can't see it.

Oh, I meant CONST.AUTO_COMPLETE_SUGGESTER already exists, let's move HERE_TEXT there

@eVoloshchak Gotcha. I've fixed it.

eVoloshchak

LGTM!
cc: @puneetlath

OSBotify · 2023-05-23T15:25:56Z

✋ 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 · 2023-05-25T00:35:12Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-25T01:08:44Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-25T01:30:40Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-26T07:07:52Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.18-2 🚀

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

fedirjh · 2023-06-11T21:14:27Z

src/pages/home/report/ReportActionCompose.js

+    getMentionOptions(personalDetails, searchValue = '') {
+        const suggestions = [];
+
+        if (CONST.AUTO_COMPLETE_SUGGESTER.HERE_TEXT.includes(searchValue)) {


This line caused a regression in #19645. We should have used searchValue.toLowerCase() to match both upper and lowercase characters.

allroundexperts added 5 commits May 17, 2023 00:47

feat: add here and yourself mentions

770dcf4

feat: update get mentions function

77b4d2f

Merge branch 'main' into fix-18746

6958863

feat: removed optionutil changes and moves the mention calculator to …

9dde3d5

…ReportActionCompose

feat: show here text after mention selection

0021f36

allroundexperts requested a review from a team as a code owner May 18, 2023 21:57

melvin-bot bot requested review from eVoloshchak and puneetlath and removed request for a team May 18, 2023 21:57

feat: update prettier styles

93bd111

allroundexperts mentioned this pull request May 18, 2023

[$1000] [HOLD for payment 2023-06-02] Include yourself and @here options in mentions auto-suggestion list #18746

Closed

puneetlath mentioned this pull request May 19, 2023

Include yourself and @here options in mentions auto-suggestion list #18956

Closed

57 tasks

puneetlath requested changes May 19, 2023

View reviewed changes

src/pages/home/report/ReportActionCompose.js Outdated Show resolved Hide resolved

feat: remove max records

38ce21a

allroundexperts requested a review from puneetlath May 19, 2023 16:26

eVoloshchak reviewed May 22, 2023

View reviewed changes

src/pages/home/report/ReportActionCompose.js Outdated Show resolved Hide resolved

feat: replace static max amount by a const

dd631ed

allroundexperts requested a review from eVoloshchak May 22, 2023 14:15

eVoloshchak suggested changes May 22, 2023

View reviewed changes

allroundexperts and others added 4 commits May 23, 2023 00:11

Update src/pages/home/report/ReportActionCompose.js

2a03a82

Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>

fix: make search case insensitive

e87cff6

fix: refactor the mention function

fd082fb

Merge branch 'main' into fix-18746

f80cfe0

allroundexperts requested a review from eVoloshchak May 22, 2023 19:57

puneetlath reviewed May 22, 2023

View reviewed changes

fix: further optimize the mention options function

1b91882

allroundexperts force-pushed the fix-18746 branch from 62f27ee to 1b91882 Compare May 22, 2023 23:28

puneetlath previously approved these changes May 22, 2023

View reviewed changes

eVoloshchak reviewed May 23, 2023

View reviewed changes

fix: move here text inside auto complete suggester

3334ef5

allroundexperts dismissed puneetlath’s stale review via 3334ef5 May 23, 2023 14:38

eVoloshchak approved these changes May 23, 2023

View reviewed changes

puneetlath approved these changes May 23, 2023

View reviewed changes

puneetlath merged commit 1ac9964 into Expensify:main May 23, 2023

OSBotify mentioned this pull request May 25, 2023

Deploy Checklist: New Expensify 2023-05-25 #19565

Closed

53 tasks

dukenv0307 mentioned this pull request May 25, 2023

[$1000] Phone number is displayed incorrect in mention list #19331

Closed

6 tasks

naveensingh mentioned this pull request May 26, 2023

HIGH - [$2000] Make mentions auto-suggestions work with phone number accounts #18729

Closed

fedirjh reviewed Jun 11, 2023

View reviewed changes

fedirjh mentioned this pull request Jun 11, 2023

[HOLD for payment 2023-06-12] [$1000] Chat - @here doesn't appear among possible mentions if typing with capital H #19645

Closed

6 tasks

flodnv mentioned this pull request Jun 23, 2023

[$1000] Chat - SMS domain shown in mentions #20866

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Include yourself and @here options in mentions auto-suggestion list #19221

Include yourself and @here options in mentions auto-suggestion list #19221

allroundexperts commented May 18, 2023

melvin-bot bot commented May 18, 2023

eVoloshchak commented May 22, 2023 •

edited

Loading

eVoloshchak May 22, 2023

eVoloshchak May 22, 2023

allroundexperts May 22, 2023

allroundexperts May 22, 2023

puneetlath May 22, 2023

allroundexperts May 22, 2023

eVoloshchak May 22, 2023

allroundexperts May 22, 2023

puneetlath May 22, 2023

allroundexperts May 22, 2023

eVoloshchak May 23, 2023

allroundexperts May 23, 2023

allroundexperts May 23, 2023

eVoloshchak May 23, 2023

allroundexperts May 23, 2023

eVoloshchak left a comment

OSBotify commented May 23, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 26, 2023

fedirjh Jun 11, 2023

	if (searchValue && !`${detail.displayName} ${detail.login}`.trim().includes(searchValue)) {
	if (searchValue && !`${detail.displayName} ${detail.login}`.trim().includes(searchValue) \|\| suggestions.length >= CONST.AUTO_COMPLETE_SUGGESTER.MAX_AMOUNT_OF_ITEMS) {

Include yourself and @here options in mentions auto-suggestion list #19221

Include yourself and @here options in mentions auto-suggestion list #19221

Conversation

allroundexperts commented May 18, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 18, 2023

eVoloshchak commented May 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eVoloshchak left a comment

Choose a reason for hiding this comment

OSBotify commented May 23, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 26, 2023

Choose a reason for hiding this comment

eVoloshchak commented May 22, 2023 •

edited

Loading