feat: add whitespace after inserting emoji via native keyboard #30412

aswin-s · 2023-10-26T04:17:27Z

Details

This PR adds the functionality of adding a whitespace after an emoji is inserted via native keyboard. Earlier this behaviour was present only if emoji is inserted via in app Emoji picker.

Fixed Issues

$ #23658
PROPOSAL: #23658 (comment)

Tests

Open any chat
Enter an emoji via native keyboard, emoji picker or short code (eg- :heart:)
Verify that the emoji gets appended by a white space.
Verify that emoji can be removed by tapping backspace.
Verify cursor is positioned properly after inserting emoji.
Verify that emoji can be inserted at the midst of text
Verify that an emoji can be copy pasted
Verify that complex emoji like '👨‍👩‍👧‍👦' can be added and removed.

Verify that no errors appear in the JS console

Offline tests

Open any chat
Enter an emoji via native keyboard, emoji picker or short code (eg- :heart:)
Verify that the emoji gets appended by a white space.
Verify that emoji can be removed by tapping backspace.
Verify cursor is positioned properly after inserting emoji.
Verify that emoji can be inserted at the midst of text
Verify that an emoji can be copy pasted
Verify that complex emoji like '👨‍👩‍👧‍👦' can be added and removed.

QA Steps

Open any chat
Enter an emoji via native keyboard, emoji picker or short code (eg- :heart:)
Verify that the emoji gets appended by a white space.
Verify that emoji can be removed by tapping backspace.
Verify cursor is positioned properly after inserting emoji.
Verify that emoji can be inserted at the midst of text
Verify that an emoji can be copy pasted
Verify that complex emoji like '👨‍👩‍👧‍👦' can be added and removed.

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

android.mp4

Android: mWeb Chrome

android-web.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

iOS-mWeb.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

…cker

melvin-bot · 2023-10-26T05:14:27Z

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

mollfpr · 2023-10-27T13:58: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(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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

30412.Android.mp4

Android: mWeb Chrome

30412.mWeb-Chrome.mp4

iOS: Native

30412.iOS.mp4

iOS: mWeb Safari

30412.mWeb-Safari.mp4

MacOS: Chrome / Safari

30412.Web.mp4

MacOS: Desktop

30412.Desktop.mp4

mollfpr · 2023-10-27T13:58:44Z

@aswin-s Could you help resolve the conflict? Thanks!

…cker

aswin-s · 2023-10-27T14:59:53Z

@mollfpr Something has changed on master and I can see some issues related to emoji suggestions. Emoji suggestions popup is not shown when there is no text in the composer. It seems to be impacting master as well. Need more time to investigate and fix. I'll update you once it is resolved.

…cker

aswin-s · 2023-10-28T11:42:55Z

@mollfpr Resolved conflicts and merged latest master which fixed the above mentioned issues. You may proceed with review.

mollfpr · 2023-10-30T13:30:59Z

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

- start: prevSelection.start + text.length + selectionSpaceLength,
- end: prevSelection.start + text.length + selectionSpaceLength,
- }));
+ (text) => {


We need to update these line

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

Line 449 in b321b0a

replaceSelectionWithText(e.key, false);

Fixed. Removed the second parameter which is redundant now.

mollfpr · 2023-10-30T13:45:29Z

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

- setSelection((prevSelection) => ({
- start: prevSelection.start + text.length + selectionSpaceLength,
- end: prevSelection.start + text.length + selectionSpaceLength,
- }));


I think this removed code makes a regression.

Screen.Recording.2023-10-30.at.20.43.23.mov

Step to reproduce:

Type a text

Place the cursor in the middle

Unfocus the composer

Press any alphabet key

The cursor should stay in the last position before the unfocus.

Nice catch 🙌. I had inadvertently removed the code to reset cursor position when the composer was focused again. However the method replaceSelectionWithText doesn't seem like an apt location for it as the method is shared with EmojiPicker callback. Instead I moved the code to the focus handler method itself which will reset the cursor to its last known location.

…cker

aswin-s · 2023-10-31T05:40:58Z

@mollfpr Fixed the issue related to composer focus. You may retest the fix now.

mollfpr · 2023-10-31T12:15:04Z

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

+ // Reset cursor to last known location
+ setSelection((prevSelection) => ({
+ start: prevSelection.start + 1,
+ end: prevSelection.end + 1,


I'm a bit confused about this logic. Previously, we also sum the text length, but not here.

@aswin-s Could you explain more?

@mollfpr Earlier it had to handle both Emoji picker input and Keyboard onPress. When emoji was inserted via picker selection, it had to adjust for emoji with white space. Now since the logic is moved into key press event, the selection is always going to be incremented by one, since it gets triggered only once for the first character being inserted.

mollfpr

It looks good and tests well 👍

Just a minor JSDoc left.

mollfpr · 2023-11-01T13:55:38Z

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

+ * Find diff between text changes in composer
+ */
+ const findNewlyAddedChars = useCallback(
+ (prevText, newText) => {


Missing the params JSDoc.

Added JSDoc params

OSBotify · 2023-11-03T14:44:12Z

✋ 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-11-06T22:32:28Z

🚀 Deployed to staging by https://github.com/flodnv in version: 1.3.96-0 🚀

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

OSBotify · 2023-11-09T22:50:01Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T15:46:42Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.97-7 🚀

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

aswin-s added 9 commits October 22, 2023 05:53

fix: append whitespace after emoji

4a67723

fix: prevent infinite loop

6db2014

fix: clean lint

a8bd005

Merge branch 'main' into fix/naitve-emoji-picker

d219bc6

fix: remove extra white space getting added

ec3284d

refactor and add comments

51406fc

Merge remote-tracking branch 'upstream/main' into fix/naitve-emoji-pi…

fe60c6f

…cker

fix: remove redundant test cases

12273a3

remove unused import

bb6bd37

aswin-s marked this pull request as ready for review October 26, 2023 05:14

aswin-s requested a review from a team as a code owner October 26, 2023 05:14

melvin-bot bot removed the request for review from a team October 26, 2023 05:14

melvin-bot bot requested a review from mollfpr October 26, 2023 05:14

aswin-s added 4 commits October 27, 2023 19:59

Merge remote-tracking branch 'upstream/main' into fix/naitve-emoji-pi…

ad91e78

…cker

fix: clean lint

f00a383

fix: prettify code

b1213cd

Merge remote-tracking branch 'upstream/main' into fix/naitve-emoji-pi…

ff7a0ef

…cker

aswin-s added 2 commits October 28, 2023 14:18

Merge remote-tracking branch 'upstream/main' into fix/naitve-emoji-pi…

681b606

…cker

fix: revert change to EmojiUtils

9f3653c

mollfpr reviewed Oct 30, 2023

View reviewed changes

aswin-s added 3 commits October 30, 2023 21:13

Merge remote-tracking branch 'upstream/main' into fix/naitve-emoji-pi…

c58c3a3

…cker

fix: reset cursor to last position on focus

40a6f85

prettify code

c66bc8c

aswin-s requested a review from mollfpr October 31, 2023 05:41

mollfpr reviewed Oct 31, 2023

View reviewed changes

mollfpr approved these changes Nov 1, 2023

View reviewed changes

melvin-bot bot requested a review from flodnv November 1, 2023 14:58

Add params for jsDoc

f2c1022

flodnv approved these changes Nov 3, 2023

View reviewed changes

flodnv merged commit 17ce0c2 into Expensify:main Nov 3, 2023
15 checks passed

Ollyws mentioned this pull request Nov 5, 2023

[HOLD for payment 2023-11-30] [$500] Cursor position is stuck after emoji on copy pasting text with emoji text in it #29795

Closed

6 tasks

barros001 mentioned this pull request Nov 6, 2023

[HOLD for payment 2024-02-07] [$2000] Chat - Whitespace is not added after an emoji while inserting via native keyboard #23658

Closed

6 tasks

OSBotify mentioned this pull request Nov 6, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

aswin-s mentioned this pull request Nov 7, 2023

feat: append whitespace after inserting emoji #30955

Merged

58 tasks

alitoshmatov mentioned this pull request Nov 7, 2023

[HOLD FOR PAYMENT] [$500] mWeb/Chrome - Compose-After pasting emoji, cursor moving single space away #30983

Closed

6 tasks

esh-g mentioned this pull request Nov 7, 2023

Chat - Default emoji skin tone works only for yellow color #31006

Closed

6 tasks

bondydaa mentioned this pull request Nov 7, 2023

Revert "feat: add whitespace after inserting emoji via native keyboard" #31011

Merged

57 tasks

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-08 #31077

Closed

barros001 mentioned this pull request Nov 14, 2023

Correctly position cursor after pasting text containing emoji #31279

Merged

47 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add whitespace after inserting emoji via native keyboard #30412

feat: add whitespace after inserting emoji via native keyboard #30412

aswin-s commented Oct 26, 2023

melvin-bot bot commented Oct 26, 2023

mollfpr commented Oct 27, 2023 •

edited

Loading

mollfpr commented Oct 27, 2023

aswin-s commented Oct 27, 2023

aswin-s commented Oct 28, 2023

mollfpr Oct 30, 2023

aswin-s Oct 31, 2023

mollfpr Oct 30, 2023

aswin-s Oct 31, 2023

aswin-s commented Oct 31, 2023

mollfpr Oct 31, 2023

aswin-s Oct 31, 2023

mollfpr left a comment

mollfpr Nov 1, 2023

aswin-s Nov 1, 2023

OSBotify commented Nov 3, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

feat: add whitespace after inserting emoji via native keyboard #30412

feat: add whitespace after inserting emoji via native keyboard #30412

Conversation

aswin-s commented Oct 26, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 26, 2023

mollfpr commented Oct 27, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr commented Oct 27, 2023

aswin-s commented Oct 27, 2023

aswin-s commented Oct 28, 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

aswin-s commented Oct 31, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mollfpr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Nov 3, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

mollfpr commented Oct 27, 2023 •

edited

Loading