perf: Improve get icons by hurali97 · Pull Request #46886 · Expensify/App

hurali97 · 2024-08-06T13:26:33Z

Details

On the trace provided by Jason, we observed that getIcons consumes ~400ms as a whole. On the heavy accounts that we have with ~15k reports, we were able to reproduce something similar and got around ~108ms.

The fix is to avoid re-calculating default workspace icons if there's no change. This helps in reducing the execution time to ~54ms.

Before:

After:

Fixed Issues

$ #45528
PROPOSAL:

Tests

Steps:

Change the icon of a workspace and verify it is updated correctly

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android-web.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

Screen.Recording.2024-08-07.at.3.27.28.PM.mov

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-08-07T11:16:24Z

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

mkhutornyi · 2024-08-07T18:08:15Z

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

android.mp4

Android: mWeb Chrome

mchrome.mp4

iOS: Native

ios.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

neil-marcellini

Looks good thanks. One NAB which could be done in a follow up, or not at all.

neil-marcellini · 2024-08-13T19:28:33Z

+    const avatarURL = allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${report?.policyID}`]?.avatarURL;
+
+    const isSameAvatarURL = iconFromCache?.icon?.source === avatarURL;
+    const isDefaultWorkspaceAvatar = !avatarURL && typeof iconFromCache?.icon?.source !== 'string';


NAB: It might be more reliable and simple to set a flag in the cached value, e.g. isDefaultWorkspaceAvatar. Maybe in the future there's a case where the source is not a string and it's not a default workspace avatar.

OSBotify · 2024-08-13T20:26:14Z

✋ 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-08-15T18:18:33Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.21-0 🚀

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

OSBotify · 2024-08-19T15:59:37Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.21-4 🚀

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

OSBotify · 2024-08-19T16:24:01Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.21-4 🚀

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

hurali97 added 3 commits August 6, 2024 18:08

perf: remove extra condition

417ac49

perf: add cache for workspace icons

f4faab6

fix: avatar not updating

d0cca3f

hurali97 marked this pull request as ready for review August 7, 2024 11:16

hurali97 requested a review from a team as a code owner August 7, 2024 11:16

melvin-bot Bot requested a review from mkhutornyi August 7, 2024 11:16

melvin-bot Bot removed the request for review from a team August 7, 2024 11:16

mkhutornyi reviewed Aug 7, 2024

View reviewed changes

Comment thread src/libs/ReportUtils.ts

Comment thread src/libs/ReportUtils.ts Outdated

hurali97 added 2 commits August 8, 2024 17:08

fix: use policyID as key

452b237

fix: use correct conditions

ebe0376

mkhutornyi reviewed Aug 8, 2024

View reviewed changes

Comment thread src/libs/ReportUtils.ts Outdated

hurali97 added 2 commits August 9, 2024 14:57

fix: use logical OR operator instead of nullish coalescing

f0bf024

fix: update cache when workspace name changes

1365d10

mkhutornyi approved these changes Aug 13, 2024

View reviewed changes

melvin-bot Bot requested a review from neil-marcellini August 13, 2024 03:06

neil-marcellini approved these changes Aug 13, 2024

View reviewed changes

neil-marcellini merged commit 0fd97c0 into Expensify:main Aug 13, 2024

adhorodyski deleted the hur/perf/improve-get-icons branch August 13, 2024 20:10

github-actions Bot mentioned this pull request Aug 15, 2024

Deploy Checklist: New Expensify 2024-08-15 #47512

Closed

74 tasks

mkhutornyi mentioned this pull request Aug 29, 2024

[HOLD for payment 2024-08-14] [HOLD for payment 2024-08-09] Optimize frontend performance in most recent mode #45528

Closed

bernhardoj mentioned this pull request Aug 31, 2024

[HOLD for Payment 2024-09-24][$250] Invoice - Default workspace avatar is displayed for invoice receiver when it has custom avatar #48358

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

perf: Improve get icons#46886

perf: Improve get icons#46886
neil-marcellini merged 7 commits into
Expensify:mainfrom
callstack-internal:hur/perf/improve-get-icons

hurali97 commented Aug 6, 2024 •

edited

Loading

Uh oh!

melvin-bot Bot commented Aug 7, 2024

Uh oh!

mkhutornyi commented Aug 7, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neil-marcellini left a comment

Uh oh!

neil-marcellini Aug 13, 2024

Uh oh!

OSBotify commented Aug 13, 2024

Uh oh!

OSBotify commented Aug 15, 2024

Uh oh!

OSBotify commented Aug 19, 2024

Uh oh!

OSBotify commented Aug 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

hurali97 commented Aug 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Aug 7, 2024

Uh oh!

mkhutornyi commented Aug 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

neil-marcellini Aug 13, 2024

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Aug 13, 2024

Uh oh!

OSBotify commented Aug 15, 2024

Uh oh!

OSBotify commented Aug 19, 2024

Uh oh!

OSBotify commented Aug 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hurali97 commented Aug 6, 2024 •

edited

Loading

mkhutornyi commented Aug 7, 2024 •

edited

Loading