Animate splash screen

[zoontek]

Details

This PR adds support for animated splash screen , instead of a simple fade out.

A few things:

• The bootsplash module has been updated to handle promises, in the exact same way as react-native-bootsplash v4. This is important to wait that the native splash screen is hidden before firing the animation.
• This PR does not rely on react-native-reanimated. As it's only scale and opacity, it's already 100% native animations (I also tried with reanimated, the behaviour / smoothness were identical)
• On the web, I kept a simple fade as it's not a common pattern to have an animated splash screen on this platform (same I tried it, it felt weird 😅)
• I removed the fallback prop on NavigationContainer, which was responsible for this ugly loading screen just after the splash screen hide. It appears their documentation say: "If you have a native splash screen, please use onReady instead of fallback prop.", so this is the way to go (Link)
• I set the status bar to BaseAppTheme android:statusBarColor on Android, at start. Before, it was the color of the splash screen: it worked since we faded the native splash screen as a whole, making the system bars fade with it. It doesn't work with this new approach since the system bars cannot just switch from splash screen background color to app status bar color when removing the native splash screen (without fade). So instead, I immediately apply the app status bar color. It continues to "blink" in development on Android >= 12 (system thread splash screen uses transparent system bars, app thread splash screen does not), but it's not an issue on release as it's nearly immediate (check videos)
• I added a navigationBarHeight constant to be able to center the logo on window height (including system bars). It uses a logic 100% identical to react-native StatusBar module.
• I re-generated the assets since they were 1px off compared to the SVG (use Github Swipe view to see the small difference)

Fixed Issues

https://github.com/Expensify/App/issues/14151

Tests

1. Compiles and starts the app on a device with iOS or Android
2. Verify that the splash screen is animated and dismissed

Offline tests

QA Steps

PR Author Checklist

• [x] I linked the correct issue in the ### Fixed Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] I added steps for the expected offline behavior in the Offline steps section
  • [x] I added steps for Staging and/or Production testing in the QA steps section
  • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [x] 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)
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android / native
  • [x] Android / Chrome
  • [x] iOS / native
  • [x] iOS / Safari
  • [x] MacOS / Chrome / Safari
  • [x] MacOS / Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] 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:
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

No changes (still a simple fade):

https://user-images.githubusercontent.com/1902323/232309117-f29193e3-7fbc-4c35-9007-6b7e93ac4854.mp4

Mobile Web - Chrome

No changes, similar to Web version.

Mobile Web - Safari

No changes, similar to Web version.

Desktop

No changes, similar to Web version.

iOS

https://user-images.githubusercontent.com/1902323/232308861-aaade986-e525-40a2-af02-99c997cd27ba.mp4

Android

Android 13 (release, Pixel 4a, high-end device):

https://user-images.githubusercontent.com/1902323/232309509-38e1be71-5dd0-4646-9a0a-94ff42fbf15b.mp4

---

Android 10 (release, Xiaomi A2, low-end device):

https://user-images.githubusercontent.com/1902323/232309564-2c47b2ab-7146-4c8f-9c66-b8ced28eee0f.mp4

[MelvinBot]

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

[Gonals]

rerolling pullerbear, as I'm OOO on parental leave

[MelvinBot]

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

[marcochavezf]

Hi @zoontek! Could you fix the conflict?

[zoontek]

@marcochavezf Done

[0xmiroslav]

reviewing today

[zoontek]

@0xmiroslav Any news?

[0xmiroslav]

iOS looks good. I am currently testing on various android devices including lower OS versions. will update soon

[0xmiroslav]

@marcochavezf can you please add Ready To Build label, so we can test release build?

[marcochavezf]

@marcochavezf can you please add Ready To Build label, so we can test release build?

Done

[0xmiroslav]

@zoontek is it ready for another review?

[zoontek]

@0xmiroslav Not yet. I published the updated animation (link) and removed Platform usage in the Expensify.js file, but there's still an issue with the new home screen and I continue to investigate.

[zoontek]

@0xmiroslav I fixed the issue! It appears that the bootsplash module can be faster to hide the native splash screen than Animated.View to render.

So I updated the logic, renamed AnimatedSplashScreen to SplashScreenHider, which is responsible to hide the native splash screen and animate the JS one when onLayout is triggered (instead of using useEffect in this case)

I restarted the app a dozen of times, I cannot reproduce it anymore 🎉 So it's ready for a second review.

[0xmiroslav]

ok, will review again. Meanwhile, @marcochavezf can you please trigger release build again?

[marcochavezf]

ok, will review again. Meanwhile, @marcochavezf can you please trigger release build again?

I noticed I had to run a workflow too. It's already triggered, the QR codes should be posted in one hour approximately.

[marcochavezf]

Oh conflict again, @zoontek could you resolve it?

[zoontek]

@marcochavezf Done ✅

[marcochavezf]

Cool thanks! Re-run action to build and deploy apps.

[0xmiroslav]

Thanks for the builds. reviewing again now

[0xmiroslav]

still hard for me to see animation

https://user-images.githubusercontent.com/97473779/236144325-29cecbf9-3b64-4c74-a116-9864e7f16b99.mp4

[zoontek]

@0xmiroslav I clearly see it in the video. This has to be fast since the app is already loaded and it's just additional wait for the user. It's approximately the same duration as the previous fade.

[0xmiroslav]

ok, let's remove platform specific code and we are all good

[zoontek]

@0xmiroslav I'm on it. PS: Given the fact that I also fixed https://github.com/Expensify/App/issues/18172 for free here can I get the Upwork job too?

This was caused by:

I removed the fallback prop on NavigationContainer, which was responsible for this ugly loading screen just after the splash screen hide. It appears their documentation say: "If you have a native splash screen, please use onReady instead of fallback prop.", so this is the way to go (Link)

[0xmiroslav]

Given the fact that I also fixed https://github.com/Expensify/App/issues/18172 for free here can I get the Upwork job too?

I am not the one who handles this. You can raise discussion on linked issue.

I noticed that you wrongly linked issue in PR description, which will break automation after merged. Please update Fixed Issues section like this:

### Fixed Issues
$ https://github.com/Expensify/App/issues/14151

[zoontek]

@0xmiroslav All done ✅

[zoontek]

I updated the description to include https://github.com/Expensify/App/issues/18172, as it has been assigned to me 🙂

[0xmiroslav]

@zoontek please merge main and fix conflict

[0xmiroslav]

@zoontek loading indicator still shows on web, fine on other platforms

https://github.com/Expensify/App/assets/97473779/4e85ce01-842c-49e3-a550-d2b58fa79fa0

[zoontek]

@0xmiroslav I just tried and I cannot reproduce it (even by throttling network to slow 3G):

https://github.com/Expensify/App/assets/1902323/764083e8-4856-4481-b8ce-c1ac92efdc92

https://github.com/Expensify/App/assets/1902323/47000455-8981-46cf-809e-62f7f34de710

I rebased against main ✅

[zoontek]

@0xmiroslav I see an error in your console (refusing to execute the inline script because of CSPs), is the splash(.js) screen script simply blocked on your test domain?

EDIT: I can confirm that the splash.js script is inlined in the HTML when built, so yeah, it's a CSP issue. You can tweak that in your server config (to accept inline script from expensify.com and *.expensify.com) 🙂