31695 theme switching composer #31831

lukemorawski · 2023-11-24T15:45:33Z

Details

This PR refactors the code to use dynamic theme/styling object, by using useThemeStyles and useTheme hooks in favor of static imports, to enable app wide theme switching.

Fixed Issues

$ #31695
PROPOSAL: no proposal

Tests

apply this diff to test light theme

diff --git a/src/styles/themes/ThemeProvider.tsx b/src/styles/themes/ThemeProvider.tsx
index 50bfb3b045..32a40cbdbf 100644
--- a/src/styles/themes/ThemeProvider.tsx
+++ b/src/styles/themes/ThemeProvider.tsx
@@ -15,7 +15,7 @@ const propTypes = {
 function ThemeProvider(props: React.PropsWithChildren) {
     const themePreference = useThemePreference();

-    const theme = useMemo(() => (themePreference === CONST.THEME.LIGHT ? lightTheme : darkTheme), [themePreference]);
+    const theme = useMemo(() => (themePreference === CONST.THEME.LIGHT ? lightTheme : lightTheme), [themePreference]);

     return <ThemeContext.Provider value={theme}>{props.children}</ThemeContext.Provider>;
 }

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

no screenshots

Android: mWeb Chrome

no screenshots

iOS: Native

no screenshots

iOS: mWeb Safari

no screenshots

MacOS: Chrome / Safari

no screenshots

MacOS: Desktop

no screenshots

src/libs/ComposerUtils/updateNumberOfLines/index.native.ts

src/components/EmojiPicker/EmojiPickerMenu/index.js

src/styles/containerComposeStyles/index.native.ts

src/styles/containerComposeStyles/index.ts

src/libs/ComposerUtils/updateNumberOfLines/types.ts

src/components/Composer/index.android.js

src/styles/containerComposeStyles/index.ts

src/styles/containerComposeStyles/index.native.ts

rezkiy37

Left comments.

lukemorawski · 2023-11-24T16:31:00Z

added some fixes

src/components/EmojiPicker/EmojiPickerMenu/index.js

src/styles/containerComposeStyles/types.ts

melvin-bot · 2023-11-28T15:13:50Z

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

chrispader

LGTM, just a few minor naming comments :)

chrispader · 2023-11-29T14:20:38Z

src/styles/containerComposeStyles/index.native.ts

 import ContainerComposeStyles from './types';

-const containerComposeStyles: ContainerComposeStyles = [styles.textInputComposeSpacing];
+const containerComposeStyles: ContainerComposeStyles = (stylesObject) => [stylesObject.textInputComposeSpacing];


can we rename this to just styles? :)

@lukemorawski would you be able to update with this change today?

chrispader · 2023-11-29T14:20:44Z

src/styles/containerComposeStyles/index.ts

 import ContainerComposeStyles from './types';

 // We need to set paddingVertical = 0 on web to avoid displaying a normal pointer on some parts of compose box when not in focus
-const containerComposeStyles: ContainerComposeStyles = [styles.textInputComposeSpacing, {paddingVertical: 0}];
+const containerComposeStyles: ContainerComposeStyles = (stylesObject) => [stylesObject.textInputComposeSpacing, {paddingVertical: 0}];


chrispader · 2023-11-29T14:20:52Z

src/styles/containerComposeStyles/types.ts


-type ContainerComposeStyles = ViewStyle[];
+type ContainerComposeStyles = (stylesObject: typeof styles) => ViewStyle[];


grgia · 2023-11-29T15:10:09Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

chrispader

Thanks for the changes :) LGTM

OSBotify · 2023-11-29T16:01: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.

kidroca · 2023-11-29T18:32:01Z

src/components/Composer/index.android.js

@@ -4,7 +4,8 @@ import {StyleSheet} from 'react-native';
 import _ from 'underscore';
 import RNTextInput from '@components/RNTextInput';
 import * as ComposerUtils from '@libs/ComposerUtils';
-import themeColors from '@styles/themes/default';
+import {useTheme} from '@styles/themes/useTheme';


I'm seeing the following error after I synced with main

Shouldn't this be

import useTheme from '@styles/themes/useTheme';

There doesn't seem to be a named export called useTheme here: src/styles/themes/useTheme.ts

I'm seeing the same thing. @lukemorawski why are there no testing steps and no screenshots on this PR?

I'm seeing the same thing. @lukemorawski why are there no testing steps and no screenshots on this PR?

Maybe because QA team cannot test this PR without switching to light theme which is not enabled yet.

But it would have been better to test in all platforms though this is very simple PR. Or have C+ review and test - should the bug have been caught earlier before merge.

sorry, wrong auto import! fixed now

Is there a PR that fixes this already?

ah perfect, thanks!

I understand this PR doesn't enable or change any functionality, but it does refactor theming in several components. We should always test these changes even if the test is a super simple "view each component and verify styling is still working". That would have been enough to catch small errors. QA regression testing should catch anything more complex.

@lukemorawski please don't cut corners and test on all platforms even for the simple stuff. I know it's annoying, but it's worth the time 🙇.

should have catched this in the review as well, sorry for that! 🫠

totally agree, sorry again for that

OSBotify · 2023-12-01T12:44:35Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.6-2 🚀

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

lukemorawski added 3 commits November 24, 2023 16:03

refactor/move to dynamic styling hooks for composer related files

7f18651

updateNumberOfLines.native

61186b0

referaldetailspage undo

358436d