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 SettlementButton/KYCWall #10193

Merged
merged 13 commits into from
Aug 9, 2022

Conversation

ctkochan22
Copy link
Contributor

@ctkochan22 ctkochan22 commented Aug 2, 2022

cc @MariaHCD

Details

Fixed Issues

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

Tests

We are testing the functionality of the KYCWall, which determines if there is any step a user needs to take before completing an action.

Setup:

  1. Create five users:
    • 1 sender
    • 1 user with no payment method
    • 1 user with a payment method (debit card), no KYC
    • 1 user with a payment method (personal bank account), no KYC
    • 1 user with payment method and KYC
  2. As the sender, request money from each of the four other users
    tsXFyVZSh0

  3. Log into the users who need to pay. Go to the chat, and click "Pay" to pull up IOU modal
    image

Test & confirm the outcome of pressing "Pay with Expensify"
- User 1 with no payment method sees option to add payment method
image

- User 2 with debit card payment method and User 3 with personal bank account, both with no kyc. Sees the additional information modal pop up
image

- User 4 with kyc filled, moves forward and you are able to settle up
image

Test and confirm the Transfer button
The sender should now have an amount after user 4 paid them successfully.

  1. Log into that user. Go to settings-> payments.
  2. Click the Transfer button. Verify that it forces you to choose an option.
    image

  3. Add a Personal Bank Account. Use credentials user_good and pass_good. Click transfer again and verify that you see the "Additional Details" modal
    image

Offline behavior
You can mock offline by going into the console, selecting "Network", setting "No throttling" to offline
image

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

You will need to test by requesting amount from several types of users:

  1. User with no payment method
  2. User with one payment method, but no KYC. (Further details on account to use for QA)
  3. User with payment method & KYC

First request an amount from all three users. As the user, navigate to the report, then click on "Pay". This should open a detailed IOU modal. Please click "Pay with Expensify" and confirm the following:

  • As the user with no payment method, you see:
    image
  • As the user with one payment method, no KYC. You see the additional details form
    • You can log into ctseng+debitqa@expensifail.com with password Password1. It has a live debit account, but no KYC set up.
      image
  • As the user with a payment method and KYC added. You will see the payment/settlement go through

@ctkochan22 ctkochan22 requested a review from a team as a code owner August 2, 2022 07:09
@ctkochan22 ctkochan22 changed the base branch from master to main August 2, 2022 07:09
@melvin-bot melvin-bot bot requested review from arosiclair and removed request for a team August 2, 2022 07:09
@ctkochan22
Copy link
Contributor Author

I need to add clear test steps, and update "OpenPaymentsPage" to a more generic command now that I want to use it for KYC

@ctkochan22 ctkochan22 requested a review from MariaHCD August 2, 2022 07:10
@ctkochan22 ctkochan22 changed the title [WIP] Refactor SettlementButton/KYCWall Refactor SettlementButton/KYCWall Aug 4, 2022
@@ -150,6 +151,7 @@ class IOUDetailsModal extends Component {
))}
</View>
)}
<OfflineIndicator containerStyles={[styles.ml5, styles.mb2]} />
Copy link
Contributor

Choose a reason for hiding this comment

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

Correct me if I'm wrong, but I think this might not be needed now that we added a global offline indicator with this PR. Does this not duplicate that indicator?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It strangely wasn't covered. IOUModal was covered but not the details page

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like this branch doesn't have those changes yet. I merged main and gave it a test here:

Screen Shot 2022-08-05 at 3 13 09 PM

That global offline indicator will display on mobile devices. On desktop we only display the indicator below the chat message compose box.

Copy link
Contributor

@arosiclair arosiclair left a comment

Choose a reason for hiding this comment

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

Aside from the duplicate OfflineIndicator, LGTM!

src/pages/iou/IOUDetailsModal.js Outdated Show resolved Hide resolved
@ctkochan22
Copy link
Contributor Author

Updated!

@arosiclair arosiclair merged commit 787f3a8 into main Aug 9, 2022
@arosiclair arosiclair deleted the ckt_refactor_settlementButtonKYC_08_1 branch August 9, 2022 14:40
@OSBotify
Copy link
Contributor

OSBotify commented Aug 9, 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.

@AndrewGable
Copy link
Contributor

Confirmed for checklist:

Screen Shot 2022-08-23 at 4 19 58 PM

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