Skip to content

Refactor VBBA setup flow with new API ConnectBankAccountWithPlaid #11162

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.

Sign up for GitHub

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

Jump to bottom
Merged
nkuoch merged 8 commits into from
Sep 26, 2022
Merged

Refactor VBBA setup flow with new API ConnectBankAccountWithPlaid #11162

nkuoch merged 8 commits into from
Sep 26, 2022

Conversation

@nkuoch
Copy link
Contributor

@nkuoch nkuoch commented Sep 21, 2022 •
edited
Loading

Details

Use ConnectBankAccountWithPlaid instead of BankAccount_SetupWithdrawal
And some small refactoring on all steps of vbba setup

Fixed Issues

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

Tests

PR Review Checklist

Contributor (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 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 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 tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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.

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed
  • 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 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 tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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.

QA Steps

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

@nkuoch nkuoch requested a review from a team as a code owner September 21, 2022 09:26
@nkuoch nkuoch self-assigned this Sep 21, 2022
@melvin-bot melvin-bot bot requested review from arosiclair and removed request for a team September 21, 2022 09:27
@nkuoch nkuoch mentioned this pull request Sep 21, 2022
Closed
1 task
@nkuoch nkuoch requested review from MariaHCD and removed request for arosiclair September 21, 2022 09:48
@nkuoch nkuoch changed the title Refactor VBBA setup flow with new API ConnectBankAccountWithPlaid [HOLD] Refactor VBBA setup flow with new API ConnectBankAccountWithPlaid Sep 21, 2022
@nkuoch nkuoch changed the title [HOLD] Refactor VBBA setup flow with new API ConnectBankAccountWithPlaid [HOLD Web 34910] Refactor VBBA setup flow with new API ConnectBankAccountWithPlaid Sep 21, 2022
MariaHCD
MariaHCD requested changes Sep 21, 2022
View reviewed changes
src/components/AddPlaidBankAccount.js
/**
* Triggered when user selects a Plaid bank account.
* @param {String} index
* @param {String} plaidAccountID
Copy link
Contributor

@MariaHCD MariaHCD Sep 21, 2022

Choose a reason for hiding this comment

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

The changes here will conflict with https://github.com/Expensify/App/pull/10953/files#diff-2a35d342f7be1cc5c1a8f02937f635a5c7083ec66b64b400027d65087d400e09 👀

cc: @ctkochan22

I do like the idea of using the plaidAccountID instead of the index, though.

luacmartins
luacmartins requested changes Sep 21, 2022
View reviewed changes
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Left an initial review. I still need to test this.

ctkochan22
ctkochan22 reviewed Sep 22, 2022
View reviewed changes
@nkuoch
Fixes from PR reviews:
f9b22c2 
- Early return
- Mispelled selectedPlaidBankAccount
- Remove getOnyxDataForVBBA
- Use Localize.translateLocal for genericErrorMessage
- Use ErrorUtils.getLatestErrorMessage
- Refactor acceptTerms
@nkuoch
Copy link
Contributor Author

nkuoch commented Sep 22, 2022

Updated!

luacmartins
luacmartins requested changes Sep 22, 2022
View reviewed changes
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

While testing, I noticed that the loading spinner in the AddPlaidBankAccount shows at the top of the form, instead of vertically centered.

Screen Shot 2022-09-22 at 2 06 53 PM

Rest LGTM.

MariaHCD
MariaHCD reviewed Sep 23, 2022
View reviewed changes
src/pages/ReimbursementAccount/BankAccountManualStep.js
...withLocalizePropTypes,
};

class BankAccountManualStep extends React.Component {
Copy link
Contributor

@MariaHCD MariaHCD Sep 23, 2022

Choose a reason for hiding this comment

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

Heads up @Gonals, we are splitting the manual step into its own component. Maybe for #10987, you can branch off this PR.

MariaHCD
MariaHCD reviewed Sep 23, 2022
View reviewed changes
MariaHCD
MariaHCD reviewed Sep 23, 2022
View reviewed changes
Copy link
Contributor

@MariaHCD MariaHCD left a comment

Choose a reason for hiding this comment

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

Just some small changes from me but otherwise, my local tests worked well 🎊

@nkuoch nkuoch changed the title [HOLD Web 34910] Refactor VBBA setup flow with new API ConnectBankAccountWithPlaid Refactor VBBA setup flow with new API ConnectBankAccountWithPlaid Sep 26, 2022
@nkuoch nkuoch merged commit 6bd5304 into main Sep 26, 2022
@nkuoch nkuoch deleted the nat-VBAnewAPIs branch September 26, 2022 13:52
@melvin-bot melvin-bot bot added the Emergency label Sep 26, 2022
@melvin-bot
Copy link

melvin-bot bot commented Sep 26, 2022

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

This was referenced Sep 26, 2022
Merged
Merged
Merged
Merged
Merged
@OSBotify
Copy link
Contributor

OSBotify commented Sep 26, 2022

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

@nkuoch nkuoch removed the Emergency label Sep 26, 2022
@nkuoch
Copy link
Contributor Author

nkuoch commented Sep 26, 2022

^ this is a bug, all the tests were passing melvin

@youssef-lr youssef-lr mentioned this pull request Sep 26, 2022
Merged
93 tasks
@OSBotify OSBotify mentioned this pull request Sep 26, 2022
Closed
19 tasks
@OSBotify
Copy link
Contributor

OSBotify commented Sep 26, 2022

🚀 Deployed to staging by @nkuoch in version: 1.2.7-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Sep 27, 2022

🚀 Deployed to production by @roryabraham in version: 1.2.7-2 🚀

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

@parasharrajat parasharrajat mentioned this pull request Oct 6, 2022
Closed
@Puneet-here Puneet-here mentioned this pull request Oct 11, 2022
Closed
@0xmiroslav 0xmiroslav mentioned this pull request May 5, 2023
Closed
6 tasks
@eVoloshchak eVoloshchak mentioned this pull request May 23, 2023
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MariaHCD MariaHCD MariaHCD approved these changes

@luacmartins luacmartins luacmartins approved these changes

@grgia grgia Awaiting requested review from grgia

+1 more reviewer

@ctkochan22 ctkochan22 ctkochan22 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@nkuoch nkuoch

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@nkuoch @OSBotify @MariaHCD @ctkochan22 @luacmartins