[No QA] [TS migration] Review and clean up Styles files #27660

fabioh8010 · 2023-09-18T11:09:19Z

Details

This PR:

Adds react-native-web style and component props to the core react-native components. Please note that the solution is not perfect as this is actually a current issue in the community (Using TypeScript x React Native Web necolas/react-native-web#832, Exporting types necolas/react-native-web#1684).
Convert styles.js to TypeScript
Refactor and clean up other style files to remove CSSProperties as it's not needed anymore.
Create some styles to isolate and handle cases where we need to use web values in some style props that couldn't be augmented / changed.

Fixed Issues

$
PROPOSAL: N/A

Tests

Main flows test.

Offline tests

Main flows test.

QA Steps

Main flows test.

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 / Chrome
- iOS / native
- iOS / 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-09-18.at.11.50.02.mov

Screen.Recording.2023-09-18.at.11.50.37.mov

Desktop

Screen.Recording.2023-09-18.at.11.51.13.mov

Mobile Web - Chrome

Screen.Recording.2023-09-18.at.11.52.21.mov

Android

Screen.Recording.2023-09-18.at.11.53.40.mov

Mobile Web - Safari

Screen.Recording.2023-09-18.at.11.55.06.mov

iOS

Screen.Recording.2023-09-18.at.11.56.04.mov

src/styles/StyleUtils.ts

src/styles/addOutlineWidth/types.ts

rezkiy37 · 2023-09-18T16:48:32Z

src/styles/themes/light.ts

@@ -62,7 +63,7 @@ const lightTheme = {
    heroCard: colors.blue400,
    uploadPreviewActivityIndicator: colors.lightHighlightBackground,
    dropUIBG: 'rgba(252, 251, 249, 0.92)',
-    dropTransparentOverlay: 'rgba(255,255,255,0)',
+    receiptDropUIBG: '', // TODO: add color


Are we going to merge with the TODO?

Suggested change

receiptDropUIBG: '', // TODO: add color

receiptDropUIBG: '', // TODO: add color

There is an ongoing Theme migration to Typescript PR, they marked receiptDropUIBG as optional. They also typed themes a bit differently, we need to coordinate these two PRs @fabioh8010, wdyt?

asked if there is proper coordination between these two PRs

rezkiy37

Left a few comments, overall LGTM. Hard and good work!

src/styles/getReportActionContextMenuStyles.ts

src/styles/themes/light.ts

src/styles/utilities/display.ts

blazejkustra

Great work overall! 💯

@fabioh8010 Did you test that using styles inside components works well?

src/styles/StyleUtils.ts

blazejkustra · 2023-09-19T10:03:09Z

src/styles/themes/light.ts

@@ -62,7 +63,7 @@ const lightTheme = {
    heroCard: colors.blue400,
    uploadPreviewActivityIndicator: colors.lightHighlightBackground,
    dropUIBG: 'rgba(252, 251, 249, 0.92)',
-    dropTransparentOverlay: 'rgba(255,255,255,0)',
+    receiptDropUIBG: '', // TODO: add color


There is an ongoing Theme migration to Typescript PR, they marked receiptDropUIBG as optional. They also typed themes a bit differently, we need to coordinate these two PRs @fabioh8010, wdyt?

src/styles/themes/light.ts

blazejkustra · 2023-09-19T17:17:36Z

Ale you need to resolve conflicts @fabioh8010

kubabutkiewicz · 2023-10-11T11:37:46Z

@hayata-suenaga will you be able to look again? 😄

…yle/styles-refactor

hayata-suenaga · 2023-10-13T13:20:57Z

Thank you for answering all questions I have 🙇

OSBotify · 2023-10-13T13:27:20Z

✋ 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-10-13T21:10:52Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.84-0 🚀

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

situchan · 2023-10-14T17:02:17Z

This PR caused regression - #29602, #29611
Anyone can raise follow-up PR?
cc: @kubabutkiewicz @rezkiy37 @blazejkustra

kubabutkiewicz · 2023-10-14T18:38:11Z

Yes, I will try to do PR asap @situchan

kubabutkiewicz · 2023-10-14T20:05:51Z

@situchan
PR is ready can you review?

situchan · 2023-10-14T23:09:25Z

src/styles/styles.ts

+            ...flex.flexWrap,
+            ...flex.flex1,


This was spacing.flexWrap, spacing.flex1 originally which didn't exist.
So let's remove these bad styles in #29629 to fix #29627

OSBotify · 2023-10-16T21:11:20Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-16T21:47:40Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

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

OSBotify · 2023-10-16T21:50:36Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.85-0 🚀

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

OSBotify · 2023-10-17T23:15:21Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.85-4 🚀

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

fabioh8010 and others added 17 commits September 4, 2023 19:01

First version of styles refactor

ba8a3c1

Add more typings

b1ee74b

Merge branch 'main' into ts/style/styles-refactor

f967e37

Remove more CSSProperties usage from styles

4aef004

Add more props and styles

58d4a25

Merge remote-tracking branch 'origin/main' into ts/style/styles-refactor

c3fc096

Refactor styles and implement missing ones

091104e

Merge branch 'main' into ts/style/styles-refactor

c7d0164

Migrate styles.ts

e4a3313

Remove unused imports

b8d36f7

Fix return types in styles.ts

24f363b

Merge remote-tracking branch 'origin/main' into ts/style/styles-refactor

88bb36f

Minor fixes in styles.ts

1be0bf5

Add stricter types to styles.ts

1338157

Isolate some web-only styles

5feb1fe

Merge remote-tracking branch 'origin/main' into ts/style/styles-refactor

98e5d4a

Merge remote-tracking branch 'origin/main' into ts/style/styles-refactor

b223759