Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: status bar color when modal is visible #28407

Merged

Conversation

ishpaul777
Copy link
Contributor

@ishpaul777 ishpaul777 commented Sep 28, 2023

Details

Fixed Issues

$ #28263
PROPOSAL: #28263 (comment)

Tests

  • Verify that no errors appear in the JS console
    On mobile devices -
  • Open FAB "+" menu in Sidebar verify statusbar color is same as overlay color
  • Open a report, click on "+" to open a modal verify statusbar color is same as overlay color

Offline tests

QA Steps

  • Verify that no errors appear in the JS console
    On mobile devices -
  • Open FAB "+" menu in Sidebar verify statusbar color is same as overlay color
  • Open a report, click on "+" to open a modal verify statusbar color is same as overlay color

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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2023-09-28.at.10.50.25.PM.mov
Mobile Web - Chrome
Record_2023-09-30-22-34-56.mp4
Mobile Web - Safari
Simulator.Screen.Recording.-.iPhone.14.Pro.-.2023-09-28.at.21.43.23.mp4
Desktop
Screen.Recording.2023-09-28.at.10.47.43.PM.mov
iOS
Simulator.Screen.Recording.-.iPhone.14.Pro.-.2023-09-28.at.21.52.16.mp4
Android
Screen.Recording.2023-09-28.at.10.41.43.PM.mov

@ishpaul777 ishpaul777 requested a review from a team as a code owner September 28, 2023 17:30
@melvin-bot melvin-bot bot requested review from fedirjh and removed request for a team September 28, 2023 17:30
@melvin-bot
Copy link

melvin-bot bot commented Sep 28, 2023

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

@fedirjh
Copy link
Contributor

fedirjh commented Sep 28, 2023

cc @s77rt can you please review this one

@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Sep 28, 2023

hii @s77rt,
Can you please explain why we are changing the status bar color on sidebarscreen.

https://github.com/Expensify/App/blob/main/src/pages/home/sidebar/SidebarScreen/index.js#L15-L24

This seems to be creating a issue (not repro on prod) on mweb chrome when we navigate from settings to sidebar or click close button on security page, and open a report, the status bar color remain unchanged.

We are already changing the color of status bar color on navigation state change here. i believe we can remove useFocusEffect entirely or atleast remove the clean up function What do you think?

@s77rt
Copy link
Contributor

s77rt commented Sep 28, 2023

@fedirjh Thanks!

@s77rt
Copy link
Contributor

s77rt commented Sep 28, 2023

@ishpaul777 Can you please upload a video for the new bug?

@ishpaul777
Copy link
Contributor Author

I am away from my machine, can you try to repro with below steps

Steps to repro-
1.Navigate to settings pages
2.Click back icon
3. Open any report

Expected result -
Status bar color same as appBg

Actual result -
Status bar color is same as sidebar

@s77rt
Copy link
Contributor

s77rt commented Sep 28, 2023

Seems fine from my end

Screen.Recording.2023-09-28.at.9.40.00.PM.mov

@ishpaul777
Copy link
Contributor Author

Weird can you try closing the security page by clicking 'x' icon

@s77rt
Copy link
Contributor

s77rt commented Sep 28, 2023

Still seems to be working well

@s77rt
Copy link
Contributor

s77rt commented Sep 29, 2023

Can you plaese include screenshot for mWeb - Chrome?

@ishpaul777
Copy link
Contributor Author

Sorry for delayed response please see below 👇

Record_2023-09-30-16-43-11.mp4

Not sure why this is not reproducable on prod.

@s77rt
Copy link
Contributor

s77rt commented Sep 30, 2023

Can you reproduce that bug on main? I'm not able to reproduce it either way and I don't see how we may be breaking the functionality with the color change.

@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Sep 30, 2023

After merging main this is not reproducable, i still am not sure whats changed, I dont believe this was related to this PR. Can you proceed with your review?

Also I reported a bug while ago - https://expensify.slack.com/archives/C049HHMV9SM/p1694868564758319 this was not reproduced, so not logged in GH, after this PR the bug is still reproducable for me, Can you confirm the same?

@s77rt
Copy link
Contributor

s77rt commented Sep 30, 2023

Can you add the mWeb Chrome test to the PR description

@s77rt
Copy link
Contributor

s77rt commented Sep 30, 2023

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 web
Mobile Web - Chrome mweb-chrome
Mobile Web - Safari mweb-safari
Desktop desktop
iOS ios
Android android

@ishpaul777
Copy link
Contributor Author

Added the video. @s77rt, awaiting your response on #28407 (comment)

@s77rt
Copy link
Contributor

s77rt commented Sep 30, 2023

I will proceed here as I don't see that bug reproducible from my end and also because it was reported previously on main.

@roryabraham
Copy link
Contributor

Noting here that in general we should be using this solution for setting the status bar color, but in the case of Modals it doesn't always work because not all modals are screens in react-navigation

@roryabraham
Copy link
Contributor

Also noticed while reviewing this that this code is unnecessary and can be safely removed – doing so is actually an improvement because the default behavior animates the status bar transition and that code does not.

@roryabraham roryabraham merged commit 69ecebc into Expensify:main Oct 2, 2023
13 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Oct 2, 2023

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Oct 2, 2023

this code is unnecessary and can be safely removed

Hii @roryabraham, 👆 Thats what i realized #28407 (comment) but was not sure why are we changing statusbar color. I am able to work on the improvement. Should I raise a PR?

@roryabraham
Copy link
Contributor

@ishpaul777 I already opened one, thanks

@OSBotify
Copy link
Contributor

OSBotify commented Oct 2, 2023

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.76-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 3, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 3, 2023

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.77-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 5, 2023

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants