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

Animate StatusBar background color #20663

Merged
merged 20 commits into from
Jun 29, 2023
Merged

Conversation

roryabraham
Copy link
Contributor

@roryabraham roryabraham commented Jun 13, 2023

Details

This PR stemmed off of #15462. For now, the only visual change is that the status bar on the homepage w/ the sidebar open matches the sidebar background color

Before

before.mov

After

after.mov

It's implemented in a very generic way, where the same effect can take place on any screen just by adding to the PAGE_BACKGROUND_COLOR constant in the theme file, because we'll be using it more in the future.

Note that this really only has any effect on mobile web, and not all browsers are even affected:

  • iOS (native) app displays edge-to-edge, so the status bar is transparent
  • Android (native) as of very recently, the app displays edge-to-edge, to the status bar is transparent
  • macOS Safari – unaffected by StatusBar.setBackgroundColor
  • macOS Chrome – unaffected
  • desktop app – unaffected
  • iOS Chrome – unaffected
  • iOS Safari – this is the primary place where this change can be observed.
  • Android Chrome – my Pixel 4a w/ Chrome is unaffected, but it's possible other devices / browsers may be affected.

Fixed Issues

$ (partial) #12261

Tests / QA Steps (iOS Safari)

  1. Run the app
  2. Verify that the while you're looking at the chat list / sidebar, the status bar matches the background
  3. Open a regular chat. Verify that the StatusBar animates to match the new page background (note: IOU reports happen to have a different background near the top of the screen than a regular chat, I'm considering this out-of-scope for now).
  4. Go back to the sidebar. Verify that the StatusBar animates to match the sidebar background.
  5. Open the settings page. Verify that the StatusBar animates to match the settings page background.
  6. Go back to the sidebar. Verify that the StatusBar animates to match the sidebar background.

Tests / QA Steps (all other platforms)

Nothing – just regression tests. Let me know if you see different behavior in an Android browser. Most likely it will not be a blocker, but since there are a lot of different Android devices I suppose it's possible something unexpected could happen 🤷🏼

  • Verify that no errors appear in the JS console

Offline tests

Repeat all the same steps offline – it should all happen the same.

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

no effect

Mobile Web - Chrome

no effect

Mobile Web - Safari
after.mov
Desktop

no effect

iOS

no effect

Android

no effect

@roryabraham roryabraham self-assigned this Jun 13, 2023
@roryabraham roryabraham changed the title Animate StatusBar background color [WIP] Animate StatusBar background color Jun 13, 2023
@roryabraham roryabraham changed the title [WIP] Animate StatusBar background color Animate StatusBar background color Jun 13, 2023
@roryabraham roryabraham marked this pull request as ready for review June 13, 2023 10:31
@roryabraham roryabraham requested a review from a team as a code owner June 13, 2023 10:31
@melvin-bot melvin-bot bot requested review from AndrewGable and removed request for a team June 13, 2023 10:31
@melvin-bot
Copy link

melvin-bot bot commented Jun 13, 2023

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

@roryabraham
Copy link
Contributor Author

@sobitneupane requesting your review since you were assigned as C+ in the original PR and issue

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting few console errors in Web:
Screenshot 2023-06-14 at 12 23 57
Screenshot 2023-06-14 at 12 23 49
Screenshot 2023-06-14 at 12 23 27
Screenshot 2023-06-14 at 12 23 16
Screenshot 2023-06-14 at 12 23 39

Screenshot 2023-06-14 at 12 24 04

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to Money Request Header, header in Task Page and AttachmentModal has lighter background color and doesn't match with statusBar. I think they are also out of scope of this PR as mentioned in the Test steps.

@roryabraham
Copy link
Contributor Author

@sobitneupane Unless I'm mistaken, all those propTypes errors were not introduced by this code.

@roryabraham
Copy link
Contributor Author

In addition to Money Request Header, header in Task Page and AttachmentModal has lighter background color and doesn't match with statusBar. I think they are also out of scope of this PR as mentioned in the Test steps.

Agree those are out of scope. As stated in the PR description, this PR is implemented in a way that should make it very easy to fix similar issues in the future by just adding the screen + background color to the style file.

@roryabraham
Copy link
Contributor Author

Updated and conflicts resolved.

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It solves the issue both on IOS/safari and Android/Chrome

Screenshots/Videos

Web Screenshot 2023-06-23 at 12 24 44
Mobile Web - Chrome
vidma_recorder_edited_23062023_125340.mp4
Mobile Web - Safari
Screen.Recording.2023-06-23.at.12.25.17.mov
Desktop Screenshot 2023-06-23 at 12 34 16
iOS Screenshot 2023-06-23 at 12 29 52
Android
Screen.Recording.2023-06-23.at.12.35.31.mov

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@roryabraham I am getting following console error on IOS and android. I am not sure if it is related to this PR or not but it is not reproducible in main. If it is not reproducilbe in your end we are good to merge this.

Screenshot 2023-06-23 at 12 31 34

() => statusBarAnimation.value,
() => {
const color = interpolateColor(statusBarAnimation.value, [0, 1], [prevStatusBarBackgroundColor.current, statusBarBackgroundColor.current]);
runOnJS(StatusBar.setBackgroundColor)(color);
Copy link
Contributor

@sobitneupane sobitneupane Jun 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like above console error is related to runOnJS.

@roryabraham
Copy link
Contributor Author

roryabraham commented Jun 26, 2023

@sobitneupane fixed the console error 👍🏼

Needed to pay attention to the Reanimated docs:

If you want to invoke some function from an external library in runOnJS please wrap it in a separate function

@roryabraham roryabraham requested a review from sobitneupane June 26, 2023 18:39
@sobitneupane
Copy link
Contributor

@roryabraham There is a new console warning on android.
Screenshot 2023-06-27 at 14 54 21

@roryabraham
Copy link
Contributor Author

roryabraham commented Jun 28, 2023

@sobitneupane that one is safe to ignore since our app displays edge-to-edge. Let me see about disabling it...

# Conflicts:
#	src/components/withCurrentReportId.js
#	src/libs/Navigation/NavigationRoot.js
@roryabraham
Copy link
Contributor Author

@sobitneupane resolved conflicts and that warning

@roryabraham roryabraham mentioned this pull request Jun 29, 2023
57 tasks
Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Screenshot 2023-06-29 at 14 12 16
Mobile Web - Chrome
vidma_recorder_edited_29062023_142335.mp4
Mobile Web - Safari
Screen.Recording.2023-06-29.at.14.09.32.mov
Desktop Screenshot 2023-06-29 at 14 26 57
iOS
Screen.Recording.2023-06-29.at.14.10.05.mov
Android
Screen.Recording.2023-06-29.at.14.13.23.mov

@AndrewGable AndrewGable merged commit c83b2d1 into main Jun 29, 2023
@AndrewGable AndrewGable deleted the Rory-AnimateHeaderBackgroundColor branch June 29, 2023 14:44
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.35-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jul 3, 2023

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Jul 3, 2023

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀

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

@sobitneupane
Copy link
Contributor

@roryabraham @AndrewGable PR was deployed to production 3 weeks ago. Should I make payment request on newDot?

@AndrewGable
Copy link
Contributor

Yes

@sobitneupane
Copy link
Contributor

Thanks @AndrewGable. Requested payment on newDot.

@JmillsExpensify
Copy link

@AndrewGable Can you confirm that the correct payment for @sobitneupane is $1,000 for this PR review?

@AndrewGable
Copy link
Contributor

Yes 👍

@JmillsExpensify
Copy link

Reviewed details for @sobitneupane. These details are accurate based on summary from Business Reviewer (note: No BugZero member assigned to this issue) and are now approved for payment in NewDot.

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