Fix mention suggestion highlight doesn't move when the text selection moves #39917

bernhardoj · 2024-04-09T11:27:43Z

Details

The highlight of the mention is based on the prefix. The current prefix doesn't consider the selection position of the input. This PR changes it so it's consistent with emoji suggestion too.

Fixed Issues

$ #39102
PROPOSAL: #39102 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Open any chat
Type a mention suggestion
Move the text selection to left/right
Verify the mention highlight also moves based on the text selection

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 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 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 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.
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-04-09.at.19.00.21.mov

Android: mWeb Chrome

Screen.Recording.2024-04-09.at.19.10.58.mov

iOS: Native

Screen.Recording.2024-04-09.at.18.58.22.mov

iOS: mWeb Safari

Screen.Recording.2024-04-09.at.18.59.59.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-09.at.18.25.38.mov

MacOS: Desktop

Screen.Recording.2024-04-09.at.18.57.42.mov

melvin-bot · 2024-04-09T11:27:48Z

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

src/pages/home/report/ReportActionCompose/SuggestionMention.tsx

eh2077

Would you like to update the changes to focus on fixing suggestion highlight issue only please?

src/pages/home/report/ReportActionCompose/SuggestionMention.tsx

…t-mention-suggestion

eh2077 · 2024-04-11T02:18:07Z

src/pages/home/report/ReportActionCompose/SuggestionEmoji.tsx

