Theme switching: Going Live! (Add preferences menu entry for ThemePage)

[chrispader]

@grgia

Details

Fixed Issues

$ #21670
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

• Verify that no errors appear in the JS console

1. Go to settings -> Preferences
2. Make sure there's a menu entry "Theme"
3. Click on it
4. Make sure you're redirected to a new "Theme" page
5. Change theme and make sure the setting is changing the color theme accordingly

Offline tests

Not needed.

QA Steps

No QA

• Verify that no errors appear in the JS console

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

See #21666

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[melvin-bot]

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

@thesahindia please ignore you're mention, @grgia is gonna review this

[grgia]

Adding Hold, since we will not be merging this until we go live

[grgia]

Commenting for Melvin, still on hold

[grgia]

@chrispader we'll need to merge main since there's been an update to the translate hook. I temporarily made the changes in this commit so design can QA but I'll remove it before we merge so we can QA all the settings in this PR.
2230d21

Also, what are your thoughts on the drawer animation here? It feels a little jagged with the rerendering, but Im not sure if there's much we can do with push to page here

Screen.Recording.2023-12-05.at.3.35.31.PM.mov

[chrispader]

@chrispader we'll need to merge main since there's been an update to the translate hook.

done 👍

[chrispader]

Also, what are your thoughts on the drawer animation here? It feels a little jagged with the rerendering, but Im not sure if there's much we can do with push to page here

I don't think there's much we can do here either. Probably due to the rendering of the lottie animation. i can take a look into this by time.

[grgia]

@chrispader yeah the jaggedness matches changing priority mode, so I think it's fine. Personally, I think the fix is actually not navigating back to preferences on button click for the settings that rerender large parts of the app

[grgia]

@chrispader for tests, here's some paths to get started:

Anonymous User
Here we are testing:
✅ Sign in Page is Dark for all users
✅ Theme matches device settings for anonymous users

• Ensure Sign In Page is Dark, Navigate to a report anonymously, ensure that theme matches OS
• Repeat this with OS set to Light, Dark, Auto

Brand New User
Here we are testing:
✅ Theme is automatically set to System

• Set OS theme to Dark
• Create a new account, ensure that the theme setting in preferences is set to System and is Dark Mode.
• Log out, set OS theme to Light
• Create a new account, ensure that the theme setting in preferences is set to System and is Light Mode.

Logged in User
Here we are testing:
✅ Theme can be changed
✅ Theme is remembered after logging out and logging back in
✅ Theme preference is synced across devices

• Go to preferences -> theme
• Set theme to Dark, ensure theme is changed to dark.
• Log out and log back in, ensure theme remains dark.
• Log into another device, ensure theme remains dark.
• Repeat steps with Light setting.
• Repeat steps with System setting. Here you will ensure that theme matches device OS theme. Change device OS theme between Dark and Light and ensure that the theme changes to match.

[chrispader]

@grgia the current default theme is dark: https://github.com/Expensify/App/blob/b0268fab8826bb964ad4c8450c342c27e23d0d50/src/CONST.ts#L699C12-L699C12

Should we change this to system?

[chrispader]

Also, should i add your comment to the test steps or is it just for us?

[grgia]

@chrispader came here to tell you to swap it to SYSTEM, but youre three steps ahead of me 😄

[grgia]

looks like in places where we do themes[CONST.THEME.DEFAULT]; system isnt working

[grgia]

hmmm clicking on the button isnt working

Screen.Recording.2023-12-13.at.12.07.40.PM.mov

[chrispader]

hmmm clicking on the button isnt working

Screen.Recording.2023-12-13.at.12.07.40.PM.mov

We had to uncomment the line in ModalStackNavigator

[grgia]

Rebuilding

[OSBotify]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
❌ FAILED ❌	❌ FAILED ❌
The QR code can't be generated, because the android build failed	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
❌ FAILED ❌	❌ FAILED ❌
The QR code can't be generated, because the Desktop build failed	The QR code can't be generated, because the web build failed

[grgia]

PS I cancelled that build ^

[grgia]

@chrispader if you merge main it should fix lint

[grgia]

QA

Brand New User

Here we are testing:
✅ Theme is automatically set to System

Set OS theme to Dark
Create a new account, and ensure that the theme setting in preferences is set to System and is Dark Mode.

Screen.Recording.2023-12-13.at.2.43.15.PM.mov

Log out, set OS theme to Light
Create a new account, and ensure that the theme setting in preferences is set to System and is Light Mode.

split.mov

[grgia]

I get this warning on IOS when switching themes

[chrispader]

I get this warning on IOS when switching themes

not sure if this is related, doesn't seem so.

can check tmrw!

[grgia]

Looked into that kind of error and I don't think it's related either, looks like a react navigation bug

[grgia]

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(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.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

See adhoc

Android: mWeb Chrome

N/A

iOS: Native

Screen.Recording.2023-12-13.at.5.41.23.PM.mov

iOS: mWeb Safari

Screen.Recording.2023-12-13.at.5.41.02.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-13.at.6.32.22.PM.mov

MacOS: Desktop

Screen.Recording.2023-12-13.at.6.40.02.PM.mov

[grgia]

waiting on the test build for android bc my local android still will not build 🙃🤖

[OSBotify]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/21669/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/21669/index.html
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/21669/NewExpensify.dmg	https://21669.pr-testing.expensify.com

[grgia]

🕺 🎊 LGTM 🎊 🕺

[OSBotify]

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

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

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

[OSBotify]

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

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

[OSBotify]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.13-8 🚀

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