Fix implementation of useCurrentUserPersonalDetails by SzymczakJ · Pull Request #69864 · Expensify/App

SzymczakJ · 2025-09-04T13:20:50Z

Explanation of Change

This PR changes the implementation of useCurrentUserPersonalDetails by remove the usePersonalDetails hook and replacing it with useOnyx. This stops rerenders triggered by context that usePersonalDetails subscribes to.

Fixed Issues

$ #70056
PROPOSAL:

Tests

Make sure that user name is highlighted with green color on SearchAutocompleteInput and on SearchRouter:

2. Make sure that user data on Profile screen is correctly loaded(no infinite loading screen etc.) 3. Make sure that paying with settlement button is possible.

Offline tests

QA Steps

Same as tests

PR Author Checklist

I linked the correct issue in the ### Fixed 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 added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 verified there are no new alerts related to the canBeMissing param for useOnyx
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 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
  - If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 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.ts 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 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.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2025-09-08T10:38:48Z

@shubham1206agra 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]

SzymczakJ · 2025-09-08T10:39:32Z

Don't mind the jest tests @shubham1206agra, they're broken on main.

shubham1206agra · 2025-09-08T11:50:50Z

    const session = useSession();
-    const personalDetails = usePersonalDetails();
+    const userAccountID = useMemo(() => session?.accountID ?? CONST.DEFAULT_NUMBER_ID, [session?.accountID]);
+    const [userPersonalDetails] = useOnyx(ONYXKEYS.PERSONAL_DETAILS_LIST, {selector: (allPersonalDetails) => allPersonalDetails?.[userAccountID], canBeMissing: true});


@SzymczakJ Whenever we use this hook, it will create this subscription again. Can we somehow get rid of this Onyx subscription duplication?

I was thinking about the same thing as you, but in the end I think this is the best solution.

I considered a few options to avoid using useOnyx here:

create Onyx.connect on the top of the file, but this option is obviously a wrong idea as we deprecate the Onyx.connect and the problems with reactivity that Onyx.connect was introducing.

create another context just for userPeronalDetails. It think it's not worth it, especially when we think of how much contexts we already have in this app. What's more, useContext also has it's own overhead(as it has to look for the closest context provider, which would be really close to the root etc.) and I'm pretty sure that it's comparable to the overhead that useOnyx gives us.

stay with previous implementation that was using usePersonalDetails. This option is the worst, it will rerender every component that uses it every time any personal details list changes. Obvioulsy cost of rerendering component many times will be bigger than adding a single useOnyx.

I also measured the performance of onyx internal function that notifies useOnyx subscribers(fireCallbacks) with the new implmentation and the total execution time was pretty much the same(with the new implementation it was even better but I guess it's a measurement error). So to conclude: yes I know that using many useOnyx connections is bad, but it doesn't hurt us as bad when we consider how much rerenders it saved us in this particular case.

But if you have any other idea how to stop using useOnyx subscription duplication, tell me because it would be a nice improvement.

@SzymczakJ It would be better if we benchmark option 2 with the current implementation

You're right, I will profile and come back to you ASAP

It turns out that option 2 with context is much better than having useOnyx for each useCurrentUserPersonalDetails.
While the profiling outcomes for a given scenario that I was testing are pretty much the same(because the whole useCurrentUserPersonalDetails is really small), there is a big difference in the total measured time of useCurrentUserPersonalDetails.

implementation using useOnyx for each hook: 2.5325 ms of overhead

implementation using context(option 2): 0.0707 ms of overhead

I've already pushed the new version.

@SzymczakJ You need to fix the test to include this new context.

Tests fixed.

roryabraham · 2025-09-08T20:50:13Z

    const session = useSession();
-    const personalDetails = usePersonalDetails();
+    const userAccountID = useMemo(() => session?.accountID ?? CONST.DEFAULT_NUMBER_ID, [session?.accountID]);
+    const [userPersonalDetails] = useOnyx(ONYXKEYS.PERSONAL_DETAILS_LIST, {selector: (allPersonalDetails) => allPersonalDetails?.[userAccountID], canBeMissing: true});


If you define the selector at the top level of the file (outside the hook), you'll get a stable reference to the selector for all usages of the hook. That in turn will mean that the OnyxSnapshotCache can do it's job, and we get one cache entry for all usages of this hook, rather than 1 cache entry per usage. That will lead to better performance (because the function call is cached) and a smaller memory footprint (because we won't be adding new entries to the snapshot cache for every usage of the hook).

Good call 😄

SzymczakJ · 2025-09-10T07:45:29Z

Ready for your review @shubham1206agra

SzymczakJ · 2025-09-10T15:09:32Z

bump @shubham1206agra, I see you posting on open source 😄 👁️ 🔭

shubham1206agra · 2025-09-10T16:03:43Z

@SzymczakJ Can you fix the warnings?

shubham1206agra · 2025-09-10T16:19:02Z

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
xIf 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

Android: mWeb Chrome

Screen.Recording.2025-09-10.at.9.11.46.PM.mov

iOS: HybridApp

Screen.Recording.2025-09-10.at.10.32.01.PM.mov

iOS: mWeb Safari

Screen.Recording.2025-09-10.at.9.09.35.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-09-10.at.9.07.17.PM.mov

MacOS: Desktop

Screen.Recording.2025-09-10.at.9.16.32.PM.mov

mountiny

Thank you!

OSBotify · 2025-09-10T19:30:09Z

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

OSBotify · 2025-09-10T23:30:30Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.2.9-0 🚀

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

OSBotify · 2025-09-11T11:11:53Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.2.11-0 🚀

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

OSBotify · 2025-09-12T00:17:10Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.2.12-4 🚀

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

shubham1206agra · 2025-12-22T14:06:26Z

+        },
+        [userAccountID],
+    );
+    const [currentUserPersonalDetails = defaultCurrentUserPersonalDetails] = useOnyx(ONYXKEYS.PERSONAL_DETAILS_LIST, {selector: userAccountSelector, canBeMissing: true});


We forgot to add dependencies for the selector, which caused #74176

fix impl of useCurrentUserPersonalDetails

c31d19f

melvin-bot Bot assigned SzymczakJ Sep 4, 2025

SzymczakJ added 3 commits September 5, 2025 15:06

Merge branch 'main' into @szymczak/fix-useCurrentUserPersonalDetails

7d60468

Merge branch 'main' into @szymczak/fix-useCurrentUserPersonalDetails

2b00ce0

fix lint

400c146

SzymczakJ marked this pull request as ready for review September 8, 2025 10:38

SzymczakJ requested a review from a team as a code owner September 8, 2025 10:38

melvin-bot Bot requested review from shubham1206agra and removed request for a team September 8, 2025 10:38

shubham1206agra reviewed Sep 8, 2025

View reviewed changes

roryabraham requested changes Sep 8, 2025

View reviewed changes

SzymczakJ added 2 commits September 9, 2025 11:27

Merge branch 'main' into @szymczak/fix-useCurrentUserPersonalDetails

6196396

change useCurrentUserPersonalDetails implementation to use context

a5fb2e0

SzymczakJ force-pushed the @szymczak/fix-useCurrentUserPersonalDetails branch from 23bc1c2 to a5fb2e0 Compare September 9, 2025 11:22

SzymczakJ added 6 commits September 9, 2025 15:07

fix tests

de1b87a

Merge branch 'main' into @szymczak/fix-useCurrentUserPersonalDetails

92398f8

fix tests

9632b2e

Merge branch 'main' into @szymczak/fix-useCurrentUserPersonalDetails

4463755

fix tests

84e8df6

make selector reference stable

3c6e716

roryabraham requested changes Sep 9, 2025

View reviewed changes

Comment thread src/components/CurrentUserPersonalDetailsProvider.tsx Outdated

fix PR comments

19dcda4

Merge branch 'main' into @szymczak/fix-useCurrentUserPersonalDetails

441e919

fix lint warnings

d246d9d

shubham1206agra approved these changes Sep 10, 2025

View reviewed changes

melvin-bot Bot requested a review from mountiny September 10, 2025 17:28

roryabraham approved these changes Sep 10, 2025

View reviewed changes

mountiny approved these changes Sep 10, 2025

View reviewed changes

mountiny merged commit 5f895cc into Expensify:main Sep 10, 2025
23 checks passed

OSBotify mentioned this pull request Sep 10, 2025

Deploy Checklist: New Expensify 2025-09-10 #70325

Closed

melvin-bot Bot mentioned this pull request Sep 12, 2025

[Due for payment 2025-09-19] [$250] Refactor useCurrentUserPersonalDetails to use useOnyx with selector #70056

Closed

shubham1206agra reviewed Dec 22, 2025

View reviewed changes

Conversation

SzymczakJ commented Sep 4, 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

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Sep 8, 2025

Uh oh!

SzymczakJ commented Sep 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shubham1206agra Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

SzymczakJ commented Sep 10, 2025

Uh oh!

SzymczakJ commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shubham1206agra commented Sep 10, 2025

Uh oh!

shubham1206agra commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Sep 10, 2025

Uh oh!

OSBotify commented Sep 10, 2025

Uh oh!

OSBotify commented Sep 11, 2025

Uh oh!

OSBotify commented Sep 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

SzymczakJ commented Sep 4, 2025 •

edited

Loading

shubham1206agra Sep 8, 2025 •

edited

Loading

SzymczakJ commented Sep 10, 2025 •

edited

Loading

shubham1206agra commented Sep 10, 2025 •

edited

Loading