Merge pull request #5008 from woocommerce/issue/4922-disable-disconnect-during-update

[Mobile Payments] [WIP] Disable disconnect button while checking for reader software update

Author: allendav

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

@@ -79,13 +79,6 @@ private extension CardReaderSettingsConnectedViewController {
         configureUpdateView()
     }
 
-    func shouldShowUpdateControls() -> Bool {
-        guard let viewModel = viewModel else {
-            return false
-        }
-        return viewModel.readerUpdateAvailable == .isTrue
-    }
-
     /// Set the title and back button.
     ///
     func configureNavigation() {
@@ -97,31 +90,27 @@ private extension CardReaderSettingsConnectedViewController {
     func configureSections() {
         sections = []
 
-        /// This section, if present, displays a prompt to update a reader running old software
+        /// This section displays whether or not there is update for the reader software
         ///
-        if shouldShowUpdateControls() {
-            sections.append(
-                Section(title: nil,
-                        rows: [
-                            .updatePrompt
-                        ]
-                )
-            )
+        let checkForReaderUpdateInProgress = viewModel?.checkForReaderUpdateInProgress ?? false
+        var rows = [Row]()
+        if checkForReaderUpdateInProgress {
+            rows = [.checkingForUpdate]
+        } else {
+            rows = [.updatePrompt]
         }
 
+        sections.append(Section(title: nil, rows: rows))
+
         /// This section displays details about the connected reader
         ///
-        var rows: [Row] = [.connectedReader]
-
-        if shouldShowUpdateControls() {
-            rows.append(.updateButton)
-        }
-
-        rows.append(.disconnectButton)
-
         sections.append(
             Section(title: Localization.sectionHeaderTitle.uppercased(),
-                    rows: rows
+                    rows: [
+                        .connectedReader,
+                        .updateButton,
+                        .disconnectButton
+                    ]
             )
         )
     }
@@ -178,6 +167,8 @@ private extension CardReaderSettingsConnectedViewController {
     ///
     func configure(_ cell: UITableViewCell, for row: Row, at indexPath: IndexPath) {
         switch cell {
+        case let cell as ActivitySpinnerAndLabelTableViewCell where row == .checkingForUpdate:
+            configureCheckingForUpdate(cell: cell)
         case let cell as LeftImageTableViewCell where row == .updatePrompt:
             configureUpdatePrompt(cell: cell)
         case let cell as ConnectedReaderTableViewCell where row == .connectedReader:
@@ -191,11 +182,29 @@ private extension CardReaderSettingsConnectedViewController {
         }
     }
 
+    private func configureCheckingForUpdate(cell: ActivitySpinnerAndLabelTableViewCell) {
+        cell.configure(labelText: Localization.updateChecking)
+        cell.selectionStyle = .none
+    }
+
     private func configureUpdatePrompt(cell: LeftImageTableViewCell) {
-        cell.configure(image: .infoOutlineImage, text: Localization.updatePromptText)
+        guard let readerUpdateAvailable = viewModel?.readerUpdateAvailable else {
+            return
+        }
+
+        if readerUpdateAvailable == .isFalse {
+            cell.configure(image: .infoOutlineImage, text: Localization.updateNotNeeded)
+            cell.backgroundColor = .none
+            cell.imageView?.tintColor = .info
+        }
+
+        if readerUpdateAvailable == .isTrue {
+            cell.configure(image: .infoOutlineImage, text: Localization.updateAvailable)
+            cell.backgroundColor = .warningBackground
+            cell.imageView?.tintColor = .warning
+        }
+
         cell.selectionStyle = .none
-        cell.backgroundColor = .warningBackground
-        cell.imageView?.tintColor = .warning
         cell.textLabel?.numberOfLines = 0
         cell.textLabel?.textColor = .text
     }
@@ -210,29 +219,39 @@ private extension CardReaderSettingsConnectedViewController {
         cell.selectionStyle = .none
     }
 
+    /// If a reader update is available, make the update button primary
+    /// If a reader update is available and a disconnect or update isn't already in progress, enable the button
+    ///
     private func configureUpdateButton(cell: ButtonTableViewCell) {
-        cell.configure(style: .primary, title: Localization.updateButtonTitle, bottomSpacing: 0) {
+        let readerUpdateAvailable = viewModel?.readerUpdateAvailable == .isTrue
+        let style: ButtonTableViewCell.Style = readerUpdateAvailable ? .primary : .secondary
+        cell.configure(style: style, title: Localization.updateButtonTitle, bottomSpacing: 0) {
             self.viewModel?.startCardReaderUpdate()
         }
 
         let readerDisconnectInProgress = viewModel?.readerDisconnectInProgress ?? false
         let readerUpdateInProgress = viewModel?.readerUpdateInProgress ?? false
-        cell.enableButton(!readerDisconnectInProgress && !readerUpdateInProgress)
+        cell.enableButton(readerUpdateAvailable && !readerDisconnectInProgress && !readerUpdateInProgress)
         cell.showActivityIndicator(readerUpdateInProgress)
 
         cell.selectionStyle = .none
         cell.backgroundColor = .clear
     }
 
+    /// If a reader update is not available, make the disconnect button primary
+    /// If a check for updates, a disconnect or an update isn't already in progress, enable the disconnect button
+    ///
     private func configureDisconnectButton(cell: ButtonTableViewCell) {
-        let style: ButtonTableViewCell.Style = shouldShowUpdateControls() ? .secondary : .primary
+        let checkForReaderUpdateInProgress = viewModel?.checkForReaderUpdateInProgress ?? false
+        let readerUpdateAvailable = viewModel?.readerUpdateAvailable == .isTrue
+        let style: ButtonTableViewCell.Style = readerUpdateAvailable ? .secondary : .primary
         cell.configure(style: style, title: Localization.disconnectButtonTitle) { [weak self] in
             self?.viewModel?.disconnectReader()
         }
 
         let readerDisconnectInProgress = viewModel?.readerDisconnectInProgress ?? false
         let readerUpdateInProgress = viewModel?.readerUpdateInProgress ?? false
-        cell.enableButton(!readerDisconnectInProgress && !readerUpdateInProgress)
+        cell.enableButton(!checkForReaderUpdateInProgress && !readerDisconnectInProgress && !readerUpdateInProgress)
         cell.showActivityIndicator(readerDisconnectInProgress)
 
         cell.selectionStyle = .none
@@ -262,10 +281,7 @@ extension CardReaderSettingsConnectedViewController: UITableViewDataSource {
     }
 
     func tableView(_ tableView: UITableView, heightForHeaderInSection section: Int) -> CGFloat {
-        if shouldShowUpdateControls() {
-            return section == 0 ? CGFloat.leastNonzeroMagnitude : UITableView.automaticDimension
-        }
-        return UITableView.automaticDimension
+        return section == 0 ? CGFloat.leastNonzeroMagnitude : UITableView.automaticDimension
     }
 
     func tableView(_ tableView: UITableView, heightForFooterInSection section: Int) -> CGFloat {
@@ -317,13 +333,16 @@ private struct Section {
 }
 
 private enum Row: CaseIterable {
+    case checkingForUpdate
     case updatePrompt
     case connectedReader
     case updateButton
     case disconnectButton
 
     var type: UITableViewCell.Type {
         switch self {
+        case .checkingForUpdate:
+            return ActivitySpinnerAndLabelTableViewCell.self
         case .updatePrompt:
             return LeftImageTableViewCell.self
         case .connectedReader:
@@ -349,11 +368,21 @@ private extension CardReaderSettingsConnectedViewController {
             comment: "Settings > Manage Card Reader > Title for the reader connected screen in settings."
         )
 
-        static let updatePromptText = NSLocalizedString(
+        static let updateChecking = NSLocalizedString(
+            "Checking for reader software updates",
+            comment: "Settings > Manage Card Reader > Connected Reader > A prompt to indicate we are checking for reader updates"
+        )
+
+        static let updateAvailable = NSLocalizedString(
             "Please update your reader software to keep accepting payments",
             comment: "Settings > Manage Card Reader > Connected Reader > A prompt to update a reader running older software"
         )
 
+        static let updateNotNeeded = NSLocalizedString(
+            "Congratulations! Your reader is running the latest software",
+            comment: "Settings > Manage Card Reader > Connected Reader > A prompt to update a reader running older software"
+        )
+
         static let sectionHeaderTitle = NSLocalizedString(
             "Connected Reader",
             comment: "Settings > Manage Card Reader > Connected Reader Table Section Heading"

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

@@ -10,6 +10,7 @@ final class CardReaderSettingsConnectedViewModel: CardReaderSettingsPresentedVie
     private var connectedReaders = [CardReader]()
     private let knownReadersProvider: CardReaderSettingsKnownReadersProvider?
 
+    private(set) var checkForReaderUpdateInProgress: Bool = false
     private(set) var readerUpdateAvailable: CardReaderSettingsTriState = .isUnknown
     private(set) var readerUpdateInProgress: Bool = false
     private(set) var readerUpdateCompletedSuccessfully: Bool = false
@@ -47,6 +48,7 @@ final class CardReaderSettingsConnectedViewModel: CardReaderSettingsPresentedVie
         updateReaderID()
         updateBatteryLevel()
         updateSoftwareVersion()
+        didUpdate?()
     }
 
     private func updateReaderID() {
@@ -76,6 +78,14 @@ final class CardReaderSettingsConnectedViewModel: CardReaderSettingsPresentedVie
     /// Dispatch a request to check for reader updates
     ///
     func checkForCardReaderUpdate() {
+        guard !checkForReaderUpdateInProgress else {
+            return
+        }
+
+        readerUpdateAvailable = .isUnknown
+        checkForReaderUpdateInProgress = true
+        didUpdate?()
+
         let action = CardPresentPaymentAction.checkForCardReaderUpdate() { [weak self] result in
             guard let self = self else {
                 return
@@ -90,6 +100,7 @@ final class CardReaderSettingsConnectedViewModel: CardReaderSettingsPresentedVie
                 DDLogError("Unexpected error when checking for reader update")
                 self.readerUpdateAvailable = .isFalse
             }
+            self.checkForReaderUpdateInProgress = false
             self.didUpdate?()
         }
         ServiceLocator.stores.dispatch(action)