Merge pull request #8757 from woocommerce/issue/8750-fix-retry-on-built-in-connection-errors

[Mobile Payments] Start search again when Try Again tapped on Built-in reader connection errors

Author: joshheald

Hardware/Hardware/CardReader/StripeCardReader/StripeCardReaderService.swift

@@ -470,10 +470,6 @@ extension StripeCardReaderService: CardReaderService {
                         .softwareUpdate(underlyingError: underlyingError, batteryLevel: nil) :
                         .connection(underlyingError: underlyingError)
                     promise(.failure(serviceError))
-
-                    if case .appleBuiltInReaderTOSAcceptanceCanceled = underlyingError {
-                        self.discoveryCancellable?.cancel({ _ in })
-                    }
                 }
 
                 if let reader = reader {

WooCommerce/Classes/ViewModels/CardPresentPayments/CardPresentModalConnectingFailed.swift

@@ -4,7 +4,7 @@ import Yosemite
 /// Modal presented when an error occurs while connecting to a reader
 ///
 final class CardPresentModalConnectingFailed: CardPresentPaymentsModalViewModel {
-    private let continueSearchAction: () -> Void
+    private let retrySearchAction: () -> Void
     private let cancelSearchAction: () -> Void
 
     let textMode: PaymentsModalTextMode = .reducedTopInfo
@@ -31,9 +31,9 @@ final class CardPresentModalConnectingFailed: CardPresentPaymentsModalViewModel
     }
 
     init(error: Error,
-         continueSearch: @escaping () -> Void,
+         retrySearch: @escaping () -> Void,
          cancelSearch: @escaping () -> Void) {
-        self.continueSearchAction = continueSearch
+        self.retrySearchAction = retrySearch
         self.cancelSearchAction = cancelSearch
 
         switch error {
@@ -45,7 +45,7 @@ final class CardPresentModalConnectingFailed: CardPresentPaymentsModalViewModel
     }
 
     func didTapPrimaryButton(in viewController: UIViewController?) {
-        continueSearchAction()
+        retrySearchAction()
     }
 
     func didTapSecondaryButton(in viewController: UIViewController?) {

WooCommerce/Classes/ViewRelated/CardPresentPayments/BuiltInCardReaderConnectionController.swift

@@ -231,6 +231,13 @@ private extension BuiltInCardReaderConnectionController {
                 /// discovered changes, so some care around state must be taken here.
                 ///
 
+                /// To avoid interrupting connecting to a known reader, ensure we are
+                /// in the searching state before proceeding further
+                ///
+                guard case .searching = self.state else {
+                    return
+                }
+
                 /// If we have a found reader, advance to `connectToReader`
                 ///
                 if cardReaders.isNotEmpty {
@@ -441,19 +448,14 @@ private extension BuiltInCardReaderConnectionController {
             self.state = .retry
         }
 
-        // TODO: Consider removing this in favour of retry only – continue doesn't make sense for a built-in reader
-        let continueSearch = {
-            self.state = .searching
-        }
-
         let cancelSearch = {
             self.state = .cancel(.connectionError)
         }
 
         guard case CardReaderServiceError.connection(let underlyingError) = error else {
             return alertsPresenter.present(
                 viewModel: alertsProvider.connectingFailed(error: error,
-                                                           continueSearch: continueSearch,
+                                                           retrySearch: retrySearch,
                                                            cancelSearch: cancelSearch))
         }
 
@@ -475,7 +477,7 @@ private extension BuiltInCardReaderConnectionController {
                 alertsPresenter.present(
                     viewModel: alertsProvider.connectingFailed(
                         error: error,
-                        continueSearch: continueSearch,
+                        retrySearch: retrySearch,
                         cancelSearch: cancelSearch))
             } else {
                 alertsPresenter.present(

WooCommerce/Classes/ViewRelated/CardPresentPayments/CardReaderConnectionController.swift

@@ -645,7 +645,7 @@ private extension CardReaderConnectionController {
         guard case CardReaderServiceError.connection(let underlyingError) = error else {
             return alertsPresenter.present(
                 viewModel: alertsProvider.connectingFailed(error: error,
-                                                           continueSearch: continueSearch,
+                                                           retrySearch: continueSearch,
                                                            cancelSearch: cancelSearch))
         }
 
@@ -668,10 +668,12 @@ private extension CardReaderConnectionController {
                     retrySearch: retrySearch,
                     cancelSearch: cancelSearch))
         default:
+            // We continueSearch here from a button labeled `Try again`, rather than retrying from the beginning,
+            // this is because the original reader can be re-discovered in the same process.
             alertsPresenter.present(
                 viewModel: alertsProvider.connectingFailed(
                     error: error,
-                    continueSearch: continueSearch,
+                    retrySearch: continueSearch,
                     cancelSearch: cancelSearch))
         }
     }

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

@@ -16,9 +16,9 @@ struct BluetoothReaderConnectionAlertsProvider: BluetoothReaderConnnectionAlerts
     }
 
     func connectingFailed(error: Error,
-                          continueSearch: @escaping () -> Void,
+                          retrySearch: @escaping () -> Void,
                           cancelSearch: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {
-        CardPresentModalConnectingFailed(error: error, continueSearch: continueSearch, cancelSearch: cancelSearch)
+        CardPresentModalConnectingFailed(error: error, retrySearch: retrySearch, cancelSearch: cancelSearch)
     }
 
     func connectingFailedNonRetryable(error: Error, close: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {

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

@@ -16,10 +16,10 @@ struct BuiltInReaderConnectionAlertsProvider: CardReaderConnectionAlertsProvidin
     }
 
     func connectingFailed(error: Error,
-                          continueSearch: @escaping () -> Void,
+                          retrySearch: @escaping () -> Void,
                           cancelSearch: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {
         CardPresentModalBuiltInConnectingFailed(error: error,
-                                                continueSearch: continueSearch,
+                                                continueSearch: retrySearch,
                                                 cancelSearch: cancelSearch)
     }
 

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

@@ -23,7 +23,7 @@ protocol CardReaderConnectionAlertsProviding {
     /// or cancel
     ///
     func connectingFailed(error: Error,
-                          continueSearch: @escaping () -> Void,
+                          retrySearch: @escaping () -> Void,
                           cancelSearch: @escaping () -> Void) -> CardPresentPaymentsModalViewModel
 
     /// Defines an alert indicating connecting failed, in a way which must be resolved outside

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

@@ -190,7 +190,7 @@ private extension CardReaderSettingsAlerts {
     func connectingFailed(error: Error,
                           continueSearch: @escaping () -> Void,
                           cancelSearch: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {
-        CardPresentModalConnectingFailed(error: error, continueSearch: continueSearch, cancelSearch: cancelSearch)
+        CardPresentModalConnectingFailed(error: error, retrySearch: continueSearch, cancelSearch: cancelSearch)
     }
 
     func connectingFailedUpdateAddress(openWCSettings: ((UIViewController) -> Void)?,

WooCommerce/WooCommerceTests/ViewModels/CardPresentPayments/CardPresentModalConnectingFailedTests.swift

@@ -12,7 +12,7 @@ final class CardPresentModalConnectingFailedTests: XCTestCase {
         closures = Closures()
         viewModel = CardPresentModalConnectingFailed(
             error: CardReaderServiceError.connection(underlyingError: .alreadyConnectedToReader),
-            continueSearch: closures.continueSearch(),
+            retrySearch: closures.continueSearch(),
             cancelSearch: closures.cancelSearch()
         )
     }