feat: append whitespace after inserting emoji #30955

aswin-s · 2023-11-07T05:15:59Z

Details

This PR fixes below regressions in #30412

Additional whitespace was added to a pasted emoji even if it already had a leading or trailing white space.
Emoji's with skin tones were getting corrupted after appending white space.

Discussion here: #23658 (comment)

Fixed Issues

$ #23658
PROPOSAL:

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 while pasting text, white space is added only when emoji is pasted. Whitespace shouldn't be added if the pasted text has any other characters other than emoji, including whitespace.
Verify that emojis with different skin tones could be inserted

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.
Verify that while pasting text, white space is added only when emoji is pasted. Whitespace shouldn't be added if the pasted text has any other characters other than emoji, including whitespace.
Verify that emojis with different skin tones could be inserted

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 while pasting text, white space is added only when emoji is pasted. Whitespace shouldn't be added if the pasted text has any other characters other than emoji, including whitespace.
Verify that emojis with different skin tones could be inserted

Verify that no errors appear in the JS console

PR Author Checklist

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

melvin-bot · 2023-11-07T05:16:04Z

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

…espace

mollfpr · 2023-11-07T13:55:50Z

@aswin-s Are this PR fixing this #30983 deploy blocker?

aswin-s · 2023-11-07T14:04:26Z

@aswin-s Are this PR fixing this #30983 deploy blocker?

Nope, it handles extra white space appended when the pasted content already contains a trailing whitespace.

…espace

mollfpr · 2024-01-10T14:34:11Z

@aswin-s Could you pull the latest main? Thank you!

…espace

aswin-s · 2024-01-10T14:57:16Z

@mollfpr Done!

mollfpr · 2024-01-10T14:59:18Z

Additional whitespace was added to a pasted emoji even if it already had a leading or trailing white space.

Emoji's with skin tones were getting corrupted after appending white space.

Also, I need help figuring out the changes for the above fix. Could you explain it more? Thanks!

aswin-s · 2024-01-11T04:00:08Z

@mollfpr Here is the explanation for the changes

Additional whitespace was added to a pasted emoji even if it already had a leading or trailing white space.

The earlier logic didn't consider if the diff from previous text had leading or trailing white space, there by appending an additional white space after emoji. This was fixed by checking if the diff indeed has leading or trailing white space and skipping the addition of white space if there is any.

Relevant Commit: 639136a

Emoji's with skin tones were getting corrupted after appending white space.

This issue occurred because of appending whitespace immediately after a detected emoji character. However for emojis with skin tone immediately after the actual emoji there were additional unicode characters that denoted what the skin tone is. By simply adding a white space after the original emoji and then followed by the skin tone unicode characters the emoji itself got corrupted. In the fix I made sure that the entire emoji length is taken into consideration before appending white space.

Relevant Commit: 6062753

aswin-s · 2024-01-17T03:42:11Z

@mollfpr Waiting for your feedback

mollfpr · 2024-01-22T14:59:39Z

@aswin-s Most cases seem to be working fine, but I have one issue with pasting only an emoji next to another, which doesn't add a whitespace after it. It works fine by pasting an emoji next to a text.

Simulator.Screen.Recording.-.iPhone.15.Pro.17.2.-.2024-01-22.at.21.53.30.mov

Also, could you resolve the conflict? Thanks!

…espace

aswin-s · 2024-01-23T04:52:04Z

@mollfpr Fixed and retested all scenarios.

fix_out.mp4

mollfpr · 2024-01-23T13:53:31Z

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

30955.ANdroid.mp4

Android: mWeb Chrome

30955.mWeb-Chrome.mp4

iOS: Native

30955.iOS.mov

iOS: mWeb Safari

30955.mWeb-Safari.mov

MacOS: Chrome / Safari

30955.Web.mp4

MacOS: Desktop

30955.Desktop.mp4

mollfpr

LGTM 🚀

src/libs/ComposerUtils/index.ts

flodnv · 2024-01-23T16:12:12Z

src/libs/ComposerUtils/index.ts

+ * @param cursorPosition - position of cursor
+ * @returns number - Length of the common suffix
+ */
+function findCommonSuffixLength(str1: string, str2: string, cursorPosition: number) {


This feels like it belongs in expensify/common str.js, no?

At the moment it is used only with composer and requires cursor position to exactly predict which character got appended when duplicate characters are present.

flodnv · 2024-01-23T16:16:17Z

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

@@ -312,14 +361,8 @@ function ComposerWithSuggestions({
     * @param {Boolean} shouldAddTrailSpace


Did we get rid of this?

@flodnv Didn't quite get the question. Do you mean did we get rid of @param from jsdoc? I think it has become redundant with Typescript migration.

Sorry, I am asking: it seems that we got rid of the shouldAddTrailSpace variable in code, and if I'm correct it seems like we should remove this @param line?

Removed the @param line

flodnv

Looks good, one more thought: is this code performing well on an input of 100k chars?

src/libs/ComposerUtils/index.ts

flodnv · 2024-01-24T14:44:22Z

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

@@ -312,14 +361,8 @@ function ComposerWithSuggestions({
     * @param {Boolean} shouldAddTrailSpace


Sorry, I am asking: it seems that we got rid of the shouldAddTrailSpace variable in code, and if I'm correct it seems like we should remove this @param line?

aswin-s · 2024-01-25T16:13:33Z

Looks good, one more thought: is this code performing well on an input of 100k chars?

Yep, tested with 100K characters and performing well.

OSBotify · 2024-01-26T13:35:50Z

✋ 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 · 2024-01-29T19:23:15Z

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

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

OSBotify · 2024-01-31T02:30:06Z

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

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

eh2077 · 2024-06-15T02:49:18Z

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

+                text: newComment,
+                emojis,
+                cursorPosition,
+            } = EmojiUtils.replaceAndExtractEmojis(isEmojiInserted ? ComposerUtils.insertWhiteSpaceAtIndex(commentValue, endIndex) : commentValue, preferredSkinTone, preferredLocale);


This line caused a regression iOS - Chat - The cursor moves one space backward when inserting text after an emoji

fix: do not append whitespace to emoji if whitespace is already present

639136a

aswin-s requested a review from a team as a code owner November 7, 2023 05:15

melvin-bot bot requested review from mollfpr and removed request for a team November 7, 2023 05:16

Merge remote-tracking branch 'upstream/main' into fix/emoji-with-whit…

944093c

…espace

aswin-s added 4 commits November 8, 2023 11:06

fix: whitespace after emoji with skin tone

6062753

fix: whitespace after short codes right before a word

4d6412e

Merge remote-tracking branch 'upstream/main' into fix/emoji-with-whit…

56b3d78

…espace

fix: insert whitespace after emoji

276cae2

aswin-s changed the title ~~fix: do not append whitespace to emoji if whitespace is already present~~ feat: append whitespace after inserting emoji Nov 8, 2023

aswin-s added 2 commits November 8, 2023 11:55

fix: prettier issue

d726960

fix: prevent duplicate character insertion on refocus

8053572

aswin-s mentioned this pull request Nov 8, 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

aswin-s added 3 commits November 24, 2023 22:32

Merge branch 'main' into fix/emoji-with-whitespace

f856ab8

fix: refactor utility methods

658038c

Merge remote-tracking branch 'upstream/main' into fix/emoji-with-whit…

6c9d374

…espace

aswin-s mentioned this pull request Jan 4, 2024

[HOLD for payment 2024-01-31] [$500] Web - Compose box - The compose box displays duplicate characters upon pressing a single key #33710

Closed

6 tasks

Merge remote-tracking branch 'upstream/main' into fix/emoji-with-whit…

f768fb6

…espace

aswin-s added 3 commits January 22, 2024 20:44

Merge remote-tracking branch 'upstream/main' into fix/emoji-with-whit…

2cc4858

…espace

fix: common suffix length calculation

f7a19ca

refactor: remove redundant changes

8355315

mollfpr approved these changes Jan 23, 2024

View reviewed changes

src/libs/ComposerUtils/index.ts Outdated Show resolved Hide resolved

src/libs/ComposerUtils/index.ts Outdated Show resolved Hide resolved

melvin-bot bot requested a review from flodnv January 23, 2024 14:18

flodnv reviewed Jan 23, 2024

View reviewed changes

fix: remove params & returns from jsdoc

84f0851

aswin-s requested a review from flodnv January 24, 2024 03:30

flodnv reviewed Jan 24, 2024

View reviewed changes

aswin-s added 2 commits January 25, 2024 21:25

fix: remove redundant param shouldAddTrailSpace

f0ebda9

fix: remove empty line

27f5395

aswin-s requested a review from flodnv January 25, 2024 16:13

flodnv approved these changes Jan 26, 2024

View reviewed changes

flodnv merged commit 1439ac0 into Expensify:main Jan 26, 2024
17 checks passed

github-actions bot mentioned this pull request Jan 29, 2024

Deploy Checklist: New Expensify 2024-01-29 #35328

Closed

situchan mentioned this pull request Jan 31, 2024

Web - Chat - Emoji is entered twice when entering via Windows OS keyboard #35339

Closed

6 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

eh2077 reviewed Jun 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: append whitespace after inserting emoji #30955

feat: append whitespace after inserting emoji #30955

aswin-s commented Nov 7, 2023 •

edited by github-actions bot

Loading

melvin-bot bot commented Nov 7, 2023

mollfpr commented Nov 7, 2023

aswin-s commented Nov 7, 2023

mollfpr commented Jan 10, 2024

aswin-s commented Jan 10, 2024

mollfpr commented Jan 10, 2024

aswin-s commented Jan 11, 2024

aswin-s commented Jan 17, 2024

mollfpr commented Jan 22, 2024

aswin-s commented Jan 23, 2024

mollfpr commented Jan 23, 2024 •

edited

Loading

mollfpr left a comment

flodnv Jan 23, 2024

aswin-s Jan 24, 2024

flodnv Jan 23, 2024

aswin-s Jan 24, 2024

flodnv Jan 24, 2024

aswin-s Jan 25, 2024

flodnv left a comment

flodnv Jan 24, 2024

aswin-s commented Jan 25, 2024

OSBotify commented Jan 26, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 31, 2024

eh2077 Jun 15, 2024

		@@ -312,14 +361,8 @@ function ComposerWithSuggestions({
		* @param {Boolean} shouldAddTrailSpace

feat: append whitespace after inserting emoji #30955

feat: append whitespace after inserting emoji #30955

Conversation

aswin-s commented Nov 7, 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 7, 2023

mollfpr commented Nov 7, 2023

aswin-s commented Nov 7, 2023

mollfpr commented Jan 10, 2024

aswin-s commented Jan 10, 2024

mollfpr commented Jan 10, 2024

aswin-s commented Jan 11, 2024

aswin-s commented Jan 17, 2024

mollfpr commented Jan 22, 2024

aswin-s commented Jan 23, 2024

mollfpr commented Jan 23, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

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

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

flodnv left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aswin-s commented Jan 25, 2024

OSBotify commented Jan 26, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 31, 2024

Choose a reason for hiding this comment

aswin-s commented Nov 7, 2023 •

edited by github-actions bot

Loading

mollfpr commented Jan 23, 2024 •

edited

Loading