Skip to content

Handling display of errors when MakeDefaultPaymentMethod fails #10322

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

Merged
merged 14 commits into from
Aug 17, 2022

Conversation

MariaHCD
Copy link
Contributor

@MariaHCD MariaHCD commented Aug 9, 2022

This PR is building off of: #10333

Details

Add red brick road offline error handling for MakeDefaultPaymentMethod

Tested with Web PR: https://github.com/Expensify/Web-Expensify/pull/34545

Fixed Issues

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

Tests

  • Have an account with multiple payment methods
  • Navigate to Settings > Payments
  • Select a payment method and click Make default payment method
  • Enter the wrong password
  • When both online and offline, verify that:
  1. The Avatar in the LHN shows the red indicator

Screen Shot 2022-08-10 at 4 02 39 PM

  1. The Settings menu items shows the red indicator

Screen Shot 2022-08-10 at 4 02 50 PM

  1. The error message is displayed

Screen Shot 2022-08-10 at 4 02 56 PM

  1. Clicking on x dismisses all the indicators and the error message

Screen Shot 2022-08-10 at 4 21 35 PM

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

  • Same as tests

Screenshots

Mobile Web

Screen Shot 2022-08-10 at 4 23 28 PM

Screen Shot 2022-08-10 at 4 23 33 PM

Screen Shot 2022-08-10 at 4 23 39 PM

@MariaHCD MariaHCD self-assigned this Aug 9, 2022
@melvin-bot
Copy link

melvin-bot bot commented Aug 10, 2022

npm has a package.json file and a package-lock.json file. It seems you updated one without the other, which is usually a sign of a mistake. If you are updating a package make sure that you update the version in package.json then run npm install

1 similar comment
@melvin-bot
Copy link

melvin-bot bot commented Aug 10, 2022

npm has a package.json file and a package-lock.json file. It seems you updated one without the other, which is usually a sign of a mistake. If you are updating a package make sure that you update the version in package.json then run npm install

@MariaHCD MariaHCD changed the base branch from main to jack-paymentMethodPatternB August 10, 2022 12:24
@MariaHCD MariaHCD changed the title [Refactor] Handling display of errors when MakeDefaultPaymentMethod fails [Refactor] [HOLD Web #34545] Handling display of errors when MakeDefaultPaymentMethod fails Aug 10, 2022
@MariaHCD MariaHCD changed the title [Refactor] [HOLD Web #34545] Handling display of errors when MakeDefaultPaymentMethod fails [HOLD Web #34545] Handling display of errors when MakeDefaultPaymentMethod fails Aug 10, 2022
@MariaHCD MariaHCD marked this pull request as ready for review August 10, 2022 12:30
@MariaHCD MariaHCD requested a review from a team as a code owner August 10, 2022 12:30
@MariaHCD MariaHCD requested a review from thienlnam August 10, 2022 12:31
@melvin-bot melvin-bot bot requested review from NikkiWines and removed request for a team August 10, 2022 12:31
thienlnam
thienlnam previously approved these changes Aug 10, 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.

Looks great! Just one NAB comment

Comment on lines 35 to 36
// eslint-disable-next-line react/default-props-match-prop-types
userWallet: {},
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can remove this lint disable, what if we updated the userWalletPropTypes to be export PropTypes.shape
and then we can use check that userwallet: userWalletPropTypes

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if there was a reason behind having userWalletPropTypes as:

export default {
    /** User's wallet information */
    userWallet: PropTypes.shape({
        ...
    }),
};

vs

export default PropTypes.shape({
    ...
});

But I've updated to the latter so we can avoid disabling the lint error: eslint-disable-next-line react/default-props-match-prop-types. Updated all usages of userWalletPropTypes as well.

cc: @marcaaron

Copy link
Contributor

Choose a reason for hiding this comment

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

Great solution! I'm not sure if there was a clear reason tbh. I probably was just in the mood to use a spread operator. This seems like a bester "best practice".

NikkiWines
NikkiWines previously approved these changes Aug 11, 2022
Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

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

👍

… maria-make-default-payment-method

# Conflicts:
#	src/libs/actions/PaymentMethods.js
@MariaHCD MariaHCD changed the title [HOLD Web #34545] Handling display of errors when MakeDefaultPaymentMethod fails [HOLD App #10333] Handling display of errors when MakeDefaultPaymentMethod fails Aug 15, 2022
Base automatically changed from jack-paymentMethodPatternB to main August 15, 2022 21:49
…yment-method

# Conflicts:
#	src/pages/EnablePayments/userWalletPropTypes.js
#	src/pages/settings/Payments/PaymentMethodList.js
@MariaHCD MariaHCD changed the title [HOLD App #10333] Handling display of errors when MakeDefaultPaymentMethod fails [HOLD Web #34545] Handling display of errors when MakeDefaultPaymentMethod fails Aug 16, 2022
@MariaHCD
Copy link
Contributor Author

Looks like the previous approvals were dismissed when the base branch changed to main. This is on hold till the web PR goes out to production but all set for re-review, @thienlnam @NikkiWines!

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.

Sweet, thanks for updating the proptype!

@@ -81,4 +87,7 @@ export default withOnyx({
cardList: {
key: ONYXKEYS.CARD_LIST,
},
userWallet: {
Copy link
Contributor

Choose a reason for hiding this comment

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

This avatarWithIndicator is going to get so bloated with all these onyx keys 😭

Copy link
Contributor Author

Choose a reason for hiding this comment

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

😭 Agreed, not sure if there's a better way?

@MariaHCD MariaHCD changed the title [HOLD Web #34545] Handling display of errors when MakeDefaultPaymentMethod fails Handling display of errors when MakeDefaultPaymentMethod fails Aug 17, 2022
@MariaHCD
Copy link
Contributor Author

Off hold!

Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

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

:shipit:

@NikkiWines NikkiWines merged commit e850b54 into main Aug 17, 2022
@NikkiWines NikkiWines deleted the maria-make-default-payment-method branch August 17, 2022 07:42
@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 staging by @NikkiWines in version: 1.1.89-0 🚀

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.

5 participants