Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NoQA] fix: bottom tab transitions duration #53754

Merged
merged 2 commits into from
Dec 19, 2024

Conversation

kirillzyusko
Copy link
Contributor

@kirillzyusko kirillzyusko commented Dec 9, 2024

Explanation of Change

Reduced animation transition to 150ms to make it faster.

Fixed Issues

$ #53347
PROPOSAL: N/A

Tests

  • go through the tabs on Android/iOS and be sure animation doesn't take too long to switch the scene

Offline tests

N/A

QA Steps

  • go through the tabs on Android/iOS and be sure animation doesn't take too long to switch the scene

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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.ts 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 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
telegram-cloud-document-2-5384371478454101952.mp4
Android: mWeb Chrome
Screen.Recording.2024-12-09.at.14.32.01.mov
iOS: Native
Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-12-09.at.14.29.35.mp4
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-12-09.at.14.33.26.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-12-09.at.14.37.15.mov
MacOS: Desktop
Screen.Recording.2024-12-09.at.14.46.03.mov

@kirillzyusko kirillzyusko marked this pull request as ready for review December 9, 2024 13:46
@kirillzyusko kirillzyusko requested a review from a team as a code owner December 9, 2024 13:46
@melvin-bot melvin-bot bot requested review from dannymcclain and DylanDylann and removed request for a team December 9, 2024 13:47
Copy link

melvin-bot bot commented Dec 9, 2024

@dannymcclain @DylanDylann One of you needs to 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]

@kirillzyusko
Copy link
Contributor Author

@mountiny may I ask you to trigger a build and ask design team to make tests to be sure that the duration is okay now? 😊

Copy link
Contributor

github-actions bot commented Dec 9, 2024

🚧 @dannymcclain has triggered a test build. You can view the workflow run here.

This comment has been minimized.

@mountiny
Copy link
Contributor

mountiny commented Dec 9, 2024

@DylanDylann @kirillzyusko Could you please add recordings here? I cannot run the ad-hoc build unfortunately.

@DylanDylann
Copy link
Contributor

Sure, I will do it soon

@kirillzyusko
Copy link
Contributor Author

Could you please add recordings here?

Ooops, I somehow uploaded wrong recordings 😔 I uploaded correct recordings now!

@DylanDylann
Copy link
Contributor

@kirillzyusko the test failed

@kirillzyusko kirillzyusko force-pushed the fix/bottom-tab-transition-duration branch from 9aa2a0d to 8b29e5e Compare December 10, 2024 11:46
@kirillzyusko
Copy link
Contributor Author

@DylanDylann tests fixed!

@mountiny
Copy link
Contributor

@DylanDylann, what is your eta for this one?

@DylanDylann
Copy link
Contributor

DylanDylann commented Dec 11, 2024

@dannymcclain Could you make a build again and test on that build to ensure the duration is fine now?

@DylanDylann
Copy link
Contributor

From my testing, I don't see a significant difference in the behavior compared to the main branch when clicking on bottom bar tab

@kirillzyusko
Copy link
Contributor Author

From my testing, I don't see a significant difference in the behavior compared to the main branch when clicking on bottom bar tab

@DylanDylann did you make a clean installation of node_modules to apply a modified patch and then re-assembled the app?

Copy link
Contributor

🚧 @mountiny has triggered a test build. You can view the workflow run here.

Copy link
Contributor

@dannymcclain
Copy link
Contributor

Would love to have @dubielzyk-expensify and @shawnborton test the latest build too. Testing the iOS ad hoc build, it still feels a little slow to me? It also kinda feels like the transition to the search tab takes longer than the other tabs... but maybe that's just in my head?

It doesn't feel bad to me, but it doesn't feel just right either. Generally I think it's shippable but could still use some improvement.

@kirillzyusko
Copy link
Contributor Author

It also kinda feels like the transition to the search tab takes longer than the other tabs... but maybe that's just in my head?

This is a separate issue. We tracked it here #53818

This PR just focuses on reducing animation duration (I haven't optimized slow rendering of Search page in this PR, we decided that it would be better to solve different problems in different PRs).

@DylanDylann
Copy link
Contributor

@kirillzyusko Ahh thanks, I had the same thought with @dannymcclain

@shawnborton
Copy link
Contributor

Hmm I think things are still broken? I was consistently tapping back and forth between Inbox and Settings and then the bottom tabs became totally unresponsive and now I can't change the tabs anymore. Can you reproduce on your end too?

@shawnborton
Copy link
Contributor

When it works though, I think it feels better? Honestly I wouldn't hate it a tad faster though I think.

import type {PlatformSpecificNavigationOptions} from '@libs/Navigation/PlatformStackNavigation/types';
import Animations from '..';

const fade: PlatformSpecificNavigationOptions = {animation: Animations.FADE, animationDuration: 150} satisfies NativeStackNavigationOptions;
Copy link
Contributor

Choose a reason for hiding this comment

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

Would be curious to try 100

Copy link
Contributor

Choose a reason for hiding this comment

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

Or rather, what is the current animation/transition duration?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Or rather, what is the current animation/transition duration?

I think at the moment it's 500ms, but visual perception is about 350ms (it's a spring animation and last 150ms we may just animate opacity from 0.95 to 1, which might be not an actual duration perception).

Do you want me to change it to 100ms?

Copy link
Contributor

Choose a reason for hiding this comment

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

@shawnborton @dannymcclain @dubielzyk-expensify I will now go ahead with this change, we can play around with the delay based on how it will feel later

@dubielzyk-expensify
Copy link
Contributor

Tested it on both Android and iOS:

  • On iOS the transition timing looks almost fine, but the delay of the tap is now even more evident
  • On Android the delay can be seen even more clearly:
IMG_1992.MOV

Part of me wonders if we should set the animation to like 50ms or lower (or even remove it), then figure out the timing of the tap -> animation start -> animation end. That way we can figure out what feels sluggish.

@kirillzyusko
Copy link
Contributor Author

On Android the delay can be seen even more clearly:

Yes, because Android are typically less optimized and works slower comparing to iOS.

Part of me wonders if we should set the animation to like 50ms or lower (or even remove it), then figure out the timing of the tap -> animation start -> animation end. That way we can figure out what feels sluggish.

Yeah, for testing purposes we can set duration to 0 or completely remove the animation. But again, optimization of transitions should be made in a separate PR. The current problem is that after native-stack PR merge screens in bottom tabs are getting re-created whenever user changes them, but these screens should be created just once and then we should just change zIndex to show a correct screens (in this case transitions should be immediate).

Maybe @chrispader can shed more light on why the behavior has been changed 👀

@chrispader
Copy link
Contributor

Maybe @chrispader can shed more light on why the behavior has been changed 👀

I think we've been discussing this at some point in the Native Stack PR too, i think this delay is mostly due to internals in the Native Stack implementation compared to stack navigator.

You are right, but I think it's only Search tab that doesn't switch immediately, right? Inbox/Settings switch happens almost immediately. When I debugged Search page it had some slow re-renders, so I think it's causing this 😔

From what i've seen, i agree with @kirillzyusko, i think this can mostly be seen for the SearchPage which is especially slow to render.

What we can try is loading the bottom tab screens statically instead of lazily (component prop instead of getComponent in the navigator). This will at least speed it up for the first tap. We can of course reduce the fade animation time, but the slight delay will still be noticeable, especially for the Search Page

@kirillzyusko
Copy link
Contributor Author

Potentially problem with slow tab switching has been fixed in #54030

@dubielzyk-expensify
Copy link
Contributor

Yes, because Android are typically less optimized and works slower comparing to iOS.

Testing it on iPhone 15 Pro and I'm still seeing a pretty big lag.

I don't know the technicals deeply but what you're all saying above sounds worth looking into

@DylanDylann
Copy link
Contributor

The current problem is that after native-stack PR merge screens in bottom tabs are getting re-created whenever user changes them, but these screens should be created just once and then we should just change zIndex to show a correct screens (in this case transitions should be immediate).

@kirillzyusko If that, we should mark this PR as NO QA and move test step to #54030

@DylanDylann
Copy link
Contributor

@kirillzyusko When clicking on the search tab and then clicking on the settings or chat tab, it is unresponsive

Screen.Recording.2024-12-17.at.15.11.53.mov

@kirillzyusko
Copy link
Contributor Author

@DylanDylann the same problem exists on main as well, so I don't think it should prevent this PR from being merged:

unresponsive-tabs-on-web.mp4

@kirillzyusko kirillzyusko changed the title fix: bottom tab transitions duration [NoQA] fix: bottom tab transitions duration Dec 17, 2024
@kirillzyusko
Copy link
Contributor Author

If that, we should mark this PR as NO QA and move test step to #54030

Okay, I marked it as NoQA 👍

cc @mountiny

@mountiny
Copy link
Contributor

@DylanDylann can you please complete the checklist and testing?

@DylanDylann
Copy link
Contributor

DylanDylann commented Dec 18, 2024

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
Screen.Recording.2024-12-18.at.12.27.45.mov
Android: mWeb Chrome
Screen.Recording.2024-12-18.at.12.17.18.mov
iOS: Native
Screen.Recording.2024-12-18.at.12.27.30.mov
iOS: mWeb Safari
Screen.Recording.2024-12-18.at.12.16.16.mov
MacOS: Chrome / Safari
Screen.Recording.2024-12-18.at.12.15.17.mov
MacOS: Desktop
Screen.Recording.2024-12-18.at.12.18.17.mov

@melvin-bot melvin-bot bot requested a review from mountiny December 18, 2024 05:28
@DylanDylann
Copy link
Contributor

All good now

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks

import type {PlatformSpecificNavigationOptions} from '@libs/Navigation/PlatformStackNavigation/types';
import Animations from '..';

const fade: PlatformSpecificNavigationOptions = {animation: Animations.FADE, animationDuration: 150} satisfies NativeStackNavigationOptions;
Copy link
Contributor

Choose a reason for hiding this comment

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

@shawnborton @dannymcclain @dubielzyk-expensify I will now go ahead with this change, we can play around with the delay based on how it will feel later

@mountiny mountiny merged commit 13700ca into Expensify:main Dec 19, 2024
19 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

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

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

Copy link
Contributor

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

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

2 similar comments
Copy link
Contributor

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

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

Copy link
Contributor

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

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

Copy link
Contributor

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

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

1 similar comment
Copy link
Contributor

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

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

Copy link
Contributor

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants