[CP Staging] feat: Improve KYC error handling by allroundexperts · Pull Request #30103 · Expensify/App

allroundexperts · 2023-10-20T19:29:18Z

Details

#30088

Fixed Issues

$ #30088
PROPOSAL: N/A

Tests

Steps for internal engineers:

Have an account with a wallet account having the Onfido result set as in progress
Have an account with a pending wallet go through KYC and verify the activation is successful

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

No QA, will fully tested after https://github.com/Expensify/Web-Expensify/pull/39342

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:
- 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 code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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 or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-10-20T19:29:23Z

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

MariaHCD

@allroundexperts code looks good but I notice that if the user is on the TermsStep, clicks Enable Payments and the isPendingOnfidoResult prop is sent as true from the AcceptWalletTerms API command, the user is not redirected to the Wallet page. If I manually navigate to /enable-payments then the user is redirected as expected:

Screen.Recording.2023-10-22.at.2.04.54.PM.mov

Am I missing something?

allroundexperts · 2023-10-22T13:34:27Z

@MariaHCD Could it be because of this line?

This is just my suspicion though. Is the backend deployed? If not, can you spin up your env again so I can test?

MariaHCD · 2023-10-22T14:27:13Z

@allroundexperts Not super sure if that's the issue. I've spun up the ngrok URL again.

allroundexperts · 2023-10-22T16:12:22Z

@allroundexperts code looks good but I notice that if the user is on the TermsStep, clicks Enable Payments and the isPendingOnfidoResult prop is sent as true from the AcceptWalletTerms API command, the user is not redirected to the Wallet page. If I manually navigate to /enable-payments then the user is redirected as expected:

Screen.Recording.2023-10-22.at.2.04.54.PM.mov
Am I missing something?

@MariaHCD Fixed!

MariaHCD

LGTM

MariaHCD · 2023-10-22T16:54:42Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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 code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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

Screen.Recording.2023-10-22.at.8.54.52.PM.mov

Screen.Recording.2023-10-22.at.8.54.12.PM.mov

Screen.Recording.2023-10-22.at.8.59.58.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-10-22.at.9.35.26.PM.mov

Mobile Web - Safari

Screen.Recording.2023-10-22.at.9.38.48.PM.mov

Desktop

Screen.Recording.2023-10-22.at.9.39.20.PM.mov

iOS

Screen.Recording.2023-10-22.at.9.41.24.PM.mov

Android

Screen.Recording.2023-10-22.at.9.50.41.PM.mov

MariaHCD · 2023-10-22T17:31:42Z

One more thing I noticed, @allroundexperts, if KYC is successful, we don't show the activation success page anymore. Is there a way to show the success page? I believe we're optimistically setting isPendingOnfidoResult to true so that's why?

Screen.Recording.2023-10-22.at.9.29.04.PM.mov

allroundexperts · 2023-10-22T17:34:40Z

One more thing I noticed, @allroundexperts, if KYC is successful, we don't show the activation success page anymore. Is there a way to show the success page? I believe we're optimistically setting isPendingOnfidoResult to true so that's why?

Yes. That's correct. I can make it so that it gets set by the backend response only. Does that work?

MariaHCD · 2023-10-22T17:40:57Z

@allroundexperts That would be better, I think! 👍🏼

allroundexperts · 2023-10-22T17:44:20Z

Handled @MariaHCD!

MariaHCD · 2023-10-22T17:49:41Z

Nice, thanks, looks better! The only thing is nothing looks to be happening in the UI when the ActivateWallet API command is processing so it looks like the page is stuck for a few seconds:

Screen.Recording.2023-10-22.at.9.47.51.PM.mov

allroundexperts · 2023-10-22T17:50:32Z

Does disabling the button work?

MariaHCD · 2023-10-22T17:52:13Z

Yes, I think it would! Do buttons have some sort of loading state, perhaps?

allroundexperts · 2023-10-22T18:00:27Z

@MariaHCD Handled. Can you please test now?

MariaHCD · 2023-10-22T18:06:45Z

Nice, looks good!

Screen.Recording.2023-10-22.at.10.01.47.PM.mov

MariaHCD · 2023-10-22T18:13:32Z

So I've tested the following scenarios:

When Onfido result is pending and the wallet is not yet activated
When Onfido succeeds and the wallet is activated

Can't think of any other scenario at the moment. In the other issue, we'll handle the case when we receive the successful or unsuccessful Onfido result asynchronously. In the case of success, the isPendingOnfidoResult will be removed from the userWallet. In case of failure, we'll have a different UI / error message.

MariaHCD · 2023-10-22T18:13:38Z

I am inclined to merge this for now so we can get this deployed.

@Expensify/design if you have any suggestions on the UI here, we can fix them in a follow up PR 🙏🏼

MariaHCD

Small changes, @allroundexperts 🙏🏼

MariaHCD · 2023-10-22T18:15:15Z

    chatReportID: PropTypes.string,
+
+    /** Boolean to indicate whether the submission of wallet terms is being processed */
+    submitting: PropTypes.bool,


Very small change, but I think we should call this isLoading to follow our naming patterns for bool props

MariaHCD · 2023-10-22T18:17:41Z

    const hasAssignedCard = !_.isEmpty(cardList);
    const shouldShowEmptyState = !hasBankAccount && !hasWallet && !hasAssignedCard;

+    const {isPendingOnfidoResult} = userWallet;


