Fix RequestMoney tabs animations #32577

kacper-mikolajczak · 2023-12-06T17:40:33Z

Details

RequestMoney screen is laggy when switching between its tabs. This PR aims to refactor animations and temporarily disable them on web-based platforms until root cause is addressed in React Navigation (or other solution is implemented).

Fixed Issues

$ #31190
PROPOSAL: #31190 (comment)

Tests

Verify that no errors appear in the JS console

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

n/a

QA Steps

Verify that no errors appear in the JS console

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

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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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 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 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.

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

mandroid.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

mios.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

src/libs/Navigation/OnyxTabNavigator.tsx

melvin-bot · 2023-12-12T11:49:36Z

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

kacper-mikolajczak · 2023-12-14T09:53:28Z

Hi @mananjadhav, could you look into that? Thanks a lot! 👍

mananjadhav · 2023-12-15T06:54:08Z

I've gone through the explanation of the PR, I am going through the code now and will test this today/tomorrow.

@kacper-mikolajczak can you resolve the conflicts.

kacper-mikolajczak · 2023-12-18T11:38:59Z

@mananjadhav conflicts are resolved 👍

mananjadhav · 2023-12-19T20:27:59Z

Tested this on Web and it looks to be working fine.

Screen.Recording.2023-12-20.at.1.55.36.AM.mov

src/libs/Navigation/OnyxTabNavigator.tsx

mountiny · 2023-12-26T16:15:53Z

@kacper-mikolajczak Seems like there are some unverified commits

mananjadhav · 2023-12-27T17:42:35Z

Going to wait for @kacper-mikolajczak to resolve conflicts and fixed the signed commits before finishing the checklist.

kacper-mikolajczak · 2023-12-28T12:44:12Z

@kacper-mikolajczak Seems like there are some unverified commits

@mountiny Fixed 👍

Going to wait for @kacper-mikolajczak to resolve conflicts and fixed the signed commits before finishing the checklist.

@mananjadhav Done ✅

mananjadhav · 2023-12-28T17:26:54Z

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-rhp-tab-animations.mov

Android: mWeb Chrome

mweb-chrome-rhp-tab-animations.mov

iOS: Native

ios-rhp-tab-animations.mov

iOS: mWeb Safari

mweb-safari-rhp-tab-animations.mov

MacOS: Chrome / Safari

web-rhp-tab-animations.mov

MacOS: Desktop

desktop-rhp-tab-animations.mov

mountiny

@kacper-mikolajczak Looking good, I see that the root cause is in react-navigation, could you link to react-navigation issue which can be used to track this and how we ensure this will be fixed and we can turn the animations for web too? thank you!

mountiny · 2023-12-28T18:24:33Z

src/components/TabSelector/TabSelectorItem.tsx

+    const getBackgroundColorStyle = useCallback(
+        (hovered: boolean) => {
+            if (hovered && !isFocused) {
+                return {backgroundColor: theme.highlightBG};
+            }
+            return {backgroundColor: focusValueRef.current.interpolate({inputRange: [0, 1], outputRange: [theme.appBG, theme.border]})};
+        },
+        [theme, isFocused],
+    );


It might be handy just to note here why we are using this approach instead of styles

Most of the code was moved from old definition in TabSelector, but I am not that familiar with the style conventions, so if you feel like there is a room for improvement, then let me know and we can fix that 👍

mountiny · 2023-12-28T20:44:14Z

Since @stitesExpensify is ooo this week and this is handy performance improvement, I am going to go ahead and merge this

OSBotify · 2023-12-28T20:48:35Z

✋ 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 · 2023-12-28T21:36:52Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.19-0 🚀

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

shubham1206agra · 2023-12-29T05:31:55Z

src/libs/Navigation/tabNavigatorAnimationEnabled/index.ts

@@ -0,0 +1,3 @@
+const tabNavigatorAnimationEnabled = false;


Comment for reference

kacper-mikolajczak · 2023-12-29T09:17:12Z

Looking good, I see that the root cause is in react-navigation, could you link to react-navigation issue which can be used to track this and how we ensure this will be fixed and we can turn the animations for web too? thank you!

Sure thing! Here is a link to the issue I posted in react-native-proposals repo: react-native-community/discussions-and-proposals#749. It turns out it more related to Animated module than react-navigation, that's why the issue ended up there 👍

situchan · 2023-12-29T09:27:50Z

@kacper-mikolajczak please also check this regression. That bug is critical

OSBotify · 2023-12-29T18:13:45Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.19-2 🚀

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

kacper-mikolajczak added 5 commits December 6, 2023 18:39

move animation from TabSelector to TabSelectorItem

ded2e8a

remove unused props

50a6b8c

disable animation on web and desktop

0fc209c

tabBar replace inline function with a component

5c2fffd

Bump

3286219

adhorodyski reviewed Dec 11, 2023

View reviewed changes

src/libs/Navigation/OnyxTabNavigator.tsx Outdated Show resolved Hide resolved

hurali97 reviewed Dec 12, 2023

View reviewed changes

src/libs/Navigation/OnyxTabNavigator.tsx Outdated Show resolved Hide resolved

fix animation enabled config

60739a1

kacper-mikolajczak mentioned this pull request Dec 12, 2023

[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

Merge branch 'main' into perf/request-money-tabs-animation

e2cf960

kacper-mikolajczak marked this pull request as ready for review December 12, 2023 11:49

kacper-mikolajczak requested a review from a team as a code owner December 12, 2023 11:49

melvin-bot bot requested review from mananjadhav and removed request for a team December 12, 2023 11:49

Merge branch 'main' into perf/request-money-tabs-animation

b493963

mananjadhav reviewed Dec 19, 2023

View reviewed changes

src/libs/Navigation/OnyxTabNavigator.tsx Outdated Show resolved Hide resolved

mananjadhav reviewed Dec 19, 2023

View reviewed changes

src/libs/Navigation/OnyxTabNavigator.tsx Outdated Show resolved Hide resolved

stitesExpensify assigned kacper-mikolajczak Dec 20, 2023

kacper-mikolajczak added 2 commits December 21, 2023 15:27

move tabNavigatorAnimationEnabled to separate files

7868c9c

fix imports and conditions

709519d

kacper-mikolajczak added 2 commits December 28, 2023 13:36

Merge branch 'main' into perf/request-money-tabs-animation

32badd2

remove unused props

058ea49

mananjadhav approved these changes Dec 28, 2023

View reviewed changes

melvin-bot bot requested a review from stitesExpensify December 28, 2023 18:19

mountiny approved these changes Dec 28, 2023

View reviewed changes

mountiny merged commit c52e2e3 into Expensify:main Dec 28, 2023
17 checks passed

github-actions bot mentioned this pull request Dec 28, 2023

Deploy Checklist: New Expensify 2023-12-28 #33727

Closed

22 tasks

This was referenced Dec 29, 2023

Revert "Fix RequestMoney tabs animations" #33737

Closed

[HOLD for payment 2024-01-09] [HOLD for payment 2024-01-05] Mweb/Chrome - IOU - Scan page keeps loading infinitely #33732

Closed

shubham1206agra reviewed Dec 29, 2023

View reviewed changes

mountiny mentioned this pull request Dec 29, 2023

[CP Staging] Revert "Fix RequestMoney tabs animations" #33761

Merged

50 tasks

kacper-mikolajczak mentioned this pull request Jan 2, 2024

Fix OnyxTab Navigator performance issues on web #33841

Merged

48 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix RequestMoney tabs animations #32577

Fix RequestMoney tabs animations #32577

kacper-mikolajczak commented Dec 6, 2023 •

edited

Loading

melvin-bot bot commented Dec 12, 2023

kacper-mikolajczak commented Dec 14, 2023

mananjadhav commented Dec 15, 2023

kacper-mikolajczak commented Dec 18, 2023

mananjadhav commented Dec 19, 2023

mountiny commented Dec 26, 2023

mananjadhav commented Dec 27, 2023

kacper-mikolajczak commented Dec 28, 2023

mananjadhav commented Dec 28, 2023 •

edited

Loading

mountiny left a comment

mountiny Dec 28, 2023

kacper-mikolajczak Dec 29, 2023

mountiny commented Dec 28, 2023

OSBotify commented Dec 28, 2023

OSBotify commented Dec 28, 2023

shubham1206agra Dec 29, 2023

kacper-mikolajczak commented Dec 29, 2023 •

edited

Loading

situchan commented Dec 29, 2023

OSBotify commented Dec 29, 2023

Fix RequestMoney tabs animations #32577

Fix RequestMoney tabs animations #32577

Conversation

kacper-mikolajczak commented Dec 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 12, 2023

kacper-mikolajczak commented Dec 14, 2023

mananjadhav commented Dec 15, 2023

kacper-mikolajczak commented Dec 18, 2023

mananjadhav commented Dec 19, 2023

mountiny commented Dec 26, 2023

mananjadhav commented Dec 27, 2023

kacper-mikolajczak commented Dec 28, 2023

mananjadhav commented Dec 28, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

mountiny Dec 28, 2023

Choose a reason for hiding this comment

kacper-mikolajczak Dec 29, 2023

Choose a reason for hiding this comment

mountiny commented Dec 28, 2023

OSBotify commented Dec 28, 2023

OSBotify commented Dec 28, 2023

shubham1206agra Dec 29, 2023

Choose a reason for hiding this comment

kacper-mikolajczak commented Dec 29, 2023 • edited Loading

situchan commented Dec 29, 2023

OSBotify commented Dec 29, 2023

kacper-mikolajczak commented Dec 6, 2023 •

edited

Loading

mananjadhav commented Dec 28, 2023 •

edited

Loading

kacper-mikolajczak commented Dec 29, 2023 •

edited

Loading