iOS - Login - The splash screen glitches and flashes on launch #35185

ikevin127 · 2024-01-25T20:41:49Z

Details

Use isSplashHidden from SplashScreenHiddenContext to prevent the rendering of both BackgroundImage (on iOS: native) and SignInHeroImage Lottie animation until the splash screen is hidden in order to prevent splash screen hide animation glitch / flash due to heavy rendering.

Fixed Issues

$ #34696
PROPOSAL: #34696 (comment)

Tests

Open the iOS:Native app
Kill the app and launch it again
Observe that the splash screen is hidding without any glitch / flash and the background image animates-in smoothly

Verify that no errors appear in the JS console

Offline tests

Open the iOS:Native app
Kill the app and launch it again
Observe that the splash screen is hidding without any glitch / flash and the background image animates-in smoothly

QA Steps

Open the iOS:Native app
Kill the app and launch it again
Observe that the splash screen is hidding without any glitch / flash and the background image animates-in smoothly

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android-native.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios-native.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-01-25T20:41:54Z

@aimane-chnaif 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]

MitchExpensify · 2024-01-31T23:27:13Z

Friendly bump on a review here @aimane-chnaif 🙇

aimane-chnaif · 2024-02-02T16:52:58Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

ios2.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

aimane-chnaif · 2024-02-02T16:53:45Z

tests/perf-test/SignInPage.perf-test.tsx

-        createNavigationContainerRef: () => ({
-            addListener: () => jest.fn(),
-            removeListener: () => jest.fn(),
-        }),


perf tests failing if this was added?

More context on Slack: https://expensify.slack.com/archives/C01GTK53T8Q/p1706732738472299

SignInPage reassure test was failing with this error:

● SignInPage › [SignInPage] should add username and click continue button TypeError: _Navigation.navigationRef.isReady is not a function 37 | 38 | const triggerUnreadUpdate = () => { > 39 | const currentReportID = navigationRef.isReady() ? Navigation.getTopmostReportId() ?? '' : ''; | ^ 40 | 41 | // We want to keep notification count consistent with what can be accessed from the LHN list 42 | const unreadReports = getUnreadReportsForUnreadIndicator(allReports, currentReportID);

And I was told to remove this part as:

I recently changed it to solve another issue, but it looks like we don't need it at all.

On recent sync w/ main the createNavigationContainerRef was added back, but tests on this PR were still failing since the navigationRef.getState() mock was missing, I added the mock and they still failed because of this line:

App/src/libs/Navigation/getTopmostReportId.ts

Line 19 in 3a702ce

const topmostCentralPane = state.routes.filter((route) => route.name === NAVIGATORS.CENTRAL_PANE_NAVIGATOR).at(-1);

where state.routes was undefined and .filter was failing. I added optional chaining there and they pass now.

aimane-chnaif · 2024-02-02T16:55:07Z

are you able to test on physical iPhone?

ikevin127 · 2024-02-02T19:11:14Z

@aimane-chnaif Did not manage to run the dev app on iOS: Native physical device. Can you do that ?
I'm interested in how others do it.

Asked on Slack as well: https://expensify.slack.com/archives/C01GTK53T8Q/p1706901761147639

ikevin127 · 2024-02-06T15:11:13Z

@aimane-chnaif Friendly bump for the checklist 🙏

aimane-chnaif · 2024-02-06T21:27:44Z

are you still working on fixing issues?

ikevin127 · 2024-02-06T21:31:03Z

@aimane-chnaif No, PR was ready for review since 2 weeks ago (Jan 25th). These force pushes I keep doing every now and then are to keep sync with latest main.

aimane-chnaif · 2024-02-08T03:39:43Z

src/pages/signin/SignInHeroImage.js

@@ -36,6 +38,14 @@ function SignInHeroImage(props) {
        };
    }

+    const {isSplashHidden} = useContext(SplashScreenHiddenContext);


How about making useIsSplashHidden hook?

I don't understand why would we write another hook when we already have it via useContext 🧐

useScrollContext for reference. Internally, it uses React Context ofc.
Btw, not blocker.
Testing with various iOS devices is most important in this PR.

aimane-chnaif · 2024-02-08T03:42:39Z

Sometimes animation is not smooth.

In this video, logo icon glitches and no fade out animation

Screen.Recording.2024-02-08.at.4.41.31.AM.mov

ikevin127 · 2024-02-08T04:00:19Z

It can behave differently / slower under heavy load when running it on the simulator especially when transitioning from the JS compiler (metro) loading to the init of the splash screen.

It did not happen on my side with just the editor and simulator open (minimized load).

aimane-chnaif · 2024-02-08T04:03:15Z

My macOS is very light at the moment. To avoid such inconsistency, this should be tested on physical iPhone. That's why I requested you.

ikevin127 · 2024-02-08T04:14:52Z

I understand.

Well, I wasn't able to build locally on a physical device even though I tried for a few hours.

I also asked on Slack but to no avail, seems like that's not possible due to certificates.

Unless we request from a team member to perform an ad-hoc build of this PR here, before we merge if possible 👀

Otherwise I'm out of options and since this is a blocker - not sure how to move forward with this PR 🥲

ikevin127 · 2024-02-08T13:26:48Z

@aimane-chnaif I managed to build dev on a real device using an older certificate / provisioning file I had which targets my iPhone UDID. I also added the useIsSplashHidden hook mentioned yesterday with the latest main sync.

Here's the physical device video, looks just as expected on an iPhone12 mini:

iOS: Native (physical device)

RPReplay_Final1707397150.mov

github-actions · 2024-02-08T17:10:48Z

🧪🧪 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/35185/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/35185/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/35185/NewExpensify.dmg	https://35185.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

aimane-chnaif · 2024-02-08T17:34:30Z

@ishpaul777 verified fix here

RPReplay_Final1707413431.mp4

situchan · 2024-02-08T17:46:26Z

Coming from https://expensify.slack.com/archives/C02NK2DQWUX/p1707413165519959?thread_ts=1707387197.936899&cid=C02NK2DQWUX

Looks good

test.MP4

ikevin127 · 2024-02-09T11:01:03Z

@aimane-chnaif What is the next step here in order to move forward ? 🚀
Do we need more physical device proof that this is working as expected ?

aimane-chnaif · 2024-02-09T11:02:08Z

Thanks everyone. I think they're enough. I will approve today

aimane-chnaif · 2024-02-13T14:52:41Z

@ikevin127 please avoid force-push once review started

aimane-chnaif · 2024-02-13T14:53:04Z

@bondydaa all yours

ikevin127 · 2024-02-13T14:56:56Z

please avoid force-push once review started

@aimane-chnaif I do this since I don't know any other way to sync w/ main without having hundreds of changes / pulling all the commits into this one. What's your flow / commands you use when doing this ?

I am asking in scenarios where main is 1000+ commits ahead and I need to sync / solve conflicts and maintain current changes instead of pulling all other commit's changes.

aimane-chnaif · 2024-02-13T15:03:11Z

please avoid force-push once review started

@aimane-chnaif I do this since I don't know any other way to sync w/ main without having hundreds of changes / pulling all the commits into this one. What's your flow / commands you use when doing this ?

I am asking in scenarios where main is 1000+ commits ahead and I need to sync / solve conflicts and maintain current changes instead of pulling all other commit's changes.

git checkout main
git remote set-url origin https://github.com/Expensify/App
git pull origin main
git remote set-url origin https://github.com/ikevin127/Expensify
git fetch
git push origin main (or can be easily done in Github UI)
git checkout fix/34696
git pull origin main
(if conflict happens) fix conflict and add changed files using git add and then git commit -m "comment something"
git push origin fix/34696

…x/34696

ikevin127 · 2024-02-13T15:48:16Z

@aimane-chnaif I tried your method, did it work as expected ?

The Typecheck fail after the latest sync w/ main, non related to this PR:

Error: src/pages/home/report/ReportDetailsShareCodePage.tsx(9,13): error TS2741: Property 'session' is missing in type '{ report: Report; }' but required in type 'Omit<HOCProps & { session: OnyxEntry<Session>; report?: OnyxEntry<Report> | undefined; }, "currentUserPersonalDetails">'.

aimane-chnaif · 2024-02-13T15:49:33Z

@aimane-chnaif I tried your method, did it work as expected ?

yes 👍

The main check is that code diff is really your code changes only and merge commit is only 1 commit

aimane-chnaif · 2024-02-13T15:55:04Z

The Typecheck fail after the latest sync w/ main, non related to this PR:

Error: src/pages/home/report/ReportDetailsShareCodePage.tsx(9,13): error TS2741: Property 'session' is missing in type '{ report: Report; }' but required in type 'Omit<HOCProps & { session: OnyxEntry<Session>; report?: OnyxEntry<Report> | undefined; }, "currentUserPersonalDetails">'.

yes, it's known - #35841 (comment)

ikevin127 · 2024-02-13T15:57:18Z

@aimane-chnaif Thanks for teaching me this method 🙏, I was not aware of it and used force-push until now 😓

Do you think the PR is still good to go for final approve / merge even though typecheck is failing ?

aimane-chnaif · 2024-02-13T16:00:02Z

Just waiting for final review from @bondydaa

TS error will be fixed soon on main since they're already aware of it so we can merge again once fixed

ikevin127 · 2024-02-13T17:56:43Z

@bondydaa All good here -> ready for final review 🚀

OSBotify · 2024-02-13T18:02:09Z

✋ 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 · 2024-02-15T05:23:43Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.41-12 🚀

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

ikevin127 requested a review from a team as a code owner January 25, 2024 20:41

melvin-bot bot requested review from aimane-chnaif and removed request for a team January 25, 2024 20:41

ikevin127 mentioned this pull request Jan 25, 2024

[HOLD for payment 2024-02-22] [$500] iOS - Login - The splash screen glitches and flashes on launch #34696

Closed

6 tasks

ikevin127 force-pushed the fix/34696 branch 2 times, most recently from ae14db3 to 9a22a0e Compare January 31, 2024 21:22

ikevin127 force-pushed the fix/34696 branch 5 times, most recently from 20f4ba7 to 1e1f146 Compare February 2, 2024 16:52

aimane-chnaif reviewed Feb 2, 2024

View reviewed changes

This comment was marked as outdated.

Sign in to view

ikevin127 force-pushed the fix/34696 branch from 1e1f146 to 7f1e6a8 Compare February 4, 2024 10:11

ikevin127 force-pushed the fix/34696 branch from 7f1e6a8 to 95faab4 Compare February 6, 2024 21:26

aimane-chnaif reviewed Feb 8, 2024

View reviewed changes

ikevin127 force-pushed the fix/34696 branch from 95faab4 to da8ec84 Compare February 8, 2024 13:26

aimane-chnaif approved these changes Feb 11, 2024

View reviewed changes

melvin-bot bot requested a review from bondydaa February 11, 2024 16:57

iOS - Login - The splash screen glitches and flashes on launch

c512dd0

ikevin127 force-pushed the fix/34696 branch from da8ec84 to c512dd0 Compare February 13, 2024 14:50

ikevin127 added 4 commits February 13, 2024 17:11

Merge branch 'main' of https://github.com/ikevin127/Expensify into fi…

f8d689d

…x/34696

fixed reassure tests

2f9aadf

Merge branch 'main' of https://github.com/Expensify/App into fix/34696

0186486

reasurre tests fix - optional chaining

cae96fa

Merge branch 'main' of https://github.com/Expensify/App into fix/34696

b3be5cd

bondydaa approved these changes Feb 13, 2024

View reviewed changes

bondydaa merged commit e1f6b13 into Expensify:main Feb 13, 2024
15 checks passed

github-actions bot mentioned this pull request Feb 13, 2024

Deploy Checklist: New Expensify 2024-02-13 #36429

Closed

bernhardoj mentioned this pull request Jul 26, 2024

[$250] Android - Login – Login page blinks when open app #46232

Closed

6 tasks

iOS - Login - The splash screen glitches and flashes on launch #35185

iOS - Login - The splash screen glitches and flashes on launch #35185

Conversation

ikevin127 commented Jan 25, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 25, 2024

MitchExpensify commented Jan 31, 2024

aimane-chnaif commented Feb 2, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

aimane-chnaif Feb 2, 2024

Choose a reason for hiding this comment

ikevin127 Feb 2, 2024

Choose a reason for hiding this comment

ikevin127 Feb 13, 2024

Choose a reason for hiding this comment

aimane-chnaif commented Feb 2, 2024

This comment was marked as outdated.

ikevin127 commented Feb 2, 2024 • edited Loading

ikevin127 commented Feb 6, 2024

aimane-chnaif commented Feb 6, 2024

ikevin127 commented Feb 6, 2024

aimane-chnaif Feb 8, 2024

Choose a reason for hiding this comment

ikevin127 Feb 8, 2024

Choose a reason for hiding this comment

aimane-chnaif Feb 8, 2024

Choose a reason for hiding this comment

aimane-chnaif commented Feb 8, 2024

ikevin127 commented Feb 8, 2024 • edited Loading

aimane-chnaif commented Feb 8, 2024

ikevin127 commented Feb 8, 2024

ikevin127 commented Feb 8, 2024

github-actions bot commented Feb 8, 2024

aimane-chnaif commented Feb 8, 2024

situchan commented Feb 8, 2024

ikevin127 commented Feb 9, 2024

aimane-chnaif commented Feb 9, 2024

aimane-chnaif commented Feb 13, 2024 • edited Loading

aimane-chnaif commented Feb 13, 2024

ikevin127 commented Feb 13, 2024

aimane-chnaif commented Feb 13, 2024 • edited Loading

ikevin127 commented Feb 13, 2024

aimane-chnaif commented Feb 13, 2024

aimane-chnaif commented Feb 13, 2024

ikevin127 commented Feb 13, 2024

aimane-chnaif commented Feb 13, 2024

ikevin127 commented Feb 13, 2024

OSBotify commented Feb 13, 2024

OSBotify commented Feb 15, 2024

aimane-chnaif commented Feb 2, 2024 •

edited

Loading

ikevin127 commented Feb 2, 2024 •

edited

Loading

ikevin127 commented Feb 8, 2024 •

edited

Loading

aimane-chnaif commented Feb 13, 2024 •

edited

Loading

aimane-chnaif commented Feb 13, 2024 •

edited

Loading