Just confirming, if isPendingOnfidoResult doesn't exist in the userWallet, then it will be undefined so do we prefer lodashGet in these cases?

MariaHCD · 2023-10-22T18:19:01Z


-    /** Whether we should show the ActivateStep success view after the user finished the KYC flow */
-    shouldShowWalletActivationSuccess?: boolean;
+    /** Whether the kyc is pending and is yet to be confirmed */


Suggested change

/** Whether the kyc is pending and is yet to be confirmed */

/** Whether the Onfido result is pending. KYC is not complete and the wallet will not be activated until we have the Onfido verification result */

OSBotify · 2023-10-22T18:54:22Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

feat: Improve KYC error handling (cherry picked from commit e780e70)

OSBotify · 2023-10-22T21:10:26Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 1.3.88-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-10-23T04:48:45Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.88-11 🚀

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

allroundexperts added 2 commits October 20, 2023 23:35

feat: show better title when onfido is pending on wallet page

bf7f200

feat: do not show enable wallet button if its loading

8419844

allroundexperts requested a review from a team as a code owner October 20, 2023 19:29

melvin-bot Bot requested review from hoangzinh and removed request for a team October 20, 2023 19:29

allroundexperts changed the title ~~Fix 30088~~ feat: Improve KYC error handling Oct 20, 2023

allroundexperts added 3 commits October 21, 2023 00:36

uncommit permissions.ts file

1d93ba6

feat: remove redundant imports

845a672

feat: properly wrap the wallet error text

56bab9e

MariaHCD requested changes Oct 22, 2023

View reviewed changes

fix: back button on enable wallets page

81fb1a2

allroundexperts requested a review from MariaHCD October 22, 2023 16:12

MariaHCD previously approved these changes Oct 22, 2023

View reviewed changes

fix: do not update isPendingOnfidoResult optimistically

89621cc

allroundexperts dismissed MariaHCD’s stale review via 89621cc October 22, 2023 17:43

fix: add submission state to the terms step

4d4ca6c

MariaHCD requested changes Oct 22, 2023

View reviewed changes

MariaHCD mentioned this pull request Oct 22, 2023

[HOLD for payment 2023-10-31] [HOLD for payment 2023-10-30] [CRITICAL] [P2P Activation] Improve KYC delay handling #30088

Closed

fix: handle comment suggestions

cc298bd

allroundexperts requested a review from MariaHCD October 22, 2023 18:25

MariaHCD approved these changes Oct 22, 2023

View reviewed changes

MariaHCD merged commit e780e70 into Expensify:main Oct 22, 2023

mountiny changed the title ~~feat: Improve KYC error handling~~ [CP Staging] feat: Improve KYC error handling Oct 22, 2023

OSBotify pushed a commit that referenced this pull request Oct 22, 2023

Merge pull request #30103 from allroundexperts/fix-30088

d4f3345

feat: Improve KYC error handling (cherry picked from commit e780e70)

OSBotify mentioned this pull request Oct 22, 2023

Deploy Checklist: New Expensify 2023-10-20 #30108

Closed

kevinksullivan mentioned this pull request Oct 23, 2023

[HOLD for payment 2023-11-01] [HOLD for payment 2023-10-31] Change copy for wallet pending onfido #30155

Closed

	/** Whether the kyc is pending and is yet to be confirmed */
	/** Whether the Onfido result is pending. KYC is not complete and the wallet will not be activated until we have the Onfido verification result */

Conversation

allroundexperts commented Oct 20, 2023 • edited by MariaHCD Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Oct 20, 2023

Uh oh!

MariaHCD left a comment

Choose a reason for hiding this comment

Uh oh!

allroundexperts commented Oct 22, 2023

Uh oh!

MariaHCD commented Oct 22, 2023

Uh oh!

allroundexperts commented Oct 22, 2023

Uh oh!

MariaHCD left a comment

Choose a reason for hiding this comment

Uh oh!

MariaHCD commented Oct 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

MariaHCD commented Oct 22, 2023

Uh oh!

allroundexperts commented Oct 22, 2023

Uh oh!

MariaHCD commented Oct 22, 2023

Uh oh!

allroundexperts commented Oct 22, 2023

Uh oh!

MariaHCD commented Oct 22, 2023

Uh oh!

allroundexperts commented Oct 22, 2023

Uh oh!

MariaHCD commented Oct 22, 2023

Uh oh!

allroundexperts commented Oct 22, 2023

Uh oh!

MariaHCD commented Oct 22, 2023

Uh oh!

MariaHCD commented Oct 22, 2023

Uh oh!

MariaHCD commented Oct 22, 2023

Uh oh!

MariaHCD left a comment

Choose a reason for hiding this comment

Uh oh!

MariaHCD Oct 22, 2023

Choose a reason for hiding this comment

Uh oh!

allroundexperts Oct 22, 2023

Choose a reason for hiding this comment

Uh oh!

MariaHCD Oct 22, 2023

Choose a reason for hiding this comment

Uh oh!

allroundexperts Oct 22, 2023

Choose a reason for hiding this comment

Uh oh!

MariaHCD Oct 22, 2023

Choose a reason for hiding this comment

Uh oh!

allroundexperts Oct 22, 2023

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Oct 22, 2023

Uh oh!

OSBotify commented Oct 22, 2023

Uh oh!

OSBotify commented Oct 23, 2023

Uh oh!

Reviewers

allroundexperts commented Oct 20, 2023 •

edited by MariaHCD

Loading

MariaHCD commented Oct 22, 2023 •

edited

Loading