Add splash screen on web and desktop #12334

vladamx · 2022-11-01T12:01:13Z

Details

Since startup on web and desktop is not instant we want to avoid having long blank screen while app is starting up. This is especially visible when resources are not cached and network is slow.

Instead, we want to show a splash screen similar to the native mobile experience we already have.

The idea is to show the splash after specified minimum display time(avoids junk) and then wait for React to mount the root element with content, which will replace the splash screen with app content.

Open questions: @roryabraham

Do we transpile and minify inline script that is needed inside index.html?
Should we use webpack plugin to inline the script for us and have the script in the separate file?
https://www.npmjs.com/package/html-inline-script-webpack-plugin
Minimum display time is open for discussion. I put 1.5 second.

UI Responsivness Preview:

Screen.Recording.2022-10-28.at.21.23.13.mov

Fixed Issues

$ #12234
$ #12234 (comment)

QA / Tests

Open the application on web or desktop
Verify that splash screen appears for 1.5s and no blank screen is visible

Verify that no errors appear in the JS console

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots

Web

Screen.Recording.2022-10-28.at.21.24.54.mov

Mobile Web - Chrome

Screen.Recording.2022-11-01.at.12.55.14.mov

Mobile Web - Safari

Screen.Recording.2022-11-01.at.12.53.35.mov

Desktop

Screen.Recording.2022-11-01.at.12.58.24.mov

iOS

Not affected

Android

Not affected

roryabraham

Should we use webpack plugin to inline the script for us and have the script in the separate file?
npmjs.com/package/html-inline-script-webpack-plugin

We could, but I think this JS is simple/standard/small enough that it will work on any browser that's modern enough for us to care about. So I'd say probably don't worry about it

roryabraham · 2022-11-02T03:38:16Z

web/index.html

@@ -47,6 +47,26 @@
        ::-ms-reveal {
            display: none;
        }
+        @media screen and (min-width: 768px) {


Can we move this stuff to web/index.css?

Is index.css inlined?

web/index.html

roryabraham · 2022-11-02T03:43:20Z

web/index.html

@@ -58,5 +78,31 @@
 <body>
    <div style="position: absolute; top: 0; left: 0; right: 0; height: 30px;" id="drag-area"></div>
    <div id="root"></div>
+    <div id="splash" style="position: absolute; top: 0; left: 0; right: 0; background-color: white; width: 100%; height: 100%; display: flex; justify-content: center; align-items: center;">


Please move these styles to the css file mentioned in a previous comment instead of using inline styles.

#12334 (comment)

roryabraham · 2022-11-02T03:47:03Z

web/index.html

@@ -58,5 +78,31 @@
 <body>
    <div style="position: absolute; top: 0; left: 0; right: 0; height: 30px;" id="drag-area"></div>
    <div id="root"></div>
+    <div id="splash" style="position: absolute; top: 0; left: 0; right: 0; background-color: white; width: 100%; height: 100%; display: flex; justify-content: center; align-items: center;">
+        <div class="splash-logo">
+            <svg fill="none" width="100%" viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg">


Can we not use assets/images/new-expensify.svg here instead (and ideally the logo for the correct environment)?

I would rather just inline svg because of performance, again if we don't have webpack inlining this for us.

same question, how much performance gain do we get by inlining the svg?

roryabraham · 2022-11-02T03:47:37Z

web/index.html

+         </div>
+    </div>
+    <script>
+       var minMilisecondsToWait = 1.5 * 1000


Why using var instead of const and/or let?

Browser compatibility mainly. If we don't care about it, i can migrate.

web/index.html

roryabraham · 2022-11-02T03:58:18Z

web/index.html

+            </svg>
+         </div>
+    </div>
+    <script>


Is there any reason we shouldn't:

Move this JS code to another file, web/index.js

Then move this script tag to the header w/ the defer attribute

I think that gives us a few benefits:

The HTML and JS are split into smaller files and downloaded in parallel, which should make them both available faster than if they're part of the same larger file.

The JS code can be separated out

The script tag can live in the header instead of the bottom of the file (not critical, but nice for html organization)

I think those optimizations are fair in general but for the splash use case I think we need this small script inlined so browser does not need to fetch since we need to run this script as soon as we can on bootstrap

@vladamx how many ms does inline scripts shave off?

Co-authored-by: Rory Abraham <47436092+roryabraham@users.noreply.github.com>

…m/vladamx/App into vladamx-splash-screen-web-desktop

roryabraham

Okay, actually I think I'm convinced that inlining this stuff makes sense for the very specific use-case of a splash screen. While some of this code is a bit "ugly" to look at (i.e: inlined svg, var in the inline script, etc...), the best fix for that would probably be to use webpack to inject that stuff inline, like @vladamx said.

So now I'm torn about whether setting up that stuff in webpack is worth it 🤔 On one hand it feels maybe over-engineered, on the other hand feels like a clean solution (and more consistent with other code in this repo)

roryabraham · 2022-11-04T15:13:51Z

@vladamx @rushatgabhane What do you think? Should we just leave this as-is or implement https://www.npmjs.com/package/html-inline-script-webpack-plugin and https://www.npmjs.com/package/html-inline-css-webpack-plugin ?

rushatgabhane · 2022-11-04T18:24:18Z

#12234 (comment)

replied in issue to implement webpack-plugin

vladamx · 2022-11-08T01:39:21Z

@roryabraham Updated.

This is the inlined output

rushatgabhane · 2022-11-08T22:39:00Z

@vladamx can you please help me trigger the splash screen

I tried

npm run desktop
cmd + r and cmd + shift + r to reload

Screen.Recording.2022-11-09.at.4.07.32.AM.mov

vladamx · 2022-11-08T22:53:03Z

@rushatgabhane Hm, I've just tested again and it seems to work fine on my side. Can you restart the server and if it persists can you provide some logs from the console or network tab if any?

Screen.Recording.2022-11-08.at.23.49.51.mov

roryabraham

Looks great, very clever with the resourceQuery and resolve alias! Also, I've got a diff in package-lock.json when I run npm i – can you check if that needs to be committed please?

config/webpack/webpack.common.js

web/index.html

vladamx · 2022-11-09T22:48:42Z

@roryabraham Updated

roryabraham

Thanks, LGTM and tests well 👍🏼

roryabraham · 2022-11-11T01:12:10Z

web/splash/splash.css

+    display: flex; 
+    justify-content: center; 
+    align-items: center;
+}


NAB missing newline at EOF

roryabraham · 2022-11-11T01:13:21Z

All yours @rushatgabhane

rushatgabhane

@vladamx bug: The logo is off-center for mWeb Android and iOS

(desktop and web look good tho!)

vladamx · 2022-11-11T18:41:06Z

Updated. Svg had its own sizing i needed to overwrite with higher specificity selector

roryabraham

LGTM, all yours @rushatgabhane

rushatgabhane

@vladamx thanks for the changes!

@roryabraham LGTM as well

Web

Screen.Recording.2022-11-13.at.12.06.32.PM.mov

mWeb

Screen.Recording.2022-11-13.at.12.09.23.PM.mov

iOS

Android

Desktop

Screen.Recording.2022-11-13.at.12.04.46.PM.mov

PR 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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

OSBotify · 2022-11-13T19:19:11Z

✋ 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 · 2022-11-15T21:58:44Z

🚀 Deployed to staging by @roryabraham in version: 1.2.28-0 🚀

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

OSBotify · 2022-11-15T23:40:44Z

🚀 Deployed to staging by @roryabraham in version: 1.2.28-0 🚀

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

roryabraham · 2022-11-16T21:36:14Z

Just coming full circle here, this PR caused a regression. It worked on dev but not staging and production. We could have prevented this regression by locally testing staging and production builds. We generally don't do that on all PRs, but it's usually a good idea when changing code in the web or desktop directories.

OSBotify · 2022-11-17T07:37:46Z

🚀 Deployed to production by @roryabraham in version: 1.2.28-2 🚀

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

Add splash screen on web and desktop

d5cb0f3

vladamx requested a review from a team as a code owner November 1, 2022 12:01

melvin-bot bot requested review from roryabraham and rushatgabhane and removed request for a team November 1, 2022 12:01

roryabraham requested changes Nov 2, 2022

View reviewed changes

vladamx and others added 3 commits November 2, 2022 15:26

Format if statement

3a21eec

Co-authored-by: Rory Abraham <47436092+roryabraham@users.noreply.github.com>

Refactor inline media styles for logo sizing

06afecf

Merge branch 'vladamx-splash-screen-web-desktop' of https://github.co…

3064a10

…m/vladamx/App into vladamx-splash-screen-web-desktop

roryabraham reviewed Nov 4, 2022

View reviewed changes

Add html-inline-script-webpack-plugin

8eb37ce

Update to new-expensify.svg

0c738b9

Map to correct logo svg based on env

80c2561

roryabraham requested changes Nov 9, 2022

View reviewed changes

config/webpack/webpack.common.js Outdated Show resolved Hide resolved

web/index.html Outdated Show resolved Hide resolved

vladamx added 2 commits November 9, 2022 23:45

Update package.lock

70dd6f4

Format webpack config and index.html

910ee6a

roryabraham previously approved these changes Nov 11, 2022

View reviewed changes

web/splash/splash.css Outdated

display: flex;

justify-content: center;

align-items: center;

}

Copy link

Contributor

roryabraham Nov 11, 2022

Choose a reason for hiding this comment

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

NAB missing newline at EOF

rushatgabhane suggested changes Nov 11, 2022

View reviewed changes

Overwrite svg size with higher selector specificity

4a9597c

vladamx dismissed roryabraham’s stale review via 4a9597c November 11, 2022 18:40

roryabraham approved these changes Nov 12, 2022

View reviewed changes

rushatgabhane approved these changes Nov 13, 2022

View reviewed changes

roryabraham merged commit 1b375ed into Expensify:main Nov 13, 2022

OSBotify mentioned this pull request Nov 15, 2022

Deploy Checklist: New Expensify 2022-11-15 #12753

Closed

31 tasks

This was referenced Nov 16, 2022

[HOLD for payment 2022-11-24] [$250] Desktop - Blank screen is displayed after update to new build 1.2.28-0 #12760

Closed

[HOLD for payment 2022-11-24] [$500] Implement a SplashScreen on web #12234

Closed

kavimuru mentioned this pull request Nov 16, 2022

No splash screen appears when opening the app #12789

Closed

techievivek mentioned this pull request Nov 30, 2022

Web- Log in - Console error appears when navigating to URL staging.new.expensify.com #12943

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add splash screen on web and desktop #12334

Add splash screen on web and desktop #12334

vladamx commented Nov 1, 2022

roryabraham left a comment

roryabraham Nov 2, 2022

vladamx Nov 2, 2022

roryabraham Nov 2, 2022

vladamx Nov 2, 2022

roryabraham Nov 2, 2022

vladamx Nov 2, 2022

rushatgabhane Nov 4, 2022

roryabraham Nov 2, 2022

vladamx Nov 2, 2022

roryabraham Nov 2, 2022

vladamx Nov 2, 2022

rushatgabhane Nov 4, 2022

roryabraham left a comment

roryabraham commented Nov 4, 2022 •

edited

Loading

rushatgabhane commented Nov 4, 2022

vladamx commented Nov 8, 2022

rushatgabhane commented Nov 8, 2022 •

edited

Loading

vladamx commented Nov 8, 2022 •

edited

Loading

roryabraham left a comment

vladamx commented Nov 9, 2022 •

edited

Loading

roryabraham left a comment

roryabraham Nov 11, 2022

roryabraham commented Nov 11, 2022

rushatgabhane left a comment •

edited

Loading

vladamx commented Nov 11, 2022 •

edited

Loading

roryabraham left a comment

rushatgabhane left a comment

OSBotify commented Nov 13, 2022

OSBotify commented Nov 15, 2022

OSBotify commented Nov 15, 2022

roryabraham commented Nov 16, 2022

OSBotify commented Nov 17, 2022

Add splash screen on web and desktop #12334

Add splash screen on web and desktop #12334

Conversation

vladamx commented Nov 1, 2022

Details

Fixed Issues

QA / Tests

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

roryabraham left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham commented Nov 4, 2022 • edited Loading

rushatgabhane commented Nov 4, 2022

vladamx commented Nov 8, 2022

rushatgabhane commented Nov 8, 2022 • edited Loading

vladamx commented Nov 8, 2022 • edited Loading

roryabraham left a comment

Choose a reason for hiding this comment

vladamx commented Nov 9, 2022 • edited Loading

roryabraham left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

roryabraham commented Nov 11, 2022

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

vladamx commented Nov 11, 2022 • edited Loading

roryabraham left a comment

Choose a reason for hiding this comment

rushatgabhane left a comment

Choose a reason for hiding this comment

PR Reviewer Checklist

OSBotify commented Nov 13, 2022

OSBotify commented Nov 15, 2022

OSBotify commented Nov 15, 2022

roryabraham commented Nov 16, 2022

OSBotify commented Nov 17, 2022

roryabraham commented Nov 4, 2022 •

edited

Loading

rushatgabhane commented Nov 8, 2022 •

edited

Loading

vladamx commented Nov 8, 2022 •

edited

Loading

vladamx commented Nov 9, 2022 •

edited

Loading

rushatgabhane left a comment •

edited

Loading

vladamx commented Nov 11, 2022 •

edited

Loading