feat: expose callback trigger value for collections

[TMisiukiewicz]

Details

This PR introduces exposing the value that triggered the connection callback. It's helpful when callback is doing some operations for each collection item - e.g. when a collection key is a dependency of derived value in E/App and it loops through all items to compute things, having this trigger value allows to make an update for a single item rather than recompute everything from scratch.

Related Issues

GH_LINK
https://expensify.slack.com/archives/C05LX9D6E07/p1741698890119029

Automated Tests

Added unit tests that check if:

• callback is called with sourceValue when waitForCollectionCallback: true
• sourceValue is not available for waitForCollectionCallback: false

Manual Tests

Opened a draft PR where getReportName is moved to derived value and it updates a single item: Expensify/App#58476

1. Checkout branch from the PR above
2. Link local react-native-onyx with this branch
3. FAB -> create new chat -> Room
4. Create a new room with any name of your choice
5. Press the chat header
6. Press the room name
7. Edit the room name and save
8. Verify the name has changed on details screen

If you want to make sure we just did a single-item computation, open chrome dev tools -> Performance and start recording before step no 7, download the trace, upload it to https://www.speedscope.app/ and search for recomputeDerivedValue. You should find compute function for reportAttributes here, which should be a very tiny update probably with <1ms of execution time.

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
  • MacOS / Desktop
• 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[MonilBhavsar]

Is it the value or an object of onyx key and value?

[TMisiukiewicz]

OnyxValue represents a value that can be either a single entry or a collection of entries

[TMisiukiewicz]

@MonilBhavsar friendly bump, could you take a look when you have a moment?

[MonilBhavsar]

Looks great! Sorry for delay. Could you please provide a usage for this in App repo, or where we're going to utilize this?

[TMisiukiewicz]

My idea is to create a new derived value that stores certain report attributes that does not change often. The goal is to avoid unnecessary recomputations and significantly reduce processing overhead. In this draft PR, I moved the getReportName logic into a derived value. This change ensures we don’t re-generate names for all reports when a message is sent to just one of them.

Initial measurements look very promising—this simple optimization already brings noticeable performance improvements. We can expand this further by moving more static or infrequently changing attributes into derived values to scale the gains even more.

[MonilBhavsar]

Thanks for explaining. Makes sense 👍

[os-botify]

🚀 Published to npm in 2.0.96 🎉