Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NoQA] Fix Virtualised List Error #49487

Merged
merged 9 commits into from
Sep 20, 2024

Conversation

allgandalf
Copy link
Contributor

@allgandalf allgandalf commented Sep 19, 2024

Details

We cannot use ScrollView with SelectionList because it is anti-pattern and will lead to performance issues and bugs.

With this PR, we are removing the usage of ScrollView and adding the extra components as either listHeaderContent or listFooterContent

Fixed Issues

$ #48974
PROPOSAL:

Tests

  • Only on Dev environment

PREREQUISITES: all betas or workspace feed beta enables

  1. Enable Expensify Card in More Features
  2. Add a new bank account and choose this bank for Expensify Card
  3. Right after adding a bank and enabling the card on the Expensify Card page go to Settings
  4. Go to Settlement Account settings page

Verify that we do not get the error: VirtualizedLists should never be nested inside plain ScrollViews with the same orientation because it can break windowing and other functionality - use another VirtualizedList-backed container instead.


  • Precondition:
  1. Comment this line of code to shouldShow={false}.

  2. Have 2 bank accounts set up on wallet page

  3. Go to settings/wallet/choose-transfer-account

Verify that we do not get the error: VirtualizedLists should never be nested inside plain ScrollViews with the same orientation because it can break windowing and other functionality - use another VirtualizedList-backed container instead.

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

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

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2024-09-20.at.5.51.23.PM.mov
MacOS: Desktop

@DylanDylann
Copy link
Contributor

Let's wrap it by View Component. This is draft implementation. YOu can apply more style to View to display the correct UI

             <View style={[styles.flexRow]}>
                <SelectionList
                    ......
                />
            </View>
            <MenuItem
                onPress={navigateToAddPaymentMethodPage}
               .......
            />   

@fabioh8010
Copy link
Contributor

Let's wrap it by View Component. This is draft implementation. YOu can apply more style to View to display the correct UI

             <View style={[styles.flexRow]}>
                <SelectionList
                    ......
                />
            </View>
            <MenuItem
                onPress={navigateToAddPaymentMethodPage}
               .......
            />   

@DylanDylann Your solution doesn't work well with scrolling or when we have several bank accounts, take a look:

Screen.Recording.2024-09-20.at.11.29.13.mov

@fabioh8010
Copy link
Contributor

@DylanDylann @allgandalf One easy way to solve this particular case is to use the listFooterContent of SelectionList component, which allows us to render the button at the bottom of the list:

            <SelectionList
                sections={[{data}]}
                ListItem={RadioListItem}
                onSelectRow={(value) => {
                    const accountType = value?.bankAccount?.accountType;
                    const accountData = value?.bankAccount?.accountData;
                    selectAccountAndNavigateBack(accountType, accountData);
                }}
                shouldSingleExecuteRowSelect
                shouldUpdateFocusedIndex
                initiallyFocusedOptionKey={walletTransfer?.selectedAccountID?.toString()}
                listFooterContent={
                    <MenuItem
                        onPress={navigateToAddPaymentMethodPage}
                        title={
                            walletTransfer?.filterPaymentMethodType === CONST.PAYMENT_METHODS.PERSONAL_BANK_ACCOUNT
                                ? translate('paymentMethodList.addNewBankAccount')
                                : translate('paymentMethodList.addNewDebitCard')
                        }
                        icon={Expensicons.Plus}
                    />
                }
            />
Screen.Recording.2024-09-20.at.11.32.04.mov

I tested on iOS Native, Safari MWeb and Chrome, seems to work well. We should test on Android too.

The only drawback of this approach is that by supplying the listFooterContent prop, SelectionList won't render the Show More button anymore if the list has more than 500 items, but I think it's unlikely for an user to have so many bank accounts. If this is a problem we should explore the FlatList "wrapper" solution then.

@DylanDylann
Copy link
Contributor

@fabioh8010 Great, It looks fine

@allgandalf
Copy link
Contributor Author

SelectionList won't render the Show More button anymore if the list has more than 500 items, but I think it's unlikely for an user to have so many bank accounts.

This would really be an edge case, and in general no single user would have 500+ bank accounts, so i guess this solution would work good, I will also apply this in settlement account page as well. thanks for looking out @fabioh8010

@fabioh8010
Copy link
Contributor

Here's the full diff in case you want to test with a lot of bank accounts:

