Merge pull request #8195 from woocommerce/issue/8080-refactor-connection-alerts-presentation

[Mobile Payments] Remove viewController from CardReaderConnectionController

Author: joshheald

WooCommerce/Classes/ViewRelated/CardPresentPayments/CardPresentPaymentPreflightController.swift

@@ -20,9 +20,9 @@ final class CardPresentPaymentPreflightController {
     ///
     private let configuration: CardPresentPaymentsConfiguration
 
-    /// View Controller used to present alerts.
+    /// Alerts presenter to send alert view models
     ///
-    private var rootViewController: UIViewController
+    private var alertsPresenter: CardPresentPaymentAlertsPresenting
 
     /// Stores manager.
     ///
@@ -38,32 +38,32 @@ final class CardPresentPaymentPreflightController {
 
     /// Controller to connect a card reader.
     ///
-    private var connectionController: LegacyCardReaderConnectionController
+    private var connectionController: CardReaderConnectionController
 
 
     private(set) var readerConnection = CurrentValueSubject<CardReaderConnectionResult?, Never>(nil)
 
     init(siteID: Int64,
          paymentGatewayAccount: PaymentGatewayAccount,
          configuration: CardPresentPaymentsConfiguration,
-         rootViewController: UIViewController,
+         alertsPresenter: CardPresentPaymentAlertsPresenting,
          stores: StoresManager = ServiceLocator.stores,
          analytics: Analytics = ServiceLocator.analytics) {
         self.siteID = siteID
         self.paymentGatewayAccount = paymentGatewayAccount
         self.configuration = configuration
-        self.rootViewController = rootViewController
+        self.alertsPresenter = alertsPresenter
         self.stores = stores
         self.analytics = analytics
         self.connectedReader = nil
         let analyticsTracker = CardReaderConnectionAnalyticsTracker(configuration: configuration,
                                                                     stores: stores,
                                                                     analytics: analytics)
         // TODO: Replace this with a refactored (New)LegacyCardReaderConnectionController
-        self.connectionController = LegacyCardReaderConnectionController(
+        self.connectionController = CardReaderConnectionController(
             forSiteID: siteID,
             knownReaderProvider: CardReaderSettingsKnownReaderStorage(),
-            alertsProvider: CardReaderSettingsAlerts(),
+            alertsPresenter: alertsPresenter,
             configuration: configuration,
             analyticsTracker: analyticsTracker)
     }
@@ -81,7 +81,7 @@ final class CardPresentPaymentPreflightController {
         // TODO: Ask for a Reader type if supported by device
 
         // Attempt to find a reader and connect
-        connectionController.searchAndConnect(from: rootViewController) { result in
+        connectionController.searchAndConnect { result in
             let connectionResult = result.map { connection in
                 switch connection {
                 case .connected:

WooCommerce/Classes/ViewRelated/CardPresentPayments/CardReaderConnectionController.swift

@@ -83,10 +83,10 @@ final class CardReaderConnectionController {
             didSetState()
         }
     }
-    private weak var fromController: UIViewController?
+
     private let siteID: Int64
     private let knownCardReaderProvider: CardReaderSettingsKnownReaderProvider
-    private let alerts: CardReaderSettingsAlertsProvider
+    private let alertsPresenter: CardPresentPaymentAlertsPresenting
     private let configuration: CardPresentPaymentsConfiguration
 
     /// Reader(s) discovered by the card reader service
@@ -139,7 +139,7 @@ final class CardReaderConnectionController {
         storageManager: StorageManagerType = ServiceLocator.storageManager,
         stores: StoresManager = ServiceLocator.stores,
         knownReaderProvider: CardReaderSettingsKnownReaderProvider,
-        alertsProvider: CardReaderSettingsAlertsProvider,
+        alertsPresenter: CardPresentPaymentAlertsPresenting,
         configuration: CardPresentPaymentsConfiguration,
         analyticsTracker: CardReaderConnectionAnalyticsTracker
     ) {
@@ -148,7 +148,7 @@ final class CardReaderConnectionController {
         self.stores = stores
         state = .idle
         knownCardReaderProvider = knownReaderProvider
-        alerts = alertsProvider
+        self.alertsPresenter = alertsPresenter
         foundReaders = []
         knownReaderID = nil
         skippedReaderIDs = []
@@ -163,12 +163,7 @@ final class CardReaderConnectionController {
         subscriptions.removeAll()
     }
 
-    func searchAndConnect(from: UIViewController?, onCompletion: @escaping (Result<ConnectionResult, Error>) -> Void) {
-        guard from != nil else {
-            return
-        }
-
-        self.fromController = from
+    func searchAndConnect(onCompletion: @escaping (Result<ConnectionResult, Error>) -> Void) {
         self.onCompletion = onCompletion
         self.state = .initializing
     }
@@ -347,7 +342,7 @@ private extension CardReaderConnectionController {
                 /// If the found-several-readers view is already presenting, update its list of found readers
                 ///
                 if case .foundSeveralReaders = self.state {
-                    self.alerts.updateSeveralReadersList(readerIDs: self.getFoundReaderIDs())
+                    self.alertsPresenter.updateSeveralReadersList(readerIDs: self.getFoundReaderIDs())
                 }
 
                 /// To avoid interrupting connecting to a known reader, ensure we are
@@ -404,10 +399,6 @@ private extension CardReaderConnectionController {
     /// If the user cancels the modal will trigger a transition to `.endSearch`
     ///
     func onSearching() {
-        guard let from = fromController else {
-            return
-        }
-
         /// If we enter this state and another reader was discovered while the
         /// "Do you want to connect to" modal was being displayed and if that reader
         /// is known and the merchant tapped keep searching on the first
@@ -438,9 +429,9 @@ private extension CardReaderConnectionController {
         /// If all else fails, display the "scanning" modal and
         /// stay in this state
         ///
-        alerts.scanningForReader(from: from, cancel: {
+        alertsPresenter.present(viewModel: CardPresentModalScanningForReader(cancel: {
             self.state = .cancel
-        })
+        }))
     }
 
     /// A (unknown) reader has been found
@@ -451,37 +442,28 @@ private extension CardReaderConnectionController {
             return
         }
 
-        guard let from = fromController else {
-            return
-        }
-
-        alerts.foundReader(
-            from: from,
-            name: candidateReader.id,
-            connect: {
-                self.state = .connectToReader
-            },
-            continueSearch: {
-                self.skippedReaderIDs.append(candidateReader.id)
-                self.candidateReader = nil
-                self.pruneSkippedReaders()
-                self.state = .searching
-            },
-            cancelSearch: { [weak self] in
-                self?.state = .cancel
-            })
+        alertsPresenter.present(
+            viewModel: CardPresentModalFoundReader(
+                name: candidateReader.id,
+                connect: {
+                    self.state = .connectToReader
+                },
+                continueSearch: {
+                    self.skippedReaderIDs.append(candidateReader.id)
+                    self.candidateReader = nil
+                    self.pruneSkippedReaders()
+                    self.state = .searching
+                },
+                cancel: { [weak self] in
+                    self?.state = .cancel
+                }))
     }
 
     /// Several readers have been found
     /// Opens a continually updating list modal for the user to pick one (or cancel the search)
     ///
     func onFoundSeveralReaders() {
-        guard let from = fromController else {
-            return
-        }
-
-        alerts.foundSeveralReaders(
-            from: from,
+        alertsPresenter.foundSeveralReaders(
             readerIDs: getFoundReaderIDs(),
             connect: { [weak self] readerID in
                 guard let self = self else {
@@ -499,10 +481,6 @@ private extension CardReaderConnectionController {
     /// A mandatory update is being installed
     ///
     func onUpdateProgress(progress: Float) {
-        guard let from = fromController else {
-            return
-        }
-
         let cancel = softwareUpdateCancelable.map { cancelable in
             return { [weak self] in
                 guard let self = self else { return }
@@ -518,16 +496,16 @@ private extension CardReaderConnectionController {
             }
         }
 
-        alerts.updateProgress(from: from,
-                              requiredUpdate: true,
-                              progress: progress,
-                              cancel: cancel)
+        alertsPresenter.present(
+            viewModel: CardPresentModalUpdateProgress(requiredUpdate: true,
+                                                      progress: progress,
+                                                      cancel: cancel))
     }
 
     /// Retry a search for a card reader
     ///
     func onRetry() {
-        alerts.dismiss()
+        alertsPresenter.dismiss()
         let action = CardPresentPaymentAction.cancelCardReaderDiscovery() { [weak self] _ in
             self?.state = .beginSearch
         }
@@ -550,10 +528,6 @@ private extension CardReaderConnectionController {
             return
         }
 
-        guard let from = fromController else {
-            return
-        }
-
         analyticsTracker.setCandidateReader(candidateReader)
 
         let softwareUpdateAction = CardPresentPaymentAction.observeCardReaderUpdateState { [weak self] softwareUpdateEvents in
@@ -618,7 +592,7 @@ private extension CardReaderConnectionController {
         }
         stores.dispatch(action)
 
-        alerts.connectingToReader(from: from)
+        alertsPresenter.present(viewModel: CardPresentModalConnectingToReader())
     }
 
     /// An error occurred while connecting
@@ -638,8 +612,7 @@ private extension CardReaderConnectionController {
     }
 
     private func onUpdateFailed(error: Error) {
-        guard let from = fromController,
-              case CardReaderServiceError.softwareUpdate(underlyingError: let underlyingError, batteryLevel: let batteryLevel) = error else {
+        guard case CardReaderServiceError.softwareUpdate(underlyingError: let underlyingError, batteryLevel: let batteryLevel) = error else {
             return
         }
 
@@ -648,28 +621,20 @@ private extension CardReaderConnectionController {
             // Update was cancelled, don't treat this as an error
             return
         case .readerSoftwareUpdateFailedBatteryLow:
-            alerts.updatingFailedLowBattery(
-                from: from,
-                batteryLevel: batteryLevel,
-                close: {
-                    self.state = .searching
-                }
-            )
+            alertsPresenter.present(
+                viewModel: CardPresentModalUpdateFailedLowBattery(batteryLevel: batteryLevel,
+                                                                  close: {
+                                                                      self.state = .searching
+                                                                  }))
         default:
-            alerts.updatingFailed(
-                from: from,
-                tryAgain: nil,
-                close: {
+            alertsPresenter.present(
+                viewModel: CardPresentModalUpdateFailedNonRetryable(close: {
                     self.state = .searching
-                })
+                }))
         }
     }
 
     private func showConnectionFailed(error: Error) {
-        guard let from = fromController else {
-            return
-        }
-
         let retrySearch = {
             self.state = .retry
         }
@@ -683,28 +648,37 @@ private extension CardReaderConnectionController {
         }
 
         guard case CardReaderServiceError.connection(let underlyingError) = error else {
-            return alerts.connectingFailed(from: from, continueSearch: continueSearch, cancelSearch: cancelSearch)
+            return alertsPresenter.present(
+                viewModel: CardPresentModalConnectingFailed(continueSearch: continueSearch, cancelSearch: cancelSearch))
         }
 
         switch underlyingError {
         case .incompleteStoreAddress(let adminUrl):
-            alerts.connectingFailedIncompleteAddress(from: from,
-                                                     openWCSettings: openWCSettingsAction(adminUrl: adminUrl,
-                                                                                          from: from,
-                                                                                          retrySearch: retrySearch),
-                                                     retrySearch: retrySearch,
-                                                     cancelSearch: cancelSearch)
+            alertsPresenter.present(
+                viewModel: CardPresentModalConnectingFailedUpdateAddress(
+                    openWCSettings: openWCSettingsAction(adminUrl: adminUrl,
+                                                         retrySearch: retrySearch),
+                    retrySearch: retrySearch,
+                    cancelSearch: cancelSearch))
         case .invalidPostalCode:
-            alerts.connectingFailedInvalidPostalCode(from: from, retrySearch: retrySearch, cancelSearch: cancelSearch)
+            alertsPresenter.present(
+                viewModel: CardPresentModalConnectingFailedUpdatePostalCode(
+                    retrySearch: retrySearch,
+                    cancelSearch: cancelSearch))
         case .bluetoothConnectionFailedBatteryCriticallyLow:
-            alerts.connectingFailedCriticallyLowBattery(from: from, retrySearch: retrySearch, cancelSearch: cancelSearch)
+            alertsPresenter.present(
+                viewModel: CardPresentModalConnectingFailedChargeReader(
+                    retrySearch: retrySearch,
+                    cancelSearch: cancelSearch))
         default:
-            alerts.connectingFailed(from: from, continueSearch: continueSearch, cancelSearch: cancelSearch)
+            alertsPresenter.present(
+                viewModel: CardPresentModalConnectingFailed(
+                    continueSearch: continueSearch,
+                    cancelSearch: cancelSearch))
         }
     }
 
     private func openWCSettingsAction(adminUrl: URL?,
-                                      from viewController: UIViewController,
                                       retrySearch: @escaping () -> Void) -> ((UIViewController) -> Void)? {
         if let adminUrl = adminUrl {
             if let site = stores.sessionManager.defaultSite,
@@ -756,27 +730,24 @@ private extension CardReaderConnectionController {
     /// Presents the error in a modal
     ///
     private func onDiscoveryFailed(error: Error) {
-        guard let from = fromController else {
-            return
-        }
-
-        alerts.scanningFailed(from: from, error: error) { [weak self] in
+        alertsPresenter.present(
+            viewModel: CardPresentModalScanningFailed(error: error) { [weak self] in
             self?.returnFailure(error: error)
-        }
+        })
     }
 
     /// Calls the completion with a success result
     ///
     private func returnSuccess(result: ConnectionResult) {
         onCompletion?(.success(result))
-        alerts.dismiss()
+        alertsPresenter.dismiss()
         state = .idle
     }
 
     /// Calls the completion with a failure result
     ///
     private func returnFailure(error: Error) {
-        alerts.dismiss()
+        alertsPresenter.dismiss()
         onCompletion?(.failure(error))
         state = .idle
     }