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

Handle emoji tooltip #35838

Merged
merged 35 commits into from
Mar 4, 2024
Merged

Handle emoji tooltip #35838

merged 35 commits into from
Mar 4, 2024

Conversation

dukenv0307
Copy link
Contributor

Details

Display a tooltip when hovering over emoji in report action

Fixed Issues

$ #34307
PROPOSAL: #34307 (comment)

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

Screenshots/Videos

Android: Native
Android: mWeb Chrome
Screen.Recording.2024-02-05.at.23.41.52.mov
iOS: Native
iOS: mWeb Safari
Screen.Recording.2024-02-05.at.23.40.44.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-05.at.23.38.47.mov
MacOS: Desktop
Screen.Recording.2024-02-05.at.23.46.52.mov

@dukenv0307 dukenv0307 marked this pull request as ready for review February 5, 2024 16:55
@dukenv0307 dukenv0307 requested a review from a team as a code owner February 5, 2024 16:55
@melvin-bot melvin-bot bot requested review from fedirjh and removed request for a team February 5, 2024 16:55
Copy link

melvin-bot bot commented Feb 5, 2024

@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
Copy link
Contributor Author

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

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

Please help me to test on these platforms.

@dukenv0307 Sure.

Comment on lines 743 to 747
!_.isUndefined(props.draftMessage)
? null
: props.action.pendingAction ||
(props.action.isOptimisticAction ? CONST.RED_BRICK_ROAD_PENDING_ACTION.ADD : '') ||
lodashGet(props, 'iouReport.pendingFields.preview')
Copy link
Contributor

Choose a reason for hiding this comment

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

why this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Missed restoring some changes to test locally.

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Feb 6, 2024

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

We can completely test now.

@fedirjh
Copy link
Contributor

fedirjh commented Feb 6, 2024

@dukenv0307 Could you please merge main ? Thank you

@dukenv0307
Copy link
Contributor Author

@fedirjh I updated.

@fedirjh
Copy link
Contributor

fedirjh commented Feb 6, 2024

@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
Copy link
Contributor Author

Was the expensify-common bumped to introduce this Expensify/expensify-common#640

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

@dukenv0307
Copy link
Contributor Author

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

Can you please hard code with this to test locally?

@dukenv0307
Copy link
Contributor Author

This is already live as per this comment

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

@fedirjh
Copy link
Contributor

fedirjh commented Feb 6, 2024

We have to bump expensify-common in this PR.

@dukenv0307
Copy link
Contributor Author

@fedirjh Bumped the expensify-common version.

@dukenv0307
Copy link
Contributor Author

#35838 (comment)

@dukenv0307
Copy link
Contributor Author

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

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

Looks good. Found a little bug with offline feedback style. Left a simpler solution to address it.

const htmlContent = styleAsDeleted ? `<del>${html}</del>` : html;
const htmlWithDeletedTag = styleAsDeleted ? `<del>${html}</del>` : html;

const containsOnlyEmojis = EmojiUtils.containsOnlyEmojis(text);
Copy link
Contributor

Choose a reason for hiding this comment

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

@dukenv0307 I got a little bug with offline feedback (deleted action); when a comment that only contains emojis is deleted in offline mode, the style is not applied correctly :

current expected
Screenshot 2024-02-26 at 6 14 22 PM Screenshot 2024-02-26 at 6 14 37 PM

I think the simplest solution in this case is to use the text source of the comment when it's pending deletion, it will fix the style issue, but it will not render the tooltip. I think that's fine since this comment will be deleted anyway. cc @stitesExpensify what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

@dukenv0307 Have you got a chance to look at this one? I think this is a blocker for this PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

The changes that should fix this one are suggested here #35838 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I saw that and I'm waiting @stitesExpensify for confirming this.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that we can ignore this for now. I am creating a new issue to prevent markdown from affecting emojis as a whole, so this will be fixed in the future in a different way

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@fedirjh Updated this case.

const htmlContent = styleAsDeleted ? `<del>${html}</del>` : html;
const htmlWithDeletedTag = styleAsDeleted ? `<del>${html}</del>` : html;

const containsOnlyEmojis = EmojiUtils.containsOnlyEmojis(text);
Copy link
Contributor

@fedirjh fedirjh Feb 26, 2024

Choose a reason for hiding this comment

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

We should move this to the top to avoid code duplication

@@ -52,7 +52,10 @@ function TextCommentFragment({fragment, styleAsDeleted, source, style, displayAs
// Only render HTML if we have html in the fragment
if (!differByLineBreaksOnly) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if (!differByLineBreaksOnly) {
if (!differByLineBreaksOnly && !(containsOnlyEmojis && styleAsDeleted)) {

This change should fix the offline style , we just need to move containsOnlyEmojis to the top.

@fedirjh
Copy link
Contributor

fedirjh commented Feb 26, 2024

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

CleanShot.2024-02-26.at.19.20.44.mp4

@fedirjh
Copy link
Contributor

fedirjh commented Feb 26, 2024

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Create a new directory shouldRenderAsText and add index.native.ts, index.ts and types.ts

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated.

const htmlContent = styleAsDeleted ? `<del>${html}</del>` : html;
const htmlWithDeletedTag = styleAsDeleted ? `<del>${html}</del>` : html;

const containsOnlyEmojis = EmojiUtils.containsOnlyEmojis(text);
Copy link
Contributor

Choose a reason for hiding this comment

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

@dukenv0307 Have you got a chance to look at this one? I think this is a blocker for this PR.

@fedirjh
Copy link
Contributor

fedirjh commented Feb 28, 2024

Both bugs were fixed 🚀

Deleted Edited
Screenshot 2024-02-28 at 7 09 13 AM Screenshot 2024-02-28 at 7 08 36 AM

@fedirjh
Copy link
Contributor

fedirjh commented Feb 28, 2024

On web: bug was fixed also 🚀

CleanShot.2024-02-28.at.07.29.12.mp4

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

Looks good to me and tests well, over to you @stitesExpensify

@stitesExpensify
Copy link
Contributor

Changes look good but there are conflicts :( Just a quick package change and we should be good to go!

@dukenv0307
Copy link
Contributor Author

@stitesExpensify I merged main and resolved the conflict.

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

LGTM!

@stitesExpensify stitesExpensify merged commit 061e432 into Expensify:main Mar 4, 2024
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Mar 4, 2024

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.4.47-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.47-10 🚀

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

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.

5 participants