Skip to content

fix: re-check cache after storage read in get() to handle concurrent writes#769

Open
TaduJR wants to merge 1 commit intoExpensify:mainfrom
TaduJR:fix-mergeCollectionWithPatches-deferred-cache-write-race-condition
Open

fix: re-check cache after storage read in get() to handle concurrent writes#769
TaduJR wants to merge 1 commit intoExpensify:mainfrom
TaduJR:fix-mergeCollectionWithPatches-deferred-cache-write-race-condition

Conversation

@TaduJR
Copy link
Copy Markdown

@TaduJR TaduJR commented Apr 11, 2026

Details

mergeCollectionWithPatches is the only Onyx write operation that defers its cache write to an async .then() chain. All other operations (setWithRetry, applyMerge, multiSetWithRetry) update cache synchronously. When Onyx.update() batches 2+ collection keys into mergeCollectionWithPatches, a concurrent Onyx.merge() on the same key can call get() before the cache write completes. get() falls back to Storage.getItem(), which returns null on Native (SQLite is slower than the deferred cache write). The merge then overwrites cache with the stale result, destroying fields set by the original update.

This affects any optimistic data written via Onyx.update() that shares a collection prefix with other keys in the same update batch. In the App, it manifests as isOptimisticReport: true being destroyed from report metadata when updateLastVisitTime fires concurrently.

The fix adds a cache re-check in get() after the async storage read resolves. If a concurrent operation populated the cache while storage was in-flight, the fresher cache value is used instead of the stale storage result.

Web is unaffected because IndexedDB completes the storage write before the getItem resolves, so storage returns the correct value. The race window exists on both platforms but only causes data loss on Native.

Related Issues

$ Expensify/App#83779

Automated Tests

Added a test in onyxTest.ts that reproduces the race condition by mocking Storage.getItem with a 50ms delay for the target key (simulating slow Native SQLite). The test calls Onyx.update with 2+ collection keys followed by a concurrent Onyx.merge on the same key. Without the fix, the merged result loses the original fields. With the fix, both fields are preserved.

Manual Tests

Prerequisite: Turn on "Simulate failing network requests"

  1. Open Expensify App
  2. Go to Inbox and tap FAB
  3. Tap Create Expense enter amount
  4. On confirmation Page choose a user you never chatted or send an expense before
  5. Create the Expense, and The chat creation/expense submission should be failed.
  6. Tap the create chat error clear button
  7. Verify that the User is redirected to the concierge chat

Author Checklist

  • I linked the correct issue in the ### Related 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 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 / Chrome
    • iOS / native
    • iOS / 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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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 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.js 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android-Native.mp4
Android: mWeb Chrome
Android-mWeb.mp4
iOS: Native
iOS-Native.mp4
iOS: mWeb Safari
iOS-Safari.mp4
MacOS: Chrome / Safari
Mac-Chrome.mp4

@TaduJR TaduJR requested a review from a team as a code owner April 11, 2026 19:10
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 11, 2026

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

@melvin-bot melvin-bot bot requested review from mollfpr and removed request for a team April 11, 2026 19:11
@TaduJR
Copy link
Copy Markdown
Author

TaduJR commented Apr 11, 2026

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

CLABotify added a commit to Expensify/CLA that referenced this pull request Apr 11, 2026
@TaduJR
Copy link
Copy Markdown
Author

TaduJR commented Apr 11, 2026

cc @hungvu193

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.

1 participant