fix: maintain consistent topbar colour on login #25908

allroundexperts · 2023-08-24T23:22:56Z

Details

This PR fixes the issue where the top bar was not of correct colour when opening the initial login page.

While implementing the fix, I found a few more issues. The animation for changing the top bar colour was running even when:

The animated value was same as the previous animated value or was null.
When it was less than the new animated value (This happened whenever we updated top bar colour, the value became from 1 -> 0 -> 1. It was needless to run the animation during the 1 -> 0 phase).

As such, I added a condition in the useAnimatedReaction function that prevented the top bar colour from changing if any of the above conditions were satisfied.

Also, I found out that it was much cleaner to replace the static value of the top bar colour being set in the CustomStatusBar component to a dynamic colour based on the current active route. This was contrary to what I proposed initially where we were essentially running the above logic inside a new useEffect hook inside the NavigationRoot component.

Fixed Issues

$ #23345
PROPOSAL: #23345 (comment)

Tests

Open the App and Logout.
Verify that the login screen has the correct top bar colour.
Login and browse the various screens.
Verify that all of them have the correct top bar colour.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Open the App and Logout.
Verify that the login screen has the correct top bar colour.
Login and browse the various screens.
Verify that all of them have the correct top bar colour.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-08-25.at.2.01.54.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-08-25.at.4.02.14.AM.mov

Mobile Web - Safari

Screen.Recording.2023-08-25.at.4.00.04.AM.mov

Desktop

iOS

Screen.Recording.2023-08-25.at.4.05.15.AM.mov

Android

Screen.Recording.2023-08-25.at.4.06.07.AM.mov

melvin-bot · 2023-08-24T23:23:01Z

@Santhosh-Sellavel 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]

Santhosh-Sellavel · 2023-08-29T22:06:16Z

src/components/CustomStatusBar/index.js

+        Navigation.isNavigationReady().then(() => {
+            const currentRoute = navigationRef.getCurrentRoute();
+            let currentScreenBackgroundColor = themeColors.appBG;
+            if (currentRoute && 'name' in currentRoute && currentRoute.name in themeColors.PAGE_BACKGROUND_COLORS) {
+                currentScreenBackgroundColor = themeColors.PAGE_BACKGROUND_COLORS[currentRoute.name];
+            }
+            StatusBar.setBarStyle('light-content', true);
+            StatusBar.setBackgroundColor(currentScreenBackgroundColor);
+        });


Please add a comment here

allroundexperts · 2023-09-03T14:40:48Z

Bump @Santhosh-Sellavel!

Santhosh-Sellavel · 2023-09-03T23:57:40Z

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 / Chrome
- iOS / native
- iOS / 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

Web

Screen.Recording.2023-09-04.at.5.20.53.AM.mov

Mobile Web - Chrome & Mobile Web - Safari

Screen.Recording.2023-09-04.at.5.15.17.AM.mov

iOS & Android

Native.mov

Santhosh-Sellavel

LGTM, Tests well!

mountiny · 2023-09-04T04:48:05Z

Thanks guys! Looks good to me too but marking it as hold freeze to focus on conference related PRs.

allroundexperts · 2023-09-11T19:07:11Z

Merged with main!

mountiny

Thanks!

OSBotify · 2023-09-12T03:09:23Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.68-6 🚀

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

OSBotify · 2023-09-13T08:41:52Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.68-17 🚀

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

OSBotify · 2023-09-14T10:56:50Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.70-0 🚀

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

OSBotify · 2023-09-18T10:14:48Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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

allroundexperts added 2 commits August 25, 2023 04:07

fix: maintain consistent topbar colour on login

7bd9bdb

fix: prettier

c736a71

allroundexperts requested a review from a team as a code owner August 24, 2023 23:22

melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team August 24, 2023 23:22

allroundexperts mentioned this pull request Aug 24, 2023

[HOLD for payment 2023-09-20] [$1000] mWeb - Topbar color is different in LHN #23345

Closed

6 tasks

fix: failing tests

18cec5e

mountiny assigned allroundexperts Aug 25, 2023

Santhosh-Sellavel reviewed Aug 29, 2023

View reviewed changes

allroundexperts added 2 commits August 31, 2023 15:45

Merge branch 'main' into fix-23345

ecf6e1f

fix: add a comment

9d28155

Santhosh-Sellavel approved these changes Sep 4, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny September 4, 2023 00:06

mountiny changed the title ~~fix: maintain consistent topbar colour on login~~ [Hold merge freeze] fix: maintain consistent topbar colour on login Sep 4, 2023

Merge branch 'main' into fix-23345

d55d166

allroundexperts changed the title ~~[Hold merge freeze] fix: maintain consistent topbar colour on login~~ fix: maintain consistent topbar colour on login Sep 11, 2023

mountiny approved these changes Sep 12, 2023

View reviewed changes

mountiny merged commit d59ef09 into Expensify:main Sep 12, 2023

OSBotify mentioned this pull request Sep 12, 2023

Deploy Checklist: New Expensify 2023-09-12 #27210

Closed

OSBotify mentioned this pull request Sep 14, 2023

Deploy Checklist: New Expensify 2023-09-14 #27425

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: maintain consistent topbar colour on login #25908

fix: maintain consistent topbar colour on login #25908

allroundexperts commented Aug 24, 2023

melvin-bot bot commented Aug 24, 2023

Santhosh-Sellavel Aug 29, 2023

allroundexperts Aug 31, 2023

allroundexperts commented Sep 3, 2023

Santhosh-Sellavel commented Sep 3, 2023

Santhosh-Sellavel left a comment

mountiny commented Sep 4, 2023

allroundexperts commented Sep 11, 2023

mountiny left a comment

OSBotify commented Sep 12, 2023

OSBotify commented Sep 13, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023

fix: maintain consistent topbar colour on login #25908

fix: maintain consistent topbar colour on login #25908

Conversation

allroundexperts commented Aug 24, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 24, 2023

Santhosh-Sellavel Aug 29, 2023

Choose a reason for hiding this comment

allroundexperts Aug 31, 2023

Choose a reason for hiding this comment

allroundexperts commented Sep 3, 2023

Santhosh-Sellavel commented Sep 3, 2023

Reviewer Checklist

Screenshots/Videos

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

mountiny commented Sep 4, 2023

allroundexperts commented Sep 11, 2023

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 12, 2023

OSBotify commented Sep 13, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023