@@ -227,7 +227,7 @@ function SuggestionEmoji(
        <EmojiSuggestions
            highlightedEmojiIndex={highlightedEmojiIndex}
            emojis={suggestionValues.suggestedEmojis}
-            prefix={value.slice(suggestionValues.colonIndex + 1, selection.start)}
+            prefix={value.slice(suggestionValues.colonIndex + 1, selection.end)}


Just left a comment in case someone is confused about this change.

I think it makes sense to use selection.end, see below comparison

eh2077 · 2024-04-11T02:24:38Z

src/pages/home/report/ReportActionCompose/SuggestionMention.tsx

+        (e: NativeSyntheticEvent<TextInputSelectionChangeEventData>) => {
+            /**
+             * we pass here e.nativeEvent.selection.end directly to calculateEmojiSuggestion
+             * because in other case calculateEmojiSuggestion will have an old calculation value


Please update the comment.

eh2077 · 2024-04-11T03:03:30Z

src/pages/home/report/ReportActionCompose/Suggestions.tsx

@@ -111,7 +111,8 @@ function Suggestions(

    const onSelectionChange = useCallback((e: NativeSyntheticEvent<TextInputSelectionChangeEventData>) => {
        const emojiHandler = suggestionEmojiRef.current?.onSelectionChange?.(e);
-        return emojiHandler;
+        const mentionHandler = suggestionMentionRef.current?.onSelectionChange?.(e);
+        return emojiHandler ?? mentionHandler;


I tried to test a corner case with precondition - have a user with Eric :smile: as the first name and empty second name.

By pasting text @eric :sm into composer, I got both two suggestion menus at the same time.

As prod has same issue and I'm not sure if this is expected, so I think we can also skip this one in this PR.

Yeah, I always wondering whether both suggestions will show or not since we don't return anything inside onSelectionChange.

…t-mention-suggestion

eh2077 · 2024-04-11T08:19:26Z

Code looks good to me. I got stuck in building Android App. I'll update checklist once the Android build issue is resolved.

eh2077 · 2024-04-12T02:31:19Z

@bernhardoj Typing @ doesn't pop up suggestion menu in my emulator. Note I merged this branch with upstream/main locally and built the App.

android-mention-not-working.mov

…t-mention-suggestion

bernhardoj · 2024-04-12T14:07:55Z

Thanks for catching that.

The issue I found is that when onSelectionChange of SuggestionMention is called, it still holds the old value of calculateMentionSuggestion which means it contains the old value of value. If I log the value here, it prints the new value, so I conclude that the onSelectionChange is called earlier before SuggestionMention rerenders.

App/src/pages/home/report/ReportActionCompose/Suggestions.tsx

Lines 112 to 115 in d4bc1b0

    
           const onSelectionChange = useCallback((e: NativeSyntheticEvent<TextInputSelectionChangeEventData>) => { 
        
               const emojiHandler = suggestionEmojiRef.current?.onSelectionChange?.(e); 
        
               return emojiHandler; 
        
           }, []);

So, I decided to remove onSelectionChange and calculate it in a useEffect when selection is changed.

Btw, you can reproduce it with emoji suggestions too if you remove this useEffect

App/src/pages/home/report/ReportActionCompose/SuggestionEmoji.tsx

Lines 181 to 186 in d4bc1b0

    
           useEffect(() => { 
        
               if (!isComposerFocused) { 
        
                   return; 
        
               } 
        
               calculateEmojiSuggestion(selection.end); 
        
           }, [selection, calculateEmojiSuggestion, isComposerFocused]);

eh2077 · 2024-04-13T02:20:11Z

@bernhardoj There're conflicts need to be resolved.

…t-mention-suggestion

bernhardoj · 2024-04-13T05:32:21Z

Conflicts solved

eh2077 · 2024-04-15T00:40:34Z

@bernhardoj I found another bug - suggestion menu is not closed after deleting @. Also confirmed this doesn't happen on the main.

Screen.Recording.2024-04-15.at.12.21.49.AM.mov

bernhardoj · 2024-04-15T06:02:39Z

@eh2077 I found that on Android mWeb, deleting a character won't immediately update the selection (onSelectionChange is not triggered). So, if I type @b, the selection end is 2, but when I delete it, the selection end is still 2. If I press delete once again, then onSelectionEnd is triggered. I tested this on react-native-web repo and can reproduce it there too. So, it's an upstream bug.

This doesn't happen on main because the useEffect depends on calculateMentionSuggestion which depends on value which I already explained before that leads to another bug.

App/src/pages/home/report/ReportActionCompose/SuggestionMention.tsx

Lines 353 to 355 in db9e01c

    
           useEffect(() => { 
        
               calculateMentionSuggestion(selection.end); 
        
           }, [selection, calculateMentionSuggestion]);

Do you think we should update the useEffect to be the same as main? If yes, we will have this issue that we discussed previously.

eh2077 · 2024-04-15T06:40:19Z

@bernhardoj Hmm, I think the new issue introduced - suggestion menu is not closed after deleting @, results in a bit worse UX than the existing issue. So, I prefer to keep it same as main and solve this existing issue - suggestion menu jumping briefly separately.

bernhardoj · 2024-04-15T07:18:21Z

Agree, I have updated the useEffect. I also pushed a fix where it's not possible to mention user with 2 words because the prefixType is empty.

eh2077 · 2024-04-15T09:12:47Z

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 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.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 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.
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.mov

Android: mWeb Chrome

mobile-chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mobile-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

eh2077

Code looks good and tested well!

OSBotify · 2024-04-16T18:50:45Z

✋ 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 · 2024-04-18T04:57:20Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.4.63-0 🚀

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

OSBotify · 2024-04-22T14:58:19Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

bernhardoj added 2 commits April 9, 2024 19:19

use selection end for the prefix

3bead8e

use selection change to calculate the mention and prefix

898262f

bernhardoj requested a review from a team as a code owner April 9, 2024 11:27

melvin-bot bot removed the request for review from a team April 9, 2024 11:27

melvin-bot bot requested a review from eh2077 April 9, 2024 11:27

bernhardoj commented Apr 9, 2024

View reviewed changes

src/pages/home/report/ReportActionCompose/SuggestionMention.tsx Outdated Show resolved Hide resolved

bernhardoj added 2 commits April 9, 2024 19:47

suppress lint

9576865

remove log

6bcc48b

bernhardoj commented Apr 9, 2024

View reviewed changes

src/pages/home/report/ReportActionCompose/SuggestionMention.tsx Outdated Show resolved Hide resolved

eh2077 reviewed Apr 10, 2024

View reviewed changes

bernhardoj added 3 commits April 10, 2024 14:16

Merge branch 'main' into fix/39102-use-selection-position-to-highligh…

0b5fe42

…t-mention-suggestion

remove the workaround

ca7c6aa

prettier

a33064d

eh2077 reviewed Apr 11, 2024

View reviewed changes

bernhardoj added 2 commits April 11, 2024 11:21

Merge branch 'main' into fix/39102-use-selection-position-to-highligh…

c531b83

…t-mention-suggestion

update comment

c13c898

bernhardoj added 2 commits April 12, 2024 11:44

Merge branch 'main' into fix/39102-use-selection-position-to-highligh…

42f0f7d

…t-mention-suggestion

calculate suggestion when selection state is updated

27f7254

remove unused import

1ea2c63

Merge branch 'main' into fix/39102-use-selection-position-to-highligh…

a3eee55

…t-mention-suggestion

bernhardoj added 2 commits April 15, 2024 15:16

add calculateMentionSuggestion to deps

307bb9c

fix can't mention 2 words user name

25a5d85

eh2077 approved these changes Apr 15, 2024

View reviewed changes

melvin-bot bot requested a review from stitesExpensify April 15, 2024 09:15

stitesExpensify approved these changes Apr 16, 2024

View reviewed changes

stitesExpensify merged commit 888ad66 into Expensify:main Apr 16, 2024
16 checks passed

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix mention suggestion highlight doesn't move when the text selection moves #39917

Fix mention suggestion highlight doesn't move when the text selection moves #39917

bernhardoj commented Apr 9, 2024

melvin-bot bot commented Apr 9, 2024

eh2077 left a comment

eh2077 Apr 11, 2024

eh2077 Apr 11, 2024

bernhardoj Apr 11, 2024

eh2077 Apr 11, 2024 •

edited

Loading

bernhardoj Apr 11, 2024

eh2077 commented Apr 11, 2024

eh2077 commented Apr 12, 2024

bernhardoj commented Apr 12, 2024 •

edited

Loading

eh2077 commented Apr 13, 2024

bernhardoj commented Apr 13, 2024

eh2077 commented Apr 15, 2024

bernhardoj commented Apr 15, 2024

eh2077 commented Apr 15, 2024

bernhardoj commented Apr 15, 2024

eh2077 commented Apr 15, 2024

eh2077 left a comment

OSBotify commented Apr 16, 2024

OSBotify commented Apr 18, 2024

OSBotify commented Apr 22, 2024

Fix mention suggestion highlight doesn't move when the text selection moves #39917

Fix mention suggestion highlight doesn't move when the text selection moves #39917

Conversation

bernhardoj commented Apr 9, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 9, 2024

eh2077 left a comment

Choose a reason for hiding this comment

eh2077 Apr 11, 2024

Choose a reason for hiding this comment

eh2077 Apr 11, 2024

Choose a reason for hiding this comment

bernhardoj Apr 11, 2024

Choose a reason for hiding this comment

eh2077 Apr 11, 2024 • edited Loading

Choose a reason for hiding this comment

bernhardoj Apr 11, 2024

Choose a reason for hiding this comment

eh2077 commented Apr 11, 2024

eh2077 commented Apr 12, 2024

bernhardoj commented Apr 12, 2024 • edited Loading

eh2077 commented Apr 13, 2024

bernhardoj commented Apr 13, 2024

eh2077 commented Apr 15, 2024

bernhardoj commented Apr 15, 2024

eh2077 commented Apr 15, 2024

bernhardoj commented Apr 15, 2024

eh2077 commented Apr 15, 2024

Reviewer Checklist

Screenshots/Videos

eh2077 left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 16, 2024

OSBotify commented Apr 18, 2024

OSBotify commented Apr 22, 2024

eh2077 Apr 11, 2024 •

edited

Loading

bernhardoj commented Apr 12, 2024 •

edited

Loading