[Fix #21022] Improve performance by reducing re-renders SidebarLinks #21406

hannojg · 2023-06-23T13:56:10Z

Details

Improve the performance by reducing unnecessary re-renders of the SidebarLinks component.

Fixed Issues

$ #21022
PROPOSAL: #21022 (comment)

Tests

Verify that no errors appear in the JS console
Open a report, verify that the highlight of the items still work
Send a message from user A to user B and verify that the reports are resorting accordingly

Offline tests

n/a

QA Steps

Verify that no errors appear in the JS console
Open a report, verify that the highlight of the items still work
Send a message from user A to user B and verify that the reports are resorting accordingly

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
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

There isn't any case where the current active report wouldn't be in the list of reports

melvin-bot · 2023-06-23T13:56:15Z

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

fedirjh · 2023-06-23T14:20:34Z

cc @0xmiroslav It should have been assigned to you.

0xmiros · 2023-06-23T14:24:00Z

Sure, thanks for the reminder @fedirjh
@hannojg can you make sure that issue linked correctly?

This is common mistake which breaks github automation:

Bad:

$ #21022

Good:

$ https://github.com/Expensify/App/issues/21022

src/components/LHNOptionsList/OptionRowLHN.js

src/libs/SidebarUtils.js

src/pages/home/sidebar/SidebarLinks.js

0xmiros · 2023-06-23T14:36:31Z

Please also update unit tests

hannojg · 2023-06-26T08:37:15Z

How about css optimization?

Sorry, what do you mean by that @venture1981

hannojg · 2023-06-26T08:38:02Z

@0xmiroslav I think I did it correctly, no?

Also thx for the review, I wasn't pushing the latest changes 😅 now everything looks correct to me

…f/21022-sidebarlinks-performance

src/libs/ReportUtils.js

mountiny · 2023-07-06T03:07:00Z

@hannojg could we get back to this one soon? thanks 🙇

…f/21022-sidebarlinks-performance

mountiny · 2023-07-07T16:45:51Z

@hannojg is this ready for review?

hannojg · 2023-07-07T17:02:46Z

No not yet, sorry, the tests are still failing. Working on it right now

hannojg · 2023-07-19T17:45:56Z

@mountiny is it possible that something broke during merge?

@0xmiroslav are you on the latest version of the perf branch?

0xmiros · 2023-07-19T17:55:39Z

Above video is from

latest main which merged this branch

vs

https://github.com/0xmiroslav/Expensify/tree/revert-21406-perf/21022-sidebarlinks-performance which reverts this branch

OSBotify · 2023-07-19T17:59:47Z

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

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

mountiny · 2023-07-19T18:04:03Z

@hannojg it is possible

jasperhuangg · 2023-07-19T21:41:51Z

This PR has caused a regression:

#23189

@hannojg @fedirjh Lets be on a look out for deploy blockers tomorrow or after the next deploy. I know you have tested well but with such PRs its always tricky and high chance of something breaking would be great to have you around to follow up with a fix as reverting would be messy

@hannojg @fedirjh are you around to help fix this deploy blocker?

aldo-expensify · 2023-07-19T22:06:47Z

src/libs/ReportActionsUtils.js

 * @returns {Object}
 */
-function getParentReportAction(report) {
+function getParentReportAction(report, allReportActionsParam = {}) {


This default is causing the deploy blocker here: #23202

If allReportActionsParam is not passed, it has value {} which is truthy, so we never use allReportActions. The allReportActionsParam || allReportActions doesn't work as intended.

thanks you for quickly fixing this!!

Thanks for the fix

OSBotify · 2023-07-20T18:20:48Z

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

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

OSBotify · 2023-07-21T18:51:45Z

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

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

OSBotify · 2023-07-22T00:18:56Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.43-7 🚀

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

OSBotify · 2023-07-25T01:25:42Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.44-2 🚀

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

s77rt · 2023-08-04T17:54:44Z

src/pages/home/sidebar/SidebarLinksData.js

+    withOnyx({
+        chatReports: {
+            key: ONYXKEYS.COLLECTION.REPORT,
+            selector: chatReportSelector,


This caused a "regression"? Without the use of the selector we used to pass the reports objects as is in Onyx. Then we mutated those objects here

App/src/libs/SidebarUtils.js

Lines 109 to 110 in bba0eb2

// eslint-disable-next-line no-param-reassign

report.displayName = ReportUtils.getReportName(report);

by adding a displayName to each report. If you try to access report.displayName from anywhere in the App you'd be able to (because we modified the onyx data).

Now, we are using a selector and we are returning a copy of Onyx data, we are mutating a clone and not the onyx data. If we try to access report.displayName from anywhere outside the Sidebar we won't get a result which in turn caused this issue #23348.

Wow great catch! But at the same time I have to say that how it was working before is very dirty and we should find a different solution for it 😅

I see that the proposal proposes a clean way, good job 💪

Santhosh-Sellavel · 2023-09-18T16:46:28Z

This PR Causes this regression more details here

marcaaron · 2023-11-02T21:17:09Z

tests/unit/SidebarFilterTest.js

@@ -253,6 +258,7 @@ describe('Sidebar', () => {
            );
        });

+        // NOTE: This is also for #focus mode, should we move this test block?


I am not sure what the original intention here was. Maybe @tgolen can remember. This comment stuck out to me as pretty confusing and something we should fix.

context: Working on a PR and encountered a failing test with this title:

Sidebar › in default (most recent) mode › all combinations of isArchived, isUserCreatedPolicyRoom, hasAddWorkspaceError, isUnread, isPinned, hasDraft › the booleans true,false,false,true,false,false

But when I look at the lines of code it's referencing I see that we are not testing "most recent" but "focus" mode.

This test also confuses me if the intention is that we should be testing "Most recent" mode.

If we are trying to see that a report is in the "Most recent" list then most all reports will be in the list.

Or at least doesn't seem dependent on the arguments we are passing.

isArchived, isUserCreatedPolicyRoom, hasAddWorkspaceError, isUnread, isPinned, hasDraft

All of those will would show in "Most recent" (all other things about the report being "normal")

Ok after reviewing the two blocks - I have determined they are identical and we should be able to remove this...

I don't think this was intended to be put here and it's not logical to test.

hannojg added 5 commits June 23, 2023 11:52

Connect OptionRowLHN manually

82974c6

don't rerender SidebarLinks just because modal opens

eada423

Remove currentReportId from shouldReportBeInOptionList

c31f7de

There isn't any case where the current active report wouldn't be in the list of reports

add active report functionality back

32c2b70

optimize optionRowLHN to not depend on current report id

6a38ee8

hannojg requested a review from a team as a code owner June 23, 2023 13:56

melvin-bot bot removed the request for review from a team June 23, 2023 13:56

melvin-bot bot requested a review from fedirjh June 23, 2023 13:56

0xmiros reviewed Jun 23, 2023

View reviewed changes

src/components/LHNOptionsList/OptionRowLHN.js Outdated Show resolved Hide resolved

src/libs/SidebarUtils.js Outdated Show resolved Hide resolved

src/pages/home/sidebar/SidebarLinks.js Show resolved Hide resolved

src/pages/home/sidebar/SidebarLinks.js Show resolved Hide resolved

fix

a651118

This was referenced Jun 26, 2023

SidebarLinks unnecessary re-renders #21022

Closed

[HOLD for payment 2023-10-13] [$250] Migrate SidebarLinks.js to function component #16271

Closed

Merge branch 'main' of github.com:margelo/expensify-app-fork into per…

c8ea565

…f/21022-sidebarlinks-performance

mountiny assigned hannojg Jul 4, 2023

mountiny self-requested a review July 4, 2023 13:41

WoLewicki reviewed Jul 5, 2023

View reviewed changes

src/libs/ReportUtils.js Outdated Show resolved Hide resolved

hannojg added 5 commits July 6, 2023 14:41

Merge branch 'main' of github.com:margelo/expensify-app-fork into per…

99c8a1d

…f/21022-sidebarlinks-performance

fix issues after merge

27f8eb0

fix import issues

f3a39b6

change back name

99d2d40

remove currentReportId from params

4bb3a19

OSBotify mentioned this pull request Jul 19, 2023

Deploy Checklist: New Expensify 2023-07-19 #23183

Closed

42 tasks

s-alves10 mentioned this pull request Jul 19, 2023

[HOLD for payment 2023-08-01] [HOLD for payment 2023-07-28] Web - Workspace avatar is not updating after renaming #23189

Closed

6 tasks

mountiny mentioned this pull request Jul 19, 2023

[HOLD for payment 2023-08-01] [HOLD for payment 2023-07-28] Room - Deleted message and broken avatar displayed in header for threaded reply in public room #23195

Closed

6 tasks

jasperhuangg mentioned this pull request Jul 19, 2023

[HOLD for payment 2023-08-01] [HOLD for payment 2023-07-28] IOU - IOU details are broken #23202

Closed

6 tasks

aldo-expensify reviewed Jul 19, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny July 20, 2023 09:40

kbecciv mentioned this pull request Jul 21, 2023

[HOLD for payment 2023-08-10] [$1000] Web - Workspace name is empty in request money page #23348

Closed

6 tasks

OSBotify mentioned this pull request Jul 21, 2023

Deploy Checklist: New Expensify 2023-07-21 #23362

Closed

trjExpensify mentioned this pull request Jul 26, 2023

Display both names for IOU Report Previews #23043

Merged

58 tasks

tienifr mentioned this pull request Jul 26, 2023

[HOLD for c+ newdot payment][$1000] Compose box loses focus when reclicking same chat in LHN #23676

Closed

6 tasks

s77rt mentioned this pull request Aug 4, 2023

Improve the performance of report name generation #12399

Merged

92 tasks

s77rt reviewed Aug 4, 2023

View reviewed changes

tienifr mentioned this pull request Aug 14, 2023

Fix: Composer does not refocus when click the same chat #24360

Merged

57 tasks

fedirjh mentioned this pull request Sep 4, 2023

[$1000] Web - Reply in thread on messages in 'owes' or 'paid' money reports does not have 'From' link in header #23492

Closed

6 tasks

s77rt mentioned this pull request Oct 4, 2023

Show Room name in Desktop notification title if message is come from a chat room #19053

Merged

57 tasks

marcaaron reviewed Nov 2, 2023

View reviewed changes

bernhardoj mentioned this pull request Nov 3, 2023

[HOLD for payment 2023-12-18] [$500] ReportUtils.shouldReportBeInOptionList will always be falsy for specific reports #30842

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fix #21022] Improve performance by reducing re-renders SidebarLinks #21406

[Fix #21022] Improve performance by reducing re-renders SidebarLinks #21406

hannojg commented Jun 23, 2023 •

edited

Loading

melvin-bot bot commented Jun 23, 2023

fedirjh commented Jun 23, 2023

0xmiros commented Jun 23, 2023

0xmiros commented Jun 23, 2023 •

edited

Loading

hannojg commented Jun 26, 2023

hannojg commented Jun 26, 2023

mountiny commented Jul 6, 2023

mountiny commented Jul 7, 2023

hannojg commented Jul 7, 2023

hannojg commented Jul 19, 2023

0xmiros commented Jul 19, 2023

OSBotify commented Jul 19, 2023

mountiny commented Jul 19, 2023

jasperhuangg commented Jul 19, 2023 •

edited

Loading

aldo-expensify Jul 19, 2023

hannojg Jul 20, 2023

mountiny Jul 20, 2023

OSBotify commented Jul 20, 2023

OSBotify commented Jul 21, 2023

OSBotify commented Jul 22, 2023

OSBotify commented Jul 25, 2023

s77rt Aug 4, 2023

hannojg Aug 7, 2023

hannojg Aug 7, 2023

Santhosh-Sellavel commented Sep 18, 2023

marcaaron Nov 2, 2023

marcaaron Nov 2, 2023

marcaaron Nov 2, 2023

	// eslint-disable-next-line no-param-reassign
	report.displayName = ReportUtils.getReportName(report);

[Fix #21022] Improve performance by reducing re-renders SidebarLinks #21406

[Fix #21022] Improve performance by reducing re-renders SidebarLinks #21406

Conversation

hannojg commented Jun 23, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 23, 2023

fedirjh commented Jun 23, 2023

0xmiros commented Jun 23, 2023

0xmiros commented Jun 23, 2023 • edited Loading

hannojg commented Jun 26, 2023

hannojg commented Jun 26, 2023

mountiny commented Jul 6, 2023

mountiny commented Jul 7, 2023

hannojg commented Jul 7, 2023

hannojg commented Jul 19, 2023

0xmiros commented Jul 19, 2023

OSBotify commented Jul 19, 2023

mountiny commented Jul 19, 2023

jasperhuangg commented Jul 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Jul 20, 2023

OSBotify commented Jul 21, 2023

OSBotify commented Jul 22, 2023

OSBotify commented Jul 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Santhosh-Sellavel commented Sep 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hannojg commented Jun 23, 2023 •

edited

Loading

0xmiros commented Jun 23, 2023 •

edited

Loading

jasperhuangg commented Jul 19, 2023 •

edited

Loading