Skip to content

Conversation

@c3024
Copy link
Contributor

@c3024 c3024 commented Mar 28, 2025

Explanation of Change

This PR implements Custom Emojis using the Private User Area Unicodes. This is part of #54643 implementation in which we add a custom emoji font containing :global_create: emoji. Two fonts CustomEmojiWebFont.ttx and CustomEmojiNativeFont.ttx are created with private user area codes allotted to different SVGs with nanoemoji. The fonts are added as per this document.

Emoji regex was updated on expensify-common. Hybrid [PR]https://github.com/Expensify/Mobile-Expensify/pull/13570) for adding these fonts here.

Fixed Issues

$ #54643
PROPOSAL: https://expensify.slack.com/archives/C07HPDRELLD/p1742914747461099?thread_ts=1742275825.663609&cid=C07HPDRELLD

MOBILE-EXPENSIFY: https://github.com/Expensify/Mobile-Expensify/pull/13570

Tests

  1. Enter :global in the composer.
  2. Verify that the suggestions show global_create (FAB) emoji.
  3. Enter :global_create: in the composer.
  4. Verify that it changes to FAB emoji.
  5. Send a message with only this emoji :global_create: and this emoji with some text.
  6. Verify that the behaviour of custom emojis in these sent messages, and LHN are same as that of regular emojis.
  • Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Same as Tests

  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 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 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.ts 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 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
globalCreateAndroid.mov
Android: mWeb Chrome
globalCreateAndroidmWeb.mov
iOS: Native
globalCreateiOS.mov
customEmojiiOS.mov
iOS: mWeb Safari
globalCreateiOSmWeb.mov
MacOS: Chrome / Safari
globalCreateChrome.mov
Screenshot 2025-04-15 at 11 19 52 PM
MacOS: Desktop
globalCreateDesktop.mov

@github-actions
Copy link
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@github-actions
Copy link
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@github-actions
Copy link
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@c3024 c3024 changed the title Add unicode custom emojis Add Custom Emojis with Private User Area Mar 28, 2025
@github-actions
Copy link
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

1 similar comment
@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@c3024 c3024 force-pushed the add-Unicode-custom-emojis branch from e95f08a to 0aa1640 Compare April 6, 2025 12:50
@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@grgia
Copy link
Contributor

grgia commented Jul 8, 2025

@eVoloshchak would you please do a final review 🙇

@eVoloshchak
Copy link
Contributor

@c3024, we call containsCustomEmoji function for every comment and every OptionRow. I wonder what are the performance implications of that
We do it only to apply custom styles for the custom font, is that right?
Might there be something wrong with the font if we don't need the same custom styles for other fonts? Can we apply those custom styles in the font itself so we don't rely on containsCustomEmoji function?

@c3024
Copy link
Contributor Author

c3024 commented Jul 9, 2025

@eVoloshchak

we call containsCustomEmoji function for every comment and every OptionRow. I wonder what are the performance implications of that

I’ve looked into this, and from what I found and understood, it’s not a problem. The regex is lightweight and the check should be performant. I haven’t seen any issues during testing on high-traffic accounts. That said, I also pushed changes to memoize the usage to avoid unnecessary repeated calls.

We do it only to apply custom styles for the custom font, is that right?

The existing fonts in the app don’t include emojis, and standard emojis are rendered natively by the platform. Including the custom emojis directly in the existing fonts could have avoided this additional styling, but we decided to avoid that approach.

On native platforms, a specific font must be applied to text—fallbacks don’t work. So we need to explicitly apply the custom font only to the custom emojis. If we applied this font to all strings, non-emoji text would fall back to the system font, which would break our styles.

I don’t think there’s anything wrong with the custom font itself, and we can’t embed these conditional styles directly into the font.

@eVoloshchak
Copy link
Contributor

and we can’t embed these conditional styles directly into the font.

Fair enough, thank you for the clarification

The new font isn't displayed in Safari

Simulator Screenshot - iPhone 15 Pro - 2025-07-09 at 14 25 17

or on Native iOS

Simulator Screenshot - iPhone 15 Pro - 2025-07-09 at 14 36 09

@c3024
Copy link
Contributor Author

c3024 commented Jul 9, 2025

It shows correctly on iOS Safari for me.

image

@c3024
Copy link
Contributor Author

c3024 commented Jul 9, 2025

On iOS too.

image

@eVoloshchak

Are you checking with the latest Adhoc build?

@eVoloshchak
Copy link
Contributor

@c3024, could you check this in a phone simulator too?
And which iOS version are you testing? Mine is 17.0, but I don't think that should make any difference

@c3024
Copy link
Contributor Author

c3024 commented Jul 9, 2025

iPad OS 18.3.2

@c3024
Copy link
Contributor Author

c3024 commented Jul 9, 2025

On simulator

Screenshot 2025-07-09 at 6 28 55 PM

@grgia
Copy link
Contributor

grgia commented Jul 9, 2025

Approving, but will wait on @eVoloshchak's confirmation

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

Don't see this bug on a physical device, but it's definitely there on a Simulator, which is weird.
Approving as it works as expected on a real device

@melvin-bot melvin-bot bot requested a review from roryabraham July 9, 2025 16:40
@grgia
Copy link
Contributor

grgia commented Jul 10, 2025

Gonna merge these then! Great work on this @c3024 and thank you for thoroughly testing this @eVoloshchak

@grgia grgia merged commit af422c7 into Expensify:main Jul 10, 2025
26 of 27 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.

@github-actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/grgia in version: 9.1.80-0 🚀

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

@nlemma
Copy link

nlemma commented Jul 11, 2025

@c3024 This PR is failing with this issue.

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.1.80-8 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 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.

10 participants