Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed problem with cursor jumping back to start when adding an emoji in edit mode #31611

Closed
wants to merge 5 commits into from

Conversation

artus9033
Copy link
Contributor

@artus9033 artus9033 commented Nov 21, 2023

Details

In the chrome browser on Android devices when the user edits the message and chooses an emoji from the emoji modal, the cursor jumps back at the beginning of the input. The problem is that addEmojiToTextbox is called from EmojiPickerButton component's onEmojiSelected callback prop, which is called just before onModalHide. The former in turn calls focusComposerWithDelay, which calls focus() on the text input. That method is annotated with the commend 'The exact behavior triggered will depend on the platform and type of view.', which apparently on Android mWeb Chrome moves the cursor to the start and is the root cause of the problem in this issue. Adding an additional parameter to this function to force-set the position to the state-carried one on this platform fixes the problem and even - when applied - renders the original proposal solution unnecessary.

Fixed Issues

$ #28563

PROPOSAL:
#28563 (comment)

Tests

  • Send a message to a chat
  • Long-press it and select "Edit comment" in the context menu
  • Append a new emoji from the emoji picker sliding menu - repeat this in several edge cases: in-between existing text, after text, before text
  • Ensure the cursor position is each time in the expected position and does not jump to the start of the text

Offline tests

Same as Tests

QA Steps

  • 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 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 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 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 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.2023-11-27.at.14.40.08.mov
Android: mWeb Chrome
Screen.Recording.2023-11-27.at.14.42.04.mov
iOS: Native
Screen.Recording.2023-11-27.at.14.49.03.mov
iOS: mWeb Safari
Screen.Recording.2023-11-27.at.16.00.55.mov
MacOS: Chrome / Safari
Screen.Recording.2023-11-27.at.16.04.58.mov
Screen.Recording.2023-11-27.at.16.05.46.mov
MacOS: Desktop
Screen.Recording.2023-11-27.at.16.19.34.mov

Co-authored-by: Fábio Henriques <fabio.lacerda@outlook.com>
@artus9033 artus9033 marked this pull request as ready for review November 23, 2023 20:16
@artus9033 artus9033 requested a review from a team as a code owner November 23, 2023 20:16
@melvin-bot melvin-bot bot requested review from abdulrahuman5196 and removed request for a team November 23, 2023 20:16
Copy link

melvin-bot bot commented Nov 23, 2023

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

@abdulrahuman5196
Copy link
Contributor

@artus9033 Doesn't it seem like the cursor is jumping to starting point(like {0,0}) and re-jumping again to the current cursor place?

@artus9033
Copy link
Contributor Author

Indeed @abdulrahuman5196 you're right, it seems like there is a momentary unwanted behaviour - thanks for the notification. I will modify the approach to evade this problem and ping you when it is ready for review.

Copy link
Contributor

@rezkiy37 rezkiy37 left a comment

Choose a reason for hiding this comment

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

Left comments.

src/libs/focusComposerWithDelay.ts Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItemMessageEdit.js Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItemMessageEdit.js Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItemMessageEdit.js Outdated Show resolved Hide resolved
src/libs/focusComposerWithDelay.ts Outdated Show resolved Hide resolved
src/libs/focusComposerWithDelay.ts Show resolved Hide resolved
Copy link
Contributor

@rezkiy37 rezkiy37 left a comment

Choose a reason for hiding this comment

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

LGTM.

@artus9033
Copy link
Contributor Author

@abdulrahuman5196 the PR is ready for review now.

@artus9033
Copy link
Contributor Author

@abdulrahuman5196 kind reminder for review 👀

@abdulrahuman5196
Copy link
Contributor

The new changes in the PR, mostly feels like we are doing lots of platform related workaround fixes to solve this minor issue.
Should we check at different angle?

What do you think @neil-marcellini

@artus9033
Copy link
Contributor Author

@abdulrahuman5196 @neil-marcellini kindly bump 😄

@MrRefactor
Copy link
Contributor

@abdulrahuman5196 kindly bump

@abdulrahuman5196
Copy link
Contributor

The new changes in the PR, mostly feels like we are doing lots of platform related workaround fixes to solve this minor issue. Should we check at different angle?

What do you think @neil-marcellini

Hi. Gentle ping on @neil-marcellini

@abdulrahuman5196
Copy link
Contributor

@sakluger I think Neil is off till Jan 15th, can we involve any other engineer for this?

@MrRefactor
Copy link
Contributor

@abdulrahuman5196 @neil-marcellini kindly bump! :D

@abdulrahuman5196
Copy link
Contributor

@neil-marcellini Any update on this?

@MrRefactor
Copy link
Contributor

Hey @abdulrahuman5196 could we close this PR and I will reopen a new one? Artur isnt working in the project so it would be easier for me to update everything

@abdulrahuman5196
Copy link
Contributor

Hey @abdulrahuman5196 could we close this PR and I will reopen a new one? Artur isnt working in the project so it would be easier for me to update everything

Thanks for the ping. @neil-marcellini Could you kindly provide direction here? #31611 (comment)

@neil-marcellini
Copy link
Contributor

👀 taking a look

@neil-marcellini
Copy link
Contributor

The new changes in the PR, mostly feels like we are doing lots of platform related workaround fixes to solve this minor issue. Should we check at different angle?

What do you think @neil-marcellini

Yes I agree. Per our guidelines, using Platform is strongly discouraged. Instead, use platform specific files.

@neil-marcellini
Copy link
Contributor

Hey @abdulrahuman5196 could we close this PR and I will reopen a new one? Artur isnt working in the project so it would be easier for me to update everything

@MrRefactor sure thing. I'll close this and re-assign you to the issue, and you can open a new PR.

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.

6 participants