Improve performance of optionslist #13398

tgolen · 2022-12-07T16:20:18Z

Held on Cleanup props and callbacks for OptionsList #13319 because I based this branch off that PR so I was working with the latest changes

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/228943

Tests

Click the magnifying glass to search for reports
Verify you can search for a report and go to it
Verify that searching feels pretty quick and definitely not any slower than it was before

Verify that no errors appear in the JS console

Offline tests

Same as the above. The only difference you will see is that avatars probably won't be displayed, which is fine.

QA Steps

Same as the above

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2022-12-07T20:56:57Z

@mollfpr @deetergp One of you needs to 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]

deetergp · 2022-12-08T00:02:31Z

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:
- 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

![android - chrome](https://user-images.githubusercontent.com/766197/206327218-80d5e97e-bb53-4826-85c4-678ae8c42a81.png)

Mobile Web - Safari

![ios - safari](https://user-images.githubusercontent.com/766197/206327236-f5217707-49ca-429f-b32c-f63a8620889f.png)

Desktop

iOS

Android

deetergp

Changes look good to me. Aside from my one, nit-picky NAB, the linter is complaining about some unused imports

deetergp · 2022-12-08T01:13:55Z

src/libs/ReportUtils.js

        CONST.REPORT.CHAT_TYPE.POLICY_ADMINS,
        CONST.REPORT.CHAT_TYPE.POLICY_ANNOUNCE,
        CONST.REPORT.CHAT_TYPE.DOMAIN_ALL,
-    ], lodashGet(report, ['chatType'], ''));
+    ].indexOf(report ? report.chatType : '') > -1;


NAB: You could probably DRY this up a bit between here and 187.

mollfpr · 2022-12-08T02:45:35Z

Test well 👍

Just need to fix the lint.

Screenshots/Videos

Web

13398.Web.mov

13398.Web.Offline.mov

Mobile Web - Chrome

13398.mWeb-Chrome.mov

Mobile Web - Safari

13398.mWeb-Safari.mov

Desktop

13398.Desktop.mov

13398.Desktop.Offline.mov

iOS

13398.iOS.mov

13398.iOS.Offline.mov

Android

13398.Android.mov

13398.Android.Offline.mov

…nslist' into tgolen-analyze-performance-optionslist

tgolen · 2022-12-08T17:02:46Z

OK, this is updated to DRY up checking the report chatType and it also fixed a console warning that I caused. Please be sure to re-run all tests.

mollfpr

LGTM and tests well! 👍

Web ✅
mWeb/Safari ✅
mWeb/Chrome ✅
Desktop ✅
iOS ✅
Android ✅

OSBotify · 2022-12-08T21:28:56Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

mollfpr · 2022-12-09T02:18:12Z

@deetergp Could you tag the BZ who assigned the final payment? Thanks!

deetergp · 2022-12-09T17:12:14Z

@mollfpr I'm not sure I understand… @tgolen is one of our internal engineers and looking at the assignment history of the linked GH, it looks like it was always internal.

mollfpr · 2022-12-10T00:30:27Z

@deetergp I just following the C+ External process 😅

https://expensify.slack.com/archives/C02NK2DQWUX/p1667333777293729?thread_ts=1665685158.152769&channel=C02NK2DQWUX&message_ts=1667333777.293729

deetergp · 2022-12-12T18:57:35Z

I just following the C+ External process

Ah, I understand now, thanks!

OSBotify · 2022-12-13T22:38:02Z

🚀 Deployed to production by @chiragsalian in version: 1.2.38-6 🚀

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

aldo-expensify · 2022-12-15T23:29:19Z

src/components/OptionRow.js

