Fix 29405 cursor displayed before emoji on ios native #30835

roksanaz · 2023-11-03T11:58:43Z

Details

In the native iOS application if the user types the emoji manually, but they unintentionally put a space after the first colon mark (e.g. “: joy:”) and then remove the space, the emoji is converted successfully, but the cursor goes before the emoji instead of after the emoji.

Fixed Issues

$ #29405
PROPOSAL: #29405 (comment)

Tests

Open the app
Open any report
Type emoji text in following way ': joy:'
Remove space before text to convert it to emoji
Cursor is displayed after emoji

Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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 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.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

29405android.mp4

Android: mWeb Chrome

29405androidWeb.mp4

iOS: Native

29405ios.mp4

iOS: mWeb Safari

29405iosWeb.mp4

MacOS: Chrome / Safari

29405web.mp4

MacOS: Desktop

29405desktop.mp4

melvin-bot · 2023-11-06T12:57:58Z

@aimane-chnaif 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]

aimane-chnaif · 2023-11-09T12:46:27Z

Please fix conflict

aimane-chnaif · 2023-11-12T21:51:56Z

@artus9033 can you please continue this PR? Just fix conflict

artus9033 · 2023-11-15T09:19:05Z

Sure! @aimane-chnaif please feel free to review, conflict resolved.

aimane-chnaif · 2023-11-15T14:51:22Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

aimane-chnaif · 2023-11-15T14:55:29Z

@artus9033 please check this video. When there's text next to emoji, not working. (iOS only)

ios.bug.mov

artus9033 · 2023-11-17T00:43:35Z

Thank you @aimane-chnaif, I can also reproduce that. At the moment it seems to me that there is a problem with React Native's TextInput component on iOS, just as @roksanaz noticed in her initial proposal. I will investigate it and correct the PR soon.

artus9033 · 2023-11-17T19:06:20Z

Update: seems like there are a few problems with Composer and TextInput has some unfavorable behaviour on iOS. I will need more time to investigate.
CC: @aimane-chnaif

artus9033 · 2023-11-22T15:04:10Z

Update: still developing an approach to address that

… emoji for marker

…Suggestions

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

artus9033 · 2023-12-08T12:15:26Z

@aimane-chnaif the PR is ready for review and below you can find a few words explaining my latest changes.

The previous fix involved a momentary behaviour of the cursor jumping to {0, 0}, as you noticed, since it was delaying setting the cursor position to the pre-calculated one. I attempted to overcome this caret behaviour, however on iOS native the original passing of the selection on iOS caused onSelectionChange to be fired sequentially when replacing emoji markers, resulting in unfavorable behaviour of the cursor "jumping around" for a brief moment before being positioned properly by the fix. Upon investigating, I discovered that onTextChange on iOS is called after onSelectionChange and call to the former breaks cursor position after inserting an emoji in place of an emoji text marker. This behaviour was unexpected since it was not mentioned anywhere in the docs and, although it was possible to minimize its effects by ignoring some of the invocations, it involved larger changes in the code and was not perfect.

For the reason described above, I decided that it will be better to drop the controlled approach in favor of using an existing ref to set a flag to sync cursor position inside onTextChange on iOS specifically by setting it after all interactions finish to the position pre-calculated in onSelectionChange.

aimane-chnaif · 2023-12-08T12:16:51Z

Was there an attempt to fix in iOS native code?

artus9033 · 2023-12-08T12:34:46Z

No, not tried. I checked issues and SO, where there were reports of such problems, but none resolved so far. Do we want to go in this direction?

aimane-chnaif · 2023-12-10T08:19:18Z

No, not tried. I checked issues and SO, where there were reports of such problems, but none resolved so far. Do we want to go in this direction?

It would be ideal.
As the current new solution is completely different from original approved proposal, can you post updated proposal on the issue to explain code changes?

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

artus9033 · 2023-12-12T01:04:35Z

Just a quick notice, I'm OOO until Wednesday - I'll report back then.

artus9033 · 2023-12-13T12:21:54Z

@aimane-chnaif

It would be ideal. As the current new solution is completely different from original approved proposal, can you post updated proposal on the issue to explain code changes?

Absolutely, posting the new proposal on main issue. Regarding the native code, I inspected it today but couldn't find the root cause of the issue there. Can we carry on with the non-native solution?

aimane-chnaif · 2023-12-16T18:26:20Z

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

+        (commentValue) => {
+            updateComment(commentValue, true);
+
+            if (isIOSNative && syncSelectionWithOnChangeTextRef.current) {


isIOSNative && may be redundant as syncSelectionWithOnChangeTextRef.current will never be set in all other platforms

Absolutely, this is true - however, since this has negligent impact on performance, I wanted it to stay there as a defensive condition for the code to be clean & stable. Please consider a situation when something that sets this ref is introduced in the future, in which case this condition would still prevent the code from being executed and also it explicitly shows that this is only to be set on iOS native. Would you agree to leave this here, then?

ok leave it then

aimane-chnaif · 2023-12-16T18:28:13Z

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

+                const positionSnapshot = syncSelectionWithOnChangeTextRef.current.position;
+                syncSelectionWithOnChangeTextRef.current = null;
+
+                InteractionManager.runAfterInteractions(() => {


please add comment why InteractionManager.runAfterInteractions is needed

Do you mean in code? It is required to ensure that the selection is set imperatively after all state changes are effective; without it, the problem would still persist since setSelection would run too eager.

Do you mean in code?

yes, please as InteractionManager.runAfterInteractions is workaround solution

Sure thing. Resolved in 98436b7

aimane-chnaif

LGTM
@youssef-lr all yours! (please check #29405 (comment))

youssef-lr

LGTM

OSBotify · 2023-12-28T12:24:21Z

✋ 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-12-28T21:36:43Z

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.4.19-0 🚀

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

OSBotify · 2023-12-29T18:13:36Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.19-2 🚀

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

roksanaz added 4 commits November 3, 2023 12:32

Fix 29405 cursor displayed before emoji on ios native

e8a054a

Merge branch 'main' into 29405-ios-emoji-cursor

15e4590

Merge branch 'main' into 29405-ios-emoji-cursor

2c6b1f1

Merge branch 'main' into 29405-ios-emoji-cursor

bd9ab69

roksanaz marked this pull request as ready for review November 6, 2023 12:57

roksanaz requested a review from a team as a code owner November 6, 2023 12:57

melvin-bot bot requested review from aimane-chnaif and removed request for a team November 6, 2023 12:57

Merge branch 'main' into 29405-ios-emoji-cursor

5359e09

aimane-chnaif mentioned this pull request Nov 22, 2023

[HOLD for payment 2024-04-05] [$500] mWeb - Cursor jumps back to the start when adding an emoji in edit #28563

Closed

6 tasks

artus9033 added 6 commits November 23, 2023 18:38

Merge branch 'main' of github.com:Expensify/App into proposal/29405

b506758

Merge branch 'main' of github.com:Expensify/App into proposal/29405

0f098ad

Fix Composer not positioning caret properly on iOS after substituting…

b107b9c

… emoji for marker

Merge branch 'main' of github.com:Expensify/App into proposal/29405

6d899c3

Added comments, additional conditions, refactored fix in ComposerWith…

e2480e5

…Suggestions

Fixed typo in ComposerWithSuggestions fix

a0b31b5

barttom reviewed Dec 7, 2023

View reviewed changes

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.js Outdated Show resolved Hide resolved

artus9033 added 2 commits December 7, 2023 15:15

Merge branch 'main' of github.com:Expensify/App into proposal/29405

fc88d76

Refactored ComposerWithSuggestions

062265e

aimane-chnaif reviewed Dec 10, 2023

View reviewed changes

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.js Outdated Show resolved Hide resolved

Stripped obsolete code from ComposerWithSuggestions.js

b2ff88c

artus9033 mentioned this pull request Dec 13, 2023

[Awaiting checklist completion] [$500] No space after emoji or cursor displayed before emoji on android chrome and ios native #29405

Closed

6 tasks

aimane-chnaif reviewed Dec 16, 2023

View reviewed changes

Added explanatory commit to ComposerWithSuggestions.js

98436b7

aimane-chnaif approved these changes Dec 24, 2023

View reviewed changes

melvin-bot bot requested a review from youssef-lr December 24, 2023 15:36

aimane-chnaif approved these changes Dec 24, 2023

View reviewed changes

youssef-lr approved these changes Dec 28, 2023

View reviewed changes

youssef-lr merged commit 88d837c into Expensify:main Dec 28, 2023
16 of 18 checks passed

github-actions bot mentioned this pull request Dec 28, 2023

Deploy Checklist: New Expensify 2023-12-28 #33727

Closed

22 tasks

bernhardoj mentioned this pull request May 28, 2024

[HOLD for payment 2024-06-20] [$250] iOS - Chat - The cursor moves one space backward when inserting text after an emoji #42664

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix 29405 cursor displayed before emoji on ios native #30835

Fix 29405 cursor displayed before emoji on ios native #30835

roksanaz commented Nov 3, 2023 •

edited by github-actions bot

Loading

melvin-bot bot commented Nov 6, 2023

aimane-chnaif commented Nov 9, 2023

aimane-chnaif commented Nov 12, 2023

artus9033 commented Nov 15, 2023

aimane-chnaif commented Nov 15, 2023 •

edited

Loading

aimane-chnaif commented Nov 15, 2023

artus9033 commented Nov 17, 2023 •

edited

Loading

artus9033 commented Nov 17, 2023

artus9033 commented Nov 22, 2023 •

edited

Loading

artus9033 commented Dec 8, 2023

aimane-chnaif commented Dec 8, 2023

artus9033 commented Dec 8, 2023 •

edited

Loading

aimane-chnaif commented Dec 10, 2023

artus9033 commented Dec 12, 2023

artus9033 commented Dec 13, 2023

aimane-chnaif Dec 16, 2023

artus9033 Dec 20, 2023

aimane-chnaif Dec 20, 2023

aimane-chnaif Dec 16, 2023

artus9033 Dec 20, 2023

aimane-chnaif Dec 20, 2023

artus9033 Dec 21, 2023

aimane-chnaif left a comment

youssef-lr left a comment

OSBotify commented Dec 28, 2023

OSBotify commented Dec 28, 2023

OSBotify commented Dec 29, 2023

Fix 29405 cursor displayed before emoji on ios native #30835

Fix 29405 cursor displayed before emoji on ios native #30835

Conversation

roksanaz commented Nov 3, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 6, 2023

aimane-chnaif commented Nov 9, 2023

aimane-chnaif commented Nov 12, 2023

artus9033 commented Nov 15, 2023

aimane-chnaif commented Nov 15, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

aimane-chnaif commented Nov 15, 2023

artus9033 commented Nov 17, 2023 • edited Loading

artus9033 commented Nov 17, 2023

artus9033 commented Nov 22, 2023 • edited Loading

artus9033 commented Dec 8, 2023

aimane-chnaif commented Dec 8, 2023

artus9033 commented Dec 8, 2023 • edited Loading

aimane-chnaif commented Dec 10, 2023

artus9033 commented Dec 12, 2023

artus9033 commented Dec 13, 2023

aimane-chnaif Dec 16, 2023

Choose a reason for hiding this comment

artus9033 Dec 20, 2023

Choose a reason for hiding this comment

aimane-chnaif Dec 20, 2023

Choose a reason for hiding this comment

aimane-chnaif Dec 16, 2023

Choose a reason for hiding this comment

artus9033 Dec 20, 2023

Choose a reason for hiding this comment

aimane-chnaif Dec 20, 2023

Choose a reason for hiding this comment

artus9033 Dec 21, 2023

Choose a reason for hiding this comment

aimane-chnaif left a comment

Choose a reason for hiding this comment

youssef-lr left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 28, 2023

OSBotify commented Dec 28, 2023

OSBotify commented Dec 29, 2023

roksanaz commented Nov 3, 2023 •

edited by github-actions bot

Loading

aimane-chnaif commented Nov 15, 2023 •

edited

Loading

artus9033 commented Nov 17, 2023 •

edited

Loading

artus9033 commented Nov 22, 2023 •

edited

Loading

artus9033 commented Dec 8, 2023 •

edited

Loading