Skip to content

LoadingBar rendering improvements#63025

Merged
JS00001 merged 27 commits into
Expensify:mainfrom
callstack-internal:loading-bar-rendering-conditions-improvement
Jun 25, 2025
Merged

LoadingBar rendering improvements#63025
JS00001 merged 27 commits into
Expensify:mainfrom
callstack-internal:loading-bar-rendering-conditions-improvement

Conversation

@martasudol

@martasudol martasudol commented May 29, 2025

Copy link
Copy Markdown
Contributor

Explanation of Change

This change replaces IS_LOADING_REPORT_DATA flag usage with useLoadingBarVisibility hook to simplify conditional rendering of loading bar as it's rendered in multiple places.

Proposal: Reliably show the LoadingBar by directly hooking into SequentialQueue

Background:

LoadingBar components display loading indicators during OpenApp, ReconnectApp, and OpenReport requests. Currently, 6 components (TopBar, MoneyReportHeader, MoneyRequestHeader, HeaderView, SearchPageNarrow, SearchSidebar) rely on the IS_LOADING_REPORT_DATA Onyx key, which gets set optimistically in App.ts when requests begin and cleared when they complete. Each component has different conditional logic - some check narrow layouts, others check offline status, creating inconsistent rendering patterns. Users depend on these loading indicators to understand when the app is processing their requests.

Problem:

When users initiate network requests, they sometimes see loading indicators that don't accurately reflect actual processing status, which prevents them from understanding whether their requests are being handled. It's hard to reproduce, but we were able to observe it being unreliable.

Solution:

  • Create a useLoadingBarVisibility hook that monitors the PERSISTED_REQUESTS Onyx key. The hook checks if any persisted requests match relevant command types (OpenApp, ReconnectApp, OpenReport).
  • Add network status monitoring to prevent showing loading indicators when currently offline, even if non-offline requests remain in the queue.
  • Replace all LoadingBar components' IS_LOADING_REPORT_DATA dependencies with this hook while preserving existing conditional logic for narrow layouts.

This provides immediate loading indicators that directly reflect actual queue processing status.

Fixed Issues

$ #63938

Tests

Basic: app initialization flow

  1. Open app and navigate to Inbox - verify LoadingBar appears/disappears correctly during initialization.
  2. Turn on Force offline.
  3. Close the app.
  4. Open the app.
  5. You should see already loaded reports and loading bar should not be visible.

Narrow resolution

For narrow layout, loading bar should be shown for every open report action.

Pusher updates: new messages flow

[Account A] Open a report with Account B
[Account B] Open a report with Account A and switch tabs/close the app
[Account A] Send several messages
[Account B] Reopen the app
[Account B] Verify that there is a loading bar shown when loading new actions

  • Verify that no errors appear in the JS console

Offline tests

Same as Tests.

QA Steps

Same as Tests.

  • 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
Nagranie.z.ekranu.2025-06-4.o.10.39.54.mov
Android: mWeb Chrome
Nagranie.z.ekranu.2025-06-4.o.10.44.37.mov
iOS: Native
Nagranie.z.ekranu.2025-06-4.o.09.52.02.mov
iOS: mWeb Safari
Nagranie.z.ekranu.2025-06-4.o.09.56.18.mov
MacOS: Chrome / Safari
Nagranie.z.ekranu.2025-06-4.o.09.58.00.mov
MacOS: Desktop
Nagranie.z.ekranu.2025-06-4.o.10.45.31.mov

Comment thread src/libs/Network/SequentialQueue.ts Outdated
Comment thread src/hooks/useLoadingBarVisibility.ts Outdated
Comment thread src/hooks/useLoadingBarVisibility.ts Outdated
Comment thread src/libs/Network/SequentialQueue.ts Outdated
Comment thread src/libs/Network/SequentialQueue.ts Outdated
Comment thread src/libs/actions/App.ts Outdated
Comment thread src/hooks/useLoadingBarVisibility.ts Outdated

@roryabraham roryabraham left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This approach looks good, only notes are:

  • if IS_LOADING_REPORT_DATA is no longer used, let's remove that key from the codebase
  • PR description is out of date

@srikarparsi srikarparsi self-requested a review June 10, 2025 04:25
@martasudol

martasudol commented Jun 11, 2025

Copy link
Copy Markdown
Contributor Author

This approach looks good, only notes are:

* if `IS_LOADING_REPORT_DATA` is no longer used, let's remove that key from the codebase

* PR description is out of date
  1. IS_LOADING_REPORT_DATA is still used (not only for loading bar) in few places like ConciergePage.tsx, ContactMethodDetailsPage.tsx, AccessOrNotFoundWrapper.tsx, withPoliAndFullScreenLoading.tsx. I think we should get rid of this flag in the future, not sure if in this PR. We're going to provide more global solution so there will be one hook, not only for loading bar visibility, that will rely on provided commands. Then I think we can get rid of IS_LOADING_REPORT_DATA totally.

  2. Thanks, updated ✅

@mountiny mountiny requested review from getusha and roryabraham June 11, 2025 08:54
@martasudol martasudol marked this pull request as ready for review June 11, 2025 08:56
Comment thread src/hooks/useLoadingBarVisibility.ts Outdated
@getusha

getusha commented Jun 23, 2025

Copy link
Copy Markdown
Contributor

Lets also make the QA steps more practical.

Something like:

[Account A] Open a report with Account B
[Account B] Open a report with Account A and switch tabs/close the app
[Account A] Send several messages
[Account B] Reopen the app
[Account B] Verify that there is a loading bar shown when loading new actions

@martasudol

Copy link
Copy Markdown
Contributor Author

@getusha done!

@getusha getusha left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

thanks

@melvin-bot melvin-bot Bot requested a review from srikarparsi June 23, 2025 11:14
Comment thread src/hooks/useLoadingBarVisibility.ts Outdated
@martasudol martasudol requested a review from JS00001 June 24, 2025 07:19
Comment thread src/hooks/useLoadingBarVisibility.ts Outdated

@srikarparsi srikarparsi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The code looks good to me other than @adhorodyski's comment, @getusha are you able to do another review of this.

Co-authored-by: Adam Horodyski <42047036+adhorodyski@users.noreply.github.com>

@getusha getusha left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good

@melvin-bot melvin-bot Bot requested a review from srikarparsi June 25, 2025 08:11
@JS00001 JS00001 merged commit 3310a94 into Expensify:main Jun 25, 2025
20 checks passed
@OSBotify

Copy link
Copy Markdown
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.

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/JS00001 in version: 9.1.72-0 🚀

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

1 similar comment
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/JS00001 in version: 9.1.72-0 🚀

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

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 9.1.72-10 🚀

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

*/
export default function useLoadingBarVisibility(): boolean {
const [persistedRequests] = useOnyx(ONYXKEYS.PERSISTED_REQUESTS, {canBeMissing: false});
const [ongoingRequests] = useOnyx(ONYXKEYS.PERSISTED_ONGOING_REQUESTS, {canBeMissing: false});

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We set canBeMissing of ONYXKEYS.PERSISTED_ONGOING_REQUESTS to true since since it can be null. (See issue #66591)

Onyx.set(ONYXKEYS.PERSISTED_ONGOING_REQUESTS, null);

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.

10 participants