Use Font XML resources and standardise font usage on native platforms #41115

fabioh8010 · 2024-04-26T19:26:47Z

Details

This PR standartise and improve font usage across the entire project.

Native platforms will now consume the fonts in the same way with a combination of fontFamily, fontStyle and fontWeight.
Android will now use Font XML resources to make possible the point above.
All files under src/styles/utils/FontUtils were refactored and simplified to standartise the font usage in E/App.

We will be using the @react-native-community/cli-link-assets tool to manage font assets in the native platforms, as part of this effort to implement it into the RN CLI.

Relevant links/discussions in chronological order:

Fixed Issues

$ #13772
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Full regression test to ensure fonts are correctly applied.

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Full regression test to ensure fonts are correctly applied.

PR Author Checklist

Screenshots/Videos

Android: Native

android-compressed.mov

Android: mWeb Chrome

android.chrome-compressed.mov

iOS: Native

ios-compressed.mov

iOS: mWeb Safari

ios.safari-compressed.mov

MacOS: Chrome / Safari

web.chrome-compressed.mov

web.safari-compressed.mov

MacOS: Desktop

desktop-compressed.mov

melvin-bot · 2024-05-07T18:12:21Z

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

dubielzyk-expensify · 2024-05-10T04:11:29Z

I assume there's no visual changes as part of this? As in before vs after all look the same? Can we perhaps just get a double check on that? Wanna make sure line heights and everything is good :)

roryabraham · 2024-05-10T06:23:18Z

No visual changes intended, no

fabioh8010 · 2024-05-10T08:45:47Z

Exactly, after this PR everything is supposed to be the same.

src/styles/utils/FontUtils/fontFamily/singleFontFamily/index.ts

roryabraham

@fabioh8010 can you also add some documentation to describe how our fonts are set up and how to change or update any fonts using the new CLI method?

src/styles/utils/FontUtils/index.ts

fabioh8010 · 2024-05-14T11:32:59Z

Update: Improved the refactors to unify native and web to use the same font family naming, did the same for ExpensifyHelp docs and Storybook, and did other minor improvements / fixes.

What's left to do:

Update PR's description to be more descriptive
Add docs for Fonts management on E/App
Add comments to explain difference between platform, single and multi fonts.

roryabraham · 2024-05-15T20:48:18Z

@fabioh8010 I'm marking this as WIP until you think it's ready for final review

fabioh8010 · 2024-07-02T10:34:24Z

@roryabraham Kind bump 🙂

roryabraham

Otherwise LGTM 👍🏼

@mollfpr back to you

roryabraham · 2024-07-09T18:05:43Z

src/styles/utils/FontUtils/fontFamily/singleFontFamily/index.ts

We did we move this from src/styles/utils/FontUtils/fontFamily/singleFontFamily.ts to src/styles/utils/FontUtils/fontFamily/singleFontFamily/index.ts, given that the singleFontFamily directory contains only one index.ts file?

I just wanted to match with multiFontFamily structure, which also has the folder.

fabioh8010 · 2024-07-15T15:43:44Z

@mollfpr kindly bump

fabioh8010 · 2024-07-19T15:56:49Z

@mollfpr bump

mollfpr · 2024-07-19T15:57:50Z

Checking 👀

mollfpr

Looks good to me!

We also need to update the font for storybook theme.

App/.storybook/theme.ts

Line 9 in f3a8f73

fontBase: 'ExpensifyNeue-Regular',

fabioh8010 · 2024-07-22T09:44:07Z

Looks good to me!

We also need to update the font for storybook theme.

App/.storybook/theme.ts

Line 9 in f3a8f73

fontBase: 'ExpensifyNeue-Regular',

@mollfpr Good catch! I've applied the fix, please have another look

mollfpr · 2024-07-22T19:10:23Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

mollfpr

LGTM 👍

fabioh8010 · 2024-07-25T15:39:14Z

@roryabraham bump 😄

roryabraham · 2024-07-25T19:59:58Z

skipping further design review here since the goal was no visible changes, and we used a full regression suite on an AdHoc build to try and accomplish that.

OSBotify · 2024-07-25T20:10:57Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-07-26T05:35:41Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.0.13-0 🚀

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

kavimuru · 2024-07-26T11:21:32Z

@roryabraham Do we have specific QA steps?

roryabraham · 2024-07-27T16:57:30Z

Not really, just be on the lookout for broken fonts. Looks like tester found one issue which was already fixed

OSBotify · 2024-07-29T18:39:17Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.13-4 🚀

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

fabioh8010 added 3 commits April 26, 2024 18:12

Link assets with Font XML resources

6839328

Remove duplicated fonts

36e3972

Refactor all usages of fontFamily

a750d10

fabioh8010 mentioned this pull request Apr 26, 2024

[HOLD for payment 2024-08-05] [$1000] Standardize on single fontFamily names across platforms #13772

Closed

fabioh8010 added 5 commits May 7, 2024 13:32

Merge branch 'main' into feature/link-assets-v2

4316e5c

Fix styles

a0afca4

Fix fonts cross-compatibilities

0254d54

Merge remote-tracking branch 'origin/main' into feature/link-assets-v2

94ea305

Fix tests

4775ecb

fabioh8010 marked this pull request as ready for review May 7, 2024 18:12

fabioh8010 requested review from a team as code owners May 7, 2024 18:12

melvin-bot bot requested review from mollfpr and removed request for a team May 7, 2024 18:12

roryabraham self-requested a review May 9, 2024 01:39

roryabraham reviewed May 10, 2024

View reviewed changes

src/styles/utils/FontUtils/fontFamily/singleFontFamily/index.ts Outdated Show resolved Hide resolved

roryabraham reviewed May 10, 2024

View reviewed changes

src/styles/utils/FontUtils/index.ts Show resolved Hide resolved

fabioh8010 added 5 commits May 13, 2024 15:34

Merge branch 'main' into feature/link-assets-v2

395523c

Removes unnecessary fontWeight

8ed64e7

Align web fonts with same naming convention native has

aae1434

Merge remote-tracking branch 'origin/main' into feature/link-assets-v2

43f3f13

Refactor improvements

7048e23

roryabraham changed the title ~~Use Font XML resources and standardise font usage on native platforms~~ [WIP] Use Font XML resources and standardise font usage on native platforms May 15, 2024

Merge branch 'main' into feature/link-assets-v2

a027ce8

roryabraham previously approved these changes Jul 9, 2024

View reviewed changes

mountiny mentioned this pull request Jul 10, 2024

[No QA] Simplify applyPatches script #45189

Merged

50 tasks

Simplify applyPatches script

07397ff

fabioh8010 dismissed roryabraham’s stale review via 07397ff July 10, 2024 17:19

Merge branch 'main' into feature/link-assets-v2

f3c84a6

Merge branch 'main' into feature/link-assets-v2

89a8783

mollfpr reviewed Jul 21, 2024

View reviewed changes

fabioh8010 added 2 commits July 22, 2024 09:34

Merge branch 'main' into feature/link-assets-v2

98735ed

Fix storybook theme.ts file

93d895b

mollfpr approved these changes Jul 22, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham July 22, 2024 19:12

Merge branch 'main' into feature/link-assets-v2

f7a5206

roryabraham approved these changes Jul 25, 2024

View reviewed changes

roryabraham merged commit 81554ad into Expensify:main Jul 25, 2024
18 checks passed

github-actions bot mentioned this pull request Jul 26, 2024

Deploy Checklist: New Expensify 2024-07-26 #46264

Closed

48 tasks

rlinoz mentioned this pull request Jul 26, 2024

[Testrail?] Markdown - Bold and Italic markdowns are not applied on links and emails #46309

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Font XML resources and standardise font usage on native platforms #41115

Use Font XML resources and standardise font usage on native platforms #41115

fabioh8010 commented Apr 26, 2024 •

edited

Loading

melvin-bot bot commented May 7, 2024

dubielzyk-expensify commented May 10, 2024 •

edited

Loading

roryabraham commented May 10, 2024

fabioh8010 commented May 10, 2024

roryabraham left a comment

fabioh8010 commented May 14, 2024

roryabraham commented May 15, 2024

fabioh8010 commented Jul 2, 2024

roryabraham left a comment

roryabraham Jul 9, 2024

fabioh8010 Jul 9, 2024

fabioh8010 commented Jul 15, 2024

fabioh8010 commented Jul 19, 2024

mollfpr commented Jul 19, 2024

mollfpr left a comment

fabioh8010 commented Jul 22, 2024

mollfpr commented Jul 22, 2024 •

edited

Loading

mollfpr left a comment

fabioh8010 commented Jul 25, 2024

roryabraham commented Jul 25, 2024

OSBotify commented Jul 25, 2024

OSBotify commented Jul 26, 2024

kavimuru commented Jul 26, 2024

roryabraham commented Jul 27, 2024

OSBotify commented Jul 29, 2024

Use Font XML resources and standardise font usage on native platforms #41115

Use Font XML resources and standardise font usage on native platforms #41115

Conversation

fabioh8010 commented Apr 26, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 7, 2024

dubielzyk-expensify commented May 10, 2024 • edited Loading

roryabraham commented May 10, 2024

fabioh8010 commented May 10, 2024

roryabraham left a comment

Choose a reason for hiding this comment

fabioh8010 commented May 14, 2024

roryabraham commented May 15, 2024

fabioh8010 commented Jul 2, 2024

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham Jul 9, 2024

Choose a reason for hiding this comment

fabioh8010 Jul 9, 2024

Choose a reason for hiding this comment

fabioh8010 commented Jul 15, 2024

fabioh8010 commented Jul 19, 2024

mollfpr commented Jul 19, 2024

mollfpr left a comment

Choose a reason for hiding this comment

fabioh8010 commented Jul 22, 2024

mollfpr commented Jul 22, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr left a comment

Choose a reason for hiding this comment

fabioh8010 commented Jul 25, 2024

roryabraham commented Jul 25, 2024

OSBotify commented Jul 25, 2024

OSBotify commented Jul 26, 2024

kavimuru commented Jul 26, 2024

roryabraham commented Jul 27, 2024

OSBotify commented Jul 29, 2024

fabioh8010 commented Apr 26, 2024 •

edited

Loading

dubielzyk-expensify commented May 10, 2024 •

edited

Loading

mollfpr commented Jul 22, 2024 •

edited

Loading