Add BTVenmoError.canceled case (#1087)

---------

Signed-off-by: Jax DesMarais-Leder <[email protected]>

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## unreleased
 * BraintreeVenmo
   * Add additional error parsing for Venmo errors
+  * Throw cancelation specific error for `BTVenmoClient.tokenize()` (fixes #1085) 
+    * _The callback style version of this function previously returned `(nil, nil)` for the cancel scenario, but will now return `(nil, error)` instead._
 * BraintreeCore
   * Send `live` instead of `production` for the `merchant_sdk_env` tag to PayPal's analytics service (FPTI)
 

Demo/Application/Features/Venmo - Custom Button/BraintreeDemoVenmoViewController.swift

@@ -80,7 +80,11 @@ class BraintreeDemoVenmoViewController: BraintreeDemoPaymentButtonBaseViewContro
                 progressBlock("Got a nonce 💎!")
                 completionBlock(venmoAccount)
             } catch {
-                progressBlock(error.localizedDescription)
+                if (error as NSError).code == 10 {
+                    progressBlock("Canceled 🔰")
+                } else {
+                    progressBlock(error.localizedDescription)
+                }
             }
         }
     }

Demo/Demo.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 52;
+	objectVersion = 54;
 	objects = {
 
 /* Begin PBXBuildFile section */

Demo/UI Tests/Venmo UI Tests/Venmo_UITests.swift

@@ -58,13 +58,12 @@ class Venmo_UITests: XCTestCase {
         XCTAssertTrue(demoApp.buttons["An error occurred during the Venmo flow"].waitForExistence(timeout: 15))
     }
 
-    // TODO: - Uncomment test once cancel case is handled as an error
-//    func testTokenizeVenmo_whenUserCancels_returnsCancel() {
-//        demoApp.buttons["Venmo"].tap()
-//        
-//        waitForElementToBeHittable(mockVenmo.buttons["Cancel"])
-//        mockVenmo.buttons["Cancel"].tap()
-//
-//        XCTAssertTrue(demoApp.buttons["Canceled 🔰"].waitForExistence(timeout: 15))
-//    }
+    func testTokenizeVenmo_whenUserCancels_returnsCancel() {
+        demoApp.buttons["Venmo"].tap()
+
+        waitForElementToBeHittable(mockVenmo.buttons["Cancel"])
+        mockVenmo.buttons["Cancel"].tap()
+
+        XCTAssertTrue(demoApp.buttons["Canceled 🔰"].waitForExistence(timeout: 15))
+    }
 }

SDK_ERROR_CODES.md

@@ -136,3 +136,4 @@ See below for a comprehensive list of error types and codes thrown by each featu
     | BTVenmoError.invalidRedirectURL | 7 |
     | BTVenmoError.fetchConfigurationFailed | 8 |
     | BTVenmoError.enrichedCustomerDataDisabled | 9 |
+    | BTVenmoError.canceled | 10 |

Sources/BraintreeVenmo/BTVenmoClient.swift

@@ -54,7 +54,8 @@ import BraintreeCore
     /// - Parameters:
     ///   - request: A Venmo request.
     ///   - completion: This completion will be invoked when app switch is complete or an error occurs. On success, you will receive
-    ///   an instance of `BTVenmoAccountNonce`; on failure, an error; on user cancellation, you will receive `nil` for both parameters.
+    ///   an instance of `BTVenmoAccountNonce`; on failure or user cancelation you will receive an error.
+    ///   If the user cancels out of the flow, the error code will be `.canceled`.
     @objc(tokenizeWithVenmoRequest:completion:)
     public func tokenize(_ request: BTVenmoRequest, completion: @escaping (BTVenmoAccountNonce?, Error?) -> Void) {
         apiClient.sendAnalyticsEvent(BTVenmoAnalytics.tokenizeStarted)
@@ -205,7 +206,7 @@ import BraintreeCore
     /// Initiates Venmo login via app switch, which returns a BTVenmoAccountNonce when successful.
     /// - Parameter request: A `BTVenmoRequest`
     /// - Returns: On success, you will receive an instance of `BTVenmoAccountNonce`
-    /// - Throws: An `Error` describing the failure
+    /// - Throws: An `Error` describing the failure. If the user cancels out of the flow, the error code will be `.canceled`.
     public func tokenize(_ request: BTVenmoRequest) async throws -> BTVenmoAccountNonce {
         try await withCheckedThrowingContinuation { continuation in
             tokenize(request) { nonce, error in
@@ -415,7 +416,7 @@ import BraintreeCore
 
     private func notifyCancel(completion: @escaping (BTVenmoAccountNonce?, Error?) -> Void) {
         apiClient.sendAnalyticsEvent(BTVenmoAnalytics.appSwitchCanceled)
-        completion(nil, nil)
+        completion(nil, BTVenmoError.canceled)
     }
 }
 

Sources/BraintreeVenmo/BTVenmoError.swift

@@ -57,6 +57,9 @@ enum BTVenmoError: Error, CustomNSError, LocalizedError {
 
     /// 9. Enriched Customer Data is disabled
     case enrichedCustomerDataDisabled
+
+    /// 10.  The Venmo flow was canceled by the user
+    case canceled
 
     static var errorDomain: String {
         "com.braintreepayments.BTVenmoErrorDomain"
@@ -84,6 +87,8 @@ enum BTVenmoError: Error, CustomNSError, LocalizedError {
             return 8
         case .enrichedCustomerDataDisabled:
             return 9
+        case .canceled:
+            return 10
         }
     }
 
@@ -109,6 +114,8 @@ enum BTVenmoError: Error, CustomNSError, LocalizedError {
             return "Failed to fetch Braintree configuration."
         case .enrichedCustomerDataDisabled:
             return "Cannot collect customer data when ECD is disabled. Enable this feature in the Control Panel to collect this data."
+        case .canceled:
+            return "Venmo flow was canceled by the user."
         }
     }
 }

UnitTests/BraintreeVenmoTests/BTVenmoClient_Tests.swift

@@ -613,7 +613,7 @@ class BTVenmoClient_Tests: XCTestCase {
         XCTAssertEqual(mockAPIClient.postedAnalyticsEvents.last!, BTVenmoAnalytics.tokenizeFailed)
     }
 
-    func testTokenizeVenmoAccount_whenAppSwitchCanceled_callsBackWithNoError() {
+    func testTokenizeVenmoAccount_whenAppSwitchCanceled_callsBackWithCancelError() {
         let venmoClient = BTVenmoClient(apiClient: mockAPIClient)
         venmoClient.application = FakeApplication()
         venmoClient.bundle = FakeBundle()
@@ -622,7 +622,12 @@ class BTVenmoClient_Tests: XCTestCase {
         let expectation = expectation(description: "Callback invoked")
         venmoClient.tokenize(venmoRequest) { venmoAccount, error in
             XCTAssertNil(venmoAccount)
-            XCTAssertNil(error)
+            XCTAssertNotNil(error)
+
+            let error = error! as NSError
+            XCTAssertEqual(error.localizedDescription, BTVenmoError.canceled.localizedDescription)
+            XCTAssertEqual(error.code, 10)
+
             expectation.fulfill()
         }
         BTVenmoClient.handleReturnURL(URL(string: "scheme://x-callback-url/vzero/auth/venmo/cancel")!)