[Theme Switching Migration] Report by rezkiy37 · Pull Request #31728 · Expensify/App

rezkiy37 · 2023-11-22T17:28:58Z

Details

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

Fixed Issues

$ #31682
PROPOSAL: N/A

Tests

Report screen -> a single message (src/pages/home/report/ReportActionItemSingle.js)
Report screen -> a group message (src/pages/home/report/ReportActionItemGrouped.js)
Report screen -> a single whisper message (src/pages/home/report/ReportActionItemSingle.js)
Report screen -> a group whisper message (src/pages/home/report/ReportActionItemGrouped.js)
Report screen -> a message that contains any HTML (src/components/HTMLEngineProvider/BaseHTMLEngineProvider.js)
Report screen -> Attach a PDF file -> PDF modal (on Android as well) (src/components/PDFView/index.js, src/components/Attachments/AttachmentView/AttachmentViewPdf/index.android.js)
Settings -> Share code -> menu items under the QR (src/components/MenuItem.js, src/components/ContextMenuItem.js, src/styles/getContextMenuItemStyles/index.native.ts, src/styles/getContextMenuItemStyles/index.ts)
FAB -> menu items (src/components/MenuItem.js, src/components/ContextMenuItem.js, src/styles/getContextMenuItemStyles/index.native.ts, src/styles/getContextMenuItemStyles/index.ts)
Report screen -> "+" -> menu items (src/components/MenuItem.js, src/components/ContextMenuItem.js, src/styles/getContextMenuItemStyles/index.native.ts, src/styles/getContextMenuItemStyles/index.ts)
Report screen -> invoke system message (src/components/InlineSystemMessage.tsx)

Apply this change and test again:

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

Same as "Tests".

QA Steps

Note: "Correctly" means that the same as it was before.

Open "Report" page -> Send a text message -> Verify that a message is displayed correctly.
Open "Report" page -> Send a couple text messages -> Verify that the messages are displayed correctly.
Open "Report" page -> Receive a text message -> Flag a message as offensive -> Verify that a newly added whisper message is displayed correctly.
Open "Report" page -> Receive a couple text messages -> Flag the messages as offensive -> Verify that newly added whisper messages are displayed correctly.
Open "Report" page -> Send a message that contains any HTML like "@ here" -> Verify that a message is displayed correctly.
Open "Report" page -> Attach a PDF file -> Verify that a modal looks correctly (on Android as well).
Open "Settings" page -> Click on "Share code" -> Verify that menu items under the QR are displayed correctly.
Click on the FAB -> Verify that menu items are displayed correctly.
Open "Report" page -> Click on "+" -> Verify that menu items are displayed correctly.
Open "Report" page -> Invoke system message -> Verify that a component is displayed correctly.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Not required

Android: mWeb Chrome

Not required

iOS: Native

Not required

iOS: mWeb Safari

Not required

MacOS: Chrome / Safari

Not required

MacOS: Desktop

Not required

melvin-bot · 2023-11-23T08:12:26Z

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

…ture/31682-theme-switching-migration-report

fabioh8010 · 2023-11-24T11:54:05Z

src/pages/home/report/ReportActionItem.js

                            <ReportActionItemSingle
                                action={parentReportAction}
                                showHeader={!props.draftMessage}
-                                wrapperStyles={[styles.chatItem]}


Why was this prop removed?

Because I added it internally to ReportActionItemSingle by default. This component is being used in 2 places and the same style was passed twice.

src/pages/home/report/ReportActionItemGrouped.js

src/pages/home/report/ReportActionItemSingle.js

This reverts commit 1c42c55.

grgia · 2023-11-28T12:13:22Z

@rezkiy37 could you try merging main for performance tests?

…ture/31682-theme-switching-migration-report

chrispader

LGTM! 🚀

chrispader · 2023-11-28T22:50:27Z

Should this PR include changes to fix hovering over messages on web? @grgia

This is currently still broken...

chrispader · 2023-11-28T22:51:46Z

Seems like some text color is still broken here..

chrispader · 2023-11-28T22:53:42Z

Also this "alert"/"info" component at the bottom?

grgia · 2023-11-29T09:54:45Z

@chrispader so long as the hook is working correctly, I think we can address colors/theme fixes in the final PR

grgia · 2023-11-29T09:55:33Z

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 · 2023-11-29T09:56:56Z

