Add better error handling for Onfido

[marcaaron]

cc @Jag96 @ctkochan22 I couldn't get Onfido to work on desktop or web no matter how hard I tried to take a picture of my ID via my phone. But tested this with the current web-secure changes and it caught the weird error about referrer.

Details

Onfido was throwing a pretty clear error but we are not logging it at all or handling it to allow the user to attempt the flow again. This will log these errors and also try to move the user back to the Company Step so they can attempt to go through Onfido again.

Fixed Issues (Only related to does not fix)

https://github.com/Expensify/Expensify/issues/177787#

Tests (iOS only)

In order to test this we need to force the Web-Secure API to do something it shouldn't do like set a bad application id or referrer. For this test I just applied this diff in Web-Secure before testing:

diff --git a/lib/Onfido/API.php b/lib/Onfido/API.php
index 957f53ac..223dad75 100644
--- a/lib/Onfido/API.php
+++ b/lib/Onfido/API.php
@@ -195,6 +195,10 @@ class Onfido_API
         $api = self::getOnfidoApi();
         $sdk_token_request = new Onfido_SdkTokenRequest();
         $sdk_token_request->setApplicantId($applicantID);
+
+        // Add incorrect application id
+        $sdk_token_request->setApplicationId('pizza');
+
         $response = $api->generateSdkToken($sdk_token_request);
         if ($response instanceof Onfido_SdkTokenResponse) {
             return $response->getToken() ?? '';

1. Create a new account with a non-public domain on the freePlan beta
2. Create a workspace
3. Tap "Expensify Card"
4. Press "Get Started"
5. Select the "Add account manually" option
6. Follow instructions for creating a Verifying bank account here
7. When you reach the Onfido step cancel out of the flow by pressing the blue arrow to the left
8. Verify you are brought back to the company step
9. Enter the password to move to the next step again
10. Press start button and allow camera access
11. Take a picture of anything
12. The upload should fail and you should be redirected back to the company step + an error growl should appear like so:
    
13. Put the app into the background so logs are flushed and tail to find the log that says:

Unexpected application_id: com.chat.expensify.chat, please check the application_id used when generating the token

Other Platforms

Test we can upload documents without issue with and without the diff applied.

QA Steps

None

Tested On

• Web
• Mobile Web
• Desktop
• iOS
• Android

Screenshots

Web

Mobile Web

Desktop

iOS

Android

[Jag96]

This looks like a good addition to me, and the comments/context is helpful as well.

I couldn't get Onfido to work on desktop or web no matter how hard I tried to take a picture of my ID via my phone. But tested this with the current web-secure changes and it caught the weird error about referrer.

I think reverting the latest secure change locally would be an easy way to test this 👍

[marcaaron]

Ok updated the tests here with a diff to apply that will make the error we experienced more noticeable. I was able to run through Onfido on web by using a passport instead of driver's license. Not too sure why I was having issues with that last week. This should be ready now.

[marcaaron]

P.S. I tested this on Android. And it doesn't look like the onError callback is firing. However, we do end up with this when there's a bad application_id:

Otherwise, I was able to pass Onfido on Android fine after requesting a good token (i.e. without the test diff applied).

[marcochavezf]

The code looks good to me, I was able to reproduce until step 12 in the simulator though. The Onfido didn't fail after capturing a black screen and allowed me to continue with the next steps (I tried 3 times with diff accounts and ensured the setApplicationId is set in web-secure), not sure if I'm missing something 🤔

If I cancel the Onfido process the app comes back to the Company Step 👍🏽

[marcaaron]

The Onfido didn't fail after capturing a black screen and allowed me to continue with the next steps (I tried 3 times with diff accounts and ensured the setApplicationId is set in web-secure), not sure if I'm missing something

To clarify, is your simulator build using the local Web-Secure? What do you have set for EXPENSIFY_URL_SECURE in your .env file and/or are you using ngrok or not?

[marcochavezf]

The Onfido didn't fail after capturing a black screen and allowed me to continue with the next steps (I tried 3 times with diff accounts and ensured the setApplicationId is set in web-secure), not sure if I'm missing something

To clarify, is your simulator build using the local Web-Secure? What do you have set for EXPENSIFY_URL_SECURE in your .env file and/or are you using ngrok or not?

This is my .env:

and I think I was using local Web-Secure because I added a breakpoint in lib/Onfido/API.php (added the line $sdk_token_request->setApplicationId('marco-pizza'); ) and the debugger stopped in that line. I'm going to try later today with USE_NGROK=false

[marcaaron]

Updated this one.

@marcochavezf I'm not sure why this isn't working for you but thought it might have to do with using an iOS simulator. So, I re-tested with a sim instead of my hardware device and did not see what you're seeing there.

[marcaaron]

Here's the error I got while testing iOS simulator:

 LOG  [Error: Encountered an error: upload(OnfidoApiError {
    id = NULL,
    type = bad_application_id,
    message = Unexpected application_id: com.chat.expensify.chat, please check the application_id used when generating the token,
    fields = {}
})]
 DEBUG  [hmmm] Onfido error in RequestorStep - {"error":"Encountered an error: upload(OnfidoApiError {\n    id = NULL,\n    type = bad_application_id,\n    message = Unexpected application_id: com.chat.expensify.chat, please check the application_id used when generating the token,\n    fields = {}\n})"}

[Jag96]

Tests passed for me!

[OSBotify]

✋ 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]

🚀 Deployed to staging by @marcaaron in version: 1.1.1-9 🚀

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

[OSBotify]

🚀 Deployed to production by @timszot in version: 1.1.2-7 🚀

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