Handle emoji tooltip

[dukenv0307]

Details

Display a tooltip when hovering over emoji in report action

Fixed Issues

$ https://github.com/Expensify/App/issues/34307 PROPOSAL: https://github.com/Expensify/App/issues/34307#issuecomment-1886072144

Tests

1. Send a message containing only emoji
2. Verify that the font size of emoji is big
3. Send a message containing only emoji and text, not contain any markdown
4. Verify that the font size of emoji is smaller
5. Send a message with emoji and any markdown
6. For the three cases above, hover over the emoji and verify that the emoji tooltip appears with the correct emoji and emoji name

• [x] Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

1. Send a message containing only emoji
2. Verify that the font size of emoji is big
3. Send a message containing only emoji and text, not contain any markdown
4. Verify that the font size of emoji is smaller
5. Send a message with emoji and any markdown
6. For three cases above, hover over the emoji and verify that the emoji tooltip appears with the correct emoji and emoji name

• [x] Verify that no errors appear in the JS console

PR Author Checklist

• [x] I linked the correct issue in the ### Fixed Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] I added steps for the expected offline behavior in the Offline steps section
  • [x] I added steps for Staging and/or Production testing in the QA steps section
  • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [x] 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)
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] 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:
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] If the PR modifies the form input styles:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label so the design team can review the changes.
• [x] 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.
• [x] If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

https://github.com/Expensify/App/assets/129500732/64beafad-4485-416b-9168-9038c75e4782

iOS: Native

iOS: mWeb Safari

https://github.com/Expensify/App/assets/129500732/b17d2228-b1ce-4c78-bfaf-843da38901bd

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/129500732/04bb4f7f-472b-4d2f-a3fe-149413f07109

MacOS: Desktop

https://github.com/Expensify/App/assets/129500732/de46358f-3453-4ef8-a7d6-3abeb59dd92f

[melvin-bot[bot]]

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

[dukenv0307]

@fedirjh My Android and IOS simulator don't work now. Please help me to test on these platforms.

[dukenv0307]

~Just add a note: Because BE change isn't complete, we should test in offline mode~

We can completely test now.

[fedirjh]

@dukenv0307 Could you please merge main ? Thank you

[dukenv0307]

@fedirjh I updated.

[fedirjh]

@dukenv0307 Was the expensify-common bumped to introduce this PR? Because the message sent to the server doesn’t include the new emoji tags

Because BE change isn't complete

This is already live as per this comment https://expensify.slack.com/archives/C01GTK53T8Q/p1707153064290739?thread_ts=1706851954.228519&cid=C01GTK53T8Q

[dukenv0307]

Was the expensify-common bumped to introduce this https://github.com/Expensify/expensify-common/pull/640

When I tested it locally, it was not. I need to hard code in ExpensifyMark.js to add emoji rule.

[dukenv0307]

{ name: 'emoji', regex: CONST.REG_EXP.EMOJIS, replacement: match => <emoji>${match}</emoji> },

Can you please hard code with this to test locally?

[dukenv0307]

This is already live as per this comment

Cool, I didn't realize this when creating the PR.

[fedirjh]

We have to bump expensify-common in this PR.

[dukenv0307]

@fedirjh Bumped the expensify-common version.

[dukenv0307]

https://github.com/Expensify/App/pull/35838#issuecomment-1928650429

[quinthar]

Hi! Who is this waiting on, what are they doing, and when will it be done?

[fedirjh]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [x] 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)
• [x] I checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (see Reviewing the code)
  • [x] 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).
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] If the PR modifies the form input styles:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label so the design team can review the changes.
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/36869046/da45070d-dd1f-4ded-872a-36861f3b899b

Android: mWeb Chrome

iOS: Native

https://github.com/Expensify/App/assets/36869046/0c180479-ce05-431a-bb85-ee02c49d4596

iOS: mWeb Safari

https://github.com/Expensify/App/assets/36869046/2c55429a-bd69-48df-9e8b-3c4bec303228

MacOS: Chrome / Safari

MacOS: Desktop

[fedirjh]

cc @dukenv0307 @stitesExpensify I believe the backend changes have not been deployed yet?. The frontend is successfully sending the data, but the backend is returning stripped data.

Request	Response

---

@quinthar @stitesExpensify It appears that we are facing a limitation with the current approach regarding emojis. Emojis sent before this PR are saved in raw format without the <emoji> tag, preventing the tooltip from functioning correctly. To address this issue, we should decide on a solution:

1. Execute a backend migration to update all emojis to utilize the new tag. (Please confirm if this is feasible)

Or

2. Implement a frontend fix: pre-process the HTML message part and replace all emojis with the new <emoji> tag.

[stitesExpensify]

@fedirjh I think that we should do nothing with regards to emojis sent before this change. They just won't work for hover, but I think that is fine IMO, we should just start doing it moving forwards

[stitesExpensify]

I believe the backend changes have not been deployed yet?. The frontend is successfully sending the data, but the backend is returning stripped data.

I will look into this, the backend PR has been deployed to production so something else must be going on

[dukenv0307]

@fedirjh I updated.

[dukenv0307]

@fedirjh Any update here.

[stitesExpensify]

Okay I have another backend PR up to stop stripping the tags. 2 other things that can be worked on in the mean time:

1. Composite emojis like 😶‍🌫️ are actually made up of 3 different emojis as you can see in the first screenshot. This is causing a bug where we are adding the tags like this test<emoji>😶</emoji><emoji>‍</emoji><emoji>🌫</emoji><emoji>️</emoji>. This also causes the hover to be incorrect.
2. Can we please change the mouse type to a regular pointer like slack does when hovering emojis?

[stitesExpensify]

[dukenv0307]

@stitesExpensify Fixed two cases above now. Waiting for https://github.com/Expensify/expensify-common/pull/649 is merged so we can bump the new version.

https://github.com/Expensify/App/assets/129500732/433fe2da-8689-4905-8bc9-8f74bd36e369

[stitesExpensify]

@dukenv0307 now that the common pr is merged, are we good to go here?

[dukenv0307]

@fedirjh @stitesExpensify Updated version of expensify-common here. Please help to review again when we have a chance.

[dukenv0307]

Tested online and seems like the BE change is also complete. We're good to go now.

[dukenv0307]

@fedirjh Thanks for your great solution, I updated this and tested.

[fedirjh]

Bug: Large Emoji is cut off at the top when the comment is edited

https://github.com/Expensify/App/assets/36869046/1439d4c1-c987-4275-bac9-1b6e5e8a0da5

[fedirjh]

@dukenv0307 To address the last bug, I think we can explore creating a separate version of TextCommentFragment for native, as for native, we can just use the text source of the comment.

[fedirjh]

Both bugs were fixed 🚀

Deleted	Edited

[fedirjh]

On web: bug was fixed also 🚀

https://github.com/Expensify/App/assets/36869046/b29bb823-dad8-448a-b099-178becf9e6f4