Fix 20516 mWeb topbar color #20805

kushu7 · 2023-06-15T11:54:43Z

Details

Setting StatusBar for mWeb to keep consistency with Native Apps.

Fixed Issues

$ #20516
PROPOSAL: #20516 (comment)

Tests

Open App in mobile browser
Verify the TopBar of LHN should match with LHN background.
Verify other pages TopBar should match with native app StatusBar.

Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

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

Web

web.mov

Mobile Web - Chrome

mweb.chrome.mov

Mobile Web - Safari

mweb.safari.mov

Desktop

desktop.mov

iOS

ios.mp4

Android

android.mov

melvin-bot · 2023-06-15T17:38:02Z

@pecanoro @thesahindia One of you needs to 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]

pecanoro · 2023-06-16T18:31:12Z

@thesahindia Friendly bump so we can merge it within the bonus!

thesahindia · 2023-06-17T08:29:17Z

Looks like I won't be able to look into it before Monday so @allroundexperts will take my place. Thanks!!

allroundexperts · 2023-06-17T08:30:03Z

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

Mobile Web - Chrome

Screen.Recording.2023-06-19.at.8.18.45.AM.mov

Mobile Web - Safari

Screen.Recording.2023-06-19.at.8.19.39.AM.mov

Desktop

iOS

Screen.Recording.2023-06-19.at.8.36.55.AM.mov

Android

Screen.Recording.2023-06-19.at.8.30.45.AM.mov

allroundexperts · 2023-06-17T20:55:10Z

src/libs/Navigation/AppNavigator/Navigators/RightModalNavigator.js

+    useEffect(() => {
+        if (!Browser.isMobile()) return;
+        InteractionManager.runAfterInteractions(() => StatusBar.setBackgroundColor(themeColors.appBG));
+    }, []);
+


Why aren't we using useFocusEffect here?

As useFocusEffect will call on every focus, we don't want it here because SidebarScreen is our main screen for mWeb with different bg color. we always have to return to main screen by going back so we have to useFocusEffect there so it can get called on everytime screen is focused. as RightModalNavigator will called for every screen it contains, changing color once will do the job. And we direct modify meta color we should always minimize the calls

allroundexperts · 2023-06-17T20:56:00Z

src/pages/home/ReportScreen.js

    componentDidMount() {
+        if (this.isMobileBrowser) {
+            InteractionManager.runAfterInteractions(() => StatusBar.setBackgroundColor(themeColors.appBG));
+        }
+


Same question as above. componentDidMount will get triggered even if the screen is not visible.

Same as above. ReportScreen contains appBG as background color. So we can just do it on screen mount.

allroundexperts · 2023-06-17T20:59:45Z

src/pages/home/sidebar/SidebarScreen/index.js

+    useFocusEffect(() => {
+        InteractionManager.runAfterInteractions(() => StatusBar.setBackgroundColor(themeColors.sidebar));
+    });


You might want to wrap this function inside a callback because if above is used as it is, the code will run ALWAYS when:

Screen is focused

The component re-renders
ref: https://reactnavigation.org/docs/use-focus-effect/

Thanks, I have updated the code. so it will run on focus only.

allroundexperts · 2023-06-17T21:02:50Z

src/pages/home/sidebar/SidebarScreen/index.js

 function SidebarScreen(props) {
    const popoverModal = useRef(null);

+    useFocusEffect(() => {


You might also want to run a cleanup function that restores the previous colour.

I guess you are right. If we use cleanup to restore previous then we don't have to use change on other screen 😇

allroundexperts · 2023-06-17T21:05:06Z

src/components/Modal/index.web.js

        }

-        StatusBar.setBackgroundColor(color);
+        InteractionManager.runAfterInteractions(() => StatusBar.setBackgroundColor(color));


@kushu7 Why do we need to change other files (like SidebarScreen etc)? Shouldn't a change in this file alone handle the status bar colours?

Its required to keep consistency between colors, SidebarScreen bg is using different color.
And Modal contains overlay, full screen modal. So changing color here alone will not work.
You should see one of my mWeb video. You will get my point.

kushu7 · 2023-06-18T00:09:06Z

@allroundexperts I have completed the requested changes and also did some cleanup ☮️

allroundexperts · 2023-06-18T00:09:39Z

src/pages/home/sidebar/SidebarScreen/index.js

+
+    useFocusEffect(
+        useCallback(() => {
+            if (!isFocused) return;


This is not needed. useFocusEffect gets triggered only when the screen is focused.

allroundexperts · 2023-06-18T00:09:59Z

src/pages/home/sidebar/SidebarScreen/index.js

+            return () => {
+                InteractionManager.runAfterInteractions(() => StatusBar.setBackgroundColor(previousColor));
+            };
+        }, [isFocused]),


This should be empty.

allroundexperts · 2023-06-18T00:10:28Z

src/pages/home/sidebar/SidebarScreen/index.js

+            InteractionManager.runAfterInteractions(() => StatusBar.setBackgroundColor(themeColors.sidebar));
+
+            return () => {
+                InteractionManager.runAfterInteractions(() => StatusBar.setBackgroundColor(previousColor));


Cant we set background without InteractionManager?

Without interaction manager will cause lag on mid-end android devices. I have tested it with two devices

Can you attach a video of before and after?

Without InteractionManager

Record_2023-06-18-05-52-41.mp4

With InteractionManager

Record_2023-06-18-05-53-28.mp4

allroundexperts · 2023-06-18T00:15:43Z

src/components/Modal/index.web.js

+import CONST from '../../CONST';

 function Modal(props) {
+    const [previousStatusBarColor, setPreviousStatusBarColor] = useState();


Where is this being used?

on hideModal

But where are we setting this?

We setPreviousStatusBarColor on showModal with currrent color. and restore it on hideModal

kushu7 · 2023-06-19T04:00:08Z

Never mind. It works once the page has loaded fully.

@allroundexperts I have attached the video that you requested.

kushu7 · 2023-06-20T14:37:53Z

@pecanoro Friendly bump for review 🫣

pecanoro · 2023-06-20T15:53:16Z

It was a federal holiday yesterday in the US so I was out (it won't count for bonus either), but I am taking a look today.

pecanoro · 2023-06-20T16:03:02Z

I noticed this while watching the videos, I think we should make the top look the same color as the IOU:

kushu7 · 2023-06-20T16:31:34Z

I noticed this while watching the videos, I think we should make the top look the same color as the IOU:

@pecanoro @allroundexperts I guess for doing this in native it would require more refactoring.
currently backgroundColor is shown in StatusBar in Native devices.
using ScreenWrapper

App/src/pages/home/ReportScreen.js

Line 272 in 99214de

for doing this we have to refactor it allow different color for both StatusBar and background.
like if we change backgroundColor to red then it would look like this.

Image

pecanoro · 2023-06-20T16:36:18Z

Ahh interesting, yeah, after digging more on how this works, I think we should stick to the background color since then it might get too complicated for future cases. With that in mind, it looks and works great, I don't think we can do anything about that tiny browser delay.

@thesahindia Can you do a final review and complete the checklist so I can do my final review?

kushu7 · 2023-06-20T16:40:03Z

@thesahindia Can you do a final review and complete the checklist so I can do my final review?

I think @allroundexperts is C+ here.

allroundexperts · 2023-06-20T16:41:49Z

@pecanoro I've already completed the review and filled in the checklist!

pecanoro · 2023-06-20T17:01:31Z

Ah sorry, got confused with the assignments in the PR, my bad for not checking 😄 I will do a final check then before approving.

pecanoro · 2023-06-20T18:09:28Z

I keep getting a crash on this branch when running the web version, I can run the app without issues on main, can you check to see if it's only me?

allroundexperts · 2023-06-20T18:10:26Z

I keep getting a crash on this branch when running the web version, I can run the app without issues on main, can you check to see if it's only me?

@pecanoro What error message are you seeing?

pecanoro · 2023-06-20T18:14:10Z

This is the error, I tried even deleting the node modules and reinstalling and still no luck:

allroundexperts · 2023-06-20T18:15:58Z

@kushu7 can you check? Probably also merge with main.

kushu7 · 2023-06-20T18:16:40Z

I just checked seems working fine,
let me merge main and push again

…-topbar-color

kushu7 · 2023-06-20T18:21:08Z

@pecanoro Can you try again, I just merged main.

pecanoro · 2023-06-20T18:40:45Z

That did the trick, thanks! Testing again

src/components/Modal/index.web.js

pecanoro · 2023-06-20T19:04:01Z

Just a small change. I wonder why it requested changes were posted twice lol

OSBotify · 2023-06-20T19:34:02Z

✋ 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 · 2023-06-21T02:26:13Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.30-0 🚀

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

OSBotify · 2023-06-22T16:53:51Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.30-5 🚀

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

kushu7 added 5 commits June 15, 2023 17:01

updated modal web to keep old statusbar color

6a6adf2

set statusbar color for RHP screen & report on mWeb

e893e6b

set statusbar color to sidebar in useFocusEffect

9280c5b

set StatusBar color based on modal type

680c84a

wrapped in run after interaction

16519e2

kushu7 marked this pull request as ready for review June 15, 2023 17:37

kushu7 requested a review from a team as a code owner June 15, 2023 17:37

melvin-bot bot requested review from pecanoro and thesahindia and removed request for a team June 15, 2023 17:38

allroundexperts reviewed Jun 17, 2023

View reviewed changes

kushu7 added 3 commits June 18, 2023 05:28

fixed useFocusEffect usage

b078ef8

removed unnecessary changes

749e863

prettier

3234d1e

kushu7 requested a review from allroundexperts June 18, 2023 00:07

allroundexperts reviewed Jun 18, 2023

View reviewed changes

removed unnecessary deps

1b18196

kushu7 requested a review from allroundexperts June 18, 2023 00:36

pecanoro removed the request for review from thesahindia June 20, 2023 17:00

Merge remote-tracking branch 'origin/main' into kushu7-fix-20516-mWeb…

77edccf

…-topbar-color

pecanoro requested changes Jun 20, 2023

View reviewed changes

src/components/Modal/index.web.js Outdated Show resolved Hide resolved

comment updated

40708cb

pecanoro approved these changes Jun 20, 2023

View reviewed changes

pecanoro merged commit 2a5aee6 into Expensify:main Jun 20, 2023

kushu7 deleted the kushu7-fix-20516-mWeb-topbar-color branch June 20, 2023 19:31

OSBotify mentioned this pull request Jun 21, 2023

Deploy Checklist: New Expensify 2023-06-21 #21172

Closed

67 tasks

melvin-bot bot mentioned this pull request Jun 22, 2023

[HOLD for payment 2023-07-17] [$1000] [mWeb-safari] topbar color is different in LHN #20516

Closed

6 tasks

alitoshmatov mentioned this pull request Jun 30, 2023

Web - LHN - Console error when clicking FAB button #21944

Closed

6 tasks

Fix 20516 mWeb topbar color #20805

Fix 20516 mWeb topbar color #20805

Uh oh!

Conversation

kushu7 commented Jun 15, 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 Jun 15, 2023

Uh oh!

pecanoro commented Jun 16, 2023

Uh oh!

thesahindia commented Jun 17, 2023

Uh oh!

allroundexperts commented Jun 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kushu7 commented Jun 18, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kushu7 commented Jun 19, 2023

Uh oh!

kushu7 commented Jun 20, 2023

Uh oh!

pecanoro commented Jun 20, 2023

Uh oh!

pecanoro commented Jun 20, 2023

Uh oh!

kushu7 commented Jun 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

kushu7 commented Jun 15, 2023 •

edited

Loading

allroundexperts commented Jun 17, 2023 •

edited

Loading

kushu7 commented Jun 20, 2023 •

edited

Loading

kushu7 commented Jun 20, 2023 •

edited

Loading