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

Create new API command: ConnectBankAccountManually #10987

Merged
merged 16 commits into from
Sep 27, 2022
Merged

Conversation

Gonals
Copy link
Contributor

@Gonals Gonals commented Sep 14, 2022

Fixed Issues

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

Tests

  1. Log into your account in NewDot. If you don't have a workspace, create one.
  2. Go to Settings>Workspace>Connect Bank Account:

Screen Shot 2022-09-16 at 11 52 03 AM

  1. Select "Connect Manually"
  2. Enter a valid routing/account number
  3. You should be taken to the next step.
  4. Repeat Up to step 4, but enter the same number in both fields. An error should show up:

Screen Shot 2022-09-15 at 5 38 34 PM

  1. Repeat 1-3 and go offline. The button should get disabled:

Screen Shot 2022-09-26 at 4 49 53 PM

  1. Go back online and repeat steps 1-2
  2. Select Connect with Plaid and follow the steps to connect your Chase bank account via Plaid.
  3. After the process is completed, you'll be taken back to the Connect Manually flow (Chase is a special case).
  4. Enter the WRONG bank account number. You should see an error:

Screen Shot 2022-09-27 at 12 28 25 PM

  1. Enter the right one. You should move forwards to the next step.
  • Verify that no errors appear in the JS console

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

Same as tests. It'd be nice to ping someone with a Chase account that can test the Chase part.

  • Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

@Gonals Gonals requested a review from a team as a code owner September 14, 2022 11:47
@Gonals Gonals self-assigned this Sep 14, 2022
@melvin-bot melvin-bot bot requested review from tylerkaraszewski and removed request for a team September 14, 2022 11:47
@Gonals Gonals changed the title [WIP] Create new API command: ConnectBankAccountManually [HOLD]Create new API command: ConnectBankAccountManually Sep 16, 2022
@Gonals Gonals requested review from dangrous and MariaHCD September 16, 2022 10:08
@Gonals
Copy link
Contributor Author

Gonals commented Sep 16, 2022

OFF WIP and ready for review!

Copy link
Contributor

@tylerkaraszewski tylerkaraszewski left a comment

Choose a reason for hiding this comment

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

I left a few comments. They're mostly just about my lack of understanding rather than requests to change anything.

optimisticData: [
{
onyxMethod: CONST.ONYX.METHOD.MERGE,
key: ONYXKEYS.REIMBURSEMENT_ACCOUNT,
Copy link
Contributor

Choose a reason for hiding this comment

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

Forgive me for asking "dumb" onyx questions, but I don't work in this code very much.

In what cases would onyxMethod and key be different for optimisticData, successData and failureData? It seems like these would always be the same? Maybe a failure would clear out an existing key?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

At least in most cases, they'll be the same, but sometimes a failure could also modify a _DRAFT key. I don't think I've seen any cases where the methods differ, but maybe a failure could clear out a key in certain cases (although, in most cases, it'll just clean up the content of the key)

BankAccounts.connectBankAccountManually(
this.state.accountNumber,
this.state.routingNumber,
'',
Copy link
Contributor

Choose a reason for hiding this comment

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

In what cases is this not blank?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm waiting on the PR for the automated flow (this is the manual one) to fully implement this. For Chase bank accounts, we need to ask people to enter the info manually afterwards (through this flow). In those cases, we'll pass the info we got from the automated flow in this parameter, so we can check the manually entered one is correct. It is basically a corner-ish case.

@Gonals
Copy link
Contributor Author

Gonals commented Sep 20, 2022

Comments addressed!

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.

You've got a couple linter errors

src/pages/ReimbursementAccount/BankAccountStep.js Outdated Show resolved Hide resolved
@Gonals
Copy link
Contributor Author

Gonals commented Sep 20, 2022

Comments readdressed!

dangrous
dangrous previously approved these changes Sep 22, 2022
Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

Updates look good and all comments addressed!

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.

We'll need to update this due to: #11162 (comment)

@nkuoch
Copy link
Contributor

nkuoch commented Sep 26, 2022

#11162 has been merged on main - please merge main on your branch

@Gonals Gonals dismissed stale reviews from tylerkaraszewski and dangrous via e155156 September 26, 2022 14:55
@Gonals
Copy link
Contributor Author

Gonals commented Sep 26, 2022

OFF HOLD! Ready for review!

@Gonals Gonals changed the title [HOLD]Create new API command: ConnectBankAccountManually Create new API command: ConnectBankAccountManually Sep 26, 2022
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.

LGTM! Could you also add test steps for connecting a Chase bank account with Plaid and verifying that we ask the user to enter the bank account numbers manually

@Gonals
Copy link
Contributor Author

Gonals commented Sep 27, 2022

LGTM! Could you also add test steps for connecting a Chase bank account with Plaid and verifying that we ask the user to enter the bank account numbers manually

I Added them to the QA section! I don't have a Chase account to test them 🤷

@nkuoch
Copy link
Contributor

nkuoch commented Sep 27, 2022

I don't have a Chase account to test them

These are the test credentials for any Plaid banks:
username: user_good
password: pass_good

@MariaHCD MariaHCD merged commit c942b3e into main Sep 27, 2022
@MariaHCD MariaHCD deleted the alberto-manualBank branch September 27, 2022 10:15
@melvin-bot
Copy link

melvin-bot bot commented Sep 27, 2022

@MariaHCD 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.

@MariaHCD
Copy link
Contributor

Merged without contributor+ checklist passing but all other tests succeeded.

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

@nkuoch
Copy link
Contributor

nkuoch commented Sep 27, 2022 via email

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @MariaHCD in version: 1.2.8-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @roryabraham in version: 1.2.8-0 🚀

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

smrutiparida pushed a commit to autosave-app/App that referenced this pull request Oct 13, 2022
Create new API command: ConnectBankAccountManually
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.

6 participants