Performance: Store `personalDetails` loading state in `personalDetailsMetadata` key #38756

tienifr · 2024-03-21T17:45:02Z

Details

There are a lot of subscribers to personalDetails key. Thus any changes to their isLoading state, which happens regularly, cause massive rerenders. This PR introduces a new Onyx key personalDetailsMetadata dedicated to hold these loading states just like we did with reportMetadata.

Fixed Issues

$ #37986
PROPOSAL: #37986 (comment)

Tests

Login with high traffic account
Go to any report
Press user avatar
Verify profile page appears seamlessly
Try to press several avatars and verify 4

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Login with high traffic account
Go to any report
Press user avatar
Verify profile page appears seamlessly
Try to press several avatars and verify 4

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Untitled-compressed.mov

Android: mWeb Chrome

Screen.Recording.2024-03-22.at.00.57.28-compressed.mov

iOS: Native

Screen.Recording.2024-03-22.at.00.51.43-compressed.mov

iOS: mWeb Safari

Screen.Recording.2024-03-22.at.00.54.32-compressed.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-22.at.00.48.26-compressed.mov

MacOS: Desktop

Screen.Recording.2024-03-22.at.00.55.41-compressed.mov

…ta onyx key

melvin-bot · 2024-03-21T17:58:51Z

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

src/ONYXKEYS.ts

c3024 · 2024-03-23T12:06:57Z

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 tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- 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 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 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 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.js 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.
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: Native

metaDataAndroid.mp4

Android: mWeb Chrome

metaDataAndroidChrome.mp4

iOS: Native

metaDataiOS.mp4

iOS: mWeb Safari

metaDataiOSSafari.mp4

MacOS: Chrome / Safari

metaDataAfterThisChange.mp4

metaDataOnMain.mp4

MacOS: Desktop

metaDataDesktop.mp4

c3024

LGTM

src/ONYXKEYS.ts

puneetlath · 2024-03-25T00:07:03Z

src/pages/ProfilePage.tsx

@@ -265,6 +268,9 @@ export default withOnyx<ProfilePageProps, ProfilePageOnyxProps>({
    personalDetails: {
        key: ONYXKEYS.PERSONAL_DETAILS_LIST,
    },
+    personalDetailsMetadata: {
+        key: ONYXKEYS.PERSONAL_DETAILS_METADATA,


Do we need to connect to the whole thing, or can we use a selector to just connect to the one accountID we're interested in?

There's no way we can retrieve the accountID from route in Onyx selector because selector does not expose the component's props in its parameters. Neither does Onyx key callback, because PERSONAL_DETAILS_METADATA is not a collection type. Wdyt?

puneetlath · 2024-03-25T00:07:38Z

src/pages/settings/Profile/ProfileAvatar.tsx

@@ -55,6 +56,9 @@ export default withOnyx<ProfileAvatarProps, ProfileAvatarOnyxProps>({
    personalDetails: {
        key: ONYXKEYS.PERSONAL_DETAILS_LIST,
    },
+    personalDetailsMetadata: {
+        key: ONYXKEYS.PERSONAL_DETAILS_METADATA,


Same question here about selector.

src/types/onyx/PersonalDetails.ts

Co-authored-by: c3024 <[email protected]>

…7986

Co-authored-by: Puneet Lath <[email protected]>

puneetlath · 2024-03-25T15:08:01Z

src/ONYXKEYS.ts

@@ -60,6 +60,9 @@ const ONYXKEYS = {
    /** Contains all the private personal details of the user */
    PRIVATE_PERSONAL_DETAILS: 'private_personalDetails',

+    /** PERSONAL_DETAILS_METADATA is a perf optimization used to hold loading states. For more explanation, see REPORT_METADATA. */


Actually I don't like this comment. We don't know that the comment for REPORT_METADATA won't change or go away. Can we update this comment to be more self-sufficient?

…7986

tienifr · 2024-03-26T11:14:32Z

@puneetlath I updated to comment for personalDetailsMetadata. Can you check again?

puneetlath

Small requested change. Then I think we're good to go.

src/ONYXKEYS.ts

OSBotify · 2024-03-28T15:54:36Z

✋ 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 · 2024-03-29T02:27:32Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.58-0 🚀

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

OSBotify · 2024-04-02T11:03:48Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.58-8 🚀

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

Perf optimization by holding personal details loading state in metada…

78efe2f

…ta onyx key

tienifr changed the title ~~Perf optimization by holding loading state in personalDetailsMetadata key~~ Performance: Hold personalDetails loading state in personalDetailsMetadata key Mar 21, 2024

tienifr changed the title ~~Performance: Hold personalDetails loading state in personalDetailsMetadata key~~ Performance: Store personalDetails loading state in personalDetailsMetadata key Mar 21, 2024

tienifr marked this pull request as ready for review March 21, 2024 17:58

tienifr requested a review from a team as a code owner March 21, 2024 17:58

melvin-bot bot requested review from c3024 and removed request for a team March 21, 2024 17:58

tienifr mentioned this pull request Mar 21, 2024

[HOLD for payment 2024-04-09] [$500] Profile page opens with a lag when clicking from a chat #37986

Closed

6 tasks

c3024 suggested changes Mar 23, 2024

View reviewed changes

src/ONYXKEYS.ts Outdated Show resolved Hide resolved

c3024 approved these changes Mar 24, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath March 24, 2024 10:00

puneetlath requested changes Mar 25, 2024

View reviewed changes

tienifr and others added 4 commits March 25, 2024 09:30

Modify metadata comment

8678241

Co-authored-by: c3024 <[email protected]>

Merge branch 'main' of https://github.com/tienifr/App into fix/37986

d35d677

Merge branch 'fix/37986' of https://github.com/tienifr/App into fix/3…

5eb3f49

…7986

Modify comment

f09167e

Co-authored-by: Puneet Lath <[email protected]>

puneetlath requested changes Mar 25, 2024

View reviewed changes

tienifr added 3 commits March 26, 2024 18:09

Merge branch 'main' of https://github.com/tienifr/App into fix/37986

e263ba4

Modify comment for personalDetailsMetadata

17f18e7

Merge branch 'fix/37986' of https://github.com/tienifr/App into fix/3…

233d24d

…7986

puneetlath requested changes Mar 27, 2024

View reviewed changes

src/ONYXKEYS.ts Outdated Show resolved Hide resolved

modify comment

6172849

puneetlath approved these changes Mar 28, 2024

View reviewed changes

puneetlath merged commit 50d35d8 into Expensify:main Mar 28, 2024
16 checks passed

github-actions bot mentioned this pull request Mar 29, 2024

Deploy Checklist: New Expensify 2024-03-29 #39222

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Performance: Store `personalDetails` loading state in `personalDetailsMetadata` key #38756

Performance: Store `personalDetails` loading state in `personalDetailsMetadata` key #38756

tienifr commented Mar 21, 2024 •

edited

Loading

melvin-bot bot commented Mar 21, 2024

c3024 commented Mar 23, 2024 •

edited

Loading

c3024 left a comment

puneetlath Mar 25, 2024

tienifr Mar 25, 2024 •

edited

Loading

puneetlath Mar 25, 2024

tienifr Mar 25, 2024

puneetlath Mar 25, 2024

tienifr commented Mar 26, 2024

puneetlath left a comment

OSBotify commented Mar 28, 2024

OSBotify commented Mar 29, 2024

OSBotify commented Apr 2, 2024

Performance: Store personalDetails loading state in personalDetailsMetadata key #38756

Performance: Store personalDetails loading state in personalDetailsMetadata key #38756

Conversation

tienifr commented Mar 21, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 21, 2024

c3024 commented Mar 23, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

c3024 left a comment

Choose a reason for hiding this comment

puneetlath Mar 25, 2024

Choose a reason for hiding this comment

tienifr Mar 25, 2024 • edited Loading

Choose a reason for hiding this comment

puneetlath Mar 25, 2024

Choose a reason for hiding this comment

tienifr Mar 25, 2024

Choose a reason for hiding this comment

puneetlath Mar 25, 2024

Choose a reason for hiding this comment

tienifr commented Mar 26, 2024

puneetlath left a comment

Choose a reason for hiding this comment

OSBotify commented Mar 28, 2024

OSBotify commented Mar 29, 2024

OSBotify commented Apr 2, 2024

Performance: Store `personalDetails` loading state in `personalDetailsMetadata` key #38756

Performance: Store `personalDetails` loading state in `personalDetailsMetadata` key #38756

tienifr commented Mar 21, 2024 •

edited

Loading

c3024 commented Mar 23, 2024 •

edited

Loading

tienifr Mar 25, 2024 •

edited

Loading