fix: check if localize should render

[WoLewicki]

Details

Some performance improvements for when opening the personal details of the user in report.

Fixed Issues

$ #22996
PROPOSAL:

Tests

1. Add console.log(“ReportScreen re-render”) (here)
2. Add console.log(“Expensify re-render”) (here)
3. Add console.log(“withLocalize re-render”) (here)
4. Add console.log(“withCurrentUserPersonalDetails re-render”) (here)
5. Navigate to the Personal Details page, as shown on the video and notice the number of re-renders.
6. Log in as another user (User B)
7. As user A, go to a chat with User B and click on their Avatar in top of the chat report to go to the report details page
8. As user B, change your name
9. Verify this got updated correctly in the User details in User A session

Compare it with main.

See that there are no withLocalize and withCurrentUserPersonalDetails rerenders if they are not needed.

• Verify that no errors appear in the JS console

Offline tests

QA Steps

1. Log in as another user (User B)
2. As user A, go to a chat with User B and click on their Avatar in top of the chat report to go to the report details page
3. As user B, change your name
4. Verify this got updated correctly in the User details in User A session

• Verify that no errors appear in the JS console

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 / 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 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 verified the translation was requested/reviewed 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

rerenders.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[melvin-bot]

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

[mananjadhav]

@WoLewicki Is this complete by any chance? I don't see the checklist completed along with the screenshots.

[mountiny]

@WoLewicki can you complete the checklist please? For recordings at least web please

[WoLewicki]

OK should be done.

[mountiny]

Appreciated

[mananjadhav]

@mountiny I didn't understand. Are we testing the number of rerenders only for Web?

[mountiny]

Are we testing the number of rerenders only for Web?

You can also see the console logs in the metro, cant you.

I think however, testing the functionality is not changed should be on all platforms and then the re-renders can be mainly on web

[WoLewicki]

I think the behavior (meaning no excessive rerenders) should be the same on all platforms.

[narefyev91]

@WoLewicki Hey! i think this changes is breaking sending messages

Screen.Recording.2023-09-14.at.10.55.48.mov

[narefyev91]

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 / Chrome
  • iOS / native
  • iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • 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(themeColors.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 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

Web

Without changes:

web-without.mov

With changes:

web-with.mov

Mobile Web - Chrome

Without changes:

android-web-without.mov

With changes:

android-web-with.mov

Mobile Web - Safari

Desktop

Without changes:

desktop-without.mov

With changes:

desktop-with.mov

Change naming:

change-name.mov

iOS

Android

[narefyev91]

For reducing re-renders - i can say that there were done a great job - and i see significant improvement (even with less console.log triggers). Just needs to fix potential issues with current changes

[mountiny]

@narefyev91 so the sending message is the only regression you have found?

[narefyev91]

@narefyev91 so the sending message is the only regression you have found?

The issue with not sending message is global one. Changes are fully breaking some things like - edit message, apply emoji to already existing message, add attachments not working, delete message not working - but if you reload the page - everything will pop-up app. We do not render related pages when any change happened. And if fix will be executed for sending message firstly - it may already unblock all other related items automatically. For now broken any page on which we have composer with interactions - and on which we can send something, like message, change amount of cash and etc

[WoLewicki]

Yeah, I am investigating it and current approach does not make sense after some more consideration. Since WithCurrentUserPersonalDetails is a HOC, there can be many different props passed to the wrapped component, probably often times too many of those to do a deep equality check on them unfortinately. I think we will have to stick only with the changes in withLocalize since we edit the context provider there and it is at the top of the App only, or am I missing something @narefyev91 ?

[narefyev91]

Yeah, I am investigating it and current approach does not make sense after some more consideration. Since WithCurrentUserPersonalDetails is a HOC, there can be many different props passed to the wrapped component, probably often times too many of those to do a deep equality check on them unfortinately. I think we will have to stick only with the changes in withLocalize since we edit the context provider there and it is at the top of the App only, or am I missing something @narefyev91 ?

Yup seems so

[WoLewicki]

Maybe we should consider transforming WithCurrentUserPersonalDetails into a context also? What are the drawback of such solution @mountiny ? Why some component are done in such way and others not?

[narefyev91]

Maybe we should consider transforming WithCurrentUserPersonalDetails into a context also? What are the drawback of such solution @mountiny ? Why some component are done in such way and others not?

I think because we still trying work with both classes and functional components

[WoLewicki]

@narefyev91 did you spot any issues or have in mind something that can break when only changes in withLocalize have been applied? If not, I think I'll go with such a solution in this PR and we can consider some more optimizations as follow ups.

[narefyev91]

@narefyev91 did you spot any issues or have in mind something that can break when only changes in withLocalize have been applied? If not, I think I'll go with such a solution in this PR and we can consider some more optimizations as follow ups.

With localize i did not see any issue

[mountiny]

Lets just do localize for now and I agree that the context consideration might be because of us not having the functional components migration completed. then it might be easier

[WoLewicki]

Ok I merged the newest main and reverted the wrong changes. Could we test it one more time? There is also another optimization to be made that comes from the slack thread with isLoading prop passed to metadata, which I hope will further improve the performance.

[narefyev91]

WEB, Desktop, Mobile web - for now no issues - will test on native platforms now

[narefyev91]

@mountiny not issues found from my side - all broken items now working as expected

[narefyev91]

LGTM!
🎀 👀 🎀 C+ reviewed

[WoLewicki]

As a thing to consider in the future, maybe we could do the API call for personal details wrapped with InteractionManager so it does not mess up the RHP animation, wdyt about it?

[mountiny]

As a thing to consider in the future, maybe we could do the API call for personal details wrapped with InteractionManager so it does not mess up the RHP animation, wdyt about it?

Could you propose this in slack in newdot-performance?

[mountiny]

Thank you very much for getting this over the finish line!

[OSBotify]

✋ 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]

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

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

[kavimuru]

@WoLewicki @mountiny Can you help us with QA steps to be followed?

[WoLewicki]

I think the steps provided in the description should be enough for manual testing

Log in as another user (User B)
As user A, go to a chat with User B and click on their Avatar in top of the chat report to go to the report details page
As user B, change your name
Verify this got updated correctly in the User details in User A session

cc @mountiny since I am not too acknowledged with those flows.

[mountiny]

@kavimuru updated the QA section

[OSBotify]

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.71-12 🚀

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