5300 Test canceled updates aren't logged as failed

Author: joshheald

Hardware/Hardware/CardReader/StripeCardReader/StripeCardReaderService.swift

@@ -499,10 +499,10 @@ extension StripeCardReaderService: BluetoothReaderDelegate {
 
     public func reader(_ reader: Reader, didFinishInstallingUpdate update: ReaderSoftwareUpdate?, error: Error?) {
         if let error = error {
-            let underlyingError = UnderlyingError(with: error)
-            if underlyingError != .commandCancelled {
-                softwareUpdateSubject.send(.failed(error: error))
-            }
+            softwareUpdateSubject.send(.failed(
+                error: CardReaderServiceError.softwareUpdate(underlyingError: UnderlyingError(with: error),
+                                                             batteryLevel: reader.batteryLevel?.doubleValue))
+            )
             softwareUpdateSubject.send(.available)
         } else {
             softwareUpdateSubject.send(.completed)

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

@@ -63,6 +63,11 @@ final class CardReaderSettingsConnectedViewModel: CardReaderSettingsPresentedVie
                     case .installing(progress: let progress):
                         self.readerUpdateProgress = progress
                     case .failed(error: let error):
+                        if case CardReaderServiceError.softwareUpdate(underlyingError: let underlyingError, batteryLevel: _) = error,
+                           underlyingError == .readerSoftwareUpdateFailedInterrupted {
+                            // Update was cancelled, don't treat this as an error
+                            break
+                        }
                         self.readerUpdateError = error
                         self.completeCardReaderUpdate(success: false)
                         ServiceLocator.analytics.track(.cardReaderSoftwareUpdateFailed)

WooCommerce/WooCommerceTests/Mocks/MockCardPresentPaymentsStoresManager.swift

@@ -97,7 +97,15 @@ extension MockCardPresentPaymentsStoresManager {
     }
 
     func simulateCancelableUpdate(onCancel: @escaping () -> Void) {
-        softwareUpdateSubject.send(.started(cancelable: MockFallibleCancelable(onCancel: onCancel)))
+        softwareUpdateSubject.send(.started(cancelable: MockFallibleCancelable(onCancel: {
+            onCancel()
+            self.softwareUpdateSubject.send(
+                .failed(error: CardReaderServiceError.softwareUpdate(
+                    underlyingError: .readerSoftwareUpdateFailedInterrupted,
+                    batteryLevel: 0.86
+                ))
+            )
+        })))
     }
 
     func simulateUpdateStarted() {

WooCommerce/WooCommerceTests/ViewRelated/Dashboard/CardReaderSettings/CardReaderSettingsConnectedViewModelTests.swift

@@ -216,4 +216,20 @@ final class CardReaderSettingsConnectedViewModelTests: XCTestCase {
         wait(for: [expectation], timeout: Constants.expectationTimeout)
         XCTAssert(analytics.receivedEvents.contains(WooAnalyticsStat.cardReaderSoftwareUpdateCanceled.rawValue))
     }
+
+    func test_WhenUpdateIsSuccessfullyCanceled_ViewModel_DoesNotLogTracksEvent_cardReaderSoftwareUpdateFailed() {
+        // Given
+        let expectation = self.expectation(description: #function)
+
+        mockStoresManager.simulateCancelableUpdate {
+            expectation.fulfill()
+        }
+
+        // When
+        viewModel.cancelCardReaderUpdate()
+
+        // Then
+        wait(for: [expectation], timeout: Constants.expectationTimeout)
+        XCTAssertFalse(analytics.receivedEvents.contains(WooAnalyticsStat.cardReaderSoftwareUpdateFailed.rawValue))
+    }
 }