Skip to content

Conversation

@kacper-mikolajczak
Copy link
Contributor

@kacper-mikolajczak kacper-mikolajczak commented Jun 2, 2025

Explanation of Change

Fixed Issues

$ #63244
PROPOSAL:

Tests

  1. Switch between screens and see how bottom tabs behaves
  2. It should remain interactive
  3. It should remain consistent during transitions

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console

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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@kacper-mikolajczak
Copy link
Contributor Author

kacper-mikolajczak commented Jun 2, 2025

Problem

NavigationTabBar apart from original its original render target TopLevelTabBar, is used in multiple components to work around existing transitions/animations issues:

  1. SearchSidebar
  2. BaseSidebarScreen
  3. SearchPageNarrow
  4. InitialSettingsPage
  5. WorkspaceInitialPage
  6. WorkspacesListPage

Those components are some of the most commonly used in the app, making NavigationTabBar be re-created at many user interactions and navigations.

Currently the cost of mounting NavigationTabBar on many interactions was measured to be:

  • ~100ms iOS simulator
  • ~20ms Web

Solution

Implement NavigationTabBarDummy which skips heavy parts and exposes only a UI component that resembles actual navigator. It can be done due to the fact that those doppelgangers are not responsible of handling logic and exist solely for fixing animations (source).

Potential cost of mounting NavigationTabBarDummy on many interactions was measured to be:

  • ~25ms iOS simulator -> 25% of original duration
  • ~5ms Web -> 25% of original duration
Platform Before After
Web
web-before.mp4
web-after.mp4
iOS
ios-before.mp4
ios-after.mp4

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.

This looks promising, @adamgrzybowski @WojtekBoman any concerns with such approach as at least some sort of improvement?

return <NavigationTabBarNarrowDummy selectedTab={selectedTab} />;
}

return <NavigationTabBarWideDummy selectedTab={selectedTab} />;
Copy link
Contributor

Choose a reason for hiding this comment

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

In which case do we need this in the Wide layout? Could we not render this at all in wide?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great question! It is there to make dummy counterpart 1:1 match with regular component, but we can investigate it further to see how it behaves on wider screens 👍

Copy link
Contributor

Choose a reason for hiding this comment

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

If we want to see the navigation bar under the overlay (the one from RHP), we need to render it per screen on the wide layout. The top level is displayed over everything else. It wouldn't be covered by the overlay.

@mountiny
Copy link
Contributor

mountiny commented Jun 2, 2025

@ishpaul777 will you be able to review?

@ishpaul777
Copy link
Contributor

yes i can review @mountiny

@kacper-mikolajczak kacper-mikolajczak marked this pull request as ready for review June 2, 2025 12:33
@kacper-mikolajczak kacper-mikolajczak requested a review from a team as a code owner June 2, 2025 12:33
@melvin-bot melvin-bot bot requested review from ishpaul777 and removed request for a team June 2, 2025 12:33
@melvin-bot
Copy link

melvin-bot bot commented Jun 2, 2025

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

Comment on lines 50 to 61
<EducationalTooltip
shouldRender={false}
anchorAlignment={{
horizontal: isWebOrDesktop ? CONST.MODAL.ANCHOR_ORIGIN_HORIZONTAL.CENTER : CONST.MODAL.ANCHOR_ORIGIN_HORIZONTAL.LEFT,
vertical: CONST.MODAL.ANCHOR_ORIGIN_VERTICAL.BOTTOM,
}}
shiftHorizontal={isWebOrDesktop ? 0 : variables.navigationTabBarInboxTooltipShiftHorizontal}
renderTooltipContent={noop}
wrapperStyle={styles.productTrainingTooltipWrapper}
shouldHideOnNavigate={false}
onTooltipPress={noop}
>
Copy link
Contributor

Choose a reason for hiding this comment

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

Tooltips are displayed only on the top level so we don't need them for the dummy componenent

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed, thanks! ✅

@WojtekBoman
Copy link
Contributor

I don't know if it's a problem, but I noticed one UI change
When RHP is shown, RBR/GBR disappear from the navigation tab bar

Screen.Recording.2025-06-02.at.15.29.12.mov

@kacper-mikolajczak kacper-mikolajczak force-pushed the perf/navigation-tab-bar-dummy branch from b822093 to 13a055a Compare June 2, 2025 13:42
@kacper-mikolajczak
Copy link
Contributor Author

kacper-mikolajczak commented Jun 2, 2025

When RHP is shown, RBR/GBR disappear from the navigation tab bar

Thanks for spotting this @WojtekBoman! It is unfortunately a tradeoff of not including responsible logic in order to make dummy component as simple as it gets - we'd need to pretty much go back to what full blown navigator consist of - ordered reports, report attributes etc.

With that said, let me know what you think @mountiny @ishpaul777

tl;dr; this part of the UI consistency requires heavy logic to be plugged in

@kacper-mikolajczak
Copy link
Contributor Author

As @mountiny suggested, I am thinking whether we need those duplicates on wide screen at all - @adamgrzybowski do you know if wide screen UI also suffers from transitions?

If not, we might skip the rendering at all in wide screen scenarios.

@mountiny
Copy link
Contributor

mountiny commented Jun 2, 2025

Its its mainly for he overlay it feels like we do not need it. However, I think the bug @WojtekBoman found is definitely a blocker for this PR as is. We do need to keep the RBR/ GBR, its bad UX if it would be hiding and re-appearing

@kacper-mikolajczak
Copy link
Contributor Author

kacper-mikolajczak commented Jun 2, 2025

Agree @mountiny 👍 In this case let's pivot the plan and:

  • provide as light dummy alternative as possible for narrow screens
  • remove redundant navigators (and dummies) for wide screens altogether

I will check what are the possibilities and new outcomes. Let me know if new plan sounds good :)

@mountiny
Copy link
Contributor

mountiny commented Jun 2, 2025

I still struggle to remember why we would need it in Wide view but also we used to have the tabs in the bottom and now they are on the Left in wide view so it might have been something specific to the previous UI. Definitely up for trying to get rid of the extra navigator in wide layout

@WojtekBoman
Copy link
Contributor

WojtekBoman commented Jun 3, 2025

I still struggle to remember why we would need it in Wide view but also we used to have the tabs in the bottom and now they are on the Left in wide view so it might have been something specific to the previous UI. Definitely up for trying to get rid of the extra navigator in wide layout

On a wide layout we use TopLevelNavigationTabBar to display tooltips and avoid flickering when switching tabs (when NavigationTabBar is re-rendered in each tab, RBR/GBR may flicker)

@kacper-mikolajczak
Copy link
Contributor Author

kacper-mikolajczak commented Jun 3, 2025

On a wide layout we use NavigationTabBar to display tooltips and avoid flickering when switching tabs (the component is then re-rendered and e.g. RBR/GBR may flicker)

@WojtekBoman Sorry my knowledge is limited in this case, but I would like to understand it fully.

Wouldn't singular NavigationTabBar inside TopLevelNavigationTabBar be enough to handle tooltips display on wide screen?

Also, it's rendered once on top and stays there and I am not sure what flickering we could experience. The behaviour should also remain the same as in duplicated NavigationTabBar that is included in the screens. Please correct me if I am mistaken.

Could you show what is the regression when using top level navigator only? Thanks ❤️

@WojtekBoman
Copy link
Contributor

WojtekBoman commented Jun 3, 2025

I updated my answer, I wanted to emphasize why we need TopLevelNavigationTabBar

Wouldn't singular NavigationTabBar inside TopLevelNavigationTabBar be enough to handle tooltips display on wide screen?

Yes TopLevelNavigationTabBar will handle this case.

When I mentioned flickering, I meant that with TopLevelNavigationTabBar we avoid flickering because we don't unmount the bar when switching tabs

@WojtekBoman
Copy link
Contributor

WojtekBoman commented Jun 3, 2025

Could you show what is the regression when using top level navigator only? Thanks ❤️

We use navigation tab bars on each sidebar screen to display them below RHP.

If we rely only on TopLevelNavigationTabBar, it will be displayed above the RHP overlay

Screen.Recording.2025-06-03.at.09.55.47.mov

@kacper-mikolajczak
Copy link
Contributor Author

I've chedk and it's indeed hard to work around current stacking context (layering) flow on web to display TopLevle without issues when RHP is open. In this case, I can limit current efforts to:

  • provide as light dummy alternative as possible for narrow screens

Sounds good @mountiny? Based on the results we can use it or not if the improvement is negligible.

@mountiny
Copy link
Contributor

mountiny commented Jun 3, 2025

@kacper-mikolajczak sounds good, if we can use it there at least that would be handy

@mountiny
Copy link
Contributor

mountiny commented Jun 3, 2025

If the bottom tabs would have gbr or RBR though, then you slide to close the page using a gesture, the dummy component would not have them and it could cause a flicker, right?

@kacper-mikolajczak
Copy link
Contributor Author

kacper-mikolajczak commented Jun 3, 2025

If the bottom tabs would have gbr or RBR though, then you slide to close the page using a gesture, the dummy component would not have them and it could cause a flicker, right?

We will keep all the logic required not to undermine functionality in any way. In practice, mostly FAB is going to be trimmed away. I am curious what's the perf diff in this case, will report you back 🔜

@kacper-mikolajczak
Copy link
Contributor Author

Result of applying RBR indicators logic on web (commit) shows no particular difference in render timings - we should be good to go!

web-after-rbr.mp4

@mountiny
Copy link
Contributor

mountiny commented Jun 4, 2025

@kacper-mikolajczak what about the GBR?

@mountiny
Copy link
Contributor

mountiny commented Jun 4, 2025

@ishpaul777 can you proceed with the review and testing please?

@mountiny
Copy link
Contributor

mountiny commented Jun 4, 2025

@kacper-mikolajczak prettier

@ishpaul777
Copy link
Contributor

catching up!

@ishpaul777
Copy link
Contributor

ishpaul777 commented Jun 4, 2025

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
Screen.Recording.2025-06-05.at.12.29.45.AM.mov
Android: mWeb Chrome
Screen.Recording.2025-06-05.at.12.38.28.AM.mov
iOS: HybridApp
Screen.Recording.2025-06-05.at.12.06.41.AM.mov
iOS: mWeb Safari
Screen.Recording.2025-06-05.at.12.02.04.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-06-04.at.11.46.19.PM.mov
MacOS: Desktop

Copy link
Contributor

@ishpaul777 ishpaul777 left a comment

Choose a reason for hiding this comment

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

looks good, tests well! please fix prettier

@kacper-mikolajczak
Copy link
Contributor Author

@ishpaul777 Prettier has been fixed ✅

Copy link
Contributor

@ishpaul777 ishpaul777 left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from mountiny June 5, 2025 16:51
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!

return <NavigationTabBarWideDummy selectedTab={selectedTab} />;
}

export default memo(NavigationTabBarDummy);
Copy link
Contributor

Choose a reason for hiding this comment

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

Display name

@mountiny mountiny merged commit 3aca737 into Expensify:main Jun 5, 2025
19 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jun 5, 2025

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

@QichenZhu
Copy link
Contributor

Found an issue while testing #62747, might be related to this PR:

  1. Go to https://staging.new.expensify.com/
  2. As user A, create a workspace and add user B as a member
  3. As user B, click Workspaces, select the workspace created by user A, then navigate back to Inbox
  4. As user A, delete the workspace
  5. As user B, click Workspaces, Reports, or Account

Expected result: Navigation bar works
Actual result: Navigation bar doesn't work

Screen.Recording.2025-06-09.at.22.37.20.mov

@github-actions
Copy link
Contributor

github-actions bot commented Jun 9, 2025

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

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

@ishpaul777
Copy link
Contributor

@kacper-mikolajczak can you please take a look at reported bug here

@mountiny
Copy link
Contributor

Thanks for raising!

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.1.63-6 🚀

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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants