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

[No QA] Update wallet transfer for Onyx::handleException #11927

Merged
merged 3 commits into from
Feb 22, 2023

Conversation

srikarparsi
Copy link
Contributor

@srikarparsi srikarparsi commented Oct 17, 2022

Details

Refactors the frontend to accept errors keyed by microtime instead of error to accommodate backend refactor below.
Blocking this PR: https://github.com/Expensify/Web-Expensify/pull/35188

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/224886
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

  1. Create two accounts A and B on an @expensifail.com domain using ../script/clitools.sh generator:account
  2. Add a payment debit card to account A using ../script/clitools.sh generator:billingcard. Answer yes to all questions.
  3. Add a deposit bank account to account B using ../script/clitools.sh generator:bankaccount. Answer the questions to create a deposit account that is validated, is not a business deposit, and use the stripe test account information.
  4. Upgrade account B's wallet to Gold so they can transfer their balance with ../script/clitools.sh validator:wallet
  5. Modify the transfer balance api to throw a test error by throwing this error throw new ExpException('test error', 666); at the top of this catch block.
  6. Sign into account A, then send money to account B
  7. Sign in to account B, go to Settings, Payments, and click transfer balance
  8. Verify that you see the error message

image

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

No QA

PR Author Checklist

We can't easily QA this right now. I didn't test on a high traffic account, nor offline, and I didn't test on all platforms because those items can't be effected by these simple changes.

  • 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:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • 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 is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • 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 any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • 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.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@srikarparsi srikarparsi requested a review from a team as a code owner October 17, 2022 20:11
@srikarparsi srikarparsi self-assigned this Oct 17, 2022
@melvin-bot melvin-bot bot requested review from eVoloshchak and marcochavezf and removed request for a team October 17, 2022 20:12
Copy link
Contributor

@neil-marcellini neil-marcellini 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. How do we test it?

Also we need to properly clear out error and errors here when we send a new request.

@srikarparsi
Copy link
Contributor Author

Maybe we could test it manually? Create a user who's not in the expensify wallet beta and then attempt to send money using their account. We could check the onyx data and also make sure the same error is being displayed on the UI.
But, this PR - https://github.com/Expensify/Web-Expensify/pull/35188 - would need to be merged in order to test this one. Would that be okay or is there a better way to do this?

Copy link
Contributor

@neil-marcellini neil-marcellini 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. Please add error and errors to the walletTransferPropTypes. error should have been there to begin with.

/** Wallet balance transfer props */
const walletTransferPropTypes = PropTypes.shape({
/** Selected accountID for transfer */
selectedAccountID: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
/** Type to filter the payment Method list */
filterPaymentMethodType: PropTypes.oneOf([CONST.PAYMENT_METHODS.DEBIT_CARD, CONST.PAYMENT_METHODS.BANK_ACCOUNT, '']),
/** Whether the success screen is shown to user. */
shouldShowSuccess: PropTypes.bool,
});
export default walletTransferPropTypes;

Also please add test steps and fill out the checklist.

@neil-marcellini
Copy link
Contributor

Oh I just saw your comment about testing. Let's make sure we run this flow so that it will trigger an error, and verify that we see the error displayed properly. We can test that it works without the Web-PR, and with the Web-PR.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

That's a good start on the testing steps, but I still find them a bit incomplete and hard to follow. How about something like this?

  1. Sign into NewDot with any account A
  2. Run ../script/clitools.sh generator:bankaccount
  3. Enter an email for an account B. Choose Withdrawal, Validated yes, Upgraded no, Use Stripe Test Acct Information yes.
  4. Sign in on another device with account B
  5. Send some money to account A

However when I go to send some money it makes me add a bank account again which doesn't make any sense to me. How did you get a wallet balance in order to be able to transfer it?

Also please fill out the PR Author Checklist in the issue description and then I will be able to fill out the reviewer checklist.

@srikarparsi srikarparsi changed the title refactor wallet transfer onyx error frontend [HOLD WAQ] refactor wallet transfer onyx error frontend Nov 25, 2022
@srikarparsi srikarparsi changed the title [HOLD WAQ] refactor wallet transfer onyx error frontend refactor wallet transfer onyx error frontend Dec 27, 2022
@neil-marcellini neil-marcellini dismissed their stale review January 3, 2023 18:52

I'm taking this PR over for Srikar

@@ -256,6 +256,7 @@ function transferWalletBalance(paymentMethod) {
value: {
loading: true,
error: null,
errors: null,
Copy link
Contributor

Choose a reason for hiding this comment

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

Reviewing a bit late here hehe, why are we having error and errors? Shouldn't we have just one property for error (or errors)?

Copy link
Contributor

Choose a reason for hiding this comment

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

We will deploy support both formats on App first. After the Web-PR is live and only sending data under the errors key, we can get rid of the error key.

@neil-marcellini neil-marcellini changed the title refactor wallet transfer onyx error frontend [No QA] Update wallet transfer for Onyx::handleException Feb 17, 2023
@neil-marcellini neil-marcellini requested review from marcochavezf and removed request for eVoloshchak February 17, 2023 22:53
@neil-marcellini
Copy link
Contributor

Ok, I merged main and updated the PR description and test steps so this should be good to go. Would you please review @marcochavezf? Since testing requires backend changes and our dev environment I'll have to remove you from review @eVoloshchak.

@marcochavezf
Copy link
Contributor

Hey @neil-marcellini 👋🏽 Why aren't we going to QA this PR? Shouldn't Applause test it too (even if it's a minor change)? Also, I noticed the screenshots/videos are missing :)

@neil-marcellini
Copy link
Contributor

@marcochavezf there's no way that I know of to QA a wallet transfer error, I think @MariaHCD would agree. As I noted in the description, I didn't test on all platforms because the changes here are platform independent. I did include a screenshot showing the error from testing on web.

Does that sound good?

@marcochavezf
Copy link
Contributor

marcochavezf commented Feb 21, 2023

Reviewer Checklist

  • 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:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • 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 is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • 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 any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • 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.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@neil-marcellini neil-marcellini merged commit a87b802 into main Feb 22, 2023
@neil-marcellini neil-marcellini deleted the srikar-frontendWalletTransfer branch February 22, 2023 17:05
@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 https://github.com/neil-marcellini in version: 1.2.76-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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.

4 participants