Skip to content

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

Merged
mountiny merged 9 commits into
Expensify:mainfrom
callstack-internal:feat/search-gates-terminal-state
Jul 27, 2026
Merged

feat: resolve Search loading gates from snapshot terminal state#96388
mountiny merged 9 commits into
Expensify:mainfrom
callstack-internal:feat/search-gates-terminal-state

Conversation

@BartekObudzinski

@BartekObudzinski BartekObudzinski commented Jul 17, 2026

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

$ #96488
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

@codecov

codecov Bot commented Jul 20, 2026

Copy link
Copy Markdown

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/hooks/useSearchLoadingState.ts 90.00% <ø> (ø)
src/hooks/useSearchPageSetup.ts 92.00% <100.00%> (ø)
src/libs/SearchUIUtils.ts 64.48% <100.00%> (+0.22%) ⬆️
src/libs/actions/Search.ts 44.56% <100.00%> (+0.38%) ⬆️
src/pages/Search/SearchPage.tsx 86.27% <100.00%> (-1.49%) ⬇️
src/pages/Search/SearchPageNarrow/index.tsx 68.88% <100.00%> (ø)
.../home/SpendOverTimeSection/useSpendOverTimeData.ts 40.00% <0.00%> (+1.29%) ⬆️
... and 21 files with indirect coverage changes

Co-authored-by: Cursor <cursoragent@cursor.com>
@BartekObudzinski
BartekObudzinski marked this pull request as ready for review July 20, 2026 15:36
@BartekObudzinski
BartekObudzinski requested review from a team as code owners July 20, 2026 15:36
@melvin-bot
melvin-bot Bot requested review from DylanDylann and JmillsExpensify and removed request for a team July 20, 2026 15:36
@melvin-bot

melvin-bot Bot commented Jul 20, 2026

Copy link
Copy Markdown

@DylanDylann 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 thread src/libs/actions/Search.ts Outdated

@JmillsExpensify JmillsExpensify 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.

Product review isn't required.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b877acb279

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/hooks/useSearchPageSetup.ts Outdated
Co-authored-by: Cursor <cursoragent@cursor.com>
@DylanDylann

Copy link
Copy Markdown
Contributor

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Chef's kiss.

Reviewed commit: 60b12ccb99

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@BartekObudzinski

Copy link
Copy Markdown
Contributor Author

@DylanDylann Are you able to complete review today?

Comment thread src/hooks/useSearchLoadingState.ts Outdated
// loading/empty states internally via shouldShowLoadingState.
// When errors are present, let Search mount so it can render FullPageErrorView.
return (hasNoData && !hasErrors) || isCardFeedsLoading;
return (hasNoData && !hasErrors && !isLoaded) || isCardFeedsLoading;

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.

NAB: This looks redundant, since hasNoData already covers it: resolved → data = {} → hasNoData = false → skeleton off. isLoaded isn't needed

}
const shouldSkipWaitForWrites = hasDeferredWrite(CONST.DEFERRED_LAYOUT_WRITE_KEYS.SEARCH);
search({queryJSON, searchKey: currentSearchKey, offset: 0, shouldCalculateTotals, isLoading: false, skipWaitForWrites: shouldSkipWaitForWrites});
}, [hash, isOffline, shouldUseLiveData, queryJSON, isSnapshotDataLoaded, isSnapshotSearchLoading, currentSearchKey, shouldCalculateTotals]);

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.

Please remove isSnapshotSearchLoading from dependency

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This one is load-bearing as a dependency. It is only a retry trigger, not a gate. handlePreventSearchAPI flips search.isLoading when the temporary prevention during handleDeleteTransactionsWithNavigation ends, and that transition is what re-runs the effect so the deferred search fires. If I drop it from the deps, the stuck skeleton case comes back and useSearchPageSetup.test.ts fails on exactly that sequence. A stranded true cannot block the initial attempt because the effect body does not gate on it. I can rename it or add a clearer comment if it reads like a stored flag dependency.

Comment thread src/pages/Search/SearchPage.tsx Outdated
let searchResults: SearchResults | undefined;
if (currentSearchResults?.data != null || currentSearchResults?.errors) {
if (isCurrentSearchResolved && currentSearchResults?.search && currentSearchResults.data === undefined) {
searchResults = {...currentSearchResults, search: currentSearchResults.search, data: {}};

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.

Suggested change
searchResults = {...currentSearchResults, search: currentSearchResults.search, data: {}};
searchResults = {...currentSearchResults, data: {}};

@DylanDylann

DylanDylann commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

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
  • 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 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 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)
  • 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.
  • 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.2026-07-23.at.17.24.49.mov
Android: mWeb Chrome
Screen.Recording.2026-07-23.at.17.20.54.mov
iOS: HybridApp
iOS: mWeb Safari
Screen.Recording.2026-07-23.at.17.21.20.mov
MacOS: Chrome / Safari
Screen.Recording.2026-07-23.at.15.33.26.mov

@DylanDylann

DylanDylann commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Discovered a new bug on main: the loading bar in the left sidebar displays infinitely when reloading the page while the search page is loading. @BartekObudzinski It would be worthwhile if you could take a look. On the other hand, I'm fine with leaving it out

Screen.Recording.2026-07-23.at.15.37.24.mov

@BartekObudzinski

Copy link
Copy Markdown
Contributor Author

@DylanDylann Confirmed and fixed. The loading lifecycle now lives in shared state keyed by reportID, so a consumer that mounts after OpenReport leaves the queue still reads as pending until the terminal loading update flushes. Added a regression test for that exact sequence: shares the observed loading lifecycle with a consumer that mounts after the request leaves the queue in useInFlightRequestsTest.ts

@DylanDylann

Copy link
Copy Markdown
Contributor

@BartekObudzinski Wrong place 😄

@BartekObudzinski

BartekObudzinski commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

Damn right 😂 I've lost in my prs

@melvin-bot
melvin-bot Bot requested a review from mountiny July 23, 2026 10:25
@DylanDylann

Copy link
Copy Markdown
Contributor

@BartekObudzinski We got conflicts

@mountiny
mountiny merged commit 0be2464 into Expensify:main Jul 27, 2026
34 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🚧 mountiny has triggered a test Expensify/App build. You can view the workflow run here.

@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.

@OSBotify

Copy link
Copy Markdown
Contributor

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

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

@MelvinBot

Copy link
Copy Markdown
Contributor

No help site changes required

I reviewed the changes in this PR and confirmed that no updates are needed to Expensify's help site files under docs/articles.

Why: This is an internal loading-state bug fix for the Search page. It reworks how the loading skeleton is gated (moving from data === undefined / a stored isLoading flag to the snapshot's explicit terminal lifecycle state loading | loaded | error) so a resolved-but-dataless response hands off to the empty view instead of pinning the skeleton indefinitely.

There is no new feature, UI element, tab, setting, or button — and no change to any documented, user-facing behavior:

  • The only observable difference is that a search returning no data now correctly shows the empty state instead of an endless skeleton, which is the expected behavior the help site already implies.
  • I checked the Search-related help articles (Search-and-Download-Expenses, Use-Search-Operators-to-Filter-and-Analyze, Use-Search-Shortcuts, Accounting-Search-Shortcuts) and none document loading/skeleton or empty-state mechanics that this PR would contradict.

Because no help site changes are required, I did not create a draft docs PR — so there is nothing to review or mark Ready for review.

@BartekObudzinski, if you believe a help site update is warranted here, let me know what behavior should be documented and I'll draft it.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 9.4.45-14 🚀

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

Bundle Size Analysis (Sentry):

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