Improve the performance of report name generation by tgolen · Pull Request #12399 · Expensify/App

tgolen · 2022-11-02T20:08:14Z

This speeds up the report name generation by about 200%. I tested this on an account with 4,000 reports. Before the change, it took 30ms to generate all the report names. After this change, it only takes 10ms.

Fixed Issues

$ #11609

Tests

Have an account with several chats with other users
Some of the users should have first and last names, while others shouldn't
Verify in the LHN that the report names look correct. For people with names, the names should be shown, for people without names, their email/phone should be shown

Verify that no errors appear in the JS console

QA Steps

Same as the tests above

Verify that no errors appear in the JS console

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

### Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

tgolen · 2022-11-02T21:09:57Z

I ran into some really fundamental problems with the optionlistutils, so I am putting this back into draft mode to see if I can figure it out.

tgolen · 2022-11-02T21:40:38Z

OK, I figured it out and this is good to go again.

Beamanator · 2022-11-03T09:13:10Z

Durn conflicts :'(

Beamanator

Overall code looking great, had only a few minor comments that are mainly NAB - will test now

src/libs/ReportUtils.js

Beamanator · 2022-11-03T09:25:47Z

src/libs/OptionsListUtils.js

        }
+        reportName = ReportUtils.getReportName(report, policies);
    } else {
+        reportName = ReportUtils.getDisplayNameForParticipant(logins[0]);


Just wondering, why use logins[0] here instead of personalDetail.login like the following 2 lines?

Beamanator · 2022-11-03T09:26:21Z

src/libs/ReportUtils.js

 }

+/**
+ * Gets the personal details for a login by looking in the allPersonalDetails from Onyx. If it doesn't exist in Onyx, then a default object is constructed.


NAB

Suggested change

* Gets the personal details for a login by looking in the allPersonalDetails from Onyx. If it doesn't exist in Onyx, then a default object is constructed.

* Gets the personal details for a login by looking in the allPersonalDetails Onyx key. If it doesn't exist in Onyx, then a default object is constructed.

I see where you're going with the suggestion, but allPersonalDetails isn't actually an Onyx key. If you want the comment to reference the actual Onyx key, then it should say something like:

by looking in the ONYXKEYS.PERSONAL_DETAILS Onyx key.

The comment is currently referencing the local variable that the data from the Onyx key is stored in, so I think the comment is correct as originally authored.

Ok definitely fair points! I'm still not a huge fan of the way the first sentence is worded, so how about this instead:

Suggested change

* Gets the personal details for a login by looking in the allPersonalDetails from Onyx. If it doesn't exist in Onyx, then a default object is constructed.

* Gets the personal details for a login by looking in the allPersonalDetails data from Onyx. If it doesn't exist in Onyx, then a default object is constructed.

Mainly I don't like the allPersonalDetails bit, am I being too picky? Yes, maybe :D

OK, I've updated this with a bit of a different suggestion and being slightly more verbose.

Beamanator · 2022-11-03T09:31:08Z

src/libs/SidebarUtils.js

+        // Normally, the spread operator would be used here to clone the report and prevent the need to reassign the params.
+        // However, this code needs to be very performant to handle thousands of reports, so in the interest of speed, we're just going to disable this lint rule and add
+        // the reportDisplayName property to the report object directly.
+        // eslint-disable-next-line no-param-reassign


Nifty 👍 I can't think of any downside to this, worst case is reportDisplayName stays on the report object even when it's not needed, but I can't see how that would cause any problems 👍

Here we are 😁 This tricked us that we were using report.reportDisplayName (or report.displayName) across the App thinking it's a natural prop. This backfired once we started passing cloned reports to this function. Cloned reports are due to the use of withOnyx selector #21406

I strongly disagree with allowing mutations into our code, it creates hard to debug bugs and is hard to track the states of objects.

Now there is a second property getting mutated below this one:

App/src/libs/SidebarUtils.js

Lines 112 to 113 in c32fb5a

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

report.iouReportAmount = ReportUtils.getMoneyRequestTotal(report, allReportsDict);

I'm fine with finding a way to remove the mutations as long as the code remains performant.

I'm not totally sure but I think we can leave the mutation now since we are mutating a clone. I don't see much benefit in cloning a clone.

I guess that makes it a bit better because we are only mutating the copy we pass down this tree, right?

App/src/pages/home/sidebar/SidebarLinksData.js

Lines 150 to 159 in fe8aeb8

const reportActionsSelector = (reportActions) =>

reportActions &&

_.map(reportActions, (reportAction) => ({

errors: lodashGet(reportAction, 'errors', []),

message: [

{

moderationDecision: {decision: lodashGet(reportAction, 'message[0].moderationDecision.decision')},

},

],

}));

Still a bad practice in react to mutate props in general, you have to follow up from where the prop is coming to verify that this is not causing more side effects and it is also hard to assure that things are getting rendered when they should down the line.

I'm fine with finding a way to remove the mutations as long as the code remains performant.

That is fair, do you know how to reproduce the performance issues?

The best way to ensure it doesn't regress on performance is to add some timers around this code, and then time it before/after making the change.

Beamanator · 2022-11-03T09:33:21Z

Actually will probably wait to test till conflicts are resolved, so I don't have to retest :D

tgolen

Updated with conflicts resolved!

tgolen · 2022-11-03T13:47:30Z

src/libs/ReportUtils.js

 }

+/**
+ * Gets the personal details for a login by looking in the allPersonalDetails from Onyx. If it doesn't exist in Onyx, then a default object is constructed.


I see where you're going with the suggestion, but allPersonalDetails isn't actually an Onyx key. If you want the comment to reference the actual Onyx key, then it should say something like:

by looking in the ONYXKEYS.PERSONAL_DETAILS Onyx key.

The comment is currently referencing the local variable that the data from the Onyx key is stored in, so I think the comment is correct as originally authored.

src/libs/ReportUtils.js

eVoloshchak · 2022-11-03T13:51:26Z

Oops, just noticed this PR
I don't have the bandwidth right now, could you unassign me please?

Beamanator · 2022-11-03T15:33:46Z

Shucksadoodle, I'm not able to test this on all platforms today, but most likely will be able to tomorrow 🙏 (Tested on web and so far that looks perfecto)

Beamanator · 2022-11-04T09:05:30Z

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

### Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Beamanator

melvin-bot · 2022-11-04T09:07:07Z

@Beamanator looks like this was merged without the checklist test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

Beamanator · 2022-11-04T09:08:36Z

99.9% sure I saw the green checkmark indicating all tests were passing 🙃

OSBotify · 2022-11-04T09:14:35Z

✋ 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 · 2022-11-04T17:51:56Z

🚀 Deployed to staging by @Beamanator in version: 1.2.24-0 🚀

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

OSBotify · 2022-11-08T19:38:04Z

🚀 Deployed to production by @yuwenmemon in version: 1.2.24-4 🚀

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

OSBotify · 2022-11-08T21:07:37Z

🚀 Deployed to production by @yuwenmemon in version: 1.2.24-4 🚀

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

OSBotify · 2022-11-08T21:37:57Z

🚀 Deployed to production by @yuwenmemon in version: 1.2.24-4 🚀

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

marcaaron · 2022-11-17T21:57:45Z

This PR has been linked to a regression reported here: #12487

The fix was kind of simple and the mistake we made was that we changed a method signature and didn't update a usage.

One thing we can learn from this is to be hyper vigilant about method signature changes and always double check that any usages of a function are updated.

We also would have caught this automatically if we used some kind of type checking like TypeScript.

Beamanator · 2022-11-21T17:19:31Z

Good catch @marcaaron , definitely good idea to be hyper vigilant about method signature changes, even when reviewing 👍

tgolen added 7 commits November 2, 2022 13:21

Optimize getting the personal details for a report name

560f2f6

Update method signature of getting the report name

363ece2

Update method signature inside of unit tests

c2247a1

Make sure multi-participant reports don't count current user

8b96341

Remove debug timing

722a71e

Remove unnecessary method argument

6e927c9

Handle participant details when details don't exist

4b0bcb2

tgolen requested a review from a team as a code owner November 2, 2022 20:08

tgolen self-assigned this Nov 2, 2022

melvin-bot bot requested review from Beamanator and eVoloshchak and removed request for a team November 2, 2022 20:08

tgolen marked this pull request as draft November 2, 2022 21:09

tgolen added 3 commits November 2, 2022 15:17

Handle search options for personal details

39e5787

Make sure the tests are all passing

83f248f

Fix lint problems

22a84bb

tgolen marked this pull request as ready for review November 2, 2022 21:40

Beamanator previously approved these changes Nov 3, 2022

View reviewed changes

Merge branch 'main' into tgolen-performant-report-name-generation

acb64f8

tgolen dismissed Beamanator’s stale review via acb64f8 November 3, 2022 13:44

tgolen commented Nov 3, 2022

View reviewed changes

tgolen removed the request for review from eVoloshchak November 3, 2022 13:54

Remove duplicate export

4207f10

Update comment to be a little more verbose.

172eaf7

Beamanator approved these changes Nov 4, 2022

View reviewed changes

Beamanator merged commit e434efa into main Nov 4, 2022

Beamanator deleted the tgolen-performant-report-name-generation branch November 4, 2022 09:07

melvin-bot bot added the Emergency label Nov 4, 2022

Beamanator removed the Emergency label Nov 4, 2022

youssef-lr mentioned this pull request Nov 4, 2022

Correctly display first name for IOU requests #12184

Merged

92 tasks

OSBotify mentioned this pull request Nov 4, 2022

Deploy Checklist: New Expensify 2022-11-04 #12476

Closed

20 tasks

0xmiroslav mentioned this pull request Nov 5, 2022

[HOLD for payment 2022-11-16] [$250] Chat - App is crashed after click on expensifail account which is closed #12487

Closed

aimane-chnaif mentioned this pull request Nov 7, 2022

[$250] Feature request - Show content when open deep link from other user profile which is not in contacts list reported by @aimane-chnaif #11922

Closed

0xmiroslav mentioned this pull request Nov 7, 2022

fix crash on profile detail #12533

Merged

92 tasks

parasharrajat mentioned this pull request Apr 7, 2023

[HOLD for payment 2023-04-14] [$1000] Chat - Name of phone member in group member's list is not displayed #16499

Closed

6 tasks

s77rt mentioned this pull request Aug 4, 2023

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

Closed

6 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

	* Gets the personal details for a login by looking in the allPersonalDetails from Onyx. If it doesn't exist in Onyx, then a default object is constructed.
	* Gets the personal details for a login by looking in the allPersonalDetails Onyx key. If it doesn't exist in Onyx, then a default object is constructed.

	// eslint-disable-next-line no-param-reassign
	report.iouReportAmount = ReportUtils.getMoneyRequestTotal(report, allReportsDict);

	const reportActionsSelector = (reportActions) =>
	reportActions &&
	_.map(reportActions, (reportAction) => ({
	errors: lodashGet(reportAction, 'errors', []),
	message: [
	{
	moderationDecision: {decision: lodashGet(reportAction, 'message[0].moderationDecision.decision')},
	},
	],
	}));

Conversation

tgolen commented Nov 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fixed Issues

Tests

QA Steps

PR Author Checklist

PR Reviewer Checklist

Uh oh!

tgolen commented Nov 2, 2022

Uh oh!

tgolen commented Nov 2, 2022

Uh oh!

Beamanator commented Nov 3, 2022

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

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!

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!

Beamanator commented Nov 3, 2022

Uh oh!

tgolen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eVoloshchak commented Nov 3, 2022

Uh oh!

Beamanator commented Nov 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Beamanator commented Nov 4, 2022

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Nov 4, 2022

Uh oh!

Beamanator commented Nov 4, 2022

Uh oh!

OSBotify commented Nov 4, 2022

Uh oh!

OSBotify commented Nov 4, 2022

Uh oh!

OSBotify commented Nov 8, 2022

Uh oh!

OSBotify commented Nov 8, 2022

Uh oh!

OSBotify commented Nov 8, 2022

Uh oh!

marcaaron commented Nov 17, 2022

Uh oh!

Beamanator commented Nov 21, 2022

tgolen commented Nov 2, 2022 •

edited

Loading

Beamanator commented Nov 3, 2022 •

edited

Loading