[Onyx Audit] Reset internal useOnyx state on key change by JKobrynski · Pull Request #756 · Expensify/react-native-onyx

JKobrynski · 2026-03-20T13:08:00Z

Details

Related Issues

GH_LINK Expensify/App#85416

Automated Tests

Unit tests were added for the new logic.

Manual Tests

Log into the app
Navigate between different chats quickly
Open an expense, go back, open a different expense
Go to the search screen and perform multiple searches one after another
Open a report via deep link, then navigate to a different one

In all of the cases above look out for:

No stale data flash - when switching between items, you shouldn't briefly see the previous item's data
Proper loading states - the hook should transition through loading → loaded for the new key
No crashes - the old code threw errors for non-collection dynamic key changes; your branch removes that restriction, so arbitrary key changes should work now

Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web-compressed.mov

…6-fix-useonyx-state-not-resetting

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8450987afc

ℹ️ 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".

chatgpt-codex-connector · 2026-03-20T14:19:42Z

lib/useOnyx.ts

+    if (key !== previousKey) {
+        previousValueRef.current = null;
+        newValueRef.current = null;
+        isFirstConnectionRef.current = true;
+        shouldGetCachedValueRef.current = true;


Keep the new key in first-connection mode until its callback arrives

Resetting previousValueRef and isFirstConnectionRef here interacts badly with the existing subscribe() cleanup. On a key change, the old subscription still cleans up and sets isFirstConnectionRef.current = false before the new Onyx.connect() callback fires. If anything rerenders the component in that window (for example a parent/context update while the new key is loading from storage), getSnapshot() takes its previousValueRef.current === null && !isFirstConnectionRef.current path and marks the new key as {status: 'loaded'} even though the initial callback for that key has not arrived yet.

Useful? React with 👍 / 👎.

@JKobrynski please check.

Should we still worry about this @JKobrynski ?

This was valid for an earlier revision that used a boolean isFirstConnectionRef, but the current code replaces it with connectedKeyRef which stores the actual key string. The "is first connection" check is now connectedKeyRef.current !== key, which is structurally immune to this race:

Cleanup sets connectedKeyRef.current = null

subscribe() doesn't touch it

Only the Onyx callback sets it to the new key

So between cleanup and the callback firing, connectedKeyRef.current is null, and null !== newKey is always true — meaning isFirstConnection stays true throughout that window. If getSnapshot() runs during a mid-window re-render, previousValueRef.current === null && !isFirstConnection evaluates to false, so the hook correctly stays in loading state until the actual callback arrives.

Krishna2323 · 2026-03-20T14:21:16Z

Reviewing...

fabioh8010 · 2026-03-23T07:30:24Z

I would like to review it too

JKobrynski · 2026-03-23T08:09:24Z

Let's hold the PR a bit so it can be reviewed internally as well.

CC: @Krishna2323

JKobrynski · 2026-03-24T16:20:24Z

@fabioh8010 I updated the PR with your solutions, take a look!

JKobrynski · 2026-03-26T08:49:04Z

@Krishna2323 I had a discussion with Fabio on Slack, he greenlighted the current solution, so the PR is all yours now!

@shubham1206agra some time ago you asked about a weird Onyx issue on Slack, we're most likely going to fix it with this PR.

fabioh8010

Forgot to push this review 🙈

fabioh8010 · 2026-03-25T15:33:20Z

lib/useOnyx.ts

+            // Reset internal state so the hook properly transitions through loading
+            // for the new key instead of preserving stale state from the previous one.
+            previousValueRef.current = null;
+            newValueRef.current = null;
+            shouldGetCachedValueRef.current = true;
+            sourceValueRef.current = undefined;
+            resultRef.current = [undefined, {status: options?.initWithStoredValues === false ? 'loaded' : 'loading'}];


Maybe could we extract this into a function?

Only if it won't complicate any further @JKobrynski

Sure, we could but I'm not sure what would be the benefit? It's not reused anywhere and the placement seems self-explanatory to me, is there anything that I'm missing? 😄

Yeah you are right!

fabioh8010 · 2026-03-25T15:34:08Z

tests/unit/useOnyxTest.ts

+                    rerender(`${ONYXKEYS.COLLECTION.TEST_KEY}2`);
+                });
+            } catch (e) {
+                fail("Expected to don't throw any errors.");


Suggested change

fail("Expected to don't throw any errors.");

fail("Expected to not throw any errors.");

Good point, done

Krishna2323 · 2026-03-26T14:41:13Z

Will start reviewing this today.

Krishna2323 · 2026-03-27T14:22:42Z

Reviewing...

Krishna2323

Looks good overall. A few suggestions:

lib/usePrevious.ts is no longer imported anywhere -- should we delete it?
Test "should return cached value immediately..." doesn't actually assert synchronously after rerender(). Consider adding a check right after rerender() before waitForPromisesToResolve() to match the title, or adjusting the title.
Would be nice to add tests for:
- Switching between non-collection keys (e.g., TEST_KEY to TEST_KEY_2) since the PR description mentions arbitrary key changes now work
- initWithStoredValues: false with dynamic keys
- A → B → A round-trip (returning to a previously used key)

JKobrynski · 2026-03-30T09:21:04Z

@Krishna2323 done! Let me know what you think

…fix-useonyx-state-not-resetting

…6-fix-useonyx-state-not-resetting

JKobrynski · 2026-03-31T13:06:47Z

@Krishna2323 kindly bump 🙏

Krishna2323 · 2026-03-31T14:46:20Z

Reviewing...

Krishna2323 · 2026-03-31T19:35:36Z

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_hybrid.mp4

Android: mWeb Chrome

android_mWeb.mp4

iOS: HybridApp

ios_hybrid.mp4

iOS: mWeb Safari

ios_mWeb.mp4

MacOS: Chrome / Safari

web_chrome.mp4

Krishna2323

LGTM and works well! 🚀

os-botify · 2026-04-01T09:54:51Z

🚀 Published to npm in 3.0.59 🎉

reset internal useOnyx state on key change

6b717dd

melvin-bot bot assigned JKobrynski Mar 20, 2026

Merge remote-tracking branch 'upstream/main' into JKobrynski/fix/8541…

8450987

…6-fix-useonyx-state-not-resetting

JKobrynski marked this pull request as ready for review March 20, 2026 14:13

JKobrynski requested a review from a team as a code owner March 20, 2026 14:13

melvin-bot bot requested review from cristipaval and removed request for a team March 20, 2026 14:14

JKobrynski mentioned this pull request Mar 20, 2026

[$250] [Onyx Audit] Fix useOnyx state not resetting on key change in getSnapshot() Expensify/App#85416

Open

chatgpt-codex-connector bot reviewed Mar 20, 2026

View reviewed changes

apply alternative solution, remove original one

ec0ba98

apply additional improvements, add more tests

0e1a5d7

fabioh8010 reviewed Mar 26, 2026

View reviewed changes

apply suggestion in useOnyxTest.ts

4f60644

Krishna2323 reviewed Mar 29, 2026

View reviewed changes

address review comments

2aab277

JKobrynski added 2 commits March 30, 2026 15:33

Merge remote-tracking branch 'origin/main' into JKobrynski/fix/85416-…

e0f54ec

…fix-useonyx-state-not-resetting

Merge remote-tracking branch 'upstream/main' into JKobrynski/fix/8541…

3f3500d

…6-fix-useonyx-state-not-resetting

Krishna2323 approved these changes Mar 31, 2026

View reviewed changes

cristipaval approved these changes Apr 1, 2026

View reviewed changes

cristipaval merged commit 9f09be3 into Expensify:main Apr 1, 2026
10 checks passed

	fail("Expected to don't throw any errors.");
	fail("Expected to not throw any errors.");

Conversation

JKobrynski commented Mar 20, 2026 • 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!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Mar 20, 2026

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!

Krishna2323 commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fabioh8010 commented Mar 23, 2026

Uh oh!

JKobrynski commented Mar 23, 2026

Uh oh!

JKobrynski commented Mar 24, 2026

Uh oh!

JKobrynski commented Mar 26, 2026

Uh oh!

fabioh8010 left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Krishna2323 commented Mar 26, 2026

Uh oh!

Krishna2323 commented Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Krishna2323 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JKobrynski commented Mar 30, 2026

Uh oh!

JKobrynski commented Mar 31, 2026

Uh oh!

Krishna2323 commented Mar 31, 2026

Uh oh!

Krishna2323 commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Krishna2323 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

os-botify bot commented Apr 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

JKobrynski commented Mar 20, 2026 •

edited

Loading

Krishna2323 commented Mar 20, 2026 •

edited

Loading

Krishna2323 commented Mar 27, 2026 •

edited

Loading

Krishna2323 left a comment •

edited

Loading

Krishna2323 commented Mar 31, 2026 •

edited

Loading