Add mention suggestions #18469

szebniok · 2023-05-05T09:17:38Z

Details

Fixed Issues

$ #17890

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Users you've chatted with before

Enter @ sign into the text input
Some suggestions should pop up
Type in a few characters
Observe that the suggestions got narrower (if they exist, and they match the typed characters)
Tap on one of the suggestions
Verify that the suggestion is inserted into the text input

Users you haven't chatted with before

Enter @ sign into the text input
Type in the whole email of a user that you haven't chatted with before (e.g. random@gmail.com)
Tap on the suggestion that appears
Verify that the suggestion is inserted into the text input

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-05-08.at.14.21.21.mov

Mobile Web - Chrome

Screen.Recording.2023-05-09.at.11.58.48.mov

Mobile Web - Safari

Screen.Recording.2023-05-09.at.12.29.37.mov

Desktop

Screen.Recording.2023-05-08.at.14.26.26.mov

iOS

Screen.Recording.2023-05-09.at.12.27.32.mov

Android

Screen.Recording.2023-05-09.at.12.25.54.mov

melvin-bot · 2023-05-09T10:30:48Z

@puneetlath @0xmiroslav 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]

ios/Podfile.lock

0xmiros · 2023-05-09T11:07:17Z

If we show suggestions in full width and above composer, what's Make auto-complete component work inline for?
cc: @puneetlath

0xmiros · 2023-05-09T11:11:56Z

BUG1:

write some text message
add mention @ and type 2 letters to show suggestions
press Esc key to cancel mention suggestion
now full composer text is cleared

bug1.mov

Question:
Is it designed to show suggestions only after 2 letters?
On other platforms like slack and discord, suggestions show immediately after adding @

src/components/MentionSuggestions.js

szebniok · 2023-05-09T12:19:02Z

BUG1:

write some text message

add mention @ and type 2 letters to show suggestions

press Esc key to cancel mention suggestion

now full composer text is cleared

bug1.mov
Question: Is it designed to show suggestions only after 2 letters? On other platforms like slack and discord, suggestions show immediately after adding @

@0xmiroslav
Regarding BUG1: The behaviour is the same for the existing emoji suggestions, and I wasn't sure If it's a bug. I could fix it with the following code change inside ReportActionCompose.js (I'll commit it right now):

Regarding the question: I think the emoji suggestions also appear after 2 letters, and I did the same thing here. I can easily change it (I'll commit it as well).

0xmiros · 2023-05-09T12:25:07Z

Mention logic should be a bit different from emoji logic.
If you check other platforms, emoji suggestions show after :xy but mention suggestions show after @

szebniok · 2023-05-09T12:38:46Z

I've noticed small bug after I've implemented the feedback, working on it now

szebniok · 2023-05-09T12:43:29Z

I've noticed small bug after I've implemented the feedback, working on it now

fixed

puneetlath · 2023-05-09T13:26:39Z

If we show suggestions in full width and above composer, what's #16078 for?

That's a refactor of the auto-suggestion component, but it's not a blocker for this.

BUG1:

I've seen a bug report for this for emojis as well, so I don't think we need to fix it here. (unless @szebniok already has).

perunt · 2023-05-09T13:53:02Z

BUG1:

It seems like this is the default behavior of the composer, as it is reproducible with plain text as well

szebniok · 2023-05-09T14:35:41Z

The fix that I've commited closes the emoji/mention suggestions on the first ESC press (if they're present), and clears the text input on the second press.

0xmiros · 2023-05-09T14:40:38Z

The fix that I've commited closes the emoji/mention suggestions on the first ESC press (if they're present), and clears the text input on the second press.

This can be out of scope but you already did good job! I like this behavior. Thoughts @puneetlath?

I believe this is not a blocker but just to confirm:
@here can be added in suggestions list in group chat?

puneetlath · 2023-05-09T14:46:01Z

This can be out of scope but you already did good job! I like this behavior. Thoughts @puneetlath?

Agreed, that seems good to me too!

@here can be added in suggestions list in group chat?

Ah, yes. @here should be an option. We can add that in follow-up though.

0xmiros · 2023-05-09T14:58:21Z

Small bug:

Type test @
Move cursor at the beginning before test
Suggestions don't disappear

bug2.mov

This doesn't happen on emoji code

0xmiros · 2023-05-09T15:09:51Z

Bug but NAB since it also happens on emoji suggestions (@puneetlath we can create new issue for tracking if not already reported)

Arrow up/down always loop with 5 even though suggestions list is less than 5

bug3.mov

0xmiros · 2023-05-09T15:17:23Z

How do we handle phone users? They're not recognized as mention because phone number has spaces

bug4.mov

0xmiros · 2023-05-10T18:04:28Z

I think QA Steps is wrong. Is there any difference between Recent report and New report in design doc?
Whatever report is, I always get suggestions list after @

puneetlath · 2023-05-10T18:08:23Z

In theory, there will always be at least one suggestion of Concierge.

puneetlath · 2023-05-10T18:10:37Z

I updated the QA steps. Do you think that's better @0xmiroslav?

0xmiros · 2023-05-10T18:13:13Z

I updated the QA steps. Do you think that's better @0xmiroslav?

yes that's clear. So list data is not related to report but contacts

0xmiros · 2023-05-10T18:16:32Z

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

web1.mov

web2.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

puneetlath · 2023-05-10T18:21:40Z

Alright! Going to go ahead and merge this baby.

0xmiros

Here's summary of follow-up issues:

suggestions view position (Add mention suggestions #18469 (comment))
suggestions don't disappear when move cursor to the start position (Add mention suggestions #18469 (comment))
Arrow up/down always loop with 5 even though suggestions list is less than 5 (Add mention suggestions #18469 (comment))
support phone users
suggestions still remaining after send and composer cleared
space is added endlessly while keep selecting suggested user (Add mention suggestions #18469 (review))
arrow index is not within range and show console error (Add mention suggestions #18469 (comment))
add myself in suggestions list
add @here in suggestions list, maybe only for group chat

puneetlath · 2023-05-10T21:06:01Z

Thanks for making the list!

suggestions view position (Add mention suggestions #18469 (comment))

Will be fixed automatically in: #16078

suggestions don't disappear when move cursor to the start position (Add mention suggestions #18469 (comment))

Looks like it was already fixed by @szebniok in this PR

Arrow up/down always loop with 5 even though suggestions list is less than 5 (Add mention suggestions #18469 (comment))

Will be fixed in: #16426

support phone users

Created issue: #18729

suggestions still remaining after send and composer cleared

Reported here: https://expensify.slack.com/archives/C049HHMV9SM/p1683751749650109

space is added endlessly while keep selecting suggested user (Add mention suggestions #18469 (review))

Issue here: #18742

arrow index is not within range and show console error (Add mention suggestions #18469 (comment))

Created issue here: #18744

add myself in suggestions list

add @here in suggestions list, maybe only for group chat

Created issue for this here: #18746

OSBotify · 2023-05-11T02:42:51Z

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

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

OSBotify · 2023-05-15T08:24:06Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.13-5 🚀

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

dukenv0307 · 2023-05-15T08:58:16Z

src/pages/home/report/ReportActionCompose.js

        }

        LayoutAnimation.configureNext(LayoutAnimation.create(50, LayoutAnimation.Types.easeInEaseOut, LayoutAnimation.Properties.opacity));

        this.setState(nextState);
    }

+    calculateMentionSuggestion() {
+        if (this.state.selection.end < 1) {


@szebniok This change caused this bug. Could you help to explain why we need to add this? Could we use !this.state.value instead of this.state.selection.end < 1?

cc @0xmiroslav @puneetlath

@dukenv0307 this is how it's done for the existing emoji suggestion feature, so I'm guessing we just replicated that behavior for mentions.

We should have called the resetSuggestions as we do for Emoji Suggestions but we missed that here.

mananjadhav · 2023-05-27T20:58:18Z

We added the highlightedMentionIndex in this PR but we didn't reset the index to 0 after selection, which caused this bug #18844.

mananjadhav · 2023-06-01T16:31:52Z

The MENTION_REPLACER caused the this issue. I think this was an odd cause and regex are difficult to test. But testing emojis next to auto completing could have picked this one.

I don't think any checklist update is required.

Santhosh-Sellavel · 2023-06-03T19:12:59Z

This PR caused a regression here. Refer to PR for more.

thesahindia · 2023-06-05T17:04:08Z

src/pages/home/report/ReportActionCompose.js

+        const mentionCode = `@${mentionObject.alternateText}`;
+        const commentAfterAtSignWithMentionRemoved = this.state.value.slice(this.state.atSignIndex).replace(CONST.REGEX.MENTION_REPLACER, '');
+
+        this.updateComment(`${commentBeforeAtSign}${mentionCode} ${commentAfterAtSignWithMentionRemoved}`, true);


Regardless of whether the commentAfterAtSignWithMentionRemoved begins with a space or not, we consistently include an additional space. This caused a regression.

Beamanator · 2023-06-08T21:16:46Z

src/pages/home/report/ReportActionCompose.js

+        personalDetails: {
+            key: ONYXKEYS.PERSONAL_DETAILS,
+        },


I think we didn't need this b/c we already had the hoc withPersonalDetails(),

mollfpr · 2023-06-15T14:28:11Z

src/pages/home/report/ReportActionCompose.js

-        if ((e.key === CONST.KEYBOARD_SHORTCUTS.ENTER.shortcutKey || e.key === CONST.KEYBOARD_SHORTCUTS.TAB.shortcutKey) && this.state.suggestedEmojis.length) {
+        const suggestionsExist = this.state.suggestedEmojis.length > 0 || this.state.suggestedMentions.length > 0;
+
+        if ((e.key === CONST.KEYBOARD_SHORTCUTS.ENTER.shortcutKey || e.key === CONST.KEYBOARD_SHORTCUTS.TAB.shortcutKey) && suggestionsExist) {


Coming from #19624 ✋

Not a regression. We want to skip the selection when pressing Shift + Enter as Slack does.

szebniok added 5 commits May 5, 2023 11:16

Add mention suggestions

a436540

Remove TODO comment

32e775d

Fix lint

c8bf61e

Fix overflowing text

3bb6208

Merge branch 'main' into add-mention-suggestions

6cf15cc

szebniok marked this pull request as ready for review May 9, 2023 10:30

szebniok requested a review from a team as a code owner May 9, 2023 10:30

melvin-bot bot requested review from 0xmiros and puneetlath and removed request for a team May 9, 2023 10:30

mountiny assigned szebniok May 9, 2023

0xmiros reviewed May 9, 2023

View reviewed changes

ios/Podfile.lock Outdated Show resolved Hide resolved

0xmiros reviewed May 9, 2023

View reviewed changes

src/components/MentionSuggestions.js Outdated Show resolved Hide resolved

src/components/MentionSuggestions.js Outdated Show resolved Hide resolved

Implement feedback

a7b37bb

Fix insertion of the mention

ddaf323

puneetlath approved these changes May 10, 2023

View reviewed changes

0xmiros approved these changes May 10, 2023

View reviewed changes

puneetlath merged commit db8eca4 into Expensify:main May 10, 2023

puneetlath mentioned this pull request May 10, 2023

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

Closed

OSBotify mentioned this pull request May 11, 2023

Deploy Checklist: New Expensify 2023-05-11 #18764

Closed

51 tasks

mollfpr mentioned this pull request May 11, 2023

[HOLD for payment 2023-05-29] [$1000] Pressing ESC when emoji suggestions list is open clears the composer #18434

Closed

6 tasks

kbecciv mentioned this pull request May 11, 2023

[HOLD for payment 2023-05-23] [HOLD for payment 2023-05-22] [$1000] Android - App crashes upon inputting @ with characters for specific accounts #18793

Closed

6 tasks

melvin-bot bot mentioned this pull request May 15, 2023

[HOLD for payment 2023-05-22] Add mentions auto-completion #17890

Closed

dukenv0307 reviewed May 15, 2023

View reviewed changes

mananjadhav mentioned this pull request May 27, 2023

[HOLD for payment 2023-05-29] [$1000] Contact suggestion focus/selection does not reset after selecting a contact #18844

Closed

6 tasks

mananjadhav mentioned this pull request Jun 1, 2023

[HOLD for payment 2023-06-02] [$1000] The emoji written next to “@” is removed upon selection of any user from the options. #18867

Closed

6 tasks

Santhosh-Sellavel mentioned this pull request Jun 3, 2023

[HOLD for payment 2023-06-01] [$1000] Mentions results does not close when we change focus #18879

Closed

6 tasks

thesahindia reviewed Jun 5, 2023

View reviewed changes

thesahindia mentioned this pull request Jun 5, 2023

[HOLD for payment 2023-06-02] [$1000] Mention auto-suggester adds extra spaces when same mention is selected #18742

Closed

Beamanator reviewed Jun 8, 2023

View reviewed changes

mollfpr reviewed Jun 15, 2023

View reviewed changes

mollfpr mentioned this pull request Jun 15, 2023

[HOLD for payment 2023-06-15] [$1000] The cursor does not move to the next line after pressing Shift+Enter while using the mention feature. #19624

Closed

6 tasks

conorpendergrast mentioned this pull request Oct 26, 2023

[HOLD for payment 2023-11-22] [$500] Chat - App does not replace # on selection of mention #29187

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add mention suggestions #18469

Add mention suggestions #18469

szebniok commented May 5, 2023 •

edited by puneetlath

Loading

melvin-bot bot commented May 9, 2023

0xmiros commented May 9, 2023

0xmiros commented May 9, 2023

szebniok commented May 9, 2023

0xmiros commented May 9, 2023

szebniok commented May 9, 2023

szebniok commented May 9, 2023

puneetlath commented May 9, 2023

perunt commented May 9, 2023

szebniok commented May 9, 2023

0xmiros commented May 9, 2023

puneetlath commented May 9, 2023

0xmiros commented May 9, 2023

0xmiros commented May 9, 2023

0xmiros commented May 9, 2023

0xmiros commented May 10, 2023

puneetlath commented May 10, 2023

puneetlath commented May 10, 2023

0xmiros commented May 10, 2023

0xmiros commented May 10, 2023

puneetlath commented May 10, 2023

0xmiros left a comment •

edited

Loading

puneetlath commented May 10, 2023

OSBotify commented May 11, 2023

OSBotify commented May 15, 2023

dukenv0307 May 15, 2023 •

edited

Loading

puneetlath May 15, 2023

Santhosh-Sellavel Jun 3, 2023 •

edited

Loading

mananjadhav commented May 27, 2023

mananjadhav commented Jun 1, 2023

Santhosh-Sellavel commented Jun 3, 2023

thesahindia Jun 5, 2023

Beamanator Jun 8, 2023

mollfpr Jun 15, 2023

Add mention suggestions #18469

Add mention suggestions #18469

Conversation

szebniok commented May 5, 2023 • edited by puneetlath Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

Users you've chatted with before

Users you haven't chatted with before

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 9, 2023

0xmiros commented May 9, 2023

0xmiros commented May 9, 2023

szebniok commented May 9, 2023

0xmiros commented May 9, 2023

szebniok commented May 9, 2023

szebniok commented May 9, 2023

puneetlath commented May 9, 2023

perunt commented May 9, 2023

szebniok commented May 9, 2023

0xmiros commented May 9, 2023

puneetlath commented May 9, 2023

0xmiros commented May 9, 2023

0xmiros commented May 9, 2023

0xmiros commented May 9, 2023

0xmiros commented May 10, 2023

puneetlath commented May 10, 2023

puneetlath commented May 10, 2023

0xmiros commented May 10, 2023

0xmiros commented May 10, 2023

Reviewer Checklist

Screenshots/Videos

puneetlath commented May 10, 2023

0xmiros left a comment • edited Loading

Choose a reason for hiding this comment

puneetlath commented May 10, 2023

OSBotify commented May 11, 2023

OSBotify commented May 15, 2023

dukenv0307 May 15, 2023 • edited Loading

Choose a reason for hiding this comment

puneetlath May 15, 2023

Choose a reason for hiding this comment

Santhosh-Sellavel Jun 3, 2023 • edited Loading

Choose a reason for hiding this comment

mananjadhav commented May 27, 2023

mananjadhav commented Jun 1, 2023

Santhosh-Sellavel commented Jun 3, 2023

thesahindia Jun 5, 2023

Choose a reason for hiding this comment

Beamanator Jun 8, 2023

Choose a reason for hiding this comment

mollfpr Jun 15, 2023

Choose a reason for hiding this comment

szebniok commented May 5, 2023 •

edited by puneetlath

Loading

0xmiros left a comment •

edited

Loading

dukenv0307 May 15, 2023 •

edited

Loading

Santhosh-Sellavel Jun 3, 2023 •

edited

Loading