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

Fix broken emoji (Safari, Firefox) #9551

Merged
merged 16 commits into from
Aug 25, 2022
Merged

Fix broken emoji (Safari, Firefox) #9551

merged 16 commits into from
Aug 25, 2022

Conversation

thesahindia
Copy link
Member

@thesahindia thesahindia commented Jun 23, 2022

Details

This PR fixes two issues -

  • Broken emoji ui at default skin tone selector (safari)

Screenshot 2022-06-28 at 7 59 10 PM

  • Black outlined emoji in Firefox (ubuntu/windows)

Screenshot 2022-06-28 at 7 58 17 PM

Fixed Issues

$ #9123

Tests

  1. Open Expensify at Safari
  2. Open emoji picker menu
  3. Select a skin tone (other than default yellow)
  4. Verify the hand emoji isn't broken

  1. Open Expensify at FireFox (windows/Ubuntu)
  2. Open emoji picker menu
  3. Verify the hand emoji is colored (not black and white)

  1. Open Expensify at FireFox (windows/Ubuntu)
  2. Add hand emoji (🖐) to the message composer
  3. Add hand emoji to the edit comment composer
  4. Verify the hand emoji is colored (not black and white)

  1. Open Expensify at FireFox (windows/Ubuntu)
  2. Send hand emoji (🖐)
  3. Send hand emoji with some text
  4. Send hand emoji with some link
  5. Verify the hand emoji is colored (not black and white) in all the messages
  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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
  • 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 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.

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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 */
    • Any functional components have the displayName property
    • 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 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 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.

QA Steps

  1. Open Expensify at Safari
  2. Open emoji picker menu
  3. Select a skin tone (other than default yellow)
  4. Verify the hand emoji isn't broken

  1. Open Expensify at FireFox (windows/Ubuntu)
  2. Open emoji picker menu
  3. Verify the hand emoji is colored (not black and white)

  1. Open Expensify at FireFox (windows/Ubuntu)
  2. Add hand emoji (🖐) to the message composer
  3. Add hand emoji to the edit comment composer
  4. Verify the hand emoji is colored (not black and white)

  1. Open Expensify at FireFox (windows/Ubuntu)
  2. Send hand emoji (🖐)
  3. Send hand emoji with some text
  4. Send hand emoji with some link
  5. Verify the hand emoji is colored (not black and white) in all the messages
  • Verify that no errors appear in the JS console

Screenshots

Web

Screenshot 2022-06-28 at 8 12 25 PM

Mobile Web

Screenshot 2022-06-28 at 8 11 40 PM

Desktop

Screenshot 2022-06-28 at 8 18 45 PM

iOS

Screenshot 2022-06-28 at 8 11 06 PM

Android

Screenshot 2022-06-28 at 8 10 36 PM

@thesahindia thesahindia changed the title Thesahindia/fix broken emoji Fix broken emoji (Safari, Firefox) Jun 23, 2022
@thesahindia thesahindia marked this pull request as ready for review June 28, 2022 15:00
@thesahindia thesahindia requested a review from a team as a code owner June 28, 2022 15:00
@melvin-bot melvin-bot bot requested review from Beamanator and parasharrajat and removed request for a team June 28, 2022 15:00
@thesahindia
Copy link
Member Author

Made the requested changes.
cc: @parasharrajat

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

The big issue: Emojis are different on messages than the picker.
image

try these emojies.

Picker
image

@thesahindia
Copy link
Member Author

Will look into it.

@thesahindia
Copy link
Member Author

thesahindia commented Jul 7, 2022

We can see this issue on composer too and to fix that we will have to use the fallback fonts.
For the messages we can add the font here -

style={EmojiUtils.containsOnlyEmojis(props.fragment.text) ? styles.onlyEmojisText : undefined}

And for composer here -
fontFamily: fontFamily.GTA,

But we have one case where it doesn't work.
We use RenderHTML for messages that contain link or code blocks, If I am not wrong for styles we pass baseFontStyle here

baseStyle={styles.webViewStyles.baseFontStyle}

App/src/styles/styles.js

Lines 133 to 136 in eb54f23

baseFontStyle: {
color: themeColors.text,
fontSize: variables.fontSizeNormal,
fontFamily: fontFamily.GTA,

If we try to add the fallback fonts in baseFontStyle it doesn't work.

@parasharrajat
Copy link
Member

How are you passing the fallback fonts?

@thesahindia
Copy link
Member Author

@parasharrajat, I tried using ${fontFamily.GTA}, ${fontFamily.EMOJI_TEXT_FONT} on line 136

App/src/styles/styles.js

Lines 133 to 136 in eb54f23

baseFontStyle: {
color: themeColors.text,
fontSize: variables.fontSizeNormal,
fontFamily: fontFamily.GTA,

but it didn't work. I also tried applying only fontFamily.EMOJI_TEXT_FONT ( contains two fonts ) and it also failed.
It only works when only one font is used.

@parasharrajat
Copy link
Member

Which platform has issues? Could you please share some videos of where it worked including the fix and before the fix?

@thesahindia
Copy link
Member Author

thesahindia commented Jul 11, 2022

It isn't platform specific. The issue is that if we use two fonts at line 136, only the first font gets applied.

App/src/styles/styles.js

Lines 133 to 136 in eb54f23

baseFontStyle: {
color: themeColors.text,
fontSize: variables.fontSizeNormal,
fontFamily: fontFamily.GTA,

For example if you try using ${fontFamily.MONOSPACE}, ${fontFamily.GTA}, only MONOSPACE font will get applied.
To check this try sending a link with some message, the font will be GTAmericaExpMono-Rg

Screen.Recording.2022-07-11.at.11.40.50.PM.mov

@thesahindia
Copy link
Member Author

Asked for the help on slack. Here's the thread.

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

Will test it soon.

@Beamanator
Copy link
Contributor

Bump?

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

Good work, it is working great.
The only difference is that emoji rendered on each platform has different styles which are expected as we are using native Unicode chars that depend on the platform.

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

A few little comments, overall looking fantastic

@thesahindia
Copy link
Member Author

A few little comments, overall looking fantastic

Will make the changes in 2-3 days.
Visiting family :)

@Beamanator
Copy link
Contributor

@thesahindia thanks for making the requested changes 7 days ago, would you please tag us when this is ready for review again so we don't delay so long? :D

Also since it has been 7 days since your last commit, would you please merge main & test again to make sure there's no regressions?

@parasharrajat
Copy link
Member

Also, it is now mandatory to complete the checklist even though things don't apply. Thus just check the non-applicable items off.

@thesahindia
Copy link
Member Author

Done 🚀
cc: @parasharrajat @Beamanator

parasharrajat
parasharrajat previously approved these changes Aug 24, 2022
Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

Just a small suggestion.

cc: @Beamanator

PR 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

🎀 👀 🎀 C+ reviewed

Co-authored-by: Rajat Parashar <[email protected]>
@thesahindia
Copy link
Member Author

@Beamanator It's ready for the review now.

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Let's get this merged :D

@Beamanator Beamanator merged commit a076572 into Expensify:main Aug 25, 2022
@melvin-bot
Copy link

melvin-bot bot commented Aug 25, 2022

@Beamanator looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@melvin-bot melvin-bot bot added the Emergency label Aug 25, 2022
@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.

@Beamanator
Copy link
Contributor

Uhh not emergency, all tests were passing 🤔 I don't believe there were any failing tests when this was merged

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @Beamanator in version: 1.1.90-0 🚀

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.

4 participants