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 and fix regression #37814

Merged
merged 19 commits into from
Mar 21, 2024

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Mar 6, 2024

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
  7. Change the language to Spanish and hover over the emoji again
  8. Verify that the emoji name is updated correctly with Spanish language
  • 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 the three cases above, hover over the emoji and verify that the emoji tooltip appears with the correct emoji and emoji name
  7. Change the language to Spanish and hover over the emoji again
  8. Verify that the emoji name is updated correctly with Spanish language
  • 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

Comment on lines 61 to 63
if (styleAsMuted) {
htmlWithTag = `<muted-text>${htmlWithTag}<muted-text>`;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's keep this block.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated this. I'm updating to fix the case emoji inside codeblock, will open the PR after I fix this case.

@dukenv0307 dukenv0307 marked this pull request as ready for review March 13, 2024 09:28
@dukenv0307 dukenv0307 requested a review from a team as a code owner March 13, 2024 09:28
@melvin-bot melvin-bot bot requested review from fedirjh and removed request for a team March 13, 2024 09:28
Copy link

melvin-bot bot commented Mar 13, 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]

@BartoszGrajdek
Copy link
Contributor

BartoszGrajdek commented Mar 15, 2024

@fedirjh kind bump 😄 - until this is merged we are blocked on one of our PRs in live-markdown

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 is needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is my mistake. Reverted this.


// Create a temporary solution to display when there are emojis in the inline code block
// We can remove this after https://github.com/Expensify/App/issues/14676 is fixed
export default function removeEmojiTag(defaultRendererProps: TDefaultRendererProps<TTextOrTPhrasing>): string {
Copy link
Contributor

Choose a reason for hiding this comment

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

How does this remove the emoji tag?

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 If data field of tnode is undefined, it means we have emoji tag inside inline codeblock and the text is divided into children data. So we can get the current text by merging the children data, this is correct because other tags will not appear inside inline codeblock except emoji tag.

I think we can rename this function to getCurrentData or getCurrentText

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, it makes sense to rename it.

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 the name of function.

@fedirjh
Copy link
Contributor

fedirjh commented Mar 15, 2024

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
CleanShot.2024-03-15.at.17.36.28.mp4
Screenshot 2024-03-15 at 5 36 23 PM
Android: mWeb Chrome Screenshot 2024-03-15 at 5 39 19 PM
iOS: Native Screenshot 2024-03-15 at 5 13 19 PM Screenshot 2024-03-15 at 5 15 03 PM
Simulator.Screen.Recording.-.iPhone.Xs.-.2024-03-15.at.17.18.23.mp4
iOS: mWeb Safari Screenshot 2024-03-15 at 4 40 37 PM
Simulator.Screen.Recording.-.iPhone.Xs.-.2024-03-15.at.16.41.09.mp4
MacOS: Chrome / Safari
CleanShot.2024-03-15.at.16.24.10.mp4
Screenshot 2024-03-15 at 4 23 53 PM
MacOS: Desktop
CleanShot.2024-03-15.at.17.41.32.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.

@dukenv0307 let's bump the expensify-common as well in this PR.


// Create a temporary solution to display when there are emojis in the inline code block
// We can remove this after https://github.com/Expensify/App/issues/14676 is fixed
export default function removeEmojiTag(defaultRendererProps: TDefaultRendererProps<TTextOrTPhrasing>): string {
Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, it makes sense to rename it.

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Mar 18, 2024

@dukenv0307 let's bump the expensify-common as well in this PR.

@fedirjh Expensify/expensify-common#664, The previous PR is reverted so I created another one here.

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Mar 18, 2024

@fedirjh As suggestion here Expensify/expensify-common#664 (comment), I update the version of expensify-common to the commit hash of the PR above for testing.

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 and tests well.

@stitesExpensify
Copy link
Contributor

Are there negative consequences of merging the expensify-common lib and not merging this? Just wondering how close our timing needs to be

@stitesExpensify
Copy link
Contributor

@dukenv0307 If you are around now I can merge the common PR and then you can update and I will merge immediately. Ping me on slack if you have time.

@fedirjh
Copy link
Contributor

fedirjh commented Mar 20, 2024

Are there negative consequences of merging the expensify-common lib and not merging this?

If the expensify-common lib PR gets merged and bumped in the App without this PR, then it will cause some regressions until this PR is merged.

@stitesExpensify stitesExpensify changed the title Handle emoji tooltip and fix regression [HOLD https://github.com/Expensify/expensify-common/pull/664Handle emoji tooltip and fix regression Mar 21, 2024
@stitesExpensify stitesExpensify changed the title [HOLD https://github.com/Expensify/expensify-common/pull/664Handle emoji tooltip and fix regression [HOLD https://github.com/Expensify/expensify-common/pull/664] Handle emoji tooltip and fix regression Mar 21, 2024
@stitesExpensify stitesExpensify changed the title [HOLD https://github.com/Expensify/expensify-common/pull/664] Handle emoji tooltip and fix regression Handle emoji tooltip and fix regression Mar 21, 2024
@stitesExpensify stitesExpensify merged commit 106c367 into Expensify:main Mar 21, 2024
18 checks passed
@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.

@situchan
Copy link
Contributor

Just to note that this PR skipped testing other changes that the version bump of expensify-common involves.
But never mind. We safely tested in other PR - #37566 (comment).
In the future, please make sure to test all changes. (you can always ask help from PR authors if they are unrelated to your change)

@OSBotify
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.56-8 🚀

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

@sobitneupane
Copy link
Contributor

It seems that the issue #49053 may have been overlooked in this PR.

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.

7 participants