Fix/31677 amend themecolors imports in utils #32264

koko57 · 2023-11-30T12:26:15Z

Details

Fixed Issues

$ #32255
PROPOSAL:

Tests

Areas of the app affected - verify if app doesn’t crash and the elements are displayed correctly:

SignIn Page (the form, magic code input)
Tooltips,
MultipleAvatars and other Avatars
Dot Indicator
Mentions
Emoji reactions (list under the message)
Quick reactions
Autocomplete Suggestions (i.e Emoji Suggestions)
Emoji picker
Text inputs (i.e while creating tasks)
Task (previews)
Address Search (i.e. in money request Distance tab)
Payment Methods List (in Wallet)
Selection list (i.e. New Chat)
Validate Code form in Contact methods in Settings

Most of them are visible on the Report Screen

Verify that no errors appear in the JS console

Offline tests

QA Steps

Areas of the app affected - verify if app doesn’t crash and the elements are displayed correctly:

SignIn Page (the form, magic code input)
Tooltips,
MultipleAvatars and other Avatars
Dot Indicator
Mentions
Emoji reactions (list under the message)
Quick reactions
Autocomplete Suggestions (i.e Emoji Suggestions)
Emoji picker
Text inputs (i.e while creating tasks)
Task (previews)
Address Search (i.e. in money request Distance tab)
Payment Methods List (in Wallet)
1. Selection list (i.e. New Chat)
1. Validate Code form in Contach methods in Settings

Most of them are visible on the Report Screen

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-11-30T12:26:20Z

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

kubabutkiewicz · 2023-11-30T12:52:52Z

src/components/Tooltip/TooltipRenderedOnPageBody.js

@@ -27,11 +29,11 @@ const propTypes = {
    targetHeight: PropTypes.number.isRequired,

    /** Any additional amount to manually adjust the horizontal position of the tooltip.
-    A positive value shifts the tooltip to the right, and a negative value shifts it to the left. */
+     A positive value shifts the tooltip to the right, and a negative value shifts it to the left. */


Is this extra space necessary ?

my Webstorm sometimes do such things 😅 But prettier didn't complain. Removing them

kubabutkiewicz · 2023-11-30T12:53:12Z

src/components/Tooltip/TooltipRenderedOnPageBody.js

    shiftHorizontal: PropTypes.number,

    /** Any additional amount to manually adjust the vertical position of the tooltip.
-    A positive value shifts the tooltip down, and a negative value shifts it up. */
+     A positive value shifts the tooltip down, and a negative value shifts it up. */


Is this extra space necessary ?

kubabutkiewicz

looking good, just one question, why the theme and styles parameters for StylesUtils function are in different places like sometimes they are first sometimes they are in the middle and other at the end? I believe its related to default parameters but just making sure 😄

koko57 · 2023-11-30T12:59:39Z

looking good, just one question, why the theme and styles parameters for StylesUtils function are in different places like sometimes they are first sometimes they are in the middle and other at the end? I believe its related to default parameters but just making sure 😄

yep, I started adding them before the default params, but then added them as first in some places. Maybe it would be a good idea to pass them first always?
cc @chrispader

chrispader · 2023-11-30T13:15:12Z

yep, I started adding them before the default params, but then added them as first in some places. Maybe it would be a good idea to pass them first always?

Yes, i also think we should always put it in first place for util functions that use styles/theme.

We can also think about changing such functions to named parameters? (or maybe all?)

cc @grgia

koko57 · 2023-11-30T13:25:50Z

@chrispader ok, so I will change the order. For making them all named params - I like the idea but maybe we could do this as a follow-up? wdyt?

fabioh8010 · 2023-11-30T13:10:44Z

src/components/EmojiPicker/EmojiPickerMenuItem/index.js

+export default withTheme(
+    withThemeStyles(


Just curiosity, what's the difference between withTheme and withThemeStyles?

from withTheme you get just colors, from withThemeStyles other styles

fabioh8010 · 2023-11-30T13:14:17Z

src/styles/StyleUtils.ts

@@ -192,17 +186,10 @@ function getAvatarSize(size: AvatarSizeName): number {
 /**
 * Return the height of magic code input container
 */
-function getHeightOfMagicCodeInput(): ViewStyle {
+function getHeightOfMagicCodeInput(styles: typeof defaultStyles): ViewStyle {


Suggested change

function getHeightOfMagicCodeInput(styles: typeof defaultStyles): ViewStyle {

function getHeightOfMagicCodeInput(styles: ThemeStyle): ViewStyle {

We can use ThemeStyle for this, wdyt about applying to the other functions?

I'll try, for one of the previous PR I tried it somewhere else, but TS was not happy with that

Yes, let's use ThemeStyle type from @styles/styles. Also, can we please rename it to ThemeStyles to match other types of this kind

@chrispader you mean to rename the type?

fabioh8010 · 2023-11-30T13:26:54Z

src/styles/StyleUtils.ts

I think we could try to standartise the theme and style param ordering. Some functions are using them in the beginning, others in the middle, others in the end of the params. Wdyt what changing to be always at the first param @koko57 ?

yep, maybe styles, theme ? (alphabetically 😅) and then other params

Sounds good to me!

Let's do theme, styles. styles depend on theme, which implicates kind of an order like ThemePreference > Theme > ThemeStyles

chrispader · 2023-11-30T13:41:32Z

@chrispader ok, so I will change the order. For making them all named params - I like the idea but maybe we could do this as a follow-up? wdyt?

yes!

melvin-bot · 2023-11-30T13:57:29Z

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

koko57 · 2023-11-30T14:02:01Z

@grgia @chrispader a lot of files were changed, looks a bit daunting in terms of testing, but fortunately a big part of components affected are used in the Report Screen

grgia · 2023-11-30T14:03:35Z

@koko57 in regards to testing, we can mainly aim to make sure theres no errors or crashes on all platforms

grgia · 2023-11-30T14:09:55Z

src/components/TextInput/BaseTextInput/index.js

@@ -333,7 +333,7 @@ function BaseTextInput(props) {
                                    !isMultiline && Browser.isMobileChrome() && {boxSizing: 'content-box', height: undefined},

                                    // Stop scrollbar flashing when breaking lines with autoGrowHeight enabled.
-                                    props.autoGrowHeight && StyleUtils.getAutoGrowHeightInputStyle(textInputHeight, maxHeight),
+                                    props.autoGrowHeight && StyleUtils.getAutoGrowHeightInputStyle(textInputHeight, maxHeight, styles),


Getting an error when I update a description of a transaction

StyleUtils.ts:313 Uncaught TypeError: Cannot read properties of undefined (reading 'paddingTop') at Module.getAutoGrowHeightInputStyle (StyleUtils.ts:313:1) at BaseTextInput (index.js:308:29) at renderWithHooks (react-dom.development.js:16175:1)

thanks! on it!

grgia · 2023-11-30T14:14:06Z

@koko57 looks like we need to run prettier too

koko57 · 2023-11-30T14:19:18Z

@grgia all fixed!

koko57 · 2023-11-30T14:21:28Z

src/styles/StyleUtils.ts

-function getEmptyAvatarStyle(size: EmptyAvatarSizeName): ViewStyle | undefined {
-    return emptyAvatarStyles[size];
-}
-


@grgia @chrispader FYI: I deleted this function as I could not find its usage anywhere

let me know if it should be restored

If its unused, all good to remove!

koko57 · 2023-11-30T15:01:39Z

@grgia fixed!

allroundexperts · 2023-11-30T15:03:33Z

@koko57 Does this seem related?

koko57 · 2023-11-30T15:05:18Z

@koko57 Does this seem related?

I'll check it

allroundexperts · 2023-11-30T15:06:06Z

This seems to be different from staging.

allroundexperts · 2023-11-30T15:12:28Z

Getting this as well:

koko57 · 2023-11-30T15:17:59Z

This seems to be different from staging.

@allroundexperts this is already on main, but investigating

grgia · 2023-11-30T15:18:54Z

@allroundexperts both Warning: Failed prop type: Invalid prop `listEmptyComponent` of type `function` supplied to `GooglePlacesAutocomplete`, expected a single ReactElement. is on main

grgia · 2023-11-30T15:21:35Z

@koko57 can you merge main? I think the tabs is fixed on main

koko57 · 2023-11-30T15:24:17Z

@grgia main merged! found hopefully last one with old theme - pushing in a minute

koko57 · 2023-11-30T15:28:50Z

@chrispader @grgia so the last imports left are those in storybook, but we agreed we're not doing it now

grgia · 2023-11-30T15:30:19Z

@koko57 yes, I can create a separate issue for storybook

grgia · 2023-11-30T15:34:51Z

@koko57 might need one more prettier run!

koko57 · 2023-11-30T15:36:32Z

@grgia done!

grgia · 2023-11-30T15:37:54Z

@allroundexperts bump on review!

allroundexperts · 2023-11-30T15:39:17Z

On it!

allroundexperts · 2023-11-30T16:07:22Z

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

Screen.Recording.2023-11-30.at.9.29.47.PM.mov

Android: mWeb Chrome

Screen.Recording.2023-11-30.at.9.25.07.PM.mov

iOS: Native

Screen.Recording.2023-11-30.at.9.28.31.PM.mov

iOS: mWeb Safari

Screen.Recording.2023-11-30.at.9.27.21.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-11-30.at.9.05.05.PM.mov

MacOS: Desktop

Screen.Recording.2023-11-30.at.9.21.32.PM.mov

allroundexperts

Works good.

Note: I just tested for console errors / crashes on the components mentioned in the PR description. I did not check for UI bugs.

OSBotify · 2023-11-30T16:39:37Z

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

chrispader · 2023-11-30T18:13:14Z

In CalendarPicker we have the wrong import. I already fixed this in #32259

App/src/components/NewDatePicker/CalendarPicker/index.js

Line 1 in b9ecec4

import {withTheme} from '@storybook/theming';

koko57 · 2023-11-30T18:33:39Z

In CalendarPicker we have the wrong import. I already fixed this in #32259

App/src/components/NewDatePicker/CalendarPicker/index.js

Line 1 in b9ecec4

import {withTheme} from '@storybook/theming';

@chrispader thanks! and sorry for that!

OSBotify · 2023-12-01T12:57:40Z

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

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

OSBotify · 2023-12-05T02:28:03Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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

koko57 added 2 commits November 30, 2023 12:05

fix: pass theme and styles to getTooltipStyles

b9c4f33

fix: pass theme and styles to utils functions

226f885

koko57 mentioned this pull request Nov 30, 2023

[HOLD for payment 2023-12-12] [Theme Switching Migration] - remove remaining default theme imports from Utils #32255

Closed

kubabutkiewicz reviewed Nov 30, 2023

View reviewed changes

fix: remove extra spaces

adb9e3b

kubabutkiewicz reviewed Nov 30, 2023

View reviewed changes

fabioh8010 reviewed Nov 30, 2023

View reviewed changes

fix: resolve conflicts

616a208

fix: change params order

de53c93

koko57 marked this pull request as ready for review November 30, 2023 13:57

koko57 requested a review from a team as a code owner November 30, 2023 13:57

melvin-bot bot requested review from cubuspl42 and removed request for a team November 30, 2023 13:57

fix: change params order pt2

bf1f63e

grgia reviewed Nov 30, 2023

View reviewed changes

fix: apply requested changes

57a694e

koko57 commented Nov 30, 2023

View reviewed changes

grgia requested a review from allroundexperts November 30, 2023 14:27

fix: minor fix

b558ace

fix: resolve conflicts

e2a0dbf

fix: minor fix

ac50070

fix: minor fix

946f362

grgia approved these changes Nov 30, 2023

View reviewed changes

allroundexperts reviewed Nov 30, 2023

View reviewed changes

grgia merged commit 9c3125f into Expensify:main Nov 30, 2023
15 of 16 checks passed

chrispader mentioned this pull request Nov 30, 2023

Finalise theme switching migration for App #32259

Merged

47 tasks

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

Deploy Checklist: New Expensify 2023-12-01 #32342

Closed

53 tasks

koko57 deleted the fix/31677-amend-themecolors-imports-in-utils branch January 17, 2024 18:39

	function getHeightOfMagicCodeInput(styles: typeof defaultStyles): ViewStyle {
	function getHeightOfMagicCodeInput(styles: ThemeStyle): ViewStyle {

Fix/31677 amend themecolors imports in utils #32264

Fix/31677 amend themecolors imports in utils #32264

Conversation

koko57 commented Nov 30, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 30, 2023

kubabutkiewicz Nov 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kubabutkiewicz left a comment

Choose a reason for hiding this comment

koko57 commented Nov 30, 2023

chrispader commented Nov 30, 2023 • edited Loading

koko57 commented Nov 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koko57 Nov 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrispader Nov 30, 2023 • edited Loading

Choose a reason for hiding this comment

chrispader commented Nov 30, 2023

melvin-bot bot commented Nov 30, 2023

koko57 commented Nov 30, 2023

grgia commented Nov 30, 2023

Choose a reason for hiding this comment

grgia Nov 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

grgia commented Nov 30, 2023

koko57 commented Nov 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koko57 commented Nov 30, 2023

allroundexperts commented Nov 30, 2023

koko57 commented Nov 30, 2023

allroundexperts commented Nov 30, 2023

allroundexperts commented Nov 30, 2023

koko57 commented Nov 30, 2023

grgia commented Nov 30, 2023 • edited Loading

grgia commented Nov 30, 2023

koko57 commented Nov 30, 2023

koko57 commented Nov 30, 2023

grgia commented Nov 30, 2023

grgia commented Nov 30, 2023

koko57 commented Nov 30, 2023

grgia commented Nov 30, 2023

allroundexperts commented Nov 30, 2023

allroundexperts commented Nov 30, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 30, 2023

chrispader commented Nov 30, 2023

koko57 commented Nov 30, 2023

OSBotify commented Dec 1, 2023

OSBotify commented Dec 5, 2023

koko57 commented Nov 30, 2023 •

edited

Loading

kubabutkiewicz Nov 30, 2023 •

edited

Loading

chrispader commented Nov 30, 2023 •

edited

Loading

koko57 Nov 30, 2023 •

edited

Loading

chrispader Nov 30, 2023 •

edited

Loading

grgia Nov 30, 2023 •

edited

Loading

grgia commented Nov 30, 2023 •

edited

Loading

allroundexperts commented Nov 30, 2023 •

edited

Loading