Change withOnyx to useOnyx in createOnyxContext #65781

zirgulis · 2025-07-09T19:45:06Z

Explanation of Change

Change the deprecated withOnyx inside createOnyxContext.tsx to useOnyx

Fixed Issues

$ #62300

Tests

Verify context providers work correctly after refactor:
- Navigate to any screen that uses a context created by createOnyxContext (e.g., settings screen, report screen)
- Verify that the screen loads without errors and displays the expected data
- Verify that the context provider is correctly passing data to consuming components
Test data reactivity and updates:
- Navigate to a screen that uses a context created by createOnyxContext
- Trigger an action that updates the Onyx data for that context (e.g., update user settings, change report data)
- Verify that the UI updates immediately to reflect the new data
Test multiple context consumers:
- Navigate to a screen with multiple components that consume the same context
- Verify that all components receive the same data and update simultaneously when the Onyx data changes
Test context hook functionality:
- Navigate to screens that use the context hook returned by createOnyxContext
- Verify that components can successfully read data using the hook
- Verify that the hook throws appropriate errors when used outside the provider
Test initial data loading:
- Clear app data/cache and restart the app
- Navigate to screens using contexts created by createOnyxContext
- Verify that initial data loads correctly and displays properly
Test error scenarios:
- Navigate to a screen that uses a context created by createOnyxContext
- Simulate network errors or invalid data scenarios
- Verify that error handling works as expected and no crashes occur

Offline tests

Test offline data availability:
- Go offline
- Navigate to screens that use contexts created by createOnyxContext
- Verify that cached data is still available and displayed correctly
Test data synchronization when going back online:
- While offline, navigate to screens using the affected contexts
- Go back online
- Verify that data syncs properly and any pending updates are reflected

QA Steps

Test 1: Personal Details Context (usePersonalDetails)

Screens to test:

Search functionality and filters
Money request flows
Task management screens
Report participant lists

Steps:

Navigate to Search → Advanced Filters → "From" field
Verify: User names and avatars load correctly
Create a money request and select participants
Verify: Personal details display correctly in participant selection
View any group chat participant list
Verify: All participant names and avatars display correctly

Test 2: Session Context (useSession)

Screens to test:

Authentication-dependent features
Task assignment flows
Image components requiring auth

Steps:

Press + button → Assign Task
In "Assign to" field, type your own name/email
Verify: You can find and select yourself
Create the task
Verify: Task is created successfully (proving session works for task creation)
Expected Result: Task assignment works and shows you have proper session access

Test 3: Policy Categories/Tags Context

Screens to test:

MoneyRequestView
Expense categorization flows

Steps:

Create a new expense request
Select categories and tags (if available)
Verify: Categories and tags load and save correctly
View expense details
Verify: Selected categories/tags display correctly

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2025-07-17.at.17.28.32.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2025-07-17.at.16.48.26.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-07-17.at.16.38.54.mov

MacOS: Desktop

fabioh8010

LGTM, let's do some testing around the app to see if everything is working good.

fabioh8010 · 2025-07-10T22:20:55Z

I think we should have some test steps here @zirgulis, this change seems innocent but I'm a little concerned about the impact. Could we remove [No QA]?

zirgulis · 2025-07-17T15:45:34Z

I did some JS profiling (iOS) on app start and the performance of withOnyx vs useOnyx is almost identical:

Before:

After:

In addition, the IS_SIDEBAR_LOADED performance metric is also the same on both cases, around 900ms on iOS.

melvin-bot · 2025-07-17T15:53:25Z

@alitoshmatov Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

zirgulis · 2025-07-17T15:53:33Z

@roryabraham ready for review

zirgulis · 2025-07-17T15:55:48Z

Not sure why TS check fails, locally no issues

EDIT:

ok needed to re-install node_modules

fails on main too

roryabraham · 2025-07-18T16:32:41Z

tests/unit/SidebarOrderTest.ts


    describe('in default mode', () => {
-        it('is not rendered when there are no props passed to it', () => {
+        it('is rendered with empty state when no reports are available', () => {


This test doesn't actually check to ensure that it's rendered with an empty state. Only that it's not null. Can we update this test to be more useful?

@roryabraham fixed

roryabraham

LGTM, to you @alitoshmatov for testing

alitoshmatov · 2025-07-28T07:46:40Z

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

context-android.mov

Android: mWeb Chrome

context-mweb.mov

iOS: HybridApp

context-ios.mp4

iOS: mWeb Safari

context-safari.mp4

MacOS: Chrome / Safari

context-web.mov

MacOS: Desktop

context-desktop.mov

alitoshmatov

LGTM!

OSBotify · 2025-07-29T19:31:30Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-07-31T12:16:47Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.1.88-0 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	success ✅
🍎 iOS 🍎	success ✅

github-actions · 2025-08-04T19:23:42Z

🚀 Deployed to production by https://github.com/grgia in version: 9.1.88-3 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	success ✅
🍎 iOS 🍎	success ✅

zirgulis mentioned this pull request Jul 9, 2025

[Due for payment 2025-08-11] [Due for payment 2025-08-05] [$250] [Due for payment 2025-07-25] Investigate createOnyxProvider performance #62300

Closed

fabioh8010 approved these changes Jul 10, 2025

View reviewed changes

fabioh8010 mentioned this pull request Jul 11, 2025

[Due for payment 2025-10-13] Remove remaining withOnyx HOCs from the project #64225

Closed

10 tasks

zirgulis changed the title ~~[No QA] Change withOnyx to useOnyx in createOnyxContext~~ Change withOnyx to useOnyx in createOnyxContext Jul 15, 2025

zirgulis force-pushed the fix/change-withOnyx-to-useOnyx branch 2 times, most recently from 2561f69 to dd3ac7c Compare July 17, 2025 14:02

zirgulis force-pushed the fix/change-withOnyx-to-useOnyx branch from dd3ac7c to 3d6773a Compare July 17, 2025 15:49

zirgulis marked this pull request as ready for review July 17, 2025 15:53

zirgulis requested a review from a team as a code owner July 17, 2025 15:53

melvin-bot bot requested review from alitoshmatov and removed request for a team July 17, 2025 15:53

change withOnyx to useOnyx in createOnyxContext

3b03278

zirgulis force-pushed the fix/change-withOnyx-to-useOnyx branch from 3d6773a to 3b03278 Compare July 18, 2025 10:48

roryabraham requested changes Jul 18, 2025

View reviewed changes

fix test to check empty LHN state

8e7d50c

zirgulis requested a review from roryabraham July 21, 2025 13:38

roryabraham approved these changes Jul 21, 2025

View reviewed changes

alitoshmatov approved these changes Jul 28, 2025

View reviewed changes

melvin-bot bot requested a review from roryabraham July 28, 2025 07:46

roryabraham approved these changes Jul 29, 2025

View reviewed changes

roryabraham merged commit 90c2a2b into Expensify:main Jul 29, 2025
19 of 21 checks passed

github-actions bot mentioned this pull request Jul 31, 2025

Deploy Checklist: New Expensify 2025-07-31 #67499

Closed

90 tasks

Change withOnyx to useOnyx in createOnyxContext #65781

Change withOnyx to useOnyx in createOnyxContext #65781

Uh oh!

Conversation

zirgulis commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

Test 1: Personal Details Context (usePersonalDetails)

Test 2: Session Context (useSession)

Test 3: Policy Categories/Tags Context

PR Author Checklist

Screenshots/Videos

Uh oh!

fabioh8010 left a comment

Choose a reason for hiding this comment

Uh oh!

fabioh8010 commented Jul 10, 2025

Uh oh!

zirgulis commented Jul 17, 2025

Uh oh!

melvin-bot bot commented Jul 17, 2025

Uh oh!

zirgulis commented Jul 17, 2025

Uh oh!

zirgulis commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

roryabraham Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

zirgulis Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

alitoshmatov commented Jul 28, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

alitoshmatov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Jul 29, 2025

Uh oh!

github-actions bot commented Jul 31, 2025

Uh oh!

github-actions bot commented Aug 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

zirgulis commented Jul 9, 2025 •

edited

Loading

zirgulis commented Jul 17, 2025 •

edited

Loading