Skip to content

Auto-track useOnyxState keys, drop declared dependencies - #8

Merged
sosek108 merged 4 commits into
feature/onyx-store-useonyxstate-recutfrom
perf/uos-auto-deps-3020
Nov 18, 2026
Merged

sosek108 merged 4 commits into
feature/onyx-store-useonyxstate-recutfrom
perf/uos-auto-deps-3020

Conversation

@sosek108

@sosek108 sosek108 commented Nov 17, 2026 •

Copy link
Copy Markdown

Details

Removes the dependencies option from useOnyxState. The hook now always tracks keys: the shared state Proxy records the keys each selector run reads, and the hook subscribes to exactly those. A selector that reads report_1 listens to that member only, and a lookup chain follows the ID as it changes. Reading a collection root still subscribes to every member.

Each run replaces the recorded set. After a commit the hook moves its subscription to the new set and re-renders if a newly read key was written in between. Recording costs one Set.add per read on the existing Proxy, so the deep-tracking cost from https://github.com/callstack-internal/expensify-issues/issues/3042 does not apply.

Measured before the option was removed (Jest on V8): auto-tracking matched hand-declared member deps exactly. Against declaring the whole collection at 1,000 rows, 5 unrelated writes ran 0 selectors instead of 5,000 (0.3 ms instead of 5 to 6 ms). Details are on the issue.

Known gap: the state view types a collection root as a member too, so state['report_'].reportName compiles.

Related Issues

https://github.com/callstack-internal/expensify-issues/issues/3020

Linked E/App PR

None yet. This targets the useOnyxState POC branch (Expensify#862), which has no App consumer pinned.

Automated Tests

tests/unit/useOnyxStateTest.tsx drops dependencies from every case and adds key-tracking cases: a sibling member write never runs the selector, a lookup follows the key it points at, a branch starts listening to a newly read key, and several hooks track independently. Type tests no longer pass dependencies. tests/perf-test/useOnyxStateAutoDeps.perf-test.tsx covers row and collection-root selectors.

Manual Tests

None. No App code on this branch uses useOnyxState.

Author Checklist

  • I linked the correct issue in the ### Related Issues section above
  • I linked the corresponding Expensify/App PR in the ### Linked E/App PR section above, and verified this change against it (E/App CI passed and manual testing completed)
  • 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

@sosek108 sosek108 changed the title Auto-track useOnyxState dependencies Auto-track useOnyxState keys, drop declared dependencies Nov 18, 2026
@sosek108
sosek108 marked this pull request as ready for review November 18, 2026 11:37
@sosek108
sosek108 merged commit 9b4cc4a into feature/onyx-store-useonyxstate-recut Nov 18, 2026
7 of 10 checks passed
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