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

Refactor SetWalletLinkedAccount #9828

Merged
merged 18 commits into from
Jul 18, 2022

Conversation

MariaHCD
Copy link
Contributor

@MariaHCD MariaHCD commented Jul 11, 2022

Hold on: https://github.com/Expensify/Web-Expensify/pull/34270

Details

Fixed Issues

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

Tests

  1. Have an account set up with a validated bank account and a P2P debit card (via clitools.sh generator:bankaccount, generator:billingcard and validator:wallet)
  2. Navigate to Settings > Payments
  3. Click on a payment method and Make default payment method, enter the account password
  4. Verify that the payment method is set as the default
  • Verify that no errors appear in the JS console
Untitled_.Jul.13.2022.11_35.AM.mp4

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

  1. Have an account (on the wallet beta) set up with a validated bank account and a P2P debit card
  2. Navigate to Settings > Payments
  3. Click on the bank payment method and Make default payment method, enter the account password
  4. Verify that the bank account is set as the default
  5. Click on the debit card and Make default payment method, enter the account password
  6. Verify that the debit card is set as the default
  • Verify that no errors appear in the JS console

Screenshots

Web

Screen Shot 2022-07-13 at 11 43 10 AM

Screen Shot 2022-07-13 at 11 43 03 AM

Screen Shot 2022-07-13 at 11 42 45 AM

Screen Shot 2022-07-13 at 11 43 14 AM

Desktop

Screen Shot 2022-07-13 at 11 36 37 AM

Screen Shot 2022-07-13 at 11 36 29 AM

Screen Shot 2022-07-13 at 11 36 14 AM

@MariaHCD MariaHCD self-assigned this Jul 11, 2022
@melvin-bot
Copy link

melvin-bot bot commented Jul 11, 2022

Looks like you modified deprecatedAPI.js! To be clear, you should not be adding any code to this file.

Instead, all new API commands should use API.js, and follow our guidelines for writing new API commands.

Unsure if your change is okay? Drop a note in #expensify-open-source!

@MariaHCD MariaHCD marked this pull request as ready for review July 13, 2022 09:12
@MariaHCD MariaHCD requested a review from a team as a code owner July 13, 2022 09:12
@melvin-bot melvin-bot bot requested review from Beamanator and removed request for a team July 13, 2022 09:12
thienlnam
thienlnam previously approved these changes Jul 13, 2022
Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

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

Everything looks good so far

},
];

API.write('MakeDefaultPaymentMethod', {password, bankAccountID, fundID}, {optimisticData, failureData});
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess this is more of a NAB, but any reason this PR doesn't list the onyx data in the function call like https://github.com/Expensify/App/pull/9589/files?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No particular reason but I like the idea of keeping it consistent so I've updated to have the onyx data in the function call vs as separate variables 👍🏼

@@ -0,0 +1,12 @@
import PropTypes from 'prop-types';

export default PropTypes.shape({
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for cleaning this up 😄

Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Looking good, just a few tiny NABs (haven't fully tested yet)

Just a tiny question, when creating cardPropTypes why not make cardListPropTypes instead? I don't think it reduce the amount of code written, just wondering 😅

@MariaHCD
Copy link
Contributor Author

MariaHCD commented Jul 14, 2022

Just a tiny question, when creating cardPropTypes why not make cardListPropTypes instead?

That's fair. Updated to cardListPropTypes but thinking about it, the props describe the shape of a card object not a card list, right? So I'm thinking cardPropTypes is more apt here.

@Beamanator
Copy link
Contributor

Beamanator commented Jul 14, 2022

That's fair. Updated to cardListPropTypes but thinking about it, the props describe the shape of a card object not a card list, right? So I'm thinking cardPropTypes is more apt here.

Yeah trueeee I guess I was thinking in cardListPropTypes include the PropTypes.arrayOf piece, something like:

import PropTypes from 'prop-types';

export default PropTypes.arrayOf(PropTypes.shape({
    /** The name of the institution (bank of america, etc) */
    cardName: PropTypes.string,

    /** The masked credit card number */
    cardNumber: PropTypes.string,

    /** The ID of the card in the cards DB */
    cardID: PropTypes.number,
}));

I'm happy to drop this idea though, just a slight personal preference :D

This reverts commit 1be91e2.

# Conflicts:
#	src/pages/settings/Payments/PaymentsPage/paymentsPagePropTypes.js
@MariaHCD
Copy link
Contributor Author

I guess I was thinking in cardListPropTypes include the PropTypes.arrayOf piece

Ah, yeah, that'd be a good way to do it as well. However, I think we'll just stay consistent with bankAccountPropTypes and stick with cardPropTypes here.

Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

Clean PR 🔥

Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

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

Leaving final review / merge to you @srikarparsi

@MariaHCD MariaHCD changed the title [HOLD Web-E #34270] Refactor SetWalletLinkedAccount Refactor SetWalletLinkedAccount Jul 15, 2022
Copy link
Contributor

@srikarparsi srikarparsi left a comment

Choose a reason for hiding this comment

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

looks good

@srikarparsi srikarparsi merged commit 65a3115 into main Jul 18, 2022
@srikarparsi srikarparsi deleted the maria-refactor-set-wallet-linked-account branch July 18, 2022 04:35
@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 production by @luacmartins in version: 1.1.85-8 🚀

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