[perf] Migrate LHNOptionList to FlashList by TMisiukiewicz · Pull Request #31711 · Expensify/App

TMisiukiewicz · 2023-11-22T14:55:27Z

Details

Migrating LHNOptionList to FlashList one more time, as previous PR #31052 introduced a regression discoverable only on devices. PR was reverted in #31642

Fixed Issues

$ #30910
$ #31610
$ #31581
PROPOSAL:

Tests

Log in into the account (possibly with a lot of chats)
Scroll the LHN list
Verify scrolling goes smoothly
Go offline
Make sure list is still visible and message about being offline is displayed on the bottom of the screen

Verify that no errors appear in the JS console

Offline tests

QA Steps

Log in into the account (possibly with a lot of chats)
Scroll the LHN list
Verify scrolling goes smoothly
Go offline
Make sure list is still visible and message about being offline is displayed on the bottom of the screen

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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
  - 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

Android: Native

ANDROID.mov

Android: mWeb Chrome

ANDROID_WEB.mov

iOS: Native

IOS.mp4

iOS: mWeb Safari

IOS_WEB.mp4

MacOS: Chrome / Safari

WEB.mov

MacOS: Desktop

DESKTOP.mov

melvin-bot · 2023-11-22T14:55:33Z

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

TMisiukiewicz · 2023-11-22T14:58:18Z

@Julesssss I'm opening a new PR after yesterdays revert. Could you please build ad-hoc and verify if the issue with skeleton doesn't exist anymore?
cc @situchan

situchan · 2023-11-22T15:01:48Z

I am interested in reviewing this if @getusha isn't able to install newDot dev on physical iPhone which is mandatory to test this PR.

situchan · 2023-11-22T15:08:49Z

+                    shouldDisableFocusOptions={isSmallScreenWidth}
+                    optionMode={viewMode}
+                />
+                {isLoading && optionListItems.length === 0 && (


I see that optionListItems.length === 0 && is fixing skeleton issue.
But were you able to find the root cause why this didn't happen on simulator? More importantly, not happened on other platforms? And more strange thing is that no issue on FlatList.

I really tried to find the root cause but i wasn't able to do it. I think the reason behind it might be the fact that when you turn off the internet connection on MacOS, the simulator still indicates that the network connection on the device is on (even if the message says you are offline). However that's just my guess, not having this issuse on other platforms is even stranger.
My general understanding of this problem is: when isLoading was true and optionListItems was empty, the FlatList had 0px height and view was filled with skeleton. So when items were already there, and FlatList had a proper height, the Skeleton component was still rendered, but the list already covered 100% of the screen. After migrating to FlashList, the component couldn't have 0px height at any phase of rendering because its using recycling, which has an alghoritm that works only with a valid size (>=2px). With that in mind, the skeleton was displayed on top of the list, using absolute positioning. So each time isLoading was true, it was displayed on top of the list.

I went through this problem together with @TMisiukiewicz and the reasoning makes sense to me. Flatlist behaved differently and 0px resulted with a 'ok UI state', whereas Flashlist just uncovered it as a bug.

TMisiukiewicz · 2023-11-22T15:39:25Z

I think we are safe to ignore the failing Reassure performance tests, as FlashList doesn't render items in the first render cycle. Already described it and we agreed on that in the previous PR

Julesssss · 2023-11-22T15:59:53Z

AdHoc build in progress

OSBotify · 2023-11-22T16:22:52Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/31711/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/31711/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/31711/NewExpensify.dmg	https://31711.pr-testing.expensify.com

getusha · 2023-11-22T17:58:19Z

I am interested in reviewing this if @getusha isn't able to install newDot dev on physical iPhone which is mandatory to test this PR.

Yeah, that sounds good to me, i don't have physical iOS device ATM so go ahead.

situchan · 2023-11-22T17:59:44Z

Thanks. reviewing now

situchan · 2023-11-22T18:55:18Z

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 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 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 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.MP4

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

situchan

Looks good, tests well

luacmartins · 2023-11-22T19:13:30Z

Reassure test failed. I'm retrying it

situchan · 2023-11-22T19:18:04Z

Reassure test failed. I'm retrying it

@luacmartins it's expected

adhorodyski · 2023-11-22T19:22:05Z

@luacmartins FYI this is to establish a new baseline for the render count on main due to how flashlist works at the initial renders.

luacmartins · 2023-11-22T19:24:27Z

Ah thanks for clarifying! Gonna merge with failing tests then.

melvin-bot · 2023-11-22T19:24:39Z

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

OSBotify · 2023-11-22T19:28:16Z

✋ 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 · 2023-11-23T17:11:42Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.3-0 🚀

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

OSBotify · 2023-11-23T17:51:52Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.3-0 🚀

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

OSBotify · 2023-11-27T19:05:48Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.3-11 🚀

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

s77rt · 2024-08-05T00:20:27Z

-                maxToRenderPerBatch={5}
-                windowSize={5}
+                estimatedItemSize={optionMode === CONST.OPTION_MODE.COMPACT ? variables.optionRowHeightCompact : variables.optionRowHeight}
+                extraData={[currentReportID]}


This is missing other data, e.g. preferredLocale which caused the list not to re-render on language change

TMisiukiewicz added 10 commits November 22, 2023 15:33

migrate LHNOptionsList to FlashList

3a69621

migrate LHNOptionsList to FlashList

b52995e

add currentReportID to extraData

c94289a

render list under the skeleton

3904226

use stylePropTypes

a5f09fe

update keyExtractor

6a393f2

fix reassure tests

da1626c

hide vertical scroll indicator

963b4f1

prevent displaying skeleton when list items are ready

48cddca

fix bg color in skeleton

e18243f

TMisiukiewicz requested a review from a team as a code owner November 22, 2023 14:55

melvin-bot Bot requested review from getusha and removed request for a team November 22, 2023 14:55

adhorodyski approved these changes Nov 22, 2023

View reviewed changes

situchan reviewed Nov 22, 2023

View reviewed changes

Julesssss assigned TMisiukiewicz Nov 22, 2023

Julesssss added the Ready To Build label Nov 22, 2023

situchan approved these changes Nov 22, 2023

View reviewed changes

melvin-bot Bot requested a review from luacmartins November 22, 2023 18:57

luacmartins approved these changes Nov 22, 2023

View reviewed changes

luacmartins merged commit 881b511 into Expensify:main Nov 22, 2023

melvin-bot Bot added the Emergency label Nov 22, 2023

github-actions Bot mentioned this pull request Nov 23, 2023

Deploy Checklist: New Expensify 2023-11-23 #31786

Closed

60 tasks

luacmartins mentioned this pull request Nov 23, 2023

[HOLD for payment 2023-12-06] [$500] Web - Login - App crashes when login to HT account #31803

Closed

6 tasks

getusha mentioned this pull request Nov 24, 2023

[HOLD for payment 2023-12-04] [HOLD for payment 2023-11-30] [$500] iOS - LHN - Skeleton appears instead of LHN if user go offline #31610

Closed

6 tasks

This was referenced Nov 27, 2023

[HOLD for payment 2023-12-04] [CRITICAL] Migrate the LHNOptionsList to Flashlist #30910

Closed

[HOLD for payment 2023-12-04] Login - Background color of chat list is different from the header in LHN when it is loading #31581

Closed

s77rt reviewed Aug 5, 2024

View reviewed changes

s77rt mentioned this pull request Aug 5, 2024

[PAID] [$250] LHN - Large part of the LHN isn't translated to Spanish if setting changed on a secondary device #45608

Closed

6 tasks

luacmartins removed the Emergency label Aug 5, 2024

Uh oh!

Conversation

TMisiukiewicz commented Nov 22, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Nov 22, 2023

Uh oh!

TMisiukiewicz commented Nov 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

situchan commented Nov 22, 2023

Uh oh!

situchan Nov 22, 2023

Choose a reason for hiding this comment

Uh oh!

TMisiukiewicz Nov 22, 2023

Choose a reason for hiding this comment

Uh oh!

adhorodyski Nov 22, 2023

Choose a reason for hiding this comment

Uh oh!

TMisiukiewicz commented Nov 22, 2023

Uh oh!

Julesssss commented Nov 22, 2023

Uh oh!

OSBotify commented Nov 22, 2023

Uh oh!

getusha commented Nov 22, 2023

Uh oh!

situchan commented Nov 22, 2023

Uh oh!

situchan commented Nov 22, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

situchan left a comment

Choose a reason for hiding this comment

Uh oh!

luacmartins commented Nov 22, 2023

Uh oh!

situchan commented Nov 22, 2023

Uh oh!

adhorodyski commented Nov 22, 2023

Uh oh!

luacmartins commented Nov 22, 2023

Uh oh!

melvin-bot Bot commented Nov 22, 2023

Uh oh!

OSBotify commented Nov 22, 2023

Uh oh!

OSBotify commented Nov 23, 2023

Uh oh!

OSBotify commented Nov 23, 2023

Uh oh!

OSBotify commented Nov 27, 2023

Uh oh!

s77rt Aug 5, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

TMisiukiewicz commented Nov 22, 2023 •

edited

Loading