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

Create a common function to insert an emoji into a text #17346

Merged

Conversation

bernhardoj
Copy link
Contributor

Details

Currently, a space is added when we add an emoji from emoji picker to main composer. The expected behavior is to not add a space and this PR address it.

Fixed Issues

$ #15951
PROPOSAL: #15951 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open any chat
  2. Press the emoji picker button on main composer
  3. Pick any emoji
  4. Verify the emoji added to the main composer without additional space
  5. Send a message
  6. Edit the message
  7. Press the emoji picker button on edit composer
  8. Pick any emoji
  9. Verify the emoji added to the edit composer without additional space
  • 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 / Chrome
    • iOS / native
    • iOS / 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 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 correct English and 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
    • 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 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

Web
web.mov
Mobile Web - Chrome
android.mweb.mov
Mobile Web - Safari
ios.mweb.mov
Desktop
desktop.mov
iOS
ios.mov
Android
android.mp4

@bernhardoj bernhardoj requested a review from a team as a code owner April 12, 2023 15:58
@melvin-bot melvin-bot bot requested review from cead22 and Santhosh-Sellavel and removed request for a team April 12, 2023 15:58
@MelvinBot
Copy link

@cead22 @Santhosh-Sellavel One of you needs to 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]

@bernhardoj
Copy link
Contributor Author

PR is ready @Santhosh-Sellavel

@cead22
Copy link
Contributor

cead22 commented Apr 13, 2023

Conflicts

@bernhardoj
Copy link
Contributor Author

@cead22 Conflict with this PR #17138. The logic of EmojiUtils.insertEmoji is now being used in 2 places inside ReportActionCompose.

replaceSelectionWithInput(text) {
const newComment = this.comment.slice(0, this.state.selection.start)
+ text
+ this.comment.slice(this.state.selection.end, this.comment.length);
this.setState(prevState => ({
selection: {
start: prevState.selection.start + text.length,
end: prevState.selection.start + text.length,
},
}), this.updateComment(newComment));
}

1st

addEmojiToTextBox(emoji) {
const emojiWithSpace = `${emoji} `;
this.replaceSelectionWithInput(emojiWithSpace);
}

2nd

this.replaceSelectionWithInput(e.key);

Is it still okay to use EmojiUtils.insertEmoji inside replaceSelectionWithInput because now we also insert a character?

replaceSelectionWithInput(text) {
    this.setState(prevState => ({
        selection: {
            start: prevState.selection.start + text.length,
            end: prevState.selection.start + text.length,
        },
    }), this.updateComment(EmojiUtils.insertEmoji(this.comment, this.state.selection, text)));
}

@cead22 cead22 changed the title create a common function to insert an emoji into a text Create a common function to insert an emoji into a text Apr 13, 2023
@Santhosh-Sellavel
Copy link
Collaborator

That would look weird. Definelty

@bernhardoj
Copy link
Contributor Author

I moved the function to ReportUtils for now.

@cead22
Copy link
Contributor

cead22 commented Apr 14, 2023

I agree EmojiUtils and insertEmoji feel off now that we're using the same logic to insert any text, so I like insertText, but I think ReportUtils feels like the wrong place to put it cause this has nothing to do with reports (or chats, since that's what reports are in this context), and ReportUtils is already bloated with things that have no relation with reports, like hasExpensifyGuidesEmails

The most fitting *Utils exiting file seems to be ReportActionsUtils.js, what do you think of putting it there, or creating a new *Utils file? I think ReportActionUtils works

@Santhosh-Sellavel
Copy link
Collaborator

Makes sense @cead22

Copy link
Contributor

@cead22 cead22 left a comment

Choose a reason for hiding this comment

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

Code looks good. Check my comment about ReportUtils

@bernhardoj
Copy link
Contributor Author

Agree that ReportUtils feels like a wrong place. What about ComposerUtils? I was trying to move it there before but can't make it work. Now, it's working with this change:

diff --git a/src/components/Composer/index.js b/src/components/Composer/index.js
index 9b2d028a73..fe192de230 100755
--- a/src/components/Composer/index.js
+++ b/src/components/Composer/index.js
@@ -9,7 +9,7 @@ import withLocalize, {withLocalizePropTypes} from '../withLocalize';
 import Growl from '../../libs/Growl';
 import themeColors from '../../styles/themes/default';
 import updateIsFullComposerAvailable from '../../libs/ComposerUtils/updateIsFullComposerAvailable';
-import getNumberOfLines from '../../libs/ComposerUtils/index';
+import * as ComposerUtils from '../../libs/ComposerUtils/index';
 import * as Browser from '../../libs/Browser';
 import Clipboard from '../../libs/Clipboard';
 import withWindowDimensions, {windowDimensionsPropTypes} from '../withWindowDimensions';
@@ -343,7 +343,7 @@ class Composer extends React.Component {
             const lineHeight = parseInt(computedStyle.lineHeight, 10) || 20;
             const paddingTopAndBottom = parseInt(computedStyle.paddingBottom, 10)
             + parseInt(computedStyle.paddingTop, 10);
-            const computedNumberOfLines = getNumberOfLines(this.props.maxLines, lineHeight, paddingTopAndBottom, this.textInput.scrollHeight);
+            const computedNumberOfLines = ComposerUtils.getNumberOfLines(this.props.maxLines, lineHeight, paddingTopAndBottom, this.textInput.scrollHeight);
             const numberOfLines = computedNumberOfLines === 0 ? this.props.numberOfLines : computedNumberOfLines;
             updateIsFullComposerAvailable(this.props, numberOfLines);
             this.setState({
diff --git a/src/libs/ComposerUtils/index.js b/src/libs/ComposerUtils/index.js
index a469da7516..e207f2bcaf 100644
--- a/src/libs/ComposerUtils/index.js
+++ b/src/libs/ComposerUtils/index.js
@@ -14,4 +14,18 @@ function getNumberOfLines(maxLines, lineHeight, paddingTopAndBottom, scrollHeigh
     return newNumberOfLines;
 }
 
-export default getNumberOfLines;
+/**
+ * Replace substring between selection with a text.
+ * @param {String} text
+ * @param {Object} selection
+ * @param {String} textToInsert
+ * @returns {String}
+ */
+function insertText(text, selection, textToInsert) {
+    return text.slice(0, selection.start) + textToInsert + text.slice(selection.end, text.length);
+}
+
+export {
+    getNumberOfLines,
+    insertText,
+};
diff --git a/src/libs/ComposerUtils/index.native.js b/src/libs/ComposerUtils/index.native.js
index 783fbac9a4..82c0d5191a 100644
--- a/src/libs/ComposerUtils/index.native.js
+++ b/src/libs/ComposerUtils/index.native.js
@@ -1,6 +1,7 @@
 import lodashGet from 'lodash/get';
 import styles from '../../styles/styles';
 import updateIsFullComposerAvailable from './updateIsFullComposerAvailable';
+import * as ComposerUtils from './index.js';
 
 /**
  * Get the current number of lines in the composer
@@ -32,7 +33,17 @@ function updateNumberOfLines(props, e) {
     updateIsFullComposerAvailable(props, numberOfLines);
 }
 
+/**
+ * Replace substring between selection with a text.
+ * @param {String} text
+ * @param {Object} selection
+ * @param {String} textToInsert
+ * @returns {String}
+ */
+const insertText = ComposerUtils.insertText;
+
 export {
     getNumberOfLines,
     updateNumberOfLines,
+    insertText,
 };
diff --git a/src/libs/ReportUtils.js b/src/libs/ReportUtils.js
index 4eb3e9b4d5..f35f2ceb77 100644
--- a/src/libs/ReportUtils.js
+++ b/src/libs/ReportUtils.js
@@ -1707,17 +1707,6 @@ function canLeaveRoom(report, isPolicyMember) {
     return true;
 }
 
-/**
- * Replace substring between selection with a text.
- * @param {String} text
- * @param {Object} selection
- * @param {String} textToInsert
- * @returns {String}
- */
-function insertText(text, selection, textToInsert) {
-    return text.slice(0, selection.start) + textToInsert + text.slice(selection.end, text.length);
-}
-
 export {
     getReportParticipantsTitle,
     isReportMessageAttachment,
@@ -1786,5 +1775,4 @@ export {
     getSmallSizeAvatar,
     getMoneyRequestOptions,
     canRequestMoney,
-    insertText,
 };
diff --git a/src/pages/home/report/ReportActionCompose/index.js b/src/pages/home/report/ReportActionCompose/index.js
index 1368305347..e5190bd9a3 100644
--- a/src/pages/home/report/ReportActionCompose/index.js
+++ b/src/pages/home/report/ReportActionCompose/index.js
@@ -52,6 +52,7 @@ import withKeyboardState, {keyboardStatePropTypes} from '../../../../components/
 import ArrowKeyFocusManager from '../../../../components/ArrowKeyFocusManager';
 import KeyboardShortcut from '../../../../libs/KeyboardShortcut';
 import KeyDownAction from './keyDownAction';
+import * as ComposerUtils from '../../../../libs/ComposerUtils';
 
 const propTypes = {
     /** Beta features list */
@@ -508,7 +509,7 @@ class ReportActionCompose extends React.Component {
                 end: prevState.selection.start + text.length,
             },
         }));
-        this.updateComment(ReportUtils.insertText(this.comment, this.state.selection, text));
+        this.updateComment(ComposerUtils.insertText(this.comment, this.state.selection, text));
     }
 
     /**
diff --git a/src/pages/home/report/ReportActionItemMessageEdit.js b/src/pages/home/report/ReportActionItemMessageEdit.js
index fc97e34f16..95f4caa724 100644
--- a/src/pages/home/report/ReportActionItemMessageEdit.js
+++ b/src/pages/home/report/ReportActionItemMessageEdit.js
@@ -27,6 +27,7 @@ import withWindowDimensions, {windowDimensionsPropTypes} from '../../../componen
 import withLocalize, {withLocalizePropTypes} from '../../../components/withLocalize';
 import withKeyboardState, {keyboardStatePropTypes} from '../../../components/withKeyboardState';
 import ONYXKEYS from '../../../ONYXKEYS';
+import * as ComposerUtils from '../../../libs/ComposerUtils';
 
 const propTypes = {
     /** All the data of the action */
@@ -235,7 +236,7 @@ class ReportActionItemMessageEdit extends React.Component {
                 end: prevState.selection.start + emoji.length,
             },
         }));
