8089 Specific error for built-in reader disconnect

When the built in reader disconnects during a payment flow, e.g. because of going in to the background, or recieving a call, we handle the error as non-retryable.

This commit updates the error message to specifically tell the user about this interruption without using the word “disconnected”, which is strange in the context of the built in reader, and informs them about how to continue with the payment.

Author: joshheald

WooCommerce/Classes/ViewModels/CardPresentPayments/CardPresentModalNonRetryableError.swift

@@ -6,9 +6,6 @@ final class CardPresentModalNonRetryableError: CardPresentPaymentsModalViewModel
     /// Amount charged
     private let amount: String
 
-    /// The error returned by the stack
-    private let error: Error
-
     /// Called when the view is dismissed
     private let onDismiss: () -> Void
 
@@ -29,9 +26,7 @@ final class CardPresentModalNonRetryableError: CardPresentPaymentsModalViewModel
 
     let auxiliaryButtonTitle: String? = nil
 
-    var bottomTitle: String? {
-        error.localizedDescription
-    }
+    let bottomTitle: String?
 
     let bottomSubtitle: String? = nil
 
@@ -43,12 +38,16 @@ final class CardPresentModalNonRetryableError: CardPresentPaymentsModalViewModel
         return topTitle + bottomTitle
     }
 
-    init(amount: String, error: Error, onDismiss: @escaping () -> Void) {
+    init(amount: String, errorDescription: String?, onDismiss: @escaping () -> Void) {
         self.amount = amount
-        self.error = error
+        self.bottomTitle = errorDescription
         self.onDismiss = onDismiss
     }
 
+    convenience init(amount: String, error: Error, onDismiss: @escaping () -> Void) {
+        self.init(amount: amount, errorDescription: error.localizedDescription, onDismiss: onDismiss)
+    }
+
     func didTapPrimaryButton(in viewController: UIViewController?) {
         viewController?.dismiss(animated: true) { [weak self] in
             self?.onDismiss()

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

@@ -48,32 +48,16 @@ final class BuiltInCardReaderPaymentAlertsProvider: CardReaderTransactionAlertsP
     }
 
     func error(error: Error, tryAgain: @escaping () -> Void, dismissCompletion: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {
-        let errorDescription: String?
-        if let error = error as? CardReaderServiceError {
-            switch error {
-            case .connection(let underlyingError),
-                    .discovery(let underlyingError),
-                    .disconnection(let underlyingError),
-                    .intentCreation(let underlyingError),
-                    .paymentMethodCollection(let underlyingError),
-                    .paymentCapture(let underlyingError),
-                    .paymentCancellation(let underlyingError),
-                    .softwareUpdate(let underlyingError, _):
-                errorDescription = Localization.errorDescription(underlyingError: underlyingError)
-            default:
-                errorDescription = error.errorDescription
-            }
-        } else {
-            errorDescription = error.localizedDescription
-        }
-        return CardPresentModalError(errorDescription: errorDescription,
+        return CardPresentModalError(errorDescription: builtInReaderDescription(for: error),
                                      transactionType: .collectPayment,
                                      primaryAction: tryAgain,
                                      dismissCompletion: dismissCompletion)
     }
 
     func nonRetryableError(error: Error, dismissCompletion: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {
-        CardPresentModalNonRetryableError(amount: amount, error: error, onDismiss: dismissCompletion)
+        CardPresentModalNonRetryableError(amount: amount,
+                                          errorDescription: builtInReaderDescription(for: error),
+                                          onDismiss: dismissCompletion)
     }
 
     func retryableError(tryAgain: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {
@@ -86,6 +70,26 @@ final class BuiltInCardReaderPaymentAlertsProvider: CardReaderTransactionAlertsP
 }
 
 private extension BuiltInCardReaderPaymentAlertsProvider {
+    func builtInReaderDescription(for error: Error) -> String? {
+        if let error = error as? CardReaderServiceError {
+            switch error {
+            case .connection(let underlyingError),
+                    .discovery(let underlyingError),
+                    .disconnection(let underlyingError),
+                    .intentCreation(let underlyingError),
+                    .paymentMethodCollection(let underlyingError),
+                    .paymentCapture(let underlyingError),
+                    .paymentCancellation(let underlyingError),
+                    .softwareUpdate(let underlyingError, _):
+                return Localization.errorDescription(underlyingError: underlyingError)
+            default:
+                return error.errorDescription
+            }
+        } else {
+            return error.localizedDescription
+        }
+    }
+
     enum Localization {
         static func errorDescription(underlyingError: UnderlyingError) -> String? {
             switch underlyingError {
@@ -102,6 +106,10 @@ private extension BuiltInCardReaderPaymentAlertsProvider {
                     "Sorry, this payment couldn’t be processed",
                     comment: "Error message when the card reader service experiences an unexpected internal service error."
                 )
+            case .notConnectedToReader:
+                return NSLocalizedString(
+                    "The payment was interrupted and cannot be continued. You can retry the payment from the order screen.",
+                    comment: "Error shown when the built-in card reader payment is interrupted by activity on the phone")
             default:
                 return underlyingError.errorDescription
             }