fix: Chat - App closes mention suggestions when cursor is between double @ #29239

paultsimura · 2023-10-10T22:24:42Z

Details

This PR enables the following behaviour: when we place a cursor at any place on the mention query, the suggestion is being searched by whole word up until the first breaking char (space, emoji, special char), and not just up until the cursor placement (as it is currently).

Fixed Issues

$ #28754
PROPOSAL: #28754 (comment)

Tests

Open any report
Write @, it will trigger mention suggestions
Write @gmail (or any other email domain that is present in your contacts) after the first "@"
Place cursor right after the first "@"

Verify that the mention suggestions are open;
Verify that the search is happening by the whole word up until the space or a special character, regardless of the cursor position on the word;
Verify that no errors appear in the JS console;

Offline tests

Open any report
Write @, it will trigger mention suggestions
Write @gmail (or any other email domain that is present in your contacts) after the first "@"
Place cursor right after the first "@"

Verify that the mention suggestions are open;
Verify that the search is happening by the whole word up until the space or a special character, regardless of the cursor position on the word;
Verify that no errors appear in the JS console;

QA Steps

Open any report
Write @, it will trigger mention suggestions
Write @gmail (or any other email domain that is present in your contacts) after the first "@"
Place cursor right after the first "@"

Verify that the mention suggestions are open;
Verify that the search is happening by the whole word up until the space or a special character, regardless of the cursor position on the word;
Verify that no errors appear in the JS console;

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

chrome.MP4

iOS: Native

ios.mp4

iOS: mWeb Safari

safari.MP4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2023-10-10T22:24:47Z

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

Clean up the mention suggestion logic;

paultsimura · 2023-10-10T22:51:45Z

@parasharrajat I have cleaned up the RegExp's a little because they were mainly duplicating each other. If we have some regression tests for them – would be great to check if it didn't break anything (it shouldn't since the content of them is identical).

parasharrajat · 2023-10-11T12:16:31Z

src/CONST.ts

All of these are just refactors or something changed for this issue.

For this issue, I have introduced the MENTION_BREAKER RegExp – it differs a tiny bit from the SPECIAL_CHAR_OR_EMOJI in my original proposal. It allows to use symbols _ and ~ in the mention, as they might be present in usernames (especially the _).

All the rest is just refactoring.

parasharrajat · 2023-10-11T13:35:04Z

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

-                indexOfLastNonWhitespaceCharAfterTheCursor = indexOfFirstWhitespaceCharOrEmojiAfterTheCursor + selectionEnd;
-            }
+            // Breaking symbol is a space, a special char, or an emoji
+            const suggestionBreakerRelativeIndex = valueAfterTheCursor.search(CONST.REGEX.MENTION_BREAKER);


let's use a better name.

Ok, reverted to the same format as before to minimize my changes.

src/CONST.ts

parasharrajat · 2023-10-11T17:13:39Z

I am a little confused about how this pattern (@@) actually works. I didn't find it useful at all from what it presents currently. Currently, the second @ is considered part of the mention itself. Is this correct behavior?

Screen.Recording.2023-10-11.at.10.38.58.PM.mov

Co-authored-by: Rajat Parashar <parasharrajat@users.noreply.github.com>

paultsimura · 2023-10-11T17:19:59Z

Currently, the second @ is considered part of the mention itself. Is this correct behavior?

Yes, it allows searching for emails only (as they contain the @).

However, you might be interested in checking this slack thread between me and @madmax330 – we've came to an agreement that this PR will be more about the search logic that gets fixed by using the correct RegExp, rather than just fixing the @@ case.

That's why I've added this test step intentionally:

Verify that the search is happening by the whole word up until the space or a special character, regardless of the cursor position on the word;

@parasharrajat

parasharrajat · 2023-10-12T17:12:22Z

Screenshots

🔲 iOS / native

Screen.Recording.2023-10-13.at.12.21.36.AM.mov

🔲 iOS / Safari

Screen.Recording.2023-10-13.at.12.23.02.AM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-10-13.at.12.18.02.AM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-10-12.at.10.47.34.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-10-13.at.12.26.09.AM.mov

🔲 Android / native

Screen.Recording.2023-10-13.at.12.33.05.AM.mov

parasharrajat · 2023-10-12T17:13:31Z

@paultsimura Please add QA steps and Offline Steps if applicable.

paultsimura · 2023-10-12T17:19:41Z

@parasharrajat they are identical to "Test", but I've updated them anyway, thanks.

parasharrajat · 2023-10-12T18:58:18Z

OK. PR looks good against https://expensify.slack.com/archives/C049HHMV9SM/p1696954215943909?thread_ts=1696338120.628179&cid=C049HHMV9SM.

parasharrajat

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.

🎀 👀 🎀 C+ reviewed

parasharrajat · 2023-10-12T19:08:48Z

src/CONST.ts


        // Define the regular expression pattern to match a string starting with an at sign and ending with a space or newline character
-        MENTION_REPLACER:
-            // eslint-disable-next-line no-misleading-character-class
-            /^@[^\n\r]*?(?=$|[\s,/?"{}[\]()&^%\\;`$=#<>!*\p{Extended_Pictographic}\u200d\u{1f1e6}-\u{1f1ff}\u{1f3fb}-\u{1f3ff}\u{e0020}-\u{e007f}\u20E3\uFE0F]|[#*0-9]\uFE0F?\u20E3)/u,


As we changed the SPECIAL_CHAR regex and removed _ & ~. Now this regex is also affected. What are the test steps for this?

@paultsimura

@parasharrajat I don't see how MENTION_REPLACER was affected by this. It did not contain _ & ~ before my changes and does not contain it now.

Also, we did not change the SPECIAL_CHAR regex – I just created it and reused in places where it already was. So none of the pre-existing regex-es should have been affected. Please correct me if I'm wrong or I'm missing something.

Oh, my bad. This is sleep, talking. Please ignore.

parasharrajat · 2023-10-12T19:10:14Z

What is wrong with tests? Does not look related but I am seeing this error for the first time.

paultsimura · 2023-10-12T20:02:23Z

What is wrong with tests? Does not look related but I am seeing this error for the first time.

It resolved itself after the CI re-run @parasharrajat

OSBotify · 2023-10-17T06:19:58Z

✋ 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-10-17T23:57:45Z

🚀 Deployed to staging by https://github.com/madmax330 in version: 1.3.86-0 🚀

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

OSBotify · 2023-10-18T23:55:15Z

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

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

eh2077 · 2024-05-13T17:27:04Z

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

            }

-            const leftString = value.substring(0, indexOfLastNonWhitespaceCharAfterTheCursor);
+            const leftString = value.substring(0, suggestionEndIndex);


This caused a regression when pressing the left/right arrow keys after typing '@', the text selection does not move, #39102

@eh2077 I think you should keep digging – this is not the correct PR for the mentioned issue. This one was released half a year ago, and your issue is quite fresh (it wasn't even happening in production).

Hi @paultsimura, thanks for your comment. I commented here to complete the checklist (the one before closing out an issue), so the linked issue has been fixed in production.

I believe that issue was introduced after this PR. Can you take a look at your recording -MacOS: Chrome / Safari?

If you're talking about the selection (and the search term) not changing – it's the expected behavior: #29239 (comment)

From what I see, your issue was about the cursor not moving, not the selection.

That's unexpected behavior as we want highlighted text to be updated when moving cursor

Did you get this confirmed with the internal team? At the time I implemented this PR, this was the expected behavior confirmed with the team.

See #39102 (comment)

paultsimura requested a review from a team as a code owner October 10, 2023 22:24

melvin-bot bot removed the request for review from a team October 10, 2023 22:24

melvin-bot bot requested a review from parasharrajat October 10, 2023 22:24

Organize suggestions RegExps;

fd994ae

Clean up the mention suggestion logic;

paultsimura force-pushed the fix/28754-suggestion-between-ats branch from a03b1fc to fd994ae Compare October 10, 2023 22:47

Merge branch 'main' into fix/28754-suggestion-between-ats

9013b09

paultsimura mentioned this pull request Oct 10, 2023

[HOLD for payment 2023-10-25] [$500] Chat - App closes mention suggestions when cursor is between double @ #28754

Closed

6 tasks

parasharrajat reviewed Oct 11, 2023

View reviewed changes

Revert variable renaming

b3804d3

paultsimura requested a review from parasharrajat October 11, 2023 13:47

parasharrajat suggested changes Oct 11, 2023

View reviewed changes

src/CONST.ts Outdated Show resolved Hide resolved

Update RegExp comment

d7ec776

Co-authored-by: Rajat Parashar <parasharrajat@users.noreply.github.com>

paultsimura requested a review from parasharrajat October 11, 2023 22:55

paultsimura added 2 commits October 12, 2023 19:26

Merge branch 'main' into fix/28754-suggestion-between-ats

64df898

Merge branch 'main' into fix/28754-suggestion-between-ats

f78bc4c

parasharrajat approved these changes Oct 12, 2023

View reviewed changes

melvin-bot bot requested a review from madmax330 October 12, 2023 19:02

parasharrajat reviewed Oct 12, 2023

View reviewed changes

Merge branch 'main' into fix/28754-suggestion-between-ats

3c5a381

fedirjh mentioned this pull request Oct 13, 2023

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

Closed

6 tasks

madmax330 approved these changes Oct 17, 2023

View reviewed changes

madmax330 merged commit 75a2cc9 into Expensify:main Oct 17, 2023
12 checks passed

OSBotify mentioned this pull request Oct 17, 2023

Deploy Checklist: New Expensify 2023-10-17 #29837

Closed

Pujan92 mentioned this pull request Oct 18, 2023

The highlighted mention does not change with the cursor movement #29884

Closed

6 tasks

eh2077 reviewed May 13, 2024

View reviewed changes

eh2077 mentioned this pull request May 13, 2024

[$500] Chat - When pressing the left/right arrow keys after typing '@', the text selection does not move #39102

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Chat - App closes mention suggestions when cursor is between double @ #29239

fix: Chat - App closes mention suggestions when cursor is between double @ #29239

paultsimura commented Oct 10, 2023 •

edited

Loading

melvin-bot bot commented Oct 10, 2023

paultsimura commented Oct 10, 2023

parasharrajat Oct 11, 2023

paultsimura Oct 11, 2023

parasharrajat Oct 11, 2023

paultsimura Oct 11, 2023

parasharrajat commented Oct 11, 2023

paultsimura commented Oct 11, 2023

parasharrajat commented Oct 12, 2023 •

edited

Loading

parasharrajat commented Oct 12, 2023 •

edited

Loading

paultsimura commented Oct 12, 2023

parasharrajat commented Oct 12, 2023

parasharrajat left a comment

parasharrajat Oct 12, 2023

parasharrajat Oct 12, 2023

paultsimura Oct 12, 2023

parasharrajat Oct 12, 2023

parasharrajat commented Oct 12, 2023

paultsimura commented Oct 12, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023

eh2077 May 13, 2024

paultsimura May 13, 2024

eh2077 May 13, 2024

paultsimura May 13, 2024

eh2077 May 13, 2024

paultsimura May 13, 2024

eh2077 May 13, 2024

fix: Chat - App closes mention suggestions when cursor is between double @ #29239

fix: Chat - App closes mention suggestions when cursor is between double @ #29239

Conversation

paultsimura commented Oct 10, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 10, 2023

paultsimura commented Oct 10, 2023

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

parasharrajat commented Oct 11, 2023

paultsimura commented Oct 11, 2023

parasharrajat commented Oct 12, 2023 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat commented Oct 12, 2023 • edited Loading

paultsimura commented Oct 12, 2023

parasharrajat commented Oct 12, 2023

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

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

parasharrajat commented Oct 12, 2023

paultsimura commented Oct 12, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023

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

paultsimura commented Oct 10, 2023 •

edited

Loading

parasharrajat commented Oct 12, 2023 •

edited

Loading

parasharrajat commented Oct 12, 2023 •

edited

Loading