-    const displayNameStyle = StyleUtils.combineStyles(props.mode === CONST.OPTION_MODE.COMPACT
-        ? [styles.optionDisplayName, ...textUnreadStyle, styles.optionDisplayNameCompact, styles.mr2]
-        : [styles.optionDisplayName, ...textUnreadStyle], props.style);
-    const alternateTextStyle = StyleUtils.combineStyles(props.mode === CONST.OPTION_MODE.COMPACT
-        ? [textStyle, styles.optionAlternateText, styles.textLabelSupporting, styles.optionAlternateTextCompact]
-        : [textStyle, styles.optionAlternateText, styles.textLabelSupporting], props.style);
-    const contentContainerStyles = props.mode === CONST.OPTION_MODE.COMPACT
-        ? [styles.flex1, styles.flexRow, styles.overflowHidden, styles.alignItemsCenter]
-        : [styles.flex1];
-    const sidebarInnerRowStyle = StyleSheet.flatten(props.mode === CONST.OPTION_MODE.COMPACT ? [
-        styles.chatLinkRowPressable,
-        styles.flexGrow1,
-        styles.optionItemAvatarNameWrapper,
-        styles.optionRowCompact,
-        styles.justifyContentCenter,
-    ] : [
+    const displayNameStyle = [styles.optionDisplayName, ...textUnreadStyle, props.style];
+    const alternateTextStyle = [textStyle, styles.optionAlternateText, styles.textLabelSupporting, props.style];
+    const contentContainerStyles = [styles.flex1];


The removal of StyleUtils.combineStyles caused this #13508

(following BugZero Checklist)

tgolen added 4 commits December 7, 2022 07:45

Remove mode prop that was always set to "default"

5bd5b2e

Remove options that are no longer used

903c879

Micro-optimize function with native sorting and for loops

774b614

Micro-optimize

fd11e18

tgolen self-assigned this Dec 7, 2022

tgolen changed the base branch from main to tgolen-optimize-optionlist December 7, 2022 16:20

tgolen changed the title ~~Tgolen analyze performance optionslist~~ Improve performance of optionslist Dec 7, 2022

tgolen changed the base branch from tgolen-optimize-optionlist to main December 7, 2022 19:08

tgolen changed the title ~~Improve performance of optionslist~~ [HOLD] Improve performance of optionslist Dec 7, 2022

tgolen changed the title ~~[HOLD] Improve performance of optionslist~~ [HOLD App/13319] Improve performance of optionslist Dec 7, 2022

tgolen changed the title ~~[HOLD App/13319] Improve performance of optionslist~~ Improve performance of optionslist Dec 7, 2022

Merge branch 'main' into tgolen-analyze-performance-optionslist

3447198

tgolen marked this pull request as ready for review December 7, 2022 20:56

tgolen requested a review from a team as a code owner December 7, 2022 20:56

melvin-bot bot requested review from deetergp and mollfpr and removed request for a team December 7, 2022 20:56

deetergp previously approved these changes Dec 8, 2022

View reviewed changes

mollfpr previously approved these changes Dec 8, 2022

View reviewed changes

DRY up checking the report chatType and fix a console error

3843798

tgolen dismissed stale reviews from mollfpr and deetergp via 3843798 December 8, 2022 17:00

tgolen added 4 commits December 8, 2022 10:01

DRY up checking the report chatType and fix a console error

c9d0981

Merge remote-tracking branch 'origin/tgolen-analyze-performance-optio…

64a7025

…nslist' into tgolen-analyze-performance-optionslist

Merge remote-tracking branch 'origin/tgolen-analyze-performance-optio…

76e388a

…nslist' into tgolen-analyze-performance-optionslist

Merge remote-tracking branch 'origin/tgolen-analyze-performance-optio…

ffac99e

…nslist' into tgolen-analyze-performance-optionslist

mollfpr approved these changes Dec 8, 2022

View reviewed changes

deetergp approved these changes Dec 8, 2022

View reviewed changes

deetergp merged commit 90e4936 into main Dec 8, 2022

deetergp deleted the tgolen-analyze-performance-optionslist branch December 8, 2022 21:24

francoisl mentioned this pull request Dec 10, 2022

Deploy Checklist: New Expensify 2022-12-09 #13498

Closed

32 tasks

aldo-expensify reviewed Dec 15, 2022

View reviewed changes

luacmartins mentioned this pull request Jan 5, 2023

[HOLD for payment 2023-01-20] Cannot read property 'length' of undefined in ReportUtils getIcon #14019

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve performance of optionslist #13398

Improve performance of optionslist #13398

tgolen commented Dec 7, 2022 •

edited

Loading

melvin-bot bot commented Dec 7, 2022

deetergp commented Dec 8, 2022 •

edited

Loading

deetergp left a comment

deetergp Dec 8, 2022

mollfpr commented Dec 8, 2022

tgolen commented Dec 8, 2022

mollfpr left a comment

OSBotify commented Dec 8, 2022

mollfpr commented Dec 9, 2022

deetergp commented Dec 9, 2022

mollfpr commented Dec 10, 2022

deetergp commented Dec 12, 2022

OSBotify commented Dec 13, 2022

aldo-expensify Dec 15, 2022

Improve performance of optionslist #13398

Improve performance of optionslist #13398

Conversation

tgolen commented Dec 7, 2022 • edited Loading

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 7, 2022

deetergp commented Dec 8, 2022 • edited Loading

Reviewer Checklist

Screenshots/Videos

deetergp left a comment

Choose a reason for hiding this comment

deetergp Dec 8, 2022

Choose a reason for hiding this comment

mollfpr commented Dec 8, 2022

Screenshots/Videos

tgolen commented Dec 8, 2022

mollfpr left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 8, 2022

mollfpr commented Dec 9, 2022

deetergp commented Dec 9, 2022

mollfpr commented Dec 10, 2022

deetergp commented Dec 12, 2022

OSBotify commented Dec 13, 2022

aldo-expensify Dec 15, 2022

Choose a reason for hiding this comment

tgolen commented Dec 7, 2022 •

edited

Loading

deetergp commented Dec 8, 2022 •

edited

Loading