Fix cache key eviction by kubabutkiewicz · Pull Request #629 · Expensify/react-native-onyx

kubabutkiewicz · 2025-04-16T14:01:29Z

Details

This PR renames safeEvictionKeys to evictableKeys throughout the codebase for clearer naming that better reflects the parameter's purpose. It also refactors the key eviction system by:

Moving eviction-related state and functionality from OnyxUtils to OnyxCache
Improving the eviction algorithm to only remove keys explicitly marked as evictable
Preserving the most recently accessed key during evictions
Updating documentation to reflect the changes
These changes make Onyx's storage management more predictable and maintainable.

Related Issues

Expensify/App#59913

Automated Tests

Added the tests verifying that only keys added to evictableKeys are evicted from cache.

Manual Tests

Verify that we are evicting keys from cache that are added to evictableKeys
Verify that data from LHN is not disappearing during using the app

Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android-web.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

wev.mp4

MacOS: Desktop

desktop.mp4

…s evicting keys not added to the list of safeEvictionKeys

github-actions · 2025-04-16T14:01:46Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

kubabutkiewicz · 2025-04-17T09:27:55Z

I have read the CLA Document and I hereby sign the CLA

…or key eviction logic, fix usage of safeEvictionKey in OnyxCache

AndrewGable · 2025-04-23T18:10:55Z

Going to assign @mountiny as they are involved in the original issue!

kubabutkiewicz · 2025-04-23T19:10:39Z

Also waiting for @fabioh8010 review!

fabioh8010 · 2025-04-24T08:09:43Z

+    /**
+     * Check if a given key matches a pattern key
+     * @param configKey - Pattern that may contain a wildcard
+     * @param key - Key to test against the pattern
+     */
+    private isKeyMatch(configKey: OnyxKey, key: OnyxKey): boolean {
+        const isCollectionKey = configKey.endsWith('_');
+        return isCollectionKey ? Str.startsWith(key, configKey) : configKey === key;
+    }


Is this a copy of OnyxUtils.isKeyMatch? Can't we reuse instead?

We cannot import OnyxUtils to OnyxCache as this produces dependency cycle

Let's please extract this to another file that both OnyxUtils and OnyxCache can import, to avoid duplicate code

We could think about splitting up the OnyxUtils file in general, because at the moment it's around ~1500 lines long and there's not that much inter-dependent state between the functions

But maybe let's do that in a follow-up PR 😅

fabioh8010 · 2025-04-24T08:13:13Z

                    // When a new connection for a safe eviction key happens
                    Onyx.connect({key: `${ONYX_KEYS.COLLECTION.MOCK_COLLECTION}10`, callback: jest.fn()});
                })
+                .then(waitForPromisesToResolve)


This is needed as we need to wait till onyx connect resolves to check if its in the cache

This is needed as we need to wait till onyx connect resolves to check if its in the cache

That sounds good to me 👍🏼

fabioh8010 · 2025-04-24T08:14:43Z

Also cc @chrispader for visibility

…st-for-keys-eviction-implementation

fabioh8010

LGTM!

mountiny · 2025-04-24T17:53:08Z

@kubabutkiewicz can you please provide videos for this PR?

mountiny · 2025-04-24T17:54:12Z

@jjcoffee will you be able to do a checklist/ test this change in App please?

kubabutkiewicz · 2025-04-24T17:55:17Z

@mountiny Yeah, I am on it

jjcoffee · 2025-04-25T07:40:38Z

@mountiny Yessir!

jjcoffee · 2025-04-25T07:59:44Z

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: Native
- Android: mWeb Chrome
- iOS: Native
- 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 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: Native

android-app-2025-04-25_15.04.04.mp4

Android: mWeb Chrome

android-chrome-2025-04-25_15.09.55.mp4

iOS: Native

ios-app-2025-04-25_14.24.18.mp4

iOS: mWeb Safari

ios-safari-2025-04-25_14.28.30.mp4

MacOS: Chrome / Safari

desktop-chrome-2025-04-25_13.49.47.mp4

MacOS: Desktop

desktop-app-2025-04-25_13.55.21.mp4

kubabutkiewicz · 2025-04-25T09:16:13Z

@jjcoffee in the App you need to change here https://github.com/Expensify/App/blob/5f5f4a0857a5211dc00b61ea77e93ea5a20bc887/src/setup/index.ts#L31 safeEvictionKeys to evictableKeys

kubabutkiewicz · 2025-04-25T10:07:42Z

@jjcoffee No its not, let me check it

kubabutkiewicz · 2025-04-25T10:27:32Z

@jjcoffee Issue fixed

jjcoffee · 2025-04-25T13:17:07Z

@kubabutkiewicz Nice thanks, tests well now! Are we ignoring the perf test fail?

kubabutkiewicz · 2025-04-25T13:23:25Z

@jjcoffee I think yes based on Fabio comment #629 (comment)

jjcoffee

LGTM!

mountiny · 2025-04-25T13:36:36Z

@fabioh8010 how can we be sure they failed due to flakiness?

fabioh8010 · 2025-04-25T14:52:34Z

+                        () => false,
+                        () => Promise.resolve(new Set(Object.keys(data))),


@kubabutkiewicz please move () => false and () => Promise.resolve(new Set(Object.keys(data))) to outside measureAsyncFunction

@fabioh8010 I am not sure what do you mean, something like that?

Yeah it's okay this way!

ok thanks, pushed a change

fabioh8010 · 2025-04-25T14:53:16Z

@fabioh8010 how can we be sure they failed due to flakiness?

Let's wait for Kuba to address the last comment and I will manually analyse the next Reassure run

fabioh8010 · 2025-04-25T16:40:37Z

@mountiny @kubabutkiewicz

Reassure output of significant changes:

 - Onyx update one call with 5k sets and 5k merges updates [async function]: 397.0 ms → 432.0 ms (+35.0 ms, +8.8%) 🔴 | 1 → 1 
 - OnyxUtils remove 10k calls [async function]: 170.2 ms → 179.7 ms (+9.5 ms, +5.6%) 🔴 | 1 → 1 
 - OnyxUtils scheduleNotifyCollectionSubscribers one call with 10k heavy objects to update 10k subscribers [async function]: 80.9 ms → 87.3 ms (+6.4 ms, +7.9%) 🔴 | 1 → 1 
 - OnyxUtils keyChanged one call with one heavy object to update 10k subscribers [function]: 36.4 ms → 41.0 ms (+4.6 ms, +12.6%) 🔴 | 1 → 1 
 - Onyx clear one call with 10k records to clean [async function]: 25.4 ms → 27.8 ms (+2.4 ms, +9.3%) 🔴 | 1 → 1 
 - OnyxCache removeLeastRecentlyUsedKeys one call removing 1000 keys [function]: 0.2 ms → 1.6 ms (+1.4 ms, +729.1%) 🔴🔴 | 1 → 1 
 - OnyxUtils multiGet one call getting 10k heavy objects from cache [async function]: 5.6 ms → 6.7 ms (+1.1 ms, +19.5%) 🔴 | 1 → 1 
 - OnyxUtils updateSnapshots one call with 100 updates [async function]: 6.5 ms → 7.6 ms (+1.1 ms, +16.6%) 🔴 | 1 → 1 
 - OnyxUtils tryGetCachedValue one call passing collection key without selector [function]: 6.0 ms → 7.1 ms (+1.1 ms, +17.7%) 🔴 | 1 → 1 
 - OnyxUtils getCachedCollection one call retrieving a collection with 5k heavy objects [function]: 4.6 ms → 5.6 ms (+1.0 ms, +22.8%) 🔴 | 1 → 1 
 - OnyxConnectionManager disconnectAll one call disconnecting 10k connections [function]: 3.7 ms → 4.4 ms (+0.8 ms, +20.5%) 🔴 | 1 → 1 
 - OnyxCache addToAccessedKeys one call adding one key [function]: 0.0 ms → 0.0 ms (+0.0 ms, +71.4%) 🔴🔴 | 1 → 1 
 - OnyxCache get one call getting one key among 10k ones [function]: 0.0 ms → 0.0 ms (+0.0 ms, +28.4%) 🔴 | 1 → 1 
 - OnyxCache set one call setting one key [function]: 0.0 ms → 0.0 ms (+0.0 ms, +18.0%) 🔴 | 1 → 1 
 - OnyxCache setRecentKeysLimit one call [function]: 0.0 ms → 0.0 ms (+0.0 ms, +11.4%) 🔴 | 1 → 1 
 - OnyxUtils hasPendingMergeForKey one call to look through 10k pending merges [function]: 0.0 ms → 0.0 ms (+0.0 ms, +37.4%) 🔴🔴 | 1 → 1 
 - OnyxUtils isSafeEvictionKey one call checking one key [function]: 0.0 ms → 0.0 ms (+0.0 ms, +105.5%) 🔴🔴 | 1 → 1 
 - OnyxCache addNullishStorageKey one call adding one key [function]: 0.0 ms → 0.0 ms (+0.0 ms, +10.2%) 🔴 | 1 → 1 
 - OnyxUtils sendActionToDevTools one call [function]: 0.0 ms → 0.0 ms (+0.0 ms, +55.5%) 🔴🔴 | 1 → 1 
 - OnyxUtils getMergeQueuePromise one call [function]: 0.0 ms → 0.0 ms (+0.0 ms, +56.1%) 🔴🔴 | 1 → 1 
 - OnyxUtils getDefaultKeyStates one call [function]: 0.0 ms → 0.0 ms (+0.0 ms, +72.8%) 🔴🔴 | 1 → 1 
 - OnyxUtils isCollectionMemberKey one call with correct key [function]: 0.0 ms → 0.0 ms (+0.0 ms, +34.1%) 🔴🔴 | 1 → 1 
 - OnyxUtils getSkippableCollectionMemberIDs one call [function]: 0.0 ms → 0.0 ms (+0.0 ms, +56.7%) 🔴🔴 | 1 → 1 
 - OnyxUtils getEvictionBlocklist one call [function]: 0.0 ms → 0.0 ms (+0.0 ms, +54.3%) 🔴🔴 | 1 → 1 
 - OnyxUtils splitCollectionMemberKey one call passing the collection key [function]: 0.0 ms → 0.0 ms (+0.0 ms, +24.0%) 🔴 | 1 → 1

This one seems to be the only one "significant" related to the PR

 - OnyxCache removeLeastRecentlyUsedKeys one call removing 1000 keys [function]: 0.2 ms → 1.6 ms (+1.4 ms, +729.1%) 🔴🔴 | 1 → 1

Still, I don't think a +1.4 ms deviation is something to worry about.

BTW, I'm working on a improvement for Reasure workflow measurements here.

fabioh8010 · 2025-04-25T20:28:00Z

@kubabutkiewicz Could you merge this again with main? The Reassure flakiness improvements PR was merged, let's see in action.

…st-for-keys-eviction-implementation

kubabutkiewicz · 2025-04-28T06:56:02Z

@fabioh8010 Done 😄

mountiny

Thanks, looks nice and clean! One question just to make sure we dont miss anything

mountiny · 2025-04-28T08:09:11Z

 ```js
 Onyx.init({
-    safeEvictionKeys: [ONYXKEYS.COLLECTION.REPORT_ACTIONS],
+    evictableKeys: [ONYXKEYS.COLLECTION.REPORT_ACTIONS],


Will this require any migration?

The only thing we need to do is just change the parameter name in the app. I am also thinking we should add more keys in the App which are evictable. Like NYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS, ONYXKEYS.COLLECTION.REPORT_ACTIONS_PAGES, ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS tested it already and there seems to not be any disadvantages

Ok thanks, feel free to work on the bump PR

os-botify · 2025-04-28T15:00:03Z

🚀 Published to npm in 2.0.104 🎉

added unit test for showing that eviction is not working properly, it…

2033dfb

…s evicting keys not added to the list of safeEvictionKeys

kubabutkiewicz added 2 commits April 16, 2025 16:02

.

f4a8fa3

.

46ab724

CLABotify added a commit to Expensify/CLA that referenced this pull request Apr 17, 2025

@kubabutkiewicz has signed the CLA in Expensify/react-native-onyx#629

8b2e3e2

kubabutkiewicz added 8 commits April 18, 2025 14:41

move logic related to key eviction to OnyxCache, add new unit tests f…

cc6fcbf

…or key eviction logic, fix usage of safeEvictionKey in OnyxCache

fix cacheEvictionTest

62557ea

fix lint

f21fe96

changed safeEvictionKeys to evictableKeys

20f4604

fix tests

ab2b57b

clean up

450a67f

remove unnecessary comments

0928485

adjust tests

22c33c4

kubabutkiewicz changed the title ~~Unit test for eviction implementation~~ Fix cache key eviction Apr 23, 2025

kubabutkiewicz marked this pull request as ready for review April 23, 2025 14:46

kubabutkiewicz requested a review from a team as a code owner April 23, 2025 14:46

melvin-bot Bot requested review from AndrewGable and removed request for a team April 23, 2025 14:46

AndrewGable requested review from mountiny and removed request for AndrewGable April 23, 2025 18:10

fabioh8010 reviewed Apr 24, 2025

View reviewed changes

mountiny assigned kubabutkiewicz Apr 24, 2025

kubabutkiewicz added 4 commits April 24, 2025 11:18

resolve comments

8a9326c

removed log

a39358f

resolve comment

3974871

Merge branch 'main' of github.com:Expensify/react-native-onyx into te…

1036d3c

…st-for-keys-eviction-implementation

fabioh8010 approved these changes Apr 24, 2025

View reviewed changes

mountiny requested a review from jjcoffee April 24, 2025 17:53

This comment was marked as resolved.

Sign in to view

kubabutkiewicz mentioned this pull request Apr 25, 2025

[Due for payment 2025-05-13] [$250] [quality] Explore smarter handling of cache key eviction Expensify/App#59913

Closed

This comment was marked as resolved.

Sign in to view

fix missing data when reloading

7135652

fix lint

1410e48

jjcoffee approved these changes Apr 25, 2025

View reviewed changes

fabioh8010 reviewed Apr 25, 2025

View reviewed changes

resolve comment

f1b02b1

Merge branch 'main' of github.com:Expensify/react-native-onyx into te…

b380086

…st-for-keys-eviction-implementation

mountiny approved these changes Apr 28, 2025

View reviewed changes

mountiny merged commit 20f9c12 into Expensify:main Apr 28, 2025
5 checks passed

fabioh8010 mentioned this pull request Sep 24, 2025

[Onyx Audit] Cache layer Expensify/App#71204

Open

		() => false,
		() => Promise.resolve(new Set(Object.keys(data))),

Conversation

kubabutkiewicz commented Apr 16, 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!

github-actions Bot commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kubabutkiewicz commented Apr 17, 2025

Uh oh!

AndrewGable commented Apr 23, 2025

Uh oh!

kubabutkiewicz commented Apr 23, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fabioh8010 commented Apr 24, 2025

Uh oh!

fabioh8010 left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mountiny commented Apr 24, 2025

Uh oh!

kubabutkiewicz commented Apr 24, 2025

Uh oh!

jjcoffee commented Apr 25, 2025

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

This comment was marked as resolved.

kubabutkiewicz commented Apr 25, 2025

Uh oh!

This comment was marked as resolved.

kubabutkiewicz commented Apr 25, 2025

Uh oh!

kubabutkiewicz commented Apr 25, 2025

Uh oh!

jjcoffee commented Apr 25, 2025

Uh oh!

kubabutkiewicz commented Apr 25, 2025

Uh oh!

jjcoffee left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny commented Apr 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kubabutkiewicz commented Apr 16, 2025 •

edited

Loading

github-actions Bot commented Apr 16, 2025 •

edited

Loading

mountiny commented Apr 24, 2025 •

edited

Loading

jjcoffee commented Apr 25, 2025 •

edited

Loading