Refactor/36648 wallet enablement flow by koko57 · Pull Request #39038 · Expensify/App

koko57 · 2024-03-27T09:43:28Z

Details

First draft PR for the refactor - it contains the changes for the first step of the flow - add your bank account.

Fixed Issues

$ #36648
PROPOSAL: -

Tests

Prerequisites: in settings/about/troubleshoot you should enable Use Staging Server if testing locally

Go to settings/wallet page
Web / mWeb: Type in '/add-bank-account-refactor' after the URL address
Mobile: run npx uri-scheme open new-expensify://settings/wallet/add-bank-account-refactor --android
or npx uri-scheme open new-expensify://settings/wallet/add-bank-account-refactor --ios
Desktop: ~~type new-expensify://settings/wallet/add-bank-account-refactor in your browser's searchbar (with app opened)~~ deep links are not working properly for nested routes
A page with "Add your bank account" is displayed (we agreed not to display the step indicator like in the VBBA flow for this step) and a button for connecting with Plaid is displayed (Manual setup will be added later)
Click Add bank account - verify that a new page is open with a step indicator and should show a loader.
Verify that after a moment Plaid sandbox appears
Choose Wells Fargo bank, login and choose account(s) to connect.
Verify that after connecting with Plaid you're redirected back to the flow and see the page titled "Choose your bank account."
Verify that all the accounts you've chosen on Plaid step are visible in the list (with checkboxes).
Verify that after clicking Next with no checkboxes checked error message s"You need to select an option to proceed." and "Please fix the errors in the form before continuing." and you're not navigated to the next step.
Verify that after clicking any checkbox it is checked and the last 4 digits of the account number appear under bank's name.
Hit next and go to the next step. Verify that you're navigated to the confirmation step.
Verify that 4 last digits of the bank account number and the bank's name are displayed in a pressable item (with a right arrow).
Verify that after clicking the pressable item you're redirected back to the page with bank account list to choose. Return to the last step by clicking Next.
Click confirm - you'll be redirected to settings/wallet/enable-payments page, the old flow will be displayed (when testing on web you will see an account added in the Bank Account section in the background)
Exit the flow, remove the bank account. Repeat going through the flow, but this time verify that the header back button navigates back to the previous page correctly.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Prerequisites: in settings/about/troubleshoot you should enable Use Staging Server if testing locally

Go to settings/wallet page
Web / mWeb: Type in '/add-bank-account-refactor' after the URL address
Mobile: run npx uri-scheme open new-expensify://settings/wallet/add-bank-account-refactor --android
or npx uri-scheme open new-expensify://settings/wallet/add-bank-account-refactor --ios
Desktop: type new-expensify://settings/wallet/add-bank-account-refactor in your browser's searchbar (with app opened)
A page with "Add your bank account" is displayed (we agreed not to display the step indicator like in the VBBA flow for this step) and a button for connecting with Plaid is displayed (Manual setup will be added later)
Click Add bank account - verify that a new page is open with a step indicator and should show a loader.
Verify that after a moment Plaid sandbox appears
Choose Wells Fargo bank, login and choose account(s) to connect.
Verify that after connecting with Plaid you're redirected back to the flow and see the page titled "Choose your bank account."
Verify that all the accounts you've chosen on Plaid step are visible in the list (with checkboxes).
Verify that after clicking Next with no checkboxes checked error message s"You need to select an option to proceed." and "Please fix the errors in the form before continuing." and you're not navigated to the next step.
Verify that after clicking any checkbox it is checked and the last 4 digits of the account number appear under bank's name.
Hit next and go to the next step. Verify that you're navigated to the confirmation step.
Verify that 4 last digits of the bank account number and the bank's name are displayed in a pressable item (with a right arrow).
Verify that after clicking the pressable item you're redirected back to the page with bank account list to choose. Return to the last step by clicking Next.
Click confirm - you'll be redirected to settings/wallet/enable-payments page, the old flow will be displayed (when testing on web you will see an account added in the Bank Account section in the background)
Exit the flow, remove the bank account. Repeat going through the flow, but this time verify that the header back button navigates back to the previous page correctly.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-04-02.at.14.19.43.mp4

Android: mWeb Chrome

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-04-02.at.14.49.34.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-04-02.at.14.19.43.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-04-02.at.14.49.34.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-04-02.at.16.06.14.mp4

MacOS: Desktop

weren't able to test desktop - deep links are not working for nested routes

src/pages/EnablePayments/AddBankAccount/AddBankAccount.tsx

src/pages/EnablePayments/AddBankAccount/substeps/Plaid.tsx

src/ROUTES.ts

src/pages/EnablePayments/AddBankAccount/substeps/Confirmation.tsx

src/ONYXKEYS.ts

src/pages/EnablePayments/AddBankAccount/AddBankAccount.tsx

src/CONST.ts

src/pages/EnablePayments/AddBankAccount/AddBankAccount.tsx

src/pages/EnablePayments/AddBankAccount/substeps/Plaid.tsx

Pujan92 · 2024-04-03T04:09:44Z

Bug: On plaid exit flow it turns to infinite loading, I think we should take user back to the method selection screen.

Screen.Recording.2024-04-03.at.09.37.30.mov

Pujan92 · 2024-04-03T04:12:03Z

Bug: Post adding the account successfully we show the additional details screen at the moment in main branch, but with this PR it doesn't show automatically and the user needs to click again on Enable Wallet.

Staging

Screen.Recording.2024-04-03.at.15.15.29.mov

This PR

Screen.Recording.2024-04-03.at.09.36.22.mov

koko57 · 2024-04-03T09:03:56Z

Bug: Post adding the account successfully we show the additional details screen at the moment in main branch, but with this PR it doesn't show automatically and the user needs to click again on Enable Wallet.

@shawnborton @Pujan92 shouldn't we go straight to the Additional Details Steps in the new flow? Should we leave the flow and resume it after Enable Wallet is clicked like is it now and @Pujan92 mentions?

Pujan92 · 2024-04-03T09:04:25Z

src/components/AddPlaidBankAccount.tsx

    isDisplayedInNewVBBA?: boolean;

+    /** Is displayed in new enable wallet flow */
+    isNewWalletFlow?: boolean;


Suggested change

isNewWalletFlow?: boolean;

isDisplayedInWalletFlow?: boolean;

How about making the name similar to isDisplayedInNewVBBA

Pujan92 · 2024-04-03T09:24:49Z

src/pages/EnablePayments/AddBankAccount/SetupMethod.tsx

+        <Section
+            icon={Illustrations.MoneyWings}
+            title={translate('walletPage.addYourBankAccount')}
+            titleStyles={[styles.textXLarge]}


Suggested change

titleStyles={[styles.textXLarge]}

titleStyles={[styles.textHeadlineLineHeightXXL]}

I think we can use the already defined textHeadlineLineHeightXXL here

Pujan92 · 2024-04-03T09:28:32Z

src/pages/settings/Wallet/WalletPage/WalletPage.tsx

-                                                    // To allow upgrading to a gold wallet, continue with the KYC flow after adding a bank account
-                                                    BankAccounts.setPersonalBankAccountContinueKYCOnSuccess(ROUTES.SETTINGS_WALLET);
-                                                }}
+                                                onSelectPaymentMethod={() => Navigation.navigate(ROUTES.SETTINGS_ADD_BANK_ACCOUNT)}


Not sure why we need this change?

Pujan92 · 2024-04-03T09:42:59Z

@shawnborton @Pujan92 shouldn't we go straight to the Additional Details Steps in the new flow? Should we leave the flow and resume it after Enable Wallet is clicked like is it now and @Pujan92 mentions?

@koko57 I am referring to the old flow here, there is an inconsistency between the main branch and this PR. I just added a recording of staging here to differentiate where the additional details screen opens automatically once we click on the Continue button in the success screen.

koko57 · 2024-04-03T10:11:24Z

@Pujan92 ah, ok, now I get it - sorry for the misunderstanding. Thanks!

koko57 · 2024-04-03T14:34:03Z

@Pujan92 all issues fixed

Pujan92 · 2024-04-03T15:20:43Z

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

abc1.webm

Android: mWeb Chrome

abc2.webm

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-04-03.at.21.33.11.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-04-03.at.21.36.38.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-04-03.at.21.24.39.mov

MacOS: Desktop

Screen.Recording.2024-04-03.at.21.52.10.mov

Pujan92

LGTM, Thanks :)

mountiny · 2024-04-04T00:13:16Z

Any more feedback from the @Expensify/design team on this one? It wont be used in the App straight away so not big pressure

shawnborton · 2024-04-04T07:16:27Z

Design-wise this looks good to me!

mountiny

thank you for the quick review and work here everyone, we can continue onto the next part

mountiny · 2024-04-04T15:25:25Z

src/libs/actions/BankAccounts.ts

 }

+/**
+ * TODO: remove the previous function and rename this function to openPersonalBankAccountSetupView after migrating to the new flow


NAB: Usually its a good practice to add a link to the issue where we are already going to do this too, so the main issue would work here

OSBotify · 2024-04-08T11:08:41Z

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

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

OSBotify · 2024-04-08T13:05:19Z

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

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

OSBotify · 2024-04-10T17:22:56Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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

koko57 added 17 commits February 22, 2024 10:14

feat: create a separate route for refactor

fccd32f

feat: UI for step 0

c20c2cb

Merge branch 'main' into refactor/36648-wallet-enablement-flow

61e3e86

Merge branch 'main' into refactor/36648-wallet-enablement-flow

c738d86

Merge branch 'main' into refactor/36648-wallet-enablement-flow

d6de861

feat: add english translations

42c592f

feat: wip - connect the substeps

9d63de6

Merge branch 'main' into refactor/36648-wallet-enablement-flow

3259d64

fix: minor changes

b89e714

fix: resolve conflicts

58d65b9

fix: resolve conflicts

5dac8aa

Merge branch 'main' into refactor/36648-wallet-enablement-flow

123f089

refactor: wip

fc1fa09

refactor: code cleanup

7e5d868

fix: remove en translations dupes

e57e120

fix: es translations

bc8cc3a

fix: translations

b21b721