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

Fix multiple Onfido screens #24079

Merged
merged 4 commits into from
Aug 18, 2023
Merged

Fix multiple Onfido screens #24079

merged 4 commits into from
Aug 18, 2023

Conversation

ginsuma
Copy link
Contributor

@ginsuma ginsuma commented Aug 2, 2023

Details

iOS: Onfido screen present multiple time when app pushed to Background

Fixed Issues

$ #23642
PROPOSAL: #23642 (comment)

Tests

  1. Go to setting.
  2. Go to any workspace.
  3. Set up a Bank account.
  4. On the last step, click Save & Continue.
  5. It will present Onfido | Real identity screen.
  6. Push the app in the background.
  7. Again, open the app.
  8. On iOS:
    8.1. Click on the back button on the Onfido screen.
    8.2. Verify that the previous screen is not an Onfido screen.
  9. On Android:
    9.1. Verify that the Onfido screen reopens.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

  • Verify that no errors appear in the JS console

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 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
      • 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 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 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 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
Screen.Recording.2023-08-03.at.3.11.22.AM.mp4
Mobile Web - Safari
Screen.Recording.2023-08-03.at.3.14.41.AM.mov
Mobile Web - Chrome
Screen.Recording.2023-08-03.at.3.21.36.AM.mov
Desktop
Screen.Recording.2023-08-03.at.3.38.03.AM.mov
iOS
Screen.Recording.2023-08-03.at.3.15.44.AM.mp4
Android
Screen.Recording.2023-08-10.at.3.34.03.PM.mov

@ginsuma ginsuma requested a review from a team as a code owner August 2, 2023 20:49
@melvin-bot melvin-bot bot requested review from allroundexperts and removed request for a team August 2, 2023 20:49
@melvin-bot
Copy link

melvin-bot bot commented Aug 2, 2023

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

@allroundexperts
Copy link
Contributor

allroundexperts commented Aug 3, 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 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 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-08-03.at.11.49.32.AM.mov
Mobile Web - Chrome
Screen.Recording.2023-08-03.at.11.58.17.AM.mov
Mobile Web - Safari
Screen.Recording.2023-08-03.at.11.57.11.AM.mov
Desktop
Screen.Recording.2023-08-03.at.11.55.19.AM.mov
iOS
Screen.Recording.2023-08-03.at.12.02.06.PM.mov
Android
Screen.Recording.2023-08-10.at.3.03.13.PM.mov

@allroundexperts
Copy link
Contributor

@ginsuma Your changes on android are behaving weirdly for me. Can you please check?

Screen.Recording.2023-08-03.at.12.00.57.PM.mov

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 3, 2023

@allroundexperts I have just tested and see this bug also happens in the current main.
I don't think my PR caused it. I will investigate it now.

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 3, 2023

This is the error when we open the app from the background
[hmmm] Onfido error on native - {"errorMessage":"Unexpected result Intent. It might be a result of incorrect integration, make sure you only pass Onfido intent to handleActivityResult. It might be due to unpredictable crash or error. Please report the problem to android-sdk@onfido.com. Intent: null \n resultCode: 0"}

Below is the condition to request camera permission

if (_.contains([CONST.ONFIDO.ERROR.USER_CAMERA_PERMISSION, CONST.ONFIDO.ERROR.USER_CAMERA_DENINED, CONST.ONFIDO.ERROR.USER_CAMERA_CONSENT_DENIED], errorMessage)) {

App/src/CONST.js

Lines 1006 to 1007 in 2f750ad

USER_CAMERA_CONSENT_DENIED:
'Unexpected result Intent. It might be a result of incorrect integration, make sure you only pass Onfido intent to handleActivityResult. It might be due to unpredictable crash or error. Please report the problem to android-sdk@onfido.com. Intent: null \n resultCode: 0',

@allroundexperts
Copy link
Contributor

allroundexperts commented Aug 3, 2023

@ginsuma On main, this error does occur but it ultimately redirects you back to the ONFIDO screen. With the changes that you've done, its redirecting me to the personal information step instead. This is the discrepancy that I was talking about earlier.

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 3, 2023

@ginsuma On main, this error does occur but it ultimately redirects you back to the ONFIDO screen. With the changes that you've done, its redirecting me to the personal information step instead. This is the discrepancy that I was talking about earlier.

@allroundexperts Ah, I see it.
But for me, showing the dialog and then redirecting to ONFIDO screen without any actions looks weird too.
What is the expected behavior?

  1. The dialog shouldn't show.
  2. The current behavior on the main.

@allroundexperts
Copy link
Contributor

@ginsuma the expected behaviour is same as how it is right now on iOS.

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 3, 2023

@ginsuma the expected behaviour is same as how it is right now on iOS.

There are three approaches to it:

  1. OnfidoSDK shouldn't throw an error when we reopen the app from the background on Android like iOS => This makes Onfido screen destroyed => Fix from the upstream.
  2. Handle the case with the error message above and make Onfido screen load again, but the error message is too general. I'm not sure it is only about the case of reopening the app from the background.
  3. Handle separately Android and iOS. On Android, the dialog will show and redirect to Onfido Screen.

What do you think @allroundexperts ?

@allroundexperts
Copy link
Contributor

@ginsuma In the original video that you uploaded, why was android working fine? I mean, what exact change is causing this issue?

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 3, 2023

@ginsuma In the original video that you uploaded, why was android working fine?

My mistake, I should reopen the app by clicking to app icon rather than using this button. The app wasn't reopened from the background.
Screen Shot 2023-08-03 at 3 48 33 PM

I mean, what exact change is causing this issue?

When we reopen the app from the background:

  • On Android, throw an error, and then Onfido screen will be destroyed, but on iOS it won't.
  • isLoadingReport reset state, which makes opening an Onfido screen.
  • On Android, we will see only one Onfido screen but on iOS, one more will be added.
  • My PR is about not opening a new Onfido screen.

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 3, 2023

I think we should choose the 3rd here #24079 (comment) and create an issue on onfido/react-native-sdk.
What do you think @allroundexperts ?

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 3, 2023

Upgrade to "@onfido/react-native-sdk": "8.3.0".

Screen Shot 2023-08-03 at 5 26 11 PM

When we reopen the app from the background:

  • On Android, it throw a clear error [Error: User exited by manual action.]. This error triggers onUserExit, and the screen returns to the previous screen.
    onUserExit={() => {
    BankAccounts.clearOnfidoToken();
    BankAccounts.goToWithdrawalAccountSetupStep(CONST.BANK_ACCOUNT.STEP.REQUESTOR);
    }}
  • On iOS, like the previous version, there is no error, and one more Onfide screen is added.

https://github.com/Expensify/App/assets/13113013/9ae38f7c-f1c5-42e0-8069-96a40aee223f
I think we should upgrade to 8.3.0 to avoid showing the dialog on Android.
Then we choose which platform behavior we want and change the other.
cc: @allroundexperts

@allroundexperts
Copy link
Contributor

@ginsuma This sounds good. But still, why is it showing the previous screen when you re-open the app unlike iOS?

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 3, 2023

@ginsuma This sounds good. But still, why is it showing the previous screen when you re-open the app unlike iOS?

@allroundexperts I just tested the new SDK version, not apply any fix in the video.
On Android, it throws the error [Error: User exited by manual action.]. We catch it and handle it as USER_EXITED and then clearOnfidoToken. This makes shouldShowOnfido is false, and Onfido won't open again.

if (_.contains([CONST.ONFIDO.ERROR.USER_CANCELLED, CONST.ONFIDO.ERROR.USER_TAPPED_BACK, CONST.ONFIDO.ERROR.USER_EXITED], errorMessage)) {
this.props.onUserExit();
return;
}

onUserExit={() => {
BankAccounts.clearOnfidoToken();
BankAccounts.goToWithdrawalAccountSetupStep(CONST.BANK_ACCOUNT.STEP.REQUESTOR);
}}

const shouldShowOnfido = this.props.onfidoToken && !achData.isOnfidoSetupComplete;

This is a meaning error message than the previous Onfido SDK version. The old one will lead to open the dialog.

We should hold this PR and create a new one to upgrade Onfido SDK first. If the upgrade doesn't cause any issues, we will continue again here. The idea is resetting onfidoToken on Android, and it will open Onfido again. Or should we both upgrade and fix the issue in this PR?

@allroundexperts
Copy link
Contributor

I think we can do both in this PR!

@allroundexperts
Copy link
Contributor

@ginsuma Any luck with above?

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 4, 2023

@allroundexperts I have some updates.

  • With 8.3.0, on Android, the error for reopening is the same as when we click the back button. I tried some ways to detect it but have yet to be successful. Both have the same flow because when Onfido screen appears, the AppState will be background https://reactnative.dev/docs/appstate.
  • I wonder if destroying Onfido screen is the default behavior of onfido-android-sdk. Because I see it has the option to exitWhenSentToBackground for customization https://github.com/onfido/onfido-android-sdk#customizing-the-sdk from a very early version. I downloaded the Onfido demo app on Play Store and did the test. It didn't reset the screen when reopening from the background.

My point until now:

  • We still need to upgrade @onfido/react-native-sdk to fix the dialog issue.
  • We need to build this one https://github.com/onfido/react-native-sdk/tree/v8.3.0/SampleApp to recheck Onfido screen's behavior. It's beneficial to find the RCA on Android. To do that, could you ask the internal team or someone who has Onfido sandbox API key?

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 8, 2023

Update:

Screen.Recording.2023-08-08.at.5.40.32.PM.mov

cc: @allroundexperts

@allroundexperts
Copy link
Contributor

@ginsuma I think it makes sense to add our fix to iOS only and leave android as it was previously. What do you think?

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 10, 2023

@allroundexperts I agree with it. We can recheck Android behavior again when we upgrade the SDK version.

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 10, 2023

@allroundexperts I updated the Android video and pushed a new commit. Please review it. Thank you.

@allroundexperts
Copy link
Contributor

@ginsuma Can you please merge main if you haven't already?

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 10, 2023

@ginsuma Can you please merge main if you haven't already?

@allroundexperts I did it.

Copy link
Contributor

@allroundexperts allroundexperts 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!

@melvin-bot melvin-bot bot requested a review from NikkiWines August 10, 2023 10:06
@allroundexperts
Copy link
Contributor

@NikkiWines We decided to dis-regard our changes on native Android because of an issue in the Onfido Android sdk. More context in the discussion proceeding this comment.

@NikkiWines
Copy link
Contributor

NikkiWines commented Aug 14, 2023

@allroundexperts sounds good, can you post the same update in the linked issue as well so that if someone references that issue in the future it's easy to track down why Android will have different behavior?

@ginsuma could you update the QA steps to reflect the different behavior on Android so that this doesn't end up failing QA after being deployed?

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 14, 2023

@ginsuma could you update the QA steps to reflect the different behavior on Android so that this doesn't end up failing QA after being deployed?

I updated the steps.

@allroundexperts
Copy link
Contributor

Added a comment in the issue @NikkiWines!

NikkiWines
NikkiWines previously approved these changes Aug 14, 2023
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.

👍

@NikkiWines
Copy link
Contributor

Ah sorry! I thought I merged this. @ginsuma you've got merge conflicts but if you update this PR I'll merge it ASAP

@ginsuma
Copy link
Contributor Author

ginsuma commented Aug 18, 2023

@NikkiWines It's ready to merge.

@NikkiWines NikkiWines merged commit cd7bbeb into Expensify:main Aug 18, 2023
11 checks passed
@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/NikkiWines in version: 1.3.56-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 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