perf: speed up cache read in useOnyx #647

TMisiukiewicz · 2025-06-25T12:34:37Z

Details

Performance improvements related to accessing data from cache. Instead of looping on all keys when connecting to entire collection, hold an indexed map for quick access to all collection items.

Related Issues

$ Expensify/App#64950

Automated Tests

Manual Tests

Login into the app
Verify the app loads correctly
Close the app/Refresh the app (if web)
Open the app again
Verify the app loads correctly

Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

mountiny · 2025-06-25T22:08:26Z

@TMisiukiewicz how will we ensure the old cache is not used once the app loads with this new structure?

allgandalf · 2025-06-26T18:50:01Z

@TMisiukiewicz can you please take the PR out of draft

TMisiukiewicz · 2025-06-27T11:43:34Z

@allgandalf I'll get back to this on Monday - I want to verify the approach where keys are not duplicated across two objects in memory

mountiny · 2025-06-30T07:55:54Z

@TMisiukiewicz lets keep this one at the top of your list except deploy blockers please, thanks

TMisiukiewicz · 2025-06-30T07:59:26Z

@mountiny yup I'm on it today

TMisiukiewicz · 2025-06-30T10:25:07Z

Ok I feel we can proceed with this PR with the current approach. With keeping the indexed collection items as a separate map we can provide a backward compatible solution and avoid building additional complexity around cache eviction. Let me do some more tests before I open PR for a review

TMisiukiewicz · 2025-06-30T12:13:38Z

Opened PR for a review. Seems like perf tests are failing due to its flakiness

lib/OnyxCache.ts

arosiclair

Changes LGTM

allgandalf · 2025-06-30T20:02:46Z

Please fix reassure test

mountiny · 2025-06-30T22:06:39Z

@allgandalf The reassure tests are flaky, please proceed with testing with priority and test these changes withing app please. If you are not available for this one, we can re-assign. Thank you

mountiny · 2025-06-30T22:11:11Z

lib/OnyxCache.ts

+     * Get all data for a collection key
+     */
+    getCollectionData(collectionKey: OnyxKey): Record<OnyxKey, OnyxValue<OnyxKey>> | undefined {
+        const memberKeys = this.collectionIndex[collectionKey];


Should you use the getCollectionMemberKeys you created?

lib/OnyxCache.ts

mountiny · 2025-06-30T22:13:14Z

lib/OnyxCache.ts

+        this.collectionKeys = collectionKeys;
+        // Initialize collection indexes for existing collection keys
+        collectionKeys.forEach((collectionKey) => {
+            if (this.collectionIndex[collectionKey]) {


Should you use getCollectionMemberKeys?

lib/OnyxCache.ts

mountiny · 2025-06-30T22:13:59Z

lib/OnyxCache.ts

            if (value === null || value === undefined) {
                this.addNullishStorageKey(key);
+                // Remove from collection index if it's a collection member
+                if (collectionKey && this.collectionIndex[collectionKey]) {


getCollectionMemberKeys

mountiny · 2025-06-30T22:14:09Z

lib/OnyxCache.ts

+
+        // Update collection index if this is a collection member
+        const collectionKey = this.getCollectionKey(key);
+        if (collectionKey && this.collectionIndex[collectionKey]) {


getCollectionMemberKeys

mountiny · 2025-06-30T22:14:22Z

lib/OnyxCache.ts


+        // Update collection index if this is a collection member
+        if (collectionKey) {
+            if (!this.collectionIndex[collectionKey]) {


getCollectionMemberKeys

mountiny · 2025-06-30T22:14:32Z

lib/OnyxCache.ts

        if (value === null || value === undefined) {
            delete this.storageMap[key];
+            // Remove from collection index if it's a collection member
+            if (collectionKey && this.collectionIndex[collectionKey]) {


getCollectionMemberKeys

mountiny · 2025-06-30T23:56:53Z

@TMisiukiewicz Can you please merge main to check if the tests are now not flaky anymore cc @fabioh8010

TMisiukiewicz · 2025-07-01T06:46:00Z

thank you @mountiny, comments addressed. Updated the branch with main, let's see if Reassure job is green now

TMisiukiewicz · 2025-07-01T07:20:37Z

Reassure is still failing, I think it is still due to flakiness because it does not seem to be related to my changes 😞

fabioh8010 · 2025-07-01T08:46:06Z

@TMisiukiewicz yeah I think the same, let me test this PR locally a couple of times.

fabioh8010 · 2025-07-01T10:37:03Z

@TMisiukiewicz @mountiny I ran Reassure on this PR locally a couple of times and we don't have regressions from it

allgandalf · 2025-07-01T18:15:15Z

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

Android: mWeb Chrome

iOS: HybridApp

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-07-02.at.9.42.11.AM.mov

MacOS: Desktop

os-botify · 2025-07-02T16:45:07Z

🚀 Published to npm in 2.0.116 🎉

TMisiukiewicz added 2 commits June 25, 2025 11:55

implement storing collections in cache as by index

22f0083

more optimized retrieval of data from cache

1de9604

mountiny assigned TMisiukiewicz Jun 25, 2025

mountiny requested a review from allgandalf June 26, 2025 06:09

fabioh8010 mentioned this pull request Jun 27, 2025

Investigate open report slowness in ios for Jasons account Expensify/App#64828

Closed

TMisiukiewicz added 2 commits June 30, 2025 10:01

Merge branch 'main' into perf/indexed-read-for-cached-collection-keys

df266b9

cleanup the solution to hold collection indexes

d63b089

reduce diff

18657a0

TMisiukiewicz marked this pull request as ready for review June 30, 2025 12:13

TMisiukiewicz requested a review from a team as a code owner June 30, 2025 12:13

melvin-bot bot requested review from arosiclair and removed request for a team June 30, 2025 12:13

adhorodyski reviewed Jun 30, 2025

View reviewed changes

lib/OnyxCache.ts Show resolved Hide resolved

arosiclair reviewed Jun 30, 2025

View reviewed changes

mountiny self-requested a review June 30, 2025 22:05

mountiny reviewed Jun 30, 2025

View reviewed changes

mountiny mentioned this pull request Jun 30, 2025

[NoQA] Investigating Reassure flakiness #646

Merged

42 tasks

mountiny added this to [#whatsnext] #quality Jul 1, 2025

mountiny moved this to Done in [#whatsnext] #quality Jul 1, 2025

mountiny moved this from Done to CRITICAL PR in [#whatsnext] #quality Jul 1, 2025

TMisiukiewicz added 4 commits July 1, 2025 08:34

Merge branch 'main' into perf/indexed-read-for-cached-collection-keys

098bb70

use getCollectionMemberKeys

4a79c6d

add newlines before comments

edb6341

update newlines in OnyxUtils

dcb6d3b

allgandalf approved these changes Jul 2, 2025

View reviewed changes

mountiny approved these changes Jul 2, 2025

View reviewed changes

mountiny merged commit 79ba513 into Expensify:main Jul 2, 2025
4 of 5 checks passed

github-project-automation bot moved this from CRITICAL PR to Done in [#whatsnext] #quality Jul 2, 2025

TMisiukiewicz mentioned this pull request Jul 3, 2025

Bump react native onyx 2.0.117 Expensify/App#65405

Merged

51 tasks

fabioh8010 mentioned this pull request Sep 24, 2025

[Onyx Audit] Cache layer Expensify/App#71204

Open

perf: speed up cache read in useOnyx #647

perf: speed up cache read in useOnyx #647

Uh oh!

Conversation

TMisiukiewicz commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Related Issues

Automated Tests

Manual Tests

Author Checklist

Screenshots/Videos

Uh oh!

mountiny commented Jun 25, 2025

Uh oh!

allgandalf commented Jun 26, 2025

Uh oh!

TMisiukiewicz commented Jun 27, 2025

Uh oh!

mountiny commented Jun 30, 2025

Uh oh!

TMisiukiewicz commented Jun 30, 2025

Uh oh!

TMisiukiewicz commented Jun 30, 2025

Uh oh!

TMisiukiewicz commented Jun 30, 2025

Uh oh!

Uh oh!

arosiclair left a comment

Choose a reason for hiding this comment

Uh oh!

allgandalf commented Jun 30, 2025

Uh oh!

mountiny commented Jun 30, 2025

Uh oh!

mountiny Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mountiny Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mountiny Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

mountiny Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

mountiny Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

mountiny Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

mountiny commented Jun 30, 2025

Uh oh!

TMisiukiewicz commented Jul 1, 2025

Uh oh!

TMisiukiewicz commented Jul 1, 2025

Uh oh!

fabioh8010 commented Jul 1, 2025

Uh oh!

fabioh8010 commented Jul 1, 2025

Uh oh!

allgandalf commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

os-botify bot commented Jul 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

TMisiukiewicz commented Jun 25, 2025 •

edited

Loading

allgandalf commented Jul 1, 2025 •

edited

Loading