-        this.updateDraft(ReportUtils.insertText(this.state.draft, this.state.selection, emoji));
+        this.updateDraft(ComposerUtils.insertText(this.state.draft, this.state.selection, emoji));
     }
 
     /**

@cead22 @Santhosh-Sellavel what do you think?

@cead22
Copy link
Contributor

cead22 commented Apr 16, 2023

That works

@bernhardoj
Copy link
Contributor Author

Updated.

@bernhardoj
Copy link
Contributor Author

Solved.

cead22
cead22 previously approved these changes Apr 18, 2023
src/libs/ComposerUtils/updateNumberOfLines/index.js Outdated Show resolved Hide resolved
src/components/Composer/index.js Outdated Show resolved Hide resolved
@Santhosh-Sellavel
Copy link
Collaborator

Please resolve conflicts

@bernhardoj
Copy link
Contributor Author

Solved.

@cead22
Copy link
Contributor

cead22 commented Apr 19, 2023

Conflicts again 🥲

@bernhardoj
Copy link
Contributor Author

bernhardoj commented Apr 20, 2023

ReportActionCompose keeps getting update 🥲. Conflicts solved.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Apr 20, 2023

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 / Chrome
    • iOS / native
    • iOS / 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 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 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

Web & Desktop
Screen.Recording.2023-04-21.at.1.13.38.AM.mov
Mobile Web - Chrome & Mobile Web - Safari
Screen.Recording.2023-04-21.at.1.30.30.AM.mov
iOS & Android
Screen.Recording.2023-04-21.at.1.27.14.AM.mov

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Apr 20, 2023

@cead22 Looks good to me just one query
When do we add emojis using shorthand space required or not on all platforms?

cc: @bernhardoj

Copy link
Contributor

@cead22 cead22 left a comment

Choose a reason for hiding this comment

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

@Santhosh-Sellavel does the file/dir structure look good to you?

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Apr 20, 2023

Yes, looks good to me!

@Santhosh-Sellavel
Copy link
Collaborator

@cead22 Looks good to me just one query When do we add emojis using shorthand space required or not on all platforms?

cc: @bernhardoj

@cead22 Whats expected in this case?

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

Tests are passing & code LGTM!

Only one query, If the space is expected to add while adding emoji via shorthand we are good to go other wise need to fix that here, thanks!

cc: @bernhardoj @cead22

@bernhardoj
Copy link
Contributor Author

bernhardoj commented Apr 21, 2023

@Santhosh-Sellavel Based on the slack discussion https://expensify.slack.com/archives/C01GTK53T8Q/p1668009281985659?thread_ts=1667208968.300839&cid=C01GTK53T8Q, if we add emoji by :smile:, space will be added on mobile only

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

LGTM as per this thread thanks!

All yours @cead22!

@cead22 cead22 merged commit 6df1b8f into Expensify:main Apr 21, 2023
@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/cead22 in version: 1.3.4-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.4-0 🚀

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

},
}));
this.updateComment(newComment);
this.updateComment(ComposerUtils.insertText(this.comment, this.state.selection, emoji));
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi, coming from #18515. This PR raise regression Emoji gets added in between the text when selecting text and adding new emoji by search and entering.

The this.state.selection we pass should be the state before it gets updated, it's due to the state update may be asynchronous.

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