diff --git a/src/pages/settings/Wallet/ChooseTransferAccountPage.tsx b/src/pages/settings/Wallet/ChooseTransferAccountPage.tsx
index 0bbcf957c31..e3deeeeb711 100644
--- a/src/pages/settings/Wallet/ChooseTransferAccountPage.tsx
+++ b/src/pages/settings/Wallet/ChooseTransferAccountPage.tsx
@@ -8,9 +8,9 @@ import getBankIcon from '@components/Icon/BankIcons';
 import * as Expensicons from '@components/Icon/Expensicons';
 import MenuItem from '@components/MenuItem';
 import ScreenWrapper from '@components/ScreenWrapper';
-import ScrollView from '@components/ScrollView';
 import SelectionList from '@components/SelectionList';
 import RadioListItem from '@components/SelectionList/RadioListItem';
+import type {ListItem} from '@components/SelectionList/types';
 import useLocalize from '@hooks/useLocalize';
 import useThemeStyles from '@hooks/useThemeStyles';
 import {getLastFourDigits} from '@libs/BankAccountUtils';
@@ -20,10 +20,15 @@ import * as PaymentMethods from '@userActions/PaymentMethods';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 import ROUTES from '@src/ROUTES';
-import type {AccountData} from '@src/types/onyx';
+import type {AccountData, BankAccount} from '@src/types/onyx';
 import type {BankName} from '@src/types/onyx/Bank';
 import isLoadingOnyxValue from '@src/types/utils/isLoadingOnyxValue';
 
+type AccountListItem = ListItem & {
+    value?: number;
+    bankAccount: BankAccount;
+};
+
 function ChooseTransferAccountPage() {
     const [walletTransfer, walletTransferResult] = useOnyx(ONYXKEYS.WALLET_TRANSFER);
 
@@ -54,7 +59,7 @@ function ChooseTransferAccountPage() {
     const [bankAccountsList] = useOnyx(ONYXKEYS.BANK_ACCOUNT_LIST);
     const selectedAccountID = walletTransfer?.selectedAccountID;
     const data = useMemo(() => {
-        const options = Object.values(bankAccountsList ?? {}).map((bankAccount) => {
+        const options = Object.values(bankAccountsList ?? {}).map((bankAccount): AccountListItem => {
             const bankName = (bankAccount.accountData?.additionalData?.bankName ?? '') as BankName;
             const bankAccountNumber = bankAccount.accountData?.accountNumber ?? '';
             const bankAccountID = bankAccount.accountData?.bankAccountID ?? bankAccount.methodID;
@@ -78,7 +83,31 @@ function ChooseTransferAccountPage() {
                 bankAccount,
             };
         });
-        return options;
+
+        const testOptions = Array.from({length: 20}).map((v, i): AccountListItem => {
+            const {icon, iconSize, iconStyles} = getBankIcon({styles});
+
+            return {
+                value: i,
+                text: `Bank ${i}`,
+                leftElement: (
+                    <View style={[styles.flexRow, styles.alignItemsCenter, styles.mr3]}>
+                        <Icon
+                            src={icon}
+                            width={iconSize}
+                            height={iconSize}
+                            additionalStyles={iconStyles}
+                        />
+                    </View>
+                ),
+                alternateText: `Bank ${i} text`,
+                keyForList: i.toString(),
+                isSelected: false,
+                bankAccount: {},
+            };
+        });
+
+        return options.concat(testOptions);
     }, [bankAccountsList, selectedAccountID, styles, translate]);
 
     if (isLoadingOnyxValue(walletTransferResult)) {
@@ -91,29 +120,29 @@ function ChooseTransferAccountPage() {
                 title={translate('chooseTransferAccountPage.chooseAccount')}
                 onBackButtonPress={() => Navigation.goBack(ROUTES.SETTINGS_WALLET_TRANSFER_BALANCE)}
             />
-            <ScrollView>
-                <SelectionList
-                    sections={[{data}]}
-                    ListItem={RadioListItem}
-                    onSelectRow={(value) => {
-                        const accountType = value?.bankAccount?.accountType;
-                        const accountData = value?.bankAccount?.accountData;
-                        selectAccountAndNavigateBack(accountType, accountData);
-                    }}
-                    shouldSingleExecuteRowSelect
-                    shouldUpdateFocusedIndex
-                    initiallyFocusedOptionKey={walletTransfer?.selectedAccountID?.toString()}
-                />
-                <MenuItem
-                    onPress={navigateToAddPaymentMethodPage}
-                    title={
-                        walletTransfer?.filterPaymentMethodType === CONST.PAYMENT_METHODS.PERSONAL_BANK_ACCOUNT
-                            ? translate('paymentMethodList.addNewBankAccount')
-                            : translate('paymentMethodList.addNewDebitCard')
-                    }
-                    icon={Expensicons.Plus}
-                />
-            </ScrollView>
+            <SelectionList
+                sections={[{data}]}
+                ListItem={RadioListItem}
+                onSelectRow={(value) => {
+                    const accountType = value?.bankAccount?.accountType;
+                    const accountData = value?.bankAccount?.accountData;
+                    selectAccountAndNavigateBack(accountType, accountData);
+                }}
+                shouldSingleExecuteRowSelect
+                shouldUpdateFocusedIndex
+                initiallyFocusedOptionKey={walletTransfer?.selectedAccountID?.toString()}
+                listFooterContent={
+                    <MenuItem
+                        onPress={navigateToAddPaymentMethodPage}
+                        title={
+                            walletTransfer?.filterPaymentMethodType === CONST.PAYMENT_METHODS.PERSONAL_BANK_ACCOUNT
+                                ? translate('paymentMethodList.addNewBankAccount')
+                                : translate('paymentMethodList.addNewDebitCard')
+                        }
+                        icon={Expensicons.Plus}
+                    />
+                }
+            />
         </ScreenWrapper>
     );
 }

@allgandalf allgandalf changed the title [WIP]: Fix Virtualised List Error Fix Virtualised List Error Sep 20, 2024
@allgandalf allgandalf marked this pull request as ready for review September 20, 2024 12:23
@allgandalf allgandalf requested a review from a team as a code owner September 20, 2024 12:23
@melvin-bot melvin-bot bot requested review from DylanDylann and removed request for a team September 20, 2024 12:23
Copy link

melvin-bot bot commented Sep 20, 2024

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

@DylanDylann
Copy link
Contributor

DylanDylann commented Sep 20, 2024

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
Screen.Recording.2024-09-20.at.20.15.05.mov
Android: mWeb Chrome
Screen.Recording.2024-09-20.at.20.14.21.mov
iOS: Native
Screen.Recording.2024-09-20.at.20.15.29.mov
iOS: mWeb Safari
Screen.Recording.2024-09-20.at.20.13.05.mov
MacOS: Chrome / Safari
Screen.Recording.2024-09-20.at.20.11.46.mov
MacOS: Desktop
Screen.Recording.2024-09-20.at.20.13.36.mov

@melvin-bot melvin-bot bot requested a review from mountiny September 20, 2024 13:17
@allgandalf allgandalf changed the title Fix Virtualised List Error [Internal QA] Fix Virtualised List Error Sep 20, 2024
@mountiny mountiny changed the title [Internal QA] Fix Virtualised List Error [NoQA] Fix Virtualised List Error Sep 20, 2024

This ensures optimal performance and avoids layout issues.


Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs looks like the below @mountiny

Screenshot 2024-09-20 at 9 53 48 PM

contributingGuides/STYLE.md Outdated Show resolved Hide resolved
contributingGuides/STYLE.md Outdated Show resolved Hide resolved
contributingGuides/STYLE.md Outdated Show resolved Hide resolved
contributingGuides/STYLE.md Outdated Show resolved Hide resolved
contributingGuides/STYLE.md Outdated Show resolved Hide resolved
contributingGuides/STYLE.md Outdated Show resolved Hide resolved
contributingGuides/STYLE.md Outdated Show resolved Hide resolved
Co-authored-by: Fábio Henriques <[email protected]>
@allgandalf
Copy link
Contributor Author

@fabioh8010 the following is the latest view after the suggestions, does that look fine now?

Screenshot 2024-09-20 at 10 10 56 PM

@fabioh8010
Copy link
Contributor

LGTM!

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, one NAB so going to merge


### Problem

When using `SelectionList` alongside other components (e.g., `Text`, `Button`), wrapping them inside a `ScrollView` can lead to alignment and performance issues. Additionally, using `ScrollView` with nested `FlatList` or `SectionList` causes the error:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When using `SelectionList` alongside other components (e.g., `Text`, `Button`), wrapping them inside a `ScrollView` can lead to alignment and performance issues. Additionally, using `ScrollView` with nested `FlatList` or `SectionList` causes the error:
When using `SelectionList` alongside other components (e.g., `Text`, `Button`), wrapping them inside a `ScrollView` can lead to alignment and performance issues. Additionally, using `ScrollView` with nested `FlatList` or `SectionList` causes this error:

@mountiny mountiny merged commit eaa7969 into Expensify:main Sep 20, 2024
18 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.40-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.40-6 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants