Skip to content

Fix suggestion list cursor bug#67720

Merged
chiragsalian merged 13 commits intoExpensify:mainfrom
LorenzoBloedow:suggestion-list-fix
Nov 10, 2025
Merged

Fix suggestion list cursor bug#67720
chiragsalian merged 13 commits intoExpensify:mainfrom
LorenzoBloedow:suggestion-list-fix

Conversation

@LorenzoBloedow
Copy link
Contributor

@LorenzoBloedow LorenzoBloedow commented Aug 2, 2025

Explanation of Change

We're removing the old logic for syncing text selection when the user selects a contact suggestion and using a new approach which overrides the cursor position with the end position of the suggestion because the old method was not correctly computing the end position.
This aligns with the expected behavior of the cursor being positioned at the end of a mention.

Fixed Issues

$ #61944
PROPOSAL: #61944 (comment)

Tests

Prerequisite:

  • Have at least 2 different Expensify contacts.
  1. Go to any chat.
  2. Type @ in the composer.
  3. Type the first letter of an email you have in your Expensify contacts.
  4. Select one of the contacts in the suggestion list.
  5. Move the cursor to the middle of the contact/email that was just inserted.
  6. Select the other contact in the suggestion list.
  7. Verify the cursor moves to the end of the text.

Offline tests

Same as tests.

QA Steps

Same as tests.

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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
Android.-.App.mov
Android: mWeb Chrome
Android.-.Chrome.mov
iOS: Native
iOS.-.App.mov
iOS: mWeb Safari
iOS.-.Safari.mov
MacOS: Chrome / Safari
macOS.-.Safari.mov
MacOS: Desktop
macOS.-.Desktop.mov

@LorenzoBloedow LorenzoBloedow requested a review from a team as a code owner August 2, 2025 15:48
@melvin-bot melvin-bot bot requested a review from ishpaul777 August 2, 2025 15:48
@melvin-bot
Copy link

melvin-bot bot commented Aug 2, 2025

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

@melvin-bot melvin-bot bot removed the request for review from a team August 2, 2025 15:48
Copy link
Contributor

@ishpaul777 ishpaul777 Aug 4, 2025

Choose a reason for hiding this comment

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

can you clarify why do we have these changes? this might cause regressions on ios Native

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's because setting the cursor imperatively is what's causing the bug and, in general, declarative is how you should use these props. As you mentioned here the bug that made us use imperative handling in the first place doesn't seem to be present anymore.

Copy link
Contributor

Choose a reason for hiding this comment

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

sorry but i didn't interpret this from you proposal, i thought we were just going to pass selection prop in and tested that only while checking proposal surprisingly that only seems to working, but since we are removing this also I'll test this more and get back ASAP!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are you talking about the changes regarding removing the imperative handling? If so, I think that was my mistake actually, I forgot to mention we should also remove it, sorry about that. I think removing the imperative handling is better since we don't need it anymore, but we can try just passing the prop and not removing the other code, I'm pretty sure both ways work at the moment.

Copy link
Contributor

Choose a reason for hiding this comment

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

so i noticed a bug when randomly putting cursor it adds random spaces in between

Screen.Recording.2025-09-01.at.12.15.57.AM.mov

Copy link
Contributor

Choose a reason for hiding this comment

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

ok so i checked that this is reproducible on main as well, and only reproducible on Hybrid app so i guess not related to the PR, will continue testing

Copy link
Contributor

@ishpaul777 ishpaul777 Sep 27, 2025

Choose a reason for hiding this comment

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

@LorenzoBloedow i have founce another bug while testing this on IOS it seems when adding a emoji from keyboard there is no space added at end while it did add on main

main:

Screen.Recording.2025-09-28.at.1.24.01.AM.mov

this branch:

Screen.Recording.2025-09-28.at.1.26.11.AM.mov

Copy link
Contributor

Choose a reason for hiding this comment

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

also it would be very much appreciate if we can track blame history and list all issue for which this imperative handling is added or modified and test each one to make sure its not reproducible anymore, Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

any updates? @LorenzoBloedow

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm testing without removing the imperative handling.

@ishpaul777
Copy link
Contributor

@LorenzoBloedow bump^

@LorenzoBloedow
Copy link
Contributor Author

@ishpaul777 Sorry for the delay, just answered your question above.

@ishpaul777
Copy link
Contributor

not able to priortize but this is still on my radar

@ishpaul777
Copy link
Contributor

Will priortize testing this weekend

@LorenzoBloedow LorenzoBloedow requested a review from a team as a code owner September 1, 2025 14:48
@LorenzoBloedow
Copy link
Contributor Author

@ishpaul777 Bump

@ishpaul777
Copy link
Contributor

sorry @LorenzoBloedow this somehow got disappeared from my k2 dashboard, i have this on list now. Sorry for delay

@LorenzoBloedow
Copy link
Contributor Author

@ishpaul777 I'm trying a new approach of overriding the selection when suggestions are used, let me know if you find any bugs, I tested it and looks like it works:

Screen.Recording.2025-10-07.at.3.25.03.PM.mov

@codecov
Copy link

codecov bot commented Oct 7, 2025

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@ishpaul777
Copy link
Contributor

@LorenzoBloedow Can you please fix conflict, and add some details of new approach like detailed RCA and solution explaination ?

@ishpaul777
Copy link
Contributor

@LorenzoBloedow any updates here?

@LorenzoBloedow
Copy link
Contributor Author

@ishpaul777 Sorry for the delay 😬, I've been really busy recently. I just fixed the conflicts and tested everything is still working as expected. Also tried to add more detailed explanation of the changes.

@ishpaul777 ishpaul777 requested a review from akinwale November 4, 2025 22:22
@akinwale
Copy link
Contributor

akinwale commented Nov 6, 2025

@LorenzoBloedow Selecting a name from the suggestions list fails with an error as seen in the screenshot below.
Screenshot 2025-11-06 at 06 37 16

I also get the following error when trying to access a session where I am already logged in.
Screenshot 2025-11-06 at 06 37 29

Could you check these?

@LorenzoBloedow
Copy link
Contributor Author

@akinwale Hi, thanks for catching these!
Just fixed the crash (it was a timing issue, the textInputRef would unmount right before we call it in useEffect).
The other error seems to be from the old main branch, I already pulled the latest and it seems to have gone away.

Screen.Recording.2025-11-09.at.6.28.25.PM.mov
Screen.Recording.2025-11-09.at.6.32.00.PM.mov

@akinwale
Copy link
Contributor

akinwale commented Nov 10, 2025

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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: HybridApp
67720-android-hybrid.mp4
Android: mWeb Chrome
67720-android-chrome.mp4
iOS: HybridApp
67720-ios-hybrid.mp4
iOS: mWeb Safari
67720-ios-safari.mp4
MacOS: Chrome / Safari
67720-web.mp4
MacOS: Desktop
67720-desktop.mp4

Copy link
Contributor

@akinwale akinwale left a comment

Choose a reason for hiding this comment

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

LGTM.

@melvin-bot melvin-bot bot requested a review from chiragsalian November 10, 2025 06:42
@chiragsalian chiragsalian merged commit 504c8c2 into Expensify:main Nov 10, 2025
27 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 9.2.49-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 9.2.49-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 9.2.52-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.2.54-1 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 9.2.52-0 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants