Error Refactor Spike

CHANGELOG.md

@@ -2,9 +2,39 @@
 # PayPal iOS SDK Release Notes
 
 ## unreleased
+* Breaking Changes
+  * PayPalNativePayments
+    * Remove entire PayPalNativePayments module
+  * PayPalWebPayments
+    * Replace delegate pattern with completion handlers and Swift concurrency
+      * Remove `PayPalWebCheckoutDelegate` and `PayPalVaultDelegate`
+      * Remove `start(request:)` method that uses delegate callbacks
+      * Remove `vault(vaultRequest:)` method that uses delegate callbacks
+      * Add `start(request:completion(PayPalWebCheckoutResult?, CoreSDKError?) -> Void)` to `PayPalWebCheckoutClient`
+      * Add `vault(vaultRequest:completion(PayPalVaultResult?, CoreSDKError?) -> Void)` to `PayPalWebCheckoutClient`
+      * Add `start(request:) async throws -> PayPalCheckoutResult`
+      * Add `vault(vaultRequest:) async throws -> PayPalVaultResult`
+  * CardPayments
+    * Replace delegate pattern with completion handlers and Swift concurrency
+      * Remove `CardDelegate` and `CardVaultDelegate`
+      * Remove `approveOrder(request:)` method that uses delegate callbacks
+      * Remove `vault(vaultRequest:)` method that uses delegate callbacks
+      * Add `approveOrder(request:completion:(CardResult?, CoreSDKError?) -> Void)` to `CardClient`
+      * Add `vault(request:completion:(CardVaultResult?, CoreSDKError?) -> Void)` to `CardClient`
+      * Add `approveOrder(request:) async throws -> CardResult`
+      * Add `vault(vaultRequest:) async throws -> CardVaultResult`   
 * PayPalWebPayments
   * Deprecate `PayPalVaultRequest(url:setupTokenID:)`
   * Add `PayPalVaultRequest(setupTokenID:)`
+  * Rename `PayPalWebCheckoutClientError` to `PayPalError`
+  * Add `.checkoutCanceledError` and `vaultCanceledError` to `PayPalError`
+  * Add public static functions `isCheckoutCanceled(Error)` and `isVaultCanceled(Error)` to `PayPalError` to distinguish cancellation errors in PayPal flows. 
+  * Make `PayPalError` public to expose cancellation error handling helpers
+* CardPayments
+  * Rename `CardClientError` to `CardError`
+  * Add `threeDSecureCanceledError` to `CardError`
+  * Add public static function `isThreeDSecureCanceled(Error)` to `CardError` to distinguish cancellation error from threeDSecure verification
+  * Make `CardError` public to expose cancellation error handling helper
 
 ## 1.4.0 (2024-07-09)
 * PayPalNativePayments (DEPRECATED)  

Demo/Demo/Networking/DemoMerchantAPI.swift

@@ -116,18 +116,6 @@ final class DemoMerchantAPI {
         return try parse(from: data)
     }
 
-    /// This function replicates a way a merchant may go about patching an order on their server and is not part of the SDK flow.
-    /// - Parameters:
-    ///   - updateOrderParams: the parameters to update the order with
-    /// - Throws: an error explaining why patching the order failed
-    func updateOrder(_ updateOrderParams: UpdateOrderParams, selectedMerchantIntegration: MerchantIntegration) async throws {
-        guard let url = buildBaseURL(with: "/orders/" + updateOrderParams.orderID) else {
-            throw URLResponseError.invalidURL
-        }
-        let urlRequest = buildURLRequest(method: "PATCH", url: url, body: updateOrderParams.updateOperations)
-        _ = try await data(for: urlRequest)
-    }
-
     /// This function fetches a clientID to initialize any module of the SDK
     /// - Parameters:
     ///   - environment: the current environment

Demo/Demo/SwiftUIComponents/FeatureSelectionView.swift

@@ -49,11 +49,6 @@ struct FeatureSelectionView: View {
                     } label: {
                         Text("PayPal Vaulting")
                     }
