Skip to content

feat: resolve Search loading gates from snapshot terminal state#96388

Draft
BartekObudzinski wants to merge 1 commit into
Expensify:mainfrom
callstack-internal:feat/search-gates-terminal-state
Draft

feat: resolve Search loading gates from snapshot terminal state#96388
BartekObudzinski wants to merge 1 commit into
Expensify:mainfrom
callstack-internal:feat/search-gates-terminal-state

Conversation

@BartekObudzinski

Copy link
Copy Markdown
Contributor

Explanation of Change

The Search page decides whether to show its loading skeleton from the shape of the snapshot data (data === undefined) and a stored search.isLoading flag. Both can lie: a successful response that writes no snapshot data leaves data undefined forever, and a reload or dropped response can strand isLoading, so the skeleton hangs indefinitely with no request running.

This change moves the Search loading gates onto the snapshot's explicit terminal lifecycle state (loading | loaded | error), which the search action always resolves on success, failure, or a network-level rejection:

  • isSearchDataLoaded treats a terminal loaded/error state as resolved, so a response that carried no data hands off to Search's own empty view instead of pinning the skeleton. The existing type/hash match still rejects a stale snapshot that Onyx can transiently return for the previous query.
  • useSearchLoadingState stops the page skeleton once the request resolves.
  • The page-setup re-fire effect no longer gates on the stored isLoading flag. It relies on resolved snapshot data plus the search action's existing in-flight de-duplication, which resets on reload, so a stranded loading state re-fires and self-heals instead of blocking forever.
  • The narrow-layout loading bar reads the pending state from the lifecycle instead of the stored flag.
  • The success and failure snapshot writes now stamp the query hash (alongside type) so a terminal state satisfies the anti-stale match even on a response that carried none of its own metadata.
  • A dataless success (jsonCode 200 with no snapshot data) now logs a diagnostic so this previously-invisible case stays queryable.

Adds a helper isSearchPending(searchResults) and unit tests for the terminal-state read side. Healthy paths are unchanged; the only behavior difference is that a resolved-but-dataless response now shows the empty view instead of an endless skeleton.

Fixed Issues

$
PROPOSAL:

Tests

  1. Open the Search page (e.g. Reports, or a saved search). Verify the loading skeleton appears, then results render.
  2. Run a search whose query returns no results. Verify the empty state renders instead of an endless skeleton.
  3. Switch quickly between different search queries. Verify each query shows its own results and no stale results flash in.
  4. Reload the app while a search is loading, then reopen the Search page. Verify the search re-fires and resolves (no stuck skeleton).
  • Verify that no errors appear in the JS console

Offline tests

  1. On the Search page, turn off the network. Verify the offline indicator shows and there is no infinite skeleton.
  2. Turn the network back on. Verify the search re-fires and results render.

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
  • 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 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 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)
  • 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)
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • 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

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.

1 participant