Fix status bar of mWeb Safari doesn't match the splash screen background color

[bernhardoj]

Details

When the splash screen is shown, the status bar doesn't match the splash screen background.

Fixed Issues

$ #40683
PROPOSAL: #40683 (comment)

Tests

Same as QA Steps

• Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

1. (mWeb) Refresh the web (Android/iOS) Close and reopen the app
2. Verify the device status bar matches the splash screen background color

Web/Desktop: there is no status bar, so I just provide a ss of the home
Android mWeb: looks like the status bar isn't customizable, so it won't match the splash screen color too

• 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: mWeb Chrome
  • iOS: Native
  • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • 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 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• 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.

Screenshots/Videos

Android: Native

Screen.Recording.2024-05-08.at.18.42.54.mov

Android: mWeb Chrome

Screen.Recording.2024-05-08.at.18.42.32.mov

iOS: Native

Screen.Recording.2024-05-08.at.18.40.14.mov

iOS: mWeb Safari

Screen.Recording.2024-05-08.at.18.39.32.mov

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot]

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

[getusha]

@bernhardoj the status bar changes to white before the splash hides, i think we should fix that wdyt?

Screen.Recording.2024-05-12.at.5.03.15.in.the.afternoon.mov

cc @grgia

[bernhardoj]

@getusha yep, I noticed it too. It's because we update the status bar color on mount here:

App/src/components/CustomStatusBarAndBackground/index.tsx

Lines 117 to 120 in 6f9f7ab

	useEffect(() => {
	updateStatusBarAppearance({backgroundColor: theme.appBG});
	// eslint-disable-next-line react-hooks/exhaustive-deps -- we only want this to run on first render
	}, []);

So it's updated before the splash hide animation is done. It's to fix #37276. The issue is that the status bar doesn't update in mWeb. The root cause is explained on the selected proposal, but basically, the root cause is that both theme.appBG and theme.splashBG (web only) have the same color value (productDark100), so the condition/logic to update the status bar here fails.

App/src/components/CustomStatusBarAndBackground/index.tsx

Lines 41 to 43 in 6f9f7ab

	// The prev and current status bar background color refs are initialized with the splash screen background color so the status bar color is changed from the splash screen color to the expected color atleast once on first render - https://github.com/Expensify/App/issues/34154
	const prevStatusBarBackgroundColor = useRef(theme.splashBG);
	const statusBarBackgroundColor = useRef(theme.splashBG);

App/src/components/CustomStatusBarAndBackground/index.tsx

Lines 98 to 101 in 6f9f7ab

	if (currentScreenBackgroundColor !== theme.appBG || prevStatusBarBackgroundColor.current !== theme.appBG) {
	statusBarAnimation.value = 0;
	statusBarAnimation.value = withDelay(300, withTiming(1));
	}

We should remove it, but it will make the issue happen again as shown by the video below.

Screen.Recording.2024-05-13.at.14.22.09.mov

Fortunately, we already updated the splash screen color for all platforms to green400, but we haven't updated the theme.splashBG value yet. So, the last step is to update the theme.splashBG to green400.

App/src/styles/theme/themes/dark.ts

Line 10 in 6f9f7ab

splashBG: getSplashBackgroundColor(),

The final result will look like this:

Screen.Recording.2024-05-13.at.14.28.31.mov

[getusha]

Fortunately, we already #39997, but we haven't updated the theme.splashBG value yet. So, the last step is to update the theme.splashBG to green400.

I wonder why we use green400 for native and not for web, it seems like on purpose.

App/src/libs/getSplashBackgroundColor/index.ts

Line 4 in 6f9f7ab

return colors.productDark100;

[getusha]

@bernhardoj bump on this

[bernhardoj]

The different colors on the web and native doesn't matter anymore because we already make it the same in this PR #39997, so we just need to update the value in the theme file as I mentioned in my previous comment.

[getusha]

thanks, can you apply the changes you described in #41830 (comment)?
the result looks good to me.

[bernhardoj]

Updated!

[shawnborton]

Can you also show what it looks like when this banner is present:

Thanks!

[bernhardoj]

We can only see that banner when the app is deployed, cmiiw @getusha

[shawnborton]

I can make a test build, let's try that?

[bernhardoj]

Yes, that would be great. I can check it tomorrow.

[github-actions]

🧪🧪 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/41830/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/41830/index.html
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/41830/NewExpensify.dmg	https://41830.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[shawnborton]

Hmm can't really test the app install banner from this build :( But I did find a different bug, notice the lag in when the status bar color changes:

RPReplay_Final1716916307.MP4

[bernhardoj]

I can't see the banner either.

notice the lag in when the status bar color changes:

I can reproduce the lag on staging too. I think it's the animation that is lagging, not the whole page.

Screen.Recording.2024-05-29.at.10.57.19.mov

[getusha]

@shawnborton does this look good to you?

[shawnborton]

Hmm I am a bit confused by your last video. Why the white status bar area?

I'm saying that there is a slight lag when the status bar goes from green to dark when the homepage is loaded. Can we fix that somehow?

[bernhardoj]

Hmm I am a bit confused by your last video. Why the white status bar area?

That's a video to show the lag on staging too.

I'm saying that there is a slight lag when the status bar goes from green to dark when the homepage is loaded. Can we fix that somehow?

Because the lag is happening on staging too, the lag isn't caused by changing the status bar color and most likely coming from the animation. Maybe we can delay the animation start? Haven't tested it yet though.

[shawnborton]

Ah okay, that makes sense. If we can fix the delay, that would be amazing. Otherwise I suppose we can ignore that for now and the green status bar is an improvement?

[bernhardoj]

I was trying to turn off the Lottie auto-play and play it manually after a delay, but the function doesn't seem to work. I also can't find a pattern to delay the animation on our App yet, so I suppose we can ignore it for now.

[getusha]

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• 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

[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.84-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.84-3 🚀

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