-                    NavigationLink {
-                        SwiftUINativeCheckoutDemo()
-                    } label: {
-                        Text("Native Checkout")
-                    }
                     NavigationLink {
                         SwiftUIPaymentButtonDemo()
                     } label: {

Demo/Demo/SwiftUIComponents/PayPalVaultViews/PayPalVaultView.swift

@@ -15,13 +15,18 @@ struct PayPalVaultView: View {
                     )
                     SetupTokenResultView(vaultViewModel: paypalVaultViewModel)
                     if let setupTokenID = paypalVaultViewModel.state.setupToken?.id {
-                        Button("Vault PayPal") {
-                            Task {
-                                await paypalVaultViewModel.vault(setupTokenID: setupTokenID)
+                        ZStack {
+                            Button("Vault PayPal") {
+                                Task {
+                                    await paypalVaultViewModel.vault(setupTokenID: setupTokenID)
+                                }
+                            }
+                            .buttonStyle(RoundedBlueButtonStyle())
+                            .padding()
+                            if case .loading = paypalVaultViewModel.state.paypalVaultTokenResponse {
+                                CircularProgressView()
                             }
                         }
-                        .buttonStyle(RoundedBlueButtonStyle())
-                        .padding()
                     }
                     PayPalVaultResultView(viewModel: paypalVaultViewModel)
                     if let paypalVaultResult = paypalVaultViewModel.state.paypalVaultToken {

Demo/Demo/SwiftUIComponents/PayPalWebPayments/PayPalWebButtonsView.swift

@@ -24,19 +24,25 @@ struct PayPalWebButtonsView: View {
                     Text("Pay Later").tag(PayPalWebCheckoutFundingSource.paylater)
                 }
                 .pickerStyle(SegmentedPickerStyle())
-
-                switch selectedFundingSource {
-                case .paypalCredit:
-                    PayPalCreditButton.Representable(color: .black, size: .full) {
-                        payPalWebViewModel.paymentButtonTapped(funding: .paypalCredit)
-                    }
-                case .paylater:
-                    PayPalPayLaterButton.Representable(color: .silver, edges: .softEdges, size: .full) {
-                        payPalWebViewModel.paymentButtonTapped(funding: .paylater)
+                ZStack {
+                    switch selectedFundingSource {
+                    case .paypalCredit:
+                        PayPalCreditButton.Representable(color: .black, size: .full) {
+                            payPalWebViewModel.paymentButtonTapped(funding: .paypalCredit)
+                        }
+                    case .paylater:
+                        PayPalPayLaterButton.Representable(color: .silver, edges: .softEdges, size: .full) {
+                            payPalWebViewModel.paymentButtonTapped(funding: .paylater)
+                        }
+                    case .paypal:
+                        PayPalButton.Representable(color: .blue, size: .full) {
+                            payPalWebViewModel.paymentButtonTapped(funding: .paypal)
+                        }
                     }
-                case .paypal:
-                    PayPalButton.Representable(color: .blue, size: .full) {
-                        payPalWebViewModel.paymentButtonTapped(funding: .paypal)
+                    if payPalWebViewModel.state == .loading &&
+                        payPalWebViewModel.checkoutResult == nil &&
+                        payPalWebViewModel.orderID != nil {
+                        CircularProgressView()
                     }
                 }
             }

Demo/Demo/SwiftUIComponents/PayPalWebPayments/PayPalWebCreateOrderView.swift

@@ -40,7 +40,7 @@ struct PayPalWebCreateOrderView: View {
                     }
                 }
                 .buttonStyle(RoundedBlueButtonStyle())
-                if payPalWebViewModel.state == .loading && payPalWebViewModel.checkoutResult == nil {
+                if payPalWebViewModel.state == .loading && payPalWebViewModel.checkoutResult == nil && payPalWebViewModel.orderID == nil {
                     CircularProgressView()
                 }
             }

Demo/Demo/SwiftUIComponents/PayPalWebPayments/PayPalWebViewModel.swift

@@ -3,7 +3,7 @@ import CorePayments
 import PayPalWebPayments
 import FraudProtection
 
-class PayPalWebViewModel: ObservableObject, PayPalWebCheckoutDelegate {
+class PayPalWebViewModel: ObservableObject {
 
     @Published var state: CurrentState = .idle
     @Published var intent: Intent = .authorize
@@ -62,16 +62,28 @@ class PayPalWebViewModel: ObservableObject, PayPalWebCheckoutDelegate {
     func paymentButtonTapped(funding: PayPalWebCheckoutFundingSource) {
         Task {
             do {
+                self.updateState(.loading)
                 payPalWebCheckoutClient = try await getPayPalClient()
-                payPalWebCheckoutClient?.delegate = self
                 guard let payPalWebCheckoutClient else {
                     print("Error initializing PayPalWebCheckoutClient")
                     return
                 }
 
                 if let orderID {
                     let payPalRequest = PayPalWebCheckoutRequest(orderID: orderID, fundingSource: funding)
-                    payPalWebCheckoutClient.start(request: payPalRequest)
+                    payPalWebCheckoutClient.start(request: payPalRequest) { result, error in
+                        if let error {
+                            if PayPalError.isCheckoutCanceled(error) {
+                                print("Canceled")
+                                self.updateState(.idle)
+                            } else {
+                                self.updateState(.error(message: error.localizedDescription))
+                            }
+                        } else {
+                            self.updateState(.success)
+                            self.checkoutResult = result
+                        }
+                    }
                 }
                 updateState(.success)
             } catch {
@@ -131,22 +143,4 @@ class PayPalWebViewModel: ObservableObject, PayPalWebCheckoutDelegate {
             self.state = state
         }
     }
-
-    // MARK: - PayPalWeb Checkout Delegate
-
-    func payPal(
-        _ payPalClient: PayPalWebCheckoutClient,
-        didFinishWithResult result: PayPalWebCheckoutResult
-    ) {
-        updateState(.success)
-        checkoutResult = result
-    }
-
-    func payPal(_ payPalClient: PayPalWebCheckoutClient, didFinishWithError error: CoreSDKError) {
-        updateState(.error(message: error.localizedDescription))
-    }
-
-    func payPalDidCancel(_ payPalClient: PayPalWebCheckoutClient) {
-        print("PayPal Checkout Canceled")
-    }
 }