Remove waitForCollectionCallback from Onyx by fabioh8010 · Pull Request #799 · Expensify/react-native-onyx

fabioh8010 · 2026-06-19T09:35:48Z

Details

Removes waitForCollectionCallback — the per-member collection subscription mode — so a collection-key subscription always receives the whole collection. Removing it exposed a latent multi-tab sync bug, which this PR also fixes.

Cross-tab sync fix

Now that every collection subscriber is a whole-collection subscriber, multi-instance (web, multi-tab) sync needed fixing. InstanceSync raised one localStorage event per changed key and the receiving tab read each with its own async getItem, so a mergeCollection of N members arrived as N independent events across N tasks. That meant collection-root subscribers either received nothing cross-tab, or — if notified per member — had the whole collection re-delivered N times (O(N²)), crashing the receiving tab on large collections.

The fix preserves the write's batch boundary across tabs:

InstanceSync raises a single SYNC_ONYX event carrying the JSON array of all keys changed in a write (falls back to a single key for the previous format).
The receiving tab reads them with one multiGet and hands the whole batch to Onyx via a new batched onStorageKeysChanged(pairs) callback.
Onyx processes the batch synchronously, grouping members by collection and firing one keysChanged() per collection (plus keyChanged() for individual keys) — mirroring a local mergeCollection.

Result: a cross-tab collection update notifies each collection-root subscriber once (O(N)) instead of N times or never.

Related Issues

Expensify/App#94331
Expensify/App#94839

Linked E/App PR

Expensify/App#93436

Automated Tests

Tests were changed to accomodate the changes.

Manual Tests

We are basically just removing waitForCollectionCallback usage here, functionality should stay the same so we only need to test the two files where we actually did some meaningful change (Report/index.ts and replaceOptimisticReportWithActualReport.ts).

Go to Offline mode.
Start a chat with an user that exists but you never messaged before.
Send a message to that user.
Go back to Online mode, assert the message is still there and the user is still the correct one.
Delete the message you just sent, assert it works.

Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

Screen.Recording.2026-06-30.at.08.46.47.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2026-06-30.at.08.40.31.mov

Collection-root subscriptions (via Onyx.connect or useOnyx) now always deliver the whole collection snapshot to the callback. The legacy per-member delivery mode for collection-root subscribers is removed; consumers needing per-member processing subscribe to a single member key. Collapses the DefaultConnectOptions/CollectionConnectOptions discriminated union into one ConnectOptions shape (callback typed on TKey), simplifies generateConnectionID and the keyChanged/keysChanged dispatch, and drops the option from useOnyx's internal connect. Per-member-mode tests were migrated to assert snapshot delivery rather than deleted. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

fabioh8010 · 2026-06-19T09:36:06Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 01704211bf

ℹ️ 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-06-19T09:42:39Z

+                if (OnyxKeys.isCollectionKey(subscriber.key)) {
+                    // Collection-root subscribers always receive the whole collection snapshot.
+                    // Skip individual key changes during collection updates to prevent duplicate
+                    // callbacks - the collection update will handle this properly.
                    if (isProcessingCollectionUpdate) {


Don't skip synced collection-member updates

On web with multiple tabs, InstanceSync raises storage events per member key and Onyx.ts calls keyChanged(..., isKeyCollectionMember) with true for those collection-member updates. With this broadened collection-root branch, the receiving tab hits the isProcessingCollectionUpdate continue, and no keysChanged() runs afterward in that tab, so Onyx.connect({key: COLLECTION...}) subscribers never receive the required collection snapshot when another tab changes the collection. Please allow the storage-sync path to notify collection-root subscribers instead of treating it like a local batched collection update.

Useful? React with 👍 / 👎.

Addressed in 9263ec9. Basically this flow was already flawed in main – the collection key callbacks with waitForCollectionCallback: true were not notified during tab syncs, only collection key callbacks without waitForCollectionCallback: true (per-member mode) or regular/collection member keys.

The solution here is to batch the writes across tab syncs instead of treating each synced member as an independent update. InstanceSync now raises a single SYNC_ONYX event carrying the JSON array of all keys changed in one write (instead of one event per key), and the receiving tab reads them with a single multiGet and hands Onyx the whole batch via a new batched onStorageKeysChanged(pairs) callback (with a single-key fallback for backwards compatibility).

Onyx then processes that batch synchronously — grouping members by their parent collection and firing exactly one keysChanged() per affected collection (plus keyChanged() for individual keys) — which mirrors how a local mergeCollection works. This makes a cross-tab collection update notify each collection-root subscriber (Onyx.connect/useOnyx on a collection key) once, in O(N), rather than re-delivering the whole collection once per member (O(N^2), which can crash the receiving tab depending on the payload) or never delivering it at all.

#799 (comment)

…e-pr-1

fabioh8010 · 2026-06-25T16:09:02Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9263ec964d

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3da566e848

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

fabioh8010 · 2026-06-26T14:25:46Z

I caught one bug with the tab sync logic when clearing Onyx cache, investigating it.

…e-pr-1

fabioh8010 · 2026-06-29T10:45:10Z

Regarding #799 (comment), I decided to extract the whole tab sync fixes into a separate PR (that will need a separate bug report issue), because:

The bug already exists on main, so we aren't introducing new regressions here
I have a almost-working solution but new bugs keep appearing and it's slowing down the work here, so it's better to push it separately from here.

truph01 · 2026-06-29T10:56:54Z

Regarding #799 (comment), I decided to extract the whole tab sync fixes into a separate PR (that will need a separate bug report issue), because:

The bug already exists on main, so we aren't introducing new regressions here

I have a almost-working solution but new bugs keep appearing and it's slowing down the work here, so it's better to push it separately from here.

I agree with this. @mountiny, could you create a separate issue for it?

mountiny · 2026-06-29T12:24:53Z

@fabioh8010 is creating one

fabioh8010 · 2026-06-29T13:32:53Z

@truph01 @mountiny Expensify/App#94839

mountiny · 2026-06-29T19:06:28Z

@fabioh8010 issue was created can you link it here please

@truph01 can you continue with the review?

fabioh8010 · 2026-06-30T07:51:09Z

Onyx and E/App PRs updated and ready to review @truph01

truph01 · 2026-06-30T11:03:43Z

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 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 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)
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)
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.
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

Screen.Recording.2026-06-30.at.18.03.11.mov

iOS: HybridApp

iOS: mWeb Safari

Screen.Recording.2026-06-30.at.18.01.13.mov

MacOS: Chrome / Safari

Screen.Recording.2026-06-30.at.17.59.23.mov

mountiny

Thanks, LGTM

os-botify · 2026-06-30T14:51:13Z

🚀 Published to npm in 3.0.89 🎉

melvin-bot Bot assigned fabioh8010 Jun 19, 2026

chatgpt-codex-connector Bot reviewed Jun 19, 2026

View reviewed changes

fabioh8010 added 3 commits June 24, 2026 14:35

Merge branch 'feature/onyx-store-poc-baseline' into feature/onyx-stor…

7bec806

…e-pr-1

Update docs

c184571

Cleanup

77f93d1

chatgpt-codex-connector Bot reviewed Jun 25, 2026

View reviewed changes

Comment thread lib/types.ts Outdated

fabioh8010 marked this pull request as ready for review June 26, 2026 13:21

fabioh8010 requested a review from a team as a code owner June 26, 2026 13:21

melvin-bot Bot requested a review from arosiclair June 26, 2026 13:21

fabioh8010 mentioned this pull request Jun 26, 2026

[$250] Collapse Onyx collection-key subscriptions to a single whole-collection delivery mode and remove the waitForCollectionCallback option Expensify/App#94331

Open

melvin-bot Bot removed the request for review from a team June 26, 2026 13:21

chatgpt-codex-connector Bot reviewed Jun 26, 2026

View reviewed changes

Comment thread lib/OnyxConnectionManager.ts

Comment thread lib/storage/InstanceSync/index.web.ts Outdated

mountiny self-requested a review June 26, 2026 13:52

fabioh8010 changed the title ~~[WIP] Remove waitForCollectionCallback from Onyx~~ Remove waitForCollectionCallback from Onyx Jun 26, 2026

mountiny requested a review from truph01 June 29, 2026 05:49

fabioh8010 added 2 commits June 29, 2026 11:17

Improve docs and types

4049c58

Add try/catch to fireCallbacks()

1d77980

fabioh8010 force-pushed the feature/onyx-store-pr-1 branch from 47c46ba to 1d77980 Compare June 29, 2026 10:19

Merge branch 'feature/onyx-store-poc-baseline' into feature/onyx-stor…

721d95b

…e-pr-1

fabioh8010 mentioned this pull request Jun 29, 2026

[$250] Certain actions in LHN don't sync between tabs Expensify/App#94839

Open

7 tasks

fabioh8010 mentioned this pull request Jun 29, 2026

[WIP] Fix cross-tab sync for collection-root subscribers #803

Draft

42 tasks

truph01 approved these changes Jun 30, 2026

View reviewed changes

mountiny approved these changes Jun 30, 2026

View reviewed changes

mountiny merged commit 1cc7acc into Expensify:main Jun 30, 2026
12 checks passed

fabioh8010 mentioned this pull request Jun 30, 2026

Remove sourceValue from Onyx #801

Merged

42 tasks

Uh oh!

Conversation

fabioh8010 commented Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Cross-tab sync fix

Related Issues

Linked E/App PR

Automated Tests

Manual Tests

Author Checklist

Screenshots/Videos

Uh oh!

fabioh8010 commented Jun 19, 2026

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector Bot Jun 19, 2026

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Jun 29, 2026

Choose a reason for hiding this comment

Uh oh!

fabioh8010 commented Jun 25, 2026

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

fabioh8010 commented Jun 26, 2026

Uh oh!

fabioh8010 commented Jun 29, 2026

Uh oh!

truph01 commented Jun 29, 2026

Uh oh!

mountiny commented Jun 29, 2026

Uh oh!

fabioh8010 commented Jun 29, 2026

Uh oh!

mountiny commented Jun 29, 2026

Uh oh!

fabioh8010 commented Jun 30, 2026

Uh oh!

truph01 commented Jun 30, 2026

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

os-botify Bot commented Jun 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fabioh8010 commented Jun 19, 2026 •

edited

Loading