refactor(28902): [FlashList migration] PaymentMethodList by adhorodyski · Pull Request #29095 · Expensify/App

adhorodyski · 2023-10-09T14:43:48Z

Details

This PR introduces FlashList as a new dependency and refactors PaymentMethodList component to use it instead of react-native's FlatList.

Before

Native Android, debug build with dev js bundle turned off, 100 items:
https://github.com/Expensify/App/assets/42047036/f7b51a2a-ef84-4038-875c-809a01afd2e0
Some really visible blank areas.
Native Android, adhoc release build, 1000 items:
https://github.com/Expensify/App/assets/42047036/f4bc8bc4-bce0-43b2-affc-1f36fee982dc
Visible blank areas, even though the FPS is around 55-60, content is mostly invisible when fast scrolling.
Native Android, adhoc release build 1000 items heavy usage results from Flashlight:

After

Native Android, debug build with dev js bundle turned off, 100 items:
https://github.com/Expensify/App/assets/42047036/12b8ed72-49f5-4826-95a3-ab4b1b3c440d
Little to no visible blank areas, definitely better than before.
Native Android, adhoc release build, 1000 items:
https://github.com/Expensify/App/assets/42047036/be38b6ea-135f-4793-a56f-1acdd5af9be5
Little to no visible blank areas.
Native Android, adhoc release build 1000 items heavy usage results from Flashlight:

Summary

Migrating to Flashlist resulted in a lower memory and CPU consumption, FPS stayed at the high level and it has eliminated blank areas especially when fast scrolling.
As per the numerous Slack discussions, the underlying components on the renderItem such as MenuItem with PressableWithSecondaryInteraction inside can be improved as a separate effort.

Fixed Issues

$ #28902
PROPOSAL: N/A

Tests

Navigate to 'Settings' -> 'Wallet'
Verify the list is fully functional and displays correctly

Verify that no errors appear in the JS console

Offline tests

QA Steps

Navigate to 'Settings' -> 'Wallet'
Verify the list is fully functional and displays correctly

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_flashlist.mp4

Android: mWeb Chrome

mweb_chrome_flashlist.mp4

iOS: Native

ios_flashlist.mp4

iOS: mWeb Safari

mweb_safari_flashlist.mp4

MacOS: Chrome / Safari

web_flashlist.mov

MacOS: Desktop

desktop_flashlist.mov

src/pages/settings/Wallet/PaymentMethodList.js

melvin-bot · 2023-10-12T18:24:10Z

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

adhorodyski · 2023-10-17T07:43:39Z

Hey @burczu, can I please ask for your review in here? I've rebased this over the latest main so it's up to date :) Let me know if I can help you in any way.

burczu · 2023-10-17T08:13:58Z

Hey @adhorodyski! Sorry for the delay, I was quite overloaded with tasks recently. I should move things forward here today.

burczu · 2023-10-17T09:33:29Z

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

Web

Screen.Recording.2023-10-17.at.12.12.40.mov

Mobile Web - Chrome

Screen.Recording.2023-10-17.at.12.25.06.mov

Mobile Web - Safari

Screen.Recording.2023-10-17.at.12.21.52.mov

Desktop

Screen.Recording.2023-10-17.at.12.14.23.mov

iOS

Screen.Recording.2023-10-17.at.12.16.51.mov

Android

Screen.Recording.2023-10-17.at.12.15.37.mov

burczu · 2023-10-17T10:20:46Z

@adhorodyski Did you notice that on native devices we get such warning while opening page with the FlashList - can we get rid of it?

adhorodyski · 2023-10-17T11:27:07Z

I don't recall having it at the later stage of development (I've seen this at the start though) - let me handle this and get back to you, thanks!

adhorodyski · 2023-10-18T11:14:35Z

I'm currently getting other errors after rebasing over main, probably related to #29839 - will get back to debugging when it's fixed.

…ment fail at initial render

adhorodyski · 2023-10-23T11:23:17Z

@burczu looks like setting the minHeight on a parent view helped with this issue, please let me know if you'd spot anything else :)

burczu

Confirmed that the warning does not show up anymore.

LGTM then.

adhorodyski · 2023-10-25T11:07:14Z

@mountiny from my end it's ready to be merged, please let me know if there's anything I can add in here :)

mountiny · 2023-10-25T21:20:11Z

Thanks Adam, I will leave this review and final approve to @roryabraham

roryabraham

Just some minor code style comments, overall no major concerns. Great job 👍🏼

src/pages/settings/Wallet/PaymentMethodList.js

adhorodyski · 2023-10-26T12:18:08Z

@roryabraham updated the PR according to your comments, thank you so much for taking the time :)

melvin-bot · 2023-10-26T17:45:48Z

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

OSBotify · 2023-10-26T17:56:09Z

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

roryabraham · 2023-10-26T19:17:40Z

src/styles/variables.ts

    anonymousReportFooterBreakpoint: 650,
    dropDownButtonDividerHeight: 28,
    addPaymentMethodLeftSpacing: 2,
+    paymentMethodHeight: 64,


@adhorodyski I just realized we already had a const for this optionRowHeight – in your next PR can you please get rid of this paymentMethodHeight and instead use optionRowHeight?

Sure thing, will update in the morning! 🙂

Please see my follow up PR #30486 :)

OSBotify · 2023-10-26T22:59:20Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.92-0 🚀

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

OSBotify · 2023-10-30T07:42:38Z

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

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

OSBotify · 2023-10-30T08:03:38Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.93-0 🚀

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

OSBotify · 2023-10-31T21:36:47Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.93-1 🚀

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

jjcoffee · 2024-01-22T16:49:10Z

src/pages/settings/Wallet/PaymentMethodList.js

-                scrollEnabled={shouldEnableScroll}
-                style={style}
-            />
+            <View style={[style, {minHeight: variables.paymentMethodHeight}]}>


I believe this may have caused #33075 as variables.paymentMethodHeight is only equal to 1 item's height, but we can have multiple cards. More details here.

adhorodyski force-pushed the refactor/28902/flashlist-migration branch from 921e05d to 4e12783 Compare October 9, 2023 14:47

gedu reviewed Oct 9, 2023

View reviewed changes

src/pages/settings/Wallet/PaymentMethodList.js Outdated Show resolved Hide resolved

gedu reviewed Oct 9, 2023

View reviewed changes

src/pages/settings/Wallet/PaymentMethodList.js Outdated Show resolved Hide resolved

adhorodyski commented Oct 10, 2023

View reviewed changes

src/pages/settings/Wallet/PaymentMethodList.js Outdated Show resolved Hide resolved

adhorodyski marked this pull request as ready for review October 12, 2023 18:24

adhorodyski requested a review from a team as a code owner October 12, 2023 18:24

melvin-bot bot requested review from burczu and removed request for a team October 12, 2023 18:24

adhorodyski force-pushed the refactor/28902/flashlist-migration branch 2 times, most recently from 8fdbad8 to 9238d80 Compare October 16, 2023 14:35

adhorodyski added 5 commits October 17, 2023 18:37

chore: add flashlist dependency

b5e45fc

chore: add flashlist to the jest setup

22e6de2

refactor: migrate PaymentMethodList to use FlashList

0de9d9d

fix: lint error with missing props declaration

6f09876

fix: improved estimated_item_size for list config, added jsdoc comments

188326e

adhorodyski force-pushed the refactor/28902/flashlist-migration branch from fa4a2ff to 188326e Compare October 17, 2023 16:39

Merge branch 'Expensify:main' into refactor/28902/flashlist-migration

44d9c4d

adhorodyski and others added 6 commits October 19, 2023 12:15

Merge branch 'Expensify:main' into refactor/28902/flashlist-migration

a1c0e24

Merge branch 'Expensify:main' into refactor/28902/flashlist-migration

da94edd

Merge branch 'Expensify:main' into refactor/28902/flashlist-migration

a660653

fix: flashlist container styles

b9138d7

fix: move flashlist container styles to a wrapper

7a9e846

chore: add minHeight to the flashlist wrapper View to prevent measure…

7ce37a6

…ment fail at initial render

burczu approved these changes Oct 25, 2023

View reviewed changes

melvin-bot bot requested a review from roryabraham October 25, 2023 08:29

mountiny assigned adhorodyski Oct 25, 2023

roryabraham requested changes Oct 26, 2023

View reviewed changes

src/pages/settings/Wallet/PaymentMethodList.js Outdated Show resolved Hide resolved

src/pages/settings/Wallet/PaymentMethodList.js Outdated Show resolved Hide resolved

adhorodyski and others added 3 commits October 26, 2023 13:58

Merge branch 'Expensify:main' into refactor/28902/flashlist-migration

02c6f00

chore: remove a redundant rename on the isOffline param

c285013

chore: reuse global paymentMethodHeight value on the list

3d6ad2f

roryabraham approved these changes Oct 26, 2023

View reviewed changes

roryabraham merged commit 92677e3 into Expensify:main Oct 26, 2023

roryabraham reviewed Oct 26, 2023

View reviewed changes

OSBotify mentioned this pull request Oct 26, 2023

Deploy Checklist: New Expensify 2023-10-26 #30469

Closed

64 tasks

melvin-bot bot mentioned this pull request Oct 30, 2023

[HOLD for payment 2023-11-07] Start migrating lists that are ready from FlatList to FlashList #28902

Closed

OSBotify mentioned this pull request Oct 30, 2023

Deploy Checklist: New Expensify 2023-10-30 #30560

Closed

jjcoffee reviewed Jan 22, 2024

View reviewed changes

jjcoffee mentioned this pull request Jan 22, 2024

[C+ Checklist Needs Completion] [$500] Wallet - "Enable Wallet" card flashes briefly when returning from card details page #33075

Closed

6 tasks

Conversation

adhorodyski commented Oct 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Before

After

Summary

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Uh oh!

Uh oh!

melvin-bot bot commented Oct 12, 2023

Uh oh!

adhorodyski commented Oct 17, 2023

Uh oh!

burczu commented Oct 17, 2023

Uh oh!

burczu commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

burczu commented Oct 17, 2023

Uh oh!

adhorodyski commented Oct 17, 2023

Uh oh!

adhorodyski commented Oct 18, 2023

Uh oh!

adhorodyski commented Oct 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

burczu left a comment

Choose a reason for hiding this comment

Uh oh!

adhorodyski commented Oct 25, 2023

Uh oh!

mountiny commented Oct 25, 2023

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

adhorodyski commented Oct 26, 2023

Uh oh!

melvin-bot bot commented Oct 26, 2023

Uh oh!

OSBotify commented Oct 26, 2023

Uh oh!

roryabraham Oct 26, 2023

Choose a reason for hiding this comment

Uh oh!

adhorodyski Oct 26, 2023

Choose a reason for hiding this comment

Uh oh!

adhorodyski Oct 27, 2023

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 26, 2023

Uh oh!

OSBotify commented Oct 30, 2023

Uh oh!

OSBotify commented Oct 30, 2023

Uh oh!

OSBotify commented Oct 31, 2023

Uh oh!

jjcoffee Jan 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

adhorodyski commented Oct 9, 2023 •

edited

Loading

burczu commented Oct 17, 2023 •

edited

Loading

adhorodyski commented Oct 23, 2023 •

edited

Loading

jjcoffee Jan 22, 2024 •

edited

Loading