Fix OnyxTab Navigator performance issues on web #33841

kacper-mikolajczak · 2024-01-02T16:58:53Z

Details

This PR tries to fix performance isseus with OnyxTabNavigator(and underlying MaterialTopTab) on web by disabling animations. The root cause lies in high intensity of calculations going on on each transition between tabs and in a way Animated works on web.

The navigation flow is bound to be changed in near future, that's why PR aims to be as concised as it can (without performing deeper changes to the animation etc.)

More details can be found in the original PR and in the quickfix.

Fixed Issues

$ #31190
PROPOSAL: #31190 (comment)

Tests

Open FAB -> RequestMoney
Switch to Manual and check if it is rendered correctly
Switch to Scan and check if it is rendered correctly
Switch to Distance and check if it is rendered correctly

Offline tests

QA Steps

N/A

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

mandroid.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

mios.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-01-02T17:10:32Z

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

shubham1206agra · 2024-01-03T03:54:38Z

@kacper-mikolajczak Can you profile this PR so we can know the performance improvement here?

kacper-mikolajczak · 2024-01-03T10:15:43Z

@kacper-mikolajczak Can you profile this PR so we can know the performance improvement here?

Definitely @shubham1206agra!

Setup

As a test I went through each tab like this:

transitions-test.mov

Results

Here are the results of profiling that on Web.

Before (profiled prod at `new.expensify`):

After (profiled current branch):

As you can see, there is less high-traffic going on after disabling animations (the rAF callbacks tend to go way beyond frametime threshold, thus slowing down the whole app).

Hope that helps 👍

shubham1206agra · 2024-01-03T11:56:15Z

@mountiny Can you start an adhoc build to test this branch on physical device?

And @mananjadhav can you check this PR in physical iphone?

mountiny · 2024-01-04T15:16:20Z

Making the build here https://github.com/Expensify/App/actions/runs/7411340404

github-actions · 2024-01-04T16:16:12Z

🧪🧪 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/33841/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/33841/NewExpensify.dmg	https://33841.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

kacper-mikolajczak · 2024-01-09T09:21:37Z

Hi folks @mountiny @shubham1206agra 👋

What is the status of the review for this one? Thanks! 👍

shubham1206agra · 2024-01-09T09:28:42Z

@kacper-mikolajczak You may want to also request review from @mananjadhav as he was the original reviewer.

kacper-mikolajczak · 2024-01-09T10:03:11Z

@kacper-mikolajczak You may want to also request review from @mananjadhav as he was the original reviewer.

Sure thing! I cannot add reviewer myself but I guess @mananjadhav already knows as we pinged him 😄

mountiny · 2024-01-09T13:56:42Z

@mananjadhav whats your ETA for this review?

mananjadhav · 2024-01-09T14:11:34Z

I'll have them reviewed by today end of day and finish the checklist by tomorrow.

mananjadhav · 2024-01-09T18:55:59Z

@kacper-mikolajczak Can you please resolve the conflicts?

mananjadhav · 2024-01-09T19:10:44Z

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-tabs-animation.mov

Android: mWeb Chrome

mweb-chrome-tabs-animation.mov

mweb-chrome-tabs-animation-2.mov

iOS: Native

ios-tabs-animation.mov

iOS: mWeb Safari

mweb-safari-tabs-animation.mov

MacOS: Chrome / Safari

web-tabs-animation.mov

MacOS: Desktop

desktop-tabs-animation_PJLaMwTQ.mp4

mananjadhav · 2024-01-09T19:12:16Z

@mountiny I couldn't find the adhoc build for iOS. I did test locally but the camera keeps loading. May be if you can try at your end locally or help with the build and I can try on my physical device.?

github-actions · 2024-01-09T21:42:13Z

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

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

👀 View the workflow run that generated this build 👀

mountiny · 2024-01-09T21:51:21Z

iOS seems to work well for me. and yes Chelsea is loosing 😢
https://github.com/Expensify/App/assets/36083550/01073296-d939-4beb-a2b7-4c90dc720805

mountiny · 2024-01-09T21:52:49Z

@kacper-mikolajczak merging main should fix the reassure test failure

shubham1206agra · 2024-01-10T07:07:18Z

@kacper-mikolajczak I am currently facing a problem with a real Android device.

Steps:

Open request money from FAB
Go to scan tab. Make sure camera works correctly.
Using manual route, go to confirmation step.
Click on Add reciept. Make sure camera is working correctly here too.
Go back to the amount step using back button.
Now go to scan tab again.

Expected - Camera is working
Actual - Camera is black screen.

shubham1206agra · 2024-01-10T07:08:01Z

NVM, this is also repro in prod. But maybe this can be fixed here.

kacper-mikolajczak · 2024-01-10T08:46:49Z

@mountiny @shubham1206agra Conflicts resolved ✅

The Blues did not win tho, let's hope they can come back in the second leg ⚽

NVM, this is also repro in prod. But maybe this can be fixed here.

If the bug did not originate here, let's tackle it in separate issue 👍

mountiny · 2024-01-10T11:40:37Z

The Blues did not win tho, let's hope they can come back in the second leg ⚽

hopefully 🙏

@shubham1206agra @mananjadhav could we wrap this up?

shubham1206agra · 2024-01-10T15:42:27Z

The Blues did not win tho, let's hope they can come back in the second leg ⚽

hopefully 🙏

@shubham1206agra @mananjadhav could we wrap this up?

Its good to go from my side. Waiting for @mananjadhav to approve the request.

mananjadhav

Tested again, except iOS.

OSBotify · 2024-01-10T16:30:33Z

✋ 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-01-11T09:59:07Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.4.24-4 🚀

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

OSBotify · 2024-01-15T11:40:27Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.24-8 🚀

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

disable OnyxTabNavigator animations on website

09f4afe

kacper-mikolajczak changed the title ~~Fix TopTab Navigator performance issues on web~~ Fix OnyxTab Navigator performance issues on web Jan 2, 2024

kacper-mikolajczak marked this pull request as ready for review January 2, 2024 17:10

kacper-mikolajczak requested a review from a team as a code owner January 2, 2024 17:10

melvin-bot bot requested review from shubham1206agra and removed request for a team January 2, 2024 17:10

kacper-mikolajczak mentioned this pull request Jan 4, 2024

[C+ Checklist Needs Completion] [$500] Web - The app is freezing after switching tabs, and the performance of the tab navigator seems to be quite poor #31190

Closed

6 tasks

mountiny assigned kacper-mikolajczak Jan 4, 2024

mountiny added the Ready To Build label Jan 4, 2024

This comment has been minimized.

Sign in to view

mountiny requested a review from mananjadhav January 9, 2024 13:56

Merge branch 'main' into fix/top-tabs-animations-performance

7bb0b0c

mananjadhav approved these changes Jan 10, 2024

View reviewed changes

melvin-bot bot requested a review from stitesExpensify January 10, 2024 15:55

stitesExpensify approved these changes Jan 10, 2024

View reviewed changes

stitesExpensify merged commit f15ed75 into Expensify:main Jan 10, 2024
16 checks passed

github-actions bot mentioned this pull request Jan 11, 2024

Deploy Checklist: New Expensify 2024-01-11 #34327

Closed

54 tasks

shubham1206agra mentioned this pull request Jan 11, 2024

Start chat - Transition between Room & Chat tab is not smooth #34377

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix OnyxTab Navigator performance issues on web #33841

Fix OnyxTab Navigator performance issues on web #33841

kacper-mikolajczak commented Jan 2, 2024 •

edited

Loading

melvin-bot bot commented Jan 2, 2024

shubham1206agra commented Jan 3, 2024

kacper-mikolajczak commented Jan 3, 2024 •

edited

Loading

shubham1206agra commented Jan 3, 2024

mountiny commented Jan 4, 2024

This comment has been minimized.

github-actions bot commented Jan 4, 2024

kacper-mikolajczak commented Jan 9, 2024

shubham1206agra commented Jan 9, 2024

kacper-mikolajczak commented Jan 9, 2024

mountiny commented Jan 9, 2024

mananjadhav commented Jan 9, 2024

mananjadhav commented Jan 9, 2024

mananjadhav commented Jan 9, 2024 •

edited

Loading

mananjadhav commented Jan 9, 2024

github-actions bot commented Jan 9, 2024

mountiny commented Jan 9, 2024

mountiny commented Jan 9, 2024

shubham1206agra commented Jan 10, 2024

shubham1206agra commented Jan 10, 2024

kacper-mikolajczak commented Jan 10, 2024

mountiny commented Jan 10, 2024

shubham1206agra commented Jan 10, 2024

mananjadhav left a comment

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

OSBotify commented Jan 15, 2024

Fix OnyxTab Navigator performance issues on web #33841

Fix OnyxTab Navigator performance issues on web #33841

Conversation

kacper-mikolajczak commented Jan 2, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 2, 2024

shubham1206agra commented Jan 3, 2024

kacper-mikolajczak commented Jan 3, 2024 • edited Loading

Setup

Results

Before (profiled prod at new.expensify):

After (profiled current branch):

shubham1206agra commented Jan 3, 2024

mountiny commented Jan 4, 2024

This comment has been minimized.

github-actions bot commented Jan 4, 2024

kacper-mikolajczak commented Jan 9, 2024

shubham1206agra commented Jan 9, 2024

kacper-mikolajczak commented Jan 9, 2024

mountiny commented Jan 9, 2024

mananjadhav commented Jan 9, 2024

mananjadhav commented Jan 9, 2024

mananjadhav commented Jan 9, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

mananjadhav commented Jan 9, 2024

github-actions bot commented Jan 9, 2024

mountiny commented Jan 9, 2024

mountiny commented Jan 9, 2024

shubham1206agra commented Jan 10, 2024

shubham1206agra commented Jan 10, 2024

kacper-mikolajczak commented Jan 10, 2024

mountiny commented Jan 10, 2024

shubham1206agra commented Jan 10, 2024

mananjadhav left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

OSBotify commented Jan 15, 2024

kacper-mikolajczak commented Jan 2, 2024 •

edited

Loading

kacper-mikolajczak commented Jan 3, 2024 •

edited

Loading

Before (profiled prod at `new.expensify`):

mananjadhav commented Jan 9, 2024 •

edited

Loading