8085 Combine cancellation reasons in underlyingerror

Author: joshheald

Hardware/Hardware/CardReader/StripeCardReader/StripeCardReaderService.swift

@@ -507,11 +507,15 @@ private extension StripeCardReaderService {
                     /// the completion block for collectPaymentMethod will be called
                     /// with error Canceled when collectPaymentMethod is canceled
                     /// https://stripe.dev/stripe-terminal-ios/docs/Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:delegate:completion:
-                    if underlyingError == .commandCancelled {
+                    if case .commandCancelled(let cancellationSource) = underlyingError {
                         DDLogWarn("💳 Warning: collect payment cancelled \(error)")
                         /// If we've not used the cancellable in the app, the cancellation must have come from the reader
-                        if self?.paymentCancellable != nil {
-                            underlyingError = .commandCancelledOnReader
+                        if case .unknown = cancellationSource {
+                            if self?.paymentCancellable != nil {
+                                underlyingError = .commandCancelled(from: .reader)
+                            } else {
+                                underlyingError = .commandCancelled(from: .app)
+                            }
                         }
                     } else {
                         DDLogError("💳 Error: collect payment method \(underlyingError)")

Hardware/Hardware/CardReader/StripeCardReader/UnderlyingError+Stripe.swift

@@ -26,7 +26,7 @@ extension UnderlyingError {
         case ErrorCode.Code.featureNotAvailableWithConnectedReader.rawValue:
             self = .featureNotAvailableWithConnectedReader
         case ErrorCode.Code.canceled.rawValue:
-            self = .commandCancelled
+            self = .commandCancelled(from: .unknown)
         case ErrorCode.Code.locationServicesDisabled.rawValue:
             self = .locationServicesDisabled
         case ErrorCode.Code.bluetoothDisabled.rawValue:

Hardware/Hardware/CardReader/UnderlyingError.swift

@@ -27,11 +27,15 @@ public enum UnderlyingError: Error, Equatable {
     case featureNotAvailableWithConnectedReader
 
     /// A command was cancelled
-    case commandCancelled
-
-    /// A command was cancelled on the reader.
-    /// Note that this is not produced by Stripe, we have to infer it from commandCancelled.
-    case commandCancelledOnReader
+    case commandCancelled(from: CancellationSource)
+
+    /// A command can be cancelled on the reader, or in the app.
+    /// Note that this is not produced by Stripe, we have to infer it from commandCancelled, so we start with `.unknown`.
+    public enum CancellationSource {
+        case unknown
+        case app
+        case reader
+    }
 
     /// Access to location services is currently disabled. This may be because:
     /// - The user disabled location services in the system settings.
@@ -286,12 +290,15 @@ extension UnderlyingError: LocalizedError {
         case .featureNotAvailableWithConnectedReader:
             return NSLocalizedString("Unable to perform request with the connected reader - unsupported feature - please try again with another reader",
                                      comment: "Error message when the card reader cannot be used to perform the requested task.")
-        case .commandCancelled:
-            return NSLocalizedString("The system canceled the command unexpectedly - please try again",
-                                     comment: "Error message when the system cancels a command.")
-        case .commandCancelledOnReader:
-            return NSLocalizedString("The payment was canceled on the reader",
-                                     comment: "Error message when the cancel button on the reader is used.")
+        case .commandCancelled(let cancellationSource):
+            switch cancellationSource {
+            case .reader:
+                return NSLocalizedString("The payment was canceled on the reader",
+                                         comment: "Error message when the cancel button on the reader is used.")
+            default:
+                return NSLocalizedString("The system canceled the command unexpectedly - please try again",
+                                         comment: "Error message when the system cancels a command.")
+            }
         case .locationServicesDisabled:
             return NSLocalizedString("Unable to access Location Services - please enable Location Services and try again",
                                      comment: "Error message when location services is not enabled for this application.")

WooCommerce/Classes/ViewRelated/Dashboard/Settings/CardReadersV2/BluetoothCardReaderPaymentAlertsProvider.swift

@@ -90,7 +90,7 @@ final class BluetoothCardReaderPaymentAlertsProvider: CardReaderTransactionAlert
 
     func cancelledOnReader() -> CardPresentPaymentsModalViewModel? {
         CardPresentModalNonRetryableError(amount: amount,
-                                          error: CardReaderServiceError.paymentMethodCollection(underlyingError: .commandCancelledOnReader),
+                                          error: CardReaderServiceError.paymentMethodCollection(underlyingError: .commandCancelled(from: .reader)),
                                           onDismiss: { })
     }
 }

WooCommerce/Classes/ViewRelated/Orders/Collect Payments/CollectOrderPaymentUseCase.swift

@@ -274,10 +274,13 @@ private extension CollectOrderPaymentUseCase {
                 switch result {
                 case .success(let capturedPaymentData):
                     self?.handleSuccessfulPayment(capturedPaymentData: capturedPaymentData, onCompletion: onCompletion)
-                case .failure(CardReaderServiceError.paymentMethodCollection(.commandCancelledOnReader)):
-                    self?.handlePaymentCancellationFromReader(alertProvider: paymentAlerts)
-                case .failure(CardReaderServiceError.paymentMethodCollection(.commandCancelled)):
-                    self?.handlePaymentCancellation()
+                case .failure(CardReaderServiceError.paymentMethodCollection(.commandCancelled(let cancellationSource))):
+                    switch cancellationSource {
+                    case .reader:
+                        self?.handlePaymentCancellationFromReader(alertProvider: paymentAlerts)
+                    default:
+                        self?.handlePaymentCancellation()
+                    }
                 case .failure(let error):
                     self?.handlePaymentFailureAndRetryPayment(error, alertProvider: paymentAlerts, onCompletion: onCompletion)
                 }

WooCommerce/Classes/ViewRelated/Orders/Collect Payments/LegacyCollectOrderPaymentUseCase.swift

@@ -293,8 +293,7 @@ private extension LegacyCollectOrderPaymentUseCase {
                 switch result {
                 case .success(let capturedPaymentData):
                     self?.handleSuccessfulPayment(capturedPaymentData: capturedPaymentData, onCompletion: onCompletion)
-                case .failure(CardReaderServiceError.paymentMethodCollection(.commandCancelledOnReader)),
-                        .failure(CardReaderServiceError.paymentMethodCollection(.commandCancelled)):
+                case .failure(CardReaderServiceError.paymentMethodCollection(.commandCancelled(_))):
                     self?.trackPaymentCancelation()
                     onCompletion(.failure(CollectOrderPaymentUseCaseError.flowCanceledByUser))
                 case .failure(let error):