Skip to content

Remove use of getPaymentMethods() in EnableStep#12909

Merged
MariaHCD merged 11 commits intomainfrom
ckt_refactor_removeEnableStepPaymentMethodget
Dec 2, 2022
Merged

Remove use of getPaymentMethods() in EnableStep#12909
MariaHCD merged 11 commits intomainfrom
ckt_refactor_removeEnableStepPaymentMethodget

Conversation

@ctkochan22
Copy link

@ctkochan22 ctkochan22 commented Nov 21, 2022

@nkuoch @MariaHCD

Details

  • Removes the use of PaymentMethods.getPaymentMethods() in EnableStep
  • Removes the deprecated method PaymentMethods.getPaymentMethods()

Fixed Issues

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

Tests / QA Steps

We need an account with a OPEN VBBA attached to a workspace. You can follow these steps to add a VBBA, but you do not need to test adding the VBBA. I'm only attaching the instructions in case you need to add an OPEN VBBA.

OR
Just test on this test account:

  • Email: ctkochan22+openvbba@gmail.com
  • Password: Password1
How to add VBBA on staging 1. Log into NewDot with an account that has a workspace set up but with no bank account set up 2. Navigate to Settings > [Workspace] > Connect bank account 3. Add Bank Account (On new dot enable Settings > Preferences > Use Secure staging server to hit our staging secure sandbox): - Click "Log into your bank" - Plaid modal - Choose Citibank - Online - Plaid modal - User Id: user_good - Plaid modal - Password: pass_good - Plaid modal - Submit - Plaid modal - If they request a verification code via mobile sms, enter: credential_good - Choose the Saving account: Plaid Saving11122XXXXXX111 - Save & Continue
  1. In the Company information form enter Alberta Bobbeth Charleson for the company name and fill out any data in the other fields. Click Save & Continue

  2. In the Personal information form, ensure to enter first name Alberta and last name Charleson. Enter any data for all the other fields. Click Save & Continue.

  3. On the Beneficial Owners page:

    • Toggle terms and conditions
    • Toggle confirmation that the information provided is true and accurate
    • Click Save & Continue
  4. Verify you land on the enable step and that you that you see:

    • Your company name
    • Last for digits of your VBBA
    image

Once you have an OPEN VBBA attached to a newDot Workspace, you do not need to repeat these steps. Just test on all platforms with this account.

Test Steps:

  1. Go to workspace settings

  2. Go to "Connect Bank Account"

  3. Verify you land on the enable step and that you that you see:

    • Your company name
    • Last for digits of your VBBA
    image

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:

    • 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 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 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 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 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 reviewer 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 expected offline behavior are in the Offline steps 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 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 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:
    • 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 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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 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.

Screenshots

csEuCkNPsU

Web

https://recordit.co/csEuCkNPsU

Mobile Web - Chrome

https://recordit.co/5trakgqPCt

Mobile Web - Safari

https://recordit.co/wYdpopllMU

Desktop

https://recordit.co/HIUiOqGFE9

iOS

https://recordit.co/p7l4Ujo5gF

@ctkochan22 ctkochan22 requested a review from a team as a code owner November 21, 2022 23:37
@ctkochan22 ctkochan22 self-assigned this Nov 21, 2022
@ctkochan22 ctkochan22 changed the base branch from master to main November 21, 2022 23:37
@melvin-bot melvin-bot bot requested review from srikarparsi and removed request for a team November 21, 2022 23:38
@melvin-bot
Copy link

melvin-bot bot commented Nov 21, 2022

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

Kosuke Tseng added 2 commits November 21, 2022 15:52
@ctkochan22
Copy link
Author

Updated ready for review

@ctkochan22 ctkochan22 changed the title [WIP] Remove use of getPaymentMethods() in EnableStep Remove use of getPaymentMethods() in EnableStep Nov 23, 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 so far. Just a lint error. Also, not sure why a C+ wasn't assigned to this PR.

@ctkochan22
Copy link
Author

Updated!

@ctkochan22 ctkochan22 requested a review from a team November 24, 2022 00:55
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team November 24, 2022 00:55
@melvin-bot
Copy link

melvin-bot bot commented Nov 24, 2022

@eVoloshchak @nkuoch One of you needs to 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]

@ctkochan22
Copy link
Author

@eVoloshchak Please test this on all platforms when you have a chance 🙇

@MariaHCD
Copy link
Contributor

MariaHCD commented Nov 24, 2022

@ctkochan22 I'm updating the test steps since @eVoloshchak would not be able to access the SO.

Update: Okay, I've added more detailed test steps. Let us know if you have any issues with testing, @eVoloshchak!

MariaHCD
MariaHCD previously approved these changes Nov 24, 2022
@ctkochan22
Copy link
Author

@eVoloshchak Let me know if you are able to get to this soon! We'd love to get this merged this week

@eVoloshchak
Copy link
Contributor

@ctkochan22 i won't be able to get to this soon, unfortunately, could you unassign me please?

@ctkochan22 ctkochan22 removed the request for review from srikarparsi November 24, 2022 19:18
@rushatgabhane
Copy link
Member

@ctkochan22 looks like we have some merge conflicts

nkuoch
nkuoch previously approved these changes Nov 25, 2022
@ctkochan22
Copy link
Author

sorry, I'm trying to understand why PaymentMethods.getPaymentMethods() is being removed. Could you please give me a gist of it

For sure, this is part of our big API refactor. We are cleaning the amount of requests we make per action. One user action should amount to one API call. GetPaymentMethods is a chain of 3 different API requests.

@ctkochan22 ctkochan22 dismissed stale reviews from nkuoch and MariaHCD via 6bad261 November 25, 2022 20:23
@ctkochan22
Copy link
Author

@rushatgabhane please test today if you can!

@rushatgabhane
Copy link
Member

yes will do in a few hours. sorry for the delay

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@ctkochan22 sorry, I can't seem to trigger the sandbox environment for plaid
I've enabled secure staging server.

Screen.Recording.2022-11-28.at.7.01.32.PM.mov

@ctkochan22
Copy link
Author

@rushatgabhane

Did you update getPlaidLinkTokenParameters/index.js to match

import ROUTES from '../../ROUTES';
import CONST from '../../CONST';

export default () => {
  const bankAccountRoute = window.location.href.includes('personal') 
      ? ROUTES.BANK_ACCOUNT_PERSONAL 
      : ROUTES.BANK_ACCOUNT;

  return {redirect_uri: `https://localhost:8080/${bankAccountRoute}`};
};

@ctkochan22
Copy link
Author

@rushatgabhane let me know when you can test this again, I can help you through it

@rushatgabhane
Copy link
Member

discussing 1:1 with @ctkochan22 on testing steps

@rushatgabhane
Copy link
Member

rushatgabhane commented Nov 29, 2022

  1. In the Company information form enter Alberta Bobbeth Charleson for the company name and fill out any data in the other fields. Click Save & Continue

@ctkochan22 in Company Information step, after clicking continue I'm getting an error "routing and account number cannot be the same"

image

But Plaid has them filled correctly

image

Screen.Recording.2022-11-29.at.11.46.31.PM.mov

@ctkochan22
Copy link
Author

The issue causing the above should be fixed with #13163

@ctkochan22
Copy link
Author

@rushatgabhane please test again please

@rushatgabhane
Copy link
Member

reviewing today

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

Reviewer Checklist

@MariaHCD LGTM! 🎉

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

Screenshots/Videos

Web

CORS issue (there isn't a known way around this for external folks)

image
Mobile Web - Chrome

CORS issue for web

Mobile Web - Safari CORS issue for web
Desktop
Screen.Recording.2022-12-01.at.11.22.36.PM.mov
iOS
Screen.Recording.2022-12-01.at.11.28.50.PM.mov
Android
WhatsApp.Video.2022-12-01.at.23.32.28.mp4

@MariaHCD MariaHCD merged commit c34e64c into main Dec 2, 2022
@MariaHCD MariaHCD deleted the ckt_refactor_removeEnableStepPaymentMethodget branch December 2, 2022 17:32
@OSBotify
Copy link
Contributor

OSBotify commented Dec 2, 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.

@OSBotify
Copy link
Contributor

OSBotify commented Dec 2, 2022

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

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

@ctkochan22
Copy link
Author

We need to add an OPEN VBBA as a freeplan bank account to test and move on with the deploy. @francoisl

UPDATE nameValuePairs SET value = 1058714 WHERE name = 'expensify_freePlanBankAccountID' and accountID = 8198785;

Afterwards, we need to figure out why we can't add a OPEN VBBA in staging.

@ctkochan22
Copy link
Author

UPdated the QA instructions to be more clear

@ctkochan22
Copy link
Author

Here is a test account on staging
Email: ctkochan22+openvbba@gmail.com
Password: Password1

@OSBotify
Copy link
Contributor

OSBotify commented Dec 8, 2022

🚀 Deployed to production by @francoisl in version: 1.2.36-4 🚀

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.

6 participants