Add `useStyleUtils` hook by chrispader · Pull Request #32498 · Expensify/App

chrispader · 2023-12-05T17:55:15Z

@grgia

Details

Fixed Issues

$ #32472
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Build the app and test on all platforms that there are no errors. Switch to light mode, and repeat.

Offline tests

QA Steps

Verify that no errors appear in the JS console

No QA.

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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-12-05T17:55:20Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2023-12-05T17:57:26Z

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

contributingGuides/TS_STYLE.md

src/components/AddressSearch/index.js

grgia

Let's add to the description why we're making this change.
For Tests, we can add something like "build the app and test on all platforms that there are no errors. Switch to light mode, and repeat"
For QA can you add something like "NO QA- this PR can be tested through normal regression testing for style-based regressions"

grgia · 2023-12-06T13:14:15Z

@allroundexperts are you able to prioritize this checklist today?

allroundexperts · 2023-12-06T18:36:44Z

@allroundexperts are you able to prioritize this checklist today?

Yes. This is catching conflicts like 🔥

allroundexperts · 2023-12-07T16:52:12Z

Sure!

chrispader · 2023-12-07T16:53:12Z

Still seeing conflicts 😄

resolved again

allroundexperts · 2023-12-07T16:58:43Z

@shubham1206agra

Screen.Recording.2023-12-07.at.9.56.32.PM.mov

shubham1206agra · 2023-12-07T17:17:47Z

@chrispader Color of split button is getting diluted to background

grgia · 2023-12-07T17:21:13Z

@shubham1206agra I'll handle that in a follow up! #32688

grgia · 2023-12-07T17:39:40Z

@shubham1206agra can we complete the review here?

shubham1206agra · 2023-12-07T17:42:11Z

NAB - Desktop giving CORS on Images query

grgia · 2023-12-07T17:59:36Z

@shubham1206agra I think the CORS are unrelated

shubham1206agra · 2023-12-07T18:19:15Z

I was able to switch theme once. Switching theme again gives this error

Code used

useEffect(() => {
        // eslint-disable-next-line rulesdir/prefer-actions-set-data
        Onyx.set(ONYXKEYS.PREFERRED_THEME, 'light'); // Adapt to "dark" if needed
    }, []);

shubham1206agra · 2023-12-07T18:24:14Z

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 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 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(themeColors.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 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

#32498 (comment)

Android: mWeb Chrome

iOS: Native

Screen.Recording.2023-12-07.at.11.34.22.PM.mp4

Screen.Recording.2023-12-07.at.11.27.00.PM.mp4

iOS: mWeb Safari

Screen.Recording.2023-12-07.at.10.55.01.PM.mp4

MacOS: Chrome / Safari

Screen.Recording.2023-12-07.at.10.41.46.PM.mp4

MacOS: Desktop

Screen.Recording.2023-12-07.at.11.12.55.PM.mp4

shubham1206agra · 2023-12-07T18:36:22Z

@chrispader Please fix this #32498 (comment) so that I can approve this PR

allroundexperts

Looking good except one comment from @shubham1206agra!

grgia · 2023-12-07T18:39:13Z

@shubham1206agra is this platform specific? I am unable to replicate
#32498 (comment)

shubham1206agra · 2023-12-07T18:41:17Z

@shubham1206agra is this platform specific? I am unable to replicate #32498 (comment)

This was on iOS native. Let me confirm this on web too.

shubham1206agra · 2023-12-07T18:45:56Z

@shubham1206agra is this platform specific? I am unable to replicate #32498 (comment)

@grgia Please ignore this

OSBotify · 2023-12-07T19:38:07Z

✋ 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 · 2023-12-08T01:24:23Z

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

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

OSBotify · 2023-12-08T02:54:16Z

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

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

OSBotify · 2023-12-11T10:41:33Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.10-1 🚀

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

OSBotify · 2023-12-11T15:23:28Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.10-1 🚀

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

rojiphil · 2024-07-11T02:22:11Z

src/styles/utils/ModalStyleUtils.ts

+                    },
+                };
+                modalContainerStyle = {
+                    borderRadius: 12,


Not using the correct radius value of componentBorderRadiusLarge i.e. 16 instead of 12 caused #42716

chrispader added 7 commits December 5, 2023 16:49

implement dynamic StyleUtils

eec906a

add separate StyleUtilsProvider

b7abf59

update

6ddf86a

improve

b5b1b78

fix: remaining style utils migration

28a280a

update imports

dbcc908

fix: eslint errros

a5edd5a

chrispader changed the title ~~useThemeStyleUtils hook~~ Add useThemeStyleUtils hook Dec 5, 2023

chrispader marked this pull request as ready for review December 5, 2023 17:57

chrispader requested a review from a team as a code owner December 5, 2023 17:57

melvin-bot bot requested review from allroundexperts and removed request for a team December 5, 2023 17:57

chrispader added 3 commits December 5, 2023 19:00

fix: ts errors

0c5aa4e

Merge branch 'main' into @chrispader/use-style-utils-hook

06464ef

add default StyleUtils

ddb2b74

grgia reviewed Dec 5, 2023

View reviewed changes

contributingGuides/TS_STYLE.md Show resolved Hide resolved

contributingGuides/TS_STYLE.md Outdated Show resolved Hide resolved

src/components/AddressSearch/index.js Outdated Show resolved Hide resolved

chrispader added 6 commits December 5, 2023 19:39

Merge branch 'main' into @chrispader/use-style-utils-hook

17a97d6

revert doc updates

97d83f4

update style utils usage

9b3ed5e

fix: more

72848f2

fix: more errors

63dbd54

fix: default style utils

3afb415

chrispader changed the title ~~Add useThemeStyleUtils hook~~ Add useStyleUtils hook Dec 5, 2023

grgia reviewed Dec 6, 2023

View reviewed changes

Merge branch 'main' into @chrispader/use-style-utils-hook

44b59a2

Merge branch 'main' into @chrispader/use-style-utils-hook

125229f

allroundexperts approved these changes Dec 7, 2023

View reviewed changes

melvin-bot bot requested a review from grgia December 7, 2023 18:39

shubham1206agra approved these changes Dec 7, 2023

View reviewed changes

grgia approved these changes Dec 7, 2023

View reviewed changes

grgia merged commit 04f273b into Expensify:main Dec 7, 2023

github-actions bot mentioned this pull request Dec 8, 2023

Deploy Checklist: New Expensify 2023-12-08 #32704

Closed

27 tasks

ZhenjaHorbach mentioned this pull request Dec 8, 2023

[$500] [HOLD for payment 2023-12-20] [HOLD for payment 2023-12-18] LHN - Applausecard account is crashing after clicking on any Request in LHN #32727

Closed

6 tasks

melvin-bot bot mentioned this pull request Dec 11, 2023

[HOLD for payment 2023-12-18] [Theme Switching] create hook for StyleUtils #32472

Closed

rojiphil reviewed Jul 11, 2024

View reviewed changes

rojiphil mentioned this pull request Jul 11, 2024

[HOLD for payment 2024-07-10] [HOLD for payment 2024-07-02] [$250] Context/popover menus have incorrect border radius #42716

Closed

6 tasks

eVoloshchak mentioned this pull request Jul 25, 2025

[Due for payment 2025-07-25] [$150] In spanish, the "Light bulb" icon is left on a line alone and also outside module #60753

Closed

8 tasks

Conversation

chrispader commented Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Dec 5, 2023

Uh oh!

melvin-bot bot commented Dec 5, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

grgia left a comment

Choose a reason for hiding this comment

Uh oh!

grgia commented Dec 6, 2023

Uh oh!

allroundexperts commented Dec 6, 2023

Uh oh!

allroundexperts commented Dec 7, 2023

Uh oh!

chrispader commented Dec 7, 2023

Uh oh!

allroundexperts commented Dec 7, 2023

Uh oh!

shubham1206agra commented Dec 7, 2023

Uh oh!

grgia commented Dec 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

grgia commented Dec 7, 2023

Uh oh!

shubham1206agra commented Dec 7, 2023

Uh oh!

grgia commented Dec 7, 2023

Uh oh!

shubham1206agra commented Dec 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shubham1206agra commented Dec 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

shubham1206agra commented Dec 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

allroundexperts left a comment

Choose a reason for hiding this comment

Uh oh!

grgia commented Dec 7, 2023

Uh oh!

shubham1206agra commented Dec 7, 2023

Uh oh!

shubham1206agra commented Dec 7, 2023

Uh oh!

OSBotify commented Dec 7, 2023

Uh oh!

OSBotify commented Dec 8, 2023

Uh oh!

OSBotify commented Dec 8, 2023

Uh oh!

OSBotify commented Dec 11, 2023

Uh oh!

OSBotify commented Dec 11, 2023

Uh oh!

rojiphil Jul 11, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

chrispader commented Dec 5, 2023 •

edited

Loading

grgia commented Dec 7, 2023 •

edited

Loading

shubham1206agra commented Dec 7, 2023 •

edited

Loading

shubham1206agra commented Dec 7, 2023 •

edited

Loading

shubham1206agra commented Dec 7, 2023 •

edited

Loading