@chrispader so long as the hook is working correctly, I think we can address colors/theme fixes in the final PR

sounds good 👍

…ture/31682-theme-switching-migration-report

OSBotify · 2023-11-29T12:20:35Z

🚀 Deployed to staging by https://github.com/grgia in version: 1.4.5-1 🚀

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

kavimuru · 2023-11-29T13:11:29Z

@rezkiy37 Can you please share the QA steps? It seems we can't test at our end.

src/components/MenuItem.js

OSBotify · 2023-11-30T12:15:45Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.5-7 🚀

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

rezkiy37 added 10 commits November 22, 2023 17:54

migrate ReportActionItemGrouped

5c73228

migrate ReportActionItemSingle

86767e1

migrate BaseHTMLEngineProvider

19e65f8

migrate PDFView

8b2d1a5

migrate InlineSystemMessage

07610b9

migrate AttachmentViewPdf

15c6aba

migrate MenuItem

ef84502

use camelCase of getContextMenuItemStyles

ed9c97f

migrate getContextMenuItemStyles

359c8e9

fix name

d00bf11

rezkiy37 marked this pull request as ready for review November 23, 2023 08:12

rezkiy37 requested a review from a team as a code owner November 23, 2023 08:12

melvin-bot bot requested review from sobitneupane and removed request for a team November 23, 2023 08:12

rezkiy37 added 2 commits November 24, 2023 11:26

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

20df2ba

…ture/31682-theme-switching-migration-report

remove undefined default props

1c42c55

fabioh8010 reviewed Nov 24, 2023

View reviewed changes

rezkiy37 requested a review from fabioh8010 November 24, 2023 12:24

rezkiy37 added 2 commits November 24, 2023 15:25

Revert "remove undefined default props"

ca70cac

This reverts commit 1c42c55.

use undefined for styles

1d44d68

koko57 mentioned this pull request Nov 24, 2023

[HOLD for payment 2023-12-08] [Theme Switching Migration] Master File Tracking #31677

Closed

31 tasks

grgia requested review from grgia and removed request for fabioh8010 November 27, 2023 10:34

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

1af9634

…ture/31682-theme-switching-migration-report

grgia approved these changes Nov 28, 2023

View reviewed changes

chrispader approved these changes Nov 28, 2023

View reviewed changes

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

0f8cc5a

…ture/31682-theme-switching-migration-report

grgia merged commit 7d595b4 into Expensify:main Nov 29, 2023

github-actions bot mentioned this pull request Nov 29, 2023

Deploy Checklist: New Expensify 2023-11-29 #32175

Closed

55 tasks

ZhenjaHorbach mentioned this pull request Nov 29, 2023

[HOLD for payment 2023-12-08] [HOLD for payment 2023-12-07] Workspace - Workspace in the workspace list is misaligned when deleted offline #32182

Closed

6 tasks

situchan reviewed Nov 29, 2023

View reviewed changes

src/components/MenuItem.js Show resolved Hide resolved

situchan reviewed Nov 29, 2023

View reviewed changes

src/components/MenuItem.js Show resolved Hide resolved

rezkiy37 mentioned this pull request Nov 29, 2023

Workspace in the workspace list is misaligned when deleted offline #32185

Merged

47 tasks

melvin-bot bot mentioned this pull request Nov 30, 2023

[HOLD for payment 2023-12-07] [Theme Switching Migration] Report(Chat) Batch #31682

Closed

9 tasks

Conversation

rezkiy37 commented Nov 22, 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 Nov 23, 2023

Uh oh!

fabioh8010 Nov 24, 2023

Choose a reason for hiding this comment

Uh oh!

rezkiy37 Nov 24, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

grgia commented Nov 28, 2023

Uh oh!

chrispader left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

chrispader commented Nov 28, 2023

Uh oh!

chrispader commented Nov 28, 2023

Uh oh!

grgia commented Nov 29, 2023

Uh oh!

grgia commented Nov 29, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

chrispader commented Nov 29, 2023

Uh oh!

OSBotify commented Nov 29, 2023

Uh oh!

kavimuru commented Nov 29, 2023

Uh oh!

Uh oh!

Uh oh!

OSBotify commented Nov 30, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

rezkiy37 commented Nov 22, 2023 •

edited

Loading

chrispader commented Nov 28, 2023 •

edited

Loading