Skip to content

[HOLD] Search: Use live onyx data if available#78877

Closed
s77rt wants to merge 11 commits intoExpensify:mainfrom
s77rt:search-live-onyx
Closed

[HOLD] Search: Use live onyx data if available#78877
s77rt wants to merge 11 commits intoExpensify:mainfrom
s77rt:search-live-onyx

Conversation

@s77rt
Copy link
Copy Markdown
Member

@s77rt s77rt commented Jan 5, 2026

Explanation of Change

  • The useOnyx hook now makes two useOnyx connections, one regular (same as passed param) and another for search results snapshot
  • If shouldUseSnapshot is true, then the search snapshot results is merged with the live onyx data
    • Merging only occurs if both values are objects
    • If snapshot data is empty, use the live data (this is a special case)
    • Otherwise return snapshot data as is (same as what we have now in main)

Fixed Issues

$ #73977
PROPOSAL:

Tests

  1. Add console logs for shouldUseSnapshot, originalResult, snapshotResult and result
  2. Verify that if shouldUseSnapshot is false then snapshotResult[0] is false
  3. Verify that if shouldUseSnapshot is true then result is the combined originalResult/snapshotResult
Screenshot 2026-01-05 at 10 51 47 PM Screenshot 2026-01-05 at 10 51 28 PM
  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Test 1:

  1. Go to Reports > Expenses
  2. Click FAB and create an expense
  3. Verify the expense is added in the search page
Screen.Recording.2026-01-06.at.9.54.28.PM.mov

Test 2:

  1. Open policy expense chat
  2. Create an expense
  3. Go to Reports > Expenses
  4. Verify the expense is added in the search page
Screen.Recording.2026-01-06.at.9.55.04.PM.mov
  • 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 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 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.
  • 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

@s77rt s77rt marked this pull request as ready for review January 5, 2026 22:24
@s77rt s77rt requested review from a team as code owners January 5, 2026 22:24
@melvin-bot melvin-bot bot requested review from a team, dukenv0307 and trjExpensify and removed request for a team January 5, 2026 22:24
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Jan 5, 2026

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

@melvin-bot melvin-bot bot requested review from luacmartins and suneox January 5, 2026 22:24
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Jan 5, 2026

@suneox @luacmartins 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]

@melvin-bot melvin-bot bot removed the request for review from a team January 5, 2026 22:24
@s77rt
Copy link
Copy Markdown
Member Author

s77rt commented Jan 5, 2026

This is missing QA steps but otherwise ready for review.

@trjExpensify
Copy link
Copy Markdown
Contributor

Not sure what happened here, but did Melv assign two C+ on purpose? 🤔

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 5, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/hooks/useOnyx.ts 75.00% <89.47%> (+3.12%) ⬆️
... and 247 files with indirect coverage changes

@dukenv0307
Copy link
Copy Markdown
Contributor

I could take it as C+ since I was assigned first

@dukenv0307
Copy link
Copy Markdown
Contributor

dukenv0307 commented Jan 6, 2026

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 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
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
  1. shouldUseSnapshot is true and originalResult[0] is empty -> result = snapshotResult
Screenshot 2026-01-06 at 09 41 43
  1. shouldUseSnapshot is true, originalResult[0] is not empty and snapshotResult[0] is not empty -> result = originalResult + snapshotResult
Screenshot 2026-01-06 at 09 43 22
  1. shouldUseSnapshot is false -> snapshotResult[0] = false
Screenshot 2026-01-06 at 09 45 03

@dukenv0307
Copy link
Copy Markdown
Contributor

@s77rt Can you pls take a look at the failed tests?

trjExpensify
trjExpensify previously approved these changes Jan 6, 2026
Copy link
Copy Markdown
Contributor

@trjExpensify trjExpensify left a comment

Choose a reason for hiding this comment

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

I don't think there's anything product related here tbh, but it's part of the Todo counters project rollout and I'm excited for it! 👍

@luacmartins luacmartins removed the request for review from suneox January 6, 2026 18:18
Copy link
Copy Markdown
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Looking good. Let's look into the failing tests.

@luacmartins luacmartins requested a review from fabioh8010 January 6, 2026 19:14
@luacmartins
Copy link
Copy Markdown
Contributor

@fabioh8010 could you please review this PR since you have context on the useOnyx hook we created for search

@mountiny
Copy link
Copy Markdown
Contributor

mountiny commented Jan 8, 2026

I am not up to date with the project but could we:

  1. ensure the live data AND existing snapshot format is always sent from the BE
  2. Update the App to only use the live data (no double subscription)
  3. Update the min app version to the version from 2.
  4. Update the BE to only return the live data and no snapshot formatted data since all clients

This way we move the temporary duplication to the BE and what data it returns but the onyx subscriptions will only ever look at one place for the data?

@mountiny mountiny changed the title Search: Use live onyx data if available [HOLD] Search: Use live onyx data if available Jan 8, 2026
@TMisiukiewicz
Copy link
Copy Markdown
Contributor

quick question from my side: Since snapshots are search-related, do we need to force every useOnyx in the app to use it? I am not much familiar with this part but couldn't we have a custom useOnyx wrapper used only for search components?

@adhorodyski
Copy link
Copy Markdown
Contributor

It's a heavy screen though, so it's still going to be a regression 🤕

@TMisiukiewicz
Copy link
Copy Markdown
Contributor

Yeah I know, but even right now we have some additional performance overhead - on opening the app useOnyx from the library is ~170ms but the entire custom hook is ~200ms. I think we shouldn't sacrifice the performance of all useOnyx calls just to satisfy one feature 🤔

@luacmartins
Copy link
Copy Markdown
Contributor

luacmartins commented Jan 8, 2026

@blazejkustra @adhorodyski @TMisiukiewicz I'm not sure if we're on the same page here. Are we testing the performance between the custom useOnyx hook and the one from the library?

If so, I'm not sure that's the correct comparison. We already use the custom useOnyx wrapper in App and have had it for a while. That was throughly tested by @fabioh8010 back in the day and we saw no performance loss. This PR is only updating it so that the return value merges live Onyx data and snapshot data, preferring live data if available.

@luacmartins
Copy link
Copy Markdown
Contributor

luacmartins commented Jan 8, 2026

or are you referring to the double call to originalUseOnyx that's being added in this PR?

@luacmartins
Copy link
Copy Markdown
Contributor

luacmartins commented Jan 8, 2026

After reading the comments above again, I think we're talking about my second comment above. In that case, maybe we could try to update the function in this PR to move the computation to the selector if possible and make a single useOnyx call.

quick question from my side: Since snapshots are search-related, do we need to force every useOnyx in the app to use it? I am not much familiar with this part but couldn't we have a custom useOnyx wrapper used only for search components?

Here's the discussion describing the problem solved by the custom wrapper.

TLDR subcomponents used in Search can connect directly to Onyx and if they don't use the correct data source, we'd display incorrect data. So to do something like you suggested, we'd need to know the entire subcomponent tree used within Search (and any future components that are added) and use the wrapper only on those components.

@luacmartins
Copy link
Copy Markdown
Contributor

luacmartins commented Jan 8, 2026

@mountiny wrt #78877 (comment), we're updating the BE to return Search data as live data for the To-dos only.

This was a long discussion we had, but TLDR is that for other Searches, we'd have to update the snapshot shape to return a list of the transactions/reports that should be shown as search results and that was deemed outside of the scope of the project. For to-dos, we can use selectors to render the correct reports based on their next action, so we don't need to update the snapshot shape.

@luacmartins
Copy link
Copy Markdown
Contributor

@TMisiukiewicz can you share the steps you used to run this analysis please? #78877 (comment)

@mountiny
Copy link
Copy Markdown
Contributor

mountiny commented Jan 8, 2026

This was a long discussion we had, but TLDR is that for other Searches, we'd have to update the snapshot shape to return a list of the transactions/reports that should be shown as search results and that was deemed outside of the scope of the project. For to-dos, we can use selectors to render the correct reports based on their next action, so we don't need to update the snapshot shape.

Ah I see, I thought we are doing it for all search. Once we will do that (inevitably) though, the snapshots can be removed (only pointer snapshots will remain)

@s77rt
Copy link
Copy Markdown
Member Author

s77rt commented Jan 8, 2026

Updated second connection to use initWithStoredValues / allowStaleData which I think should help reduce/avoid the connection overhead. Can you please check

@TMisiukiewicz
Copy link
Copy Markdown
Contributor

@TMisiukiewicz can you share the steps you used to run this analysis please? #78877 (comment)

I use heavy account or imported state on iOS or Android and use Performance tab in React Native devtools:

For app startup:

  1. Start the profiling session
  2. Refresh the app (r)
  3. Once everything loaded, stop the profiling
  4. Download the profile

For creating an expense:

  1. Create expense -> Manual -> Go to confirmation screen, feel the required data
  2. Start the profiling session
  3. Press "Create expense"
  4. Once navigated to expenses report stop profiling
  5. Download the profile

Then upload the profile to https://www.speedscope.app/, go to Sandwich view, cmd+F and look for useOnyx. You should see two of them here - the shorter one is the accumulated time of useOnyx from react-native-onyx, and the longer one is accumulated time of the one from custom hook

@luacmartins
Copy link
Copy Markdown
Contributor

@TMisiukiewicz @blazejkustra @adhorodyski did you get a chance to retest the performance after the latest changes? #78877 (comment)

@TMisiukiewicz
Copy link
Copy Markdown
Contributor

I retested the branch on app startup and I'm still seeing the performance degradation of useOnyx
Before: 182ms
After 319ms

@adhorodyski
Copy link
Copy Markdown
Contributor

This still looks like a degradation, and not a small one. My question is can we do something fundamentally better to make this work, without derailing the design doc release?

@adhorodyski
Copy link
Copy Markdown
Contributor

adhorodyski commented Jan 12, 2026

Using #73977 (comment) as a source of truth for what we're trying to cover, my best bet is relying on Onyx Derived Values instead of altering the useOnyx wrapper in any way. As per its doc comment, this is what they're for and it sounds exactly like our use case here:

A derived value configuration describes:
 *  - a tuple of Onyx keys to subscribe to (dependencies),
 *  - a compute function that derives a value from the dependent Onyx values.
 *    The compute function receives a single argument that's a tuple of the onyx values for the declared dependencies.
 *    For example, if your dependencies are `['report_', 'account'], then compute will receive a [OnyxCollection<Report>, OnyxEntry<Account>]
 * 

Here's how one should look like:

export default createOnyxDerivedValueConfig({

Should I work on trying to put this together or @s77rt you feel comfortable with trying out this approach? It should not come with a performance penalty, not the size of the above measurements.

@luacmartins
Copy link
Copy Markdown
Contributor

luacmartins commented Jan 12, 2026

So you're proposing to duplicate the merged data in derived values?

@adhorodyski
Copy link
Copy Markdown
Contributor

adhorodyski commented Jan 12, 2026

It looks like the usecase is exactly what this API was designed for, yes. It auto-updates on changes to any of the keys and allows for a simple useOnyx usage across React components, just to the new, 'virtual' key instead of the raw one of either data set. You can see other usecases for which we've decided to build a derived value, and here I see how the compute() function could encapsulate this live/snapshot logic nicely.

@luacmartins
Copy link
Copy Markdown
Contributor

I'm not sure if that's feasible. We'd end up duplicating almost the entire Onyx DB in derived values, since the components in Search could potentially access any report, policy, transaction, reportAction, reportNameValuePairs, etc keys

s77rt added 2 commits January 12, 2026 20:10
The condition must never change in any react component lifecycle, otherwise this would cause weird bugs
@luacmartins
Copy link
Copy Markdown
Contributor

We're going with a different approach #79506

@s77rt s77rt closed this Jan 14, 2026
@jesus614
Copy link
Copy Markdown

jesus614 commented Jan 15, 2026

Hi @s77rt, how are you? Could you help me find the .zip file whmcs for rdpcloud? I understand if the assistance involves payment. My email is espaciovirtual.com@gmail.com

@s77rt

This comment was marked as off-topic.

@jesus614
Copy link
Copy Markdown

@jesus614 After you run the make command the zip file can be found in client/php/whmcs-provisioning-module/dist.

Thanks, would you be so kind as to contact me or leave me a contact? @s77rt

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