5300 Add card reader software update Tracks events

Author: joshheald

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -155,6 +155,15 @@ public enum WooAnalyticsStat: String {
     case cardReaderConnectionSuccess = "card_reader_connection_success"
     case cardReaderDisconnectTapped = "card_reader_disconnect_tapped"
 
+    // MARK: Card Reader Software Update Events
+    //
+    case cardReaderSoftwareUpdateTapped = "card_reader_software_update_tapped"
+    case cardReaderSoftwareUpdateStarted = "card_reader_software_update_started"
+    case cardReaderSoftwareUpdateSuccess = "card_reader_software_update_success"
+    case cardReaderSoftwareUpdateFailed = "card_reader_software_update_failed"
+    case cardReaderSoftwareUpdateCancelTapped = "card_reader_software_update_cancel_tapped"
+    case cardReaderSoftwareUpdateCanceled = "card_reader_software_update_canceled"
+
     // MARK: Card-Present Payments Onboarding
     case cardPresentOnboardingLearnMoreTapped = "card_present_onboarding_learn_more_tapped"
     case cardPresentOnboardingNotCompleted = "card_present_onboarding_not_completed"

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

@@ -59,14 +59,17 @@ final class CardReaderSettingsConnectedViewModel: CardReaderSettingsPresentedVie
                         self.readerUpdateError = nil
                         self.softwareUpdateCancelable = cancelable
                         self.readerUpdateProgress = 0
+                        ServiceLocator.analytics.track(.cardReaderSoftwareUpdateStarted)
                     case .installing(progress: let progress):
                         self.readerUpdateProgress = progress
                     case .failed(error: let error):
                         self.readerUpdateError = error
                         self.completeCardReaderUpdate(success: false)
+                        ServiceLocator.analytics.track(.cardReaderSoftwareUpdateFailed)
                     case .completed:
                         self.readerUpdateProgress = 1
                         self.softwareUpdateCancelable = nil
+                        ServiceLocator.analytics.track(.cardReaderSoftwareUpdateSuccess)
                         // If we were installing a software update, introduce a small delay so the user can
                         // actually see a success message showing the installation was complete
                         DispatchQueue.main.asyncAfter(deadline: .now() + .seconds(1)) { [weak self] in
@@ -117,16 +120,19 @@ final class CardReaderSettingsConnectedViewModel: CardReaderSettingsPresentedVie
     /// Allows the view controller to kick off a card reader update
     ///
     func startCardReaderUpdate() {
+        ServiceLocator.analytics.track(.cardReaderSoftwareUpdateTapped)
         let action = CardPresentPaymentAction.startCardReaderUpdate
         ServiceLocator.stores.dispatch(action)
     }
 
     func cancelCardReaderUpdate() {
+        ServiceLocator.analytics.track(.cardReaderSoftwareUpdateCancelTapped)
         softwareUpdateCancelable?.cancel(completion: { [weak self] result in
             if case .failure(let error) = result {
                 print("=== error canceling software update: \(error)")
             } else {
                 self?.completeCardReaderUpdate(success: false)
+                ServiceLocator.analytics.track(.cardReaderSoftwareUpdateCanceled)
             }
         })
     }

WooCommerce/WooCommerceTests/Mocks/MockCardPresentPaymentsStoresManager.swift

@@ -86,3 +86,21 @@ extension MockCardPresentPaymentsStoresManager {
         case connectionFailure
     }
 }
+
+extension MockCardPresentPaymentsStoresManager {
+    func simulateSuccessfulUpdate() {
+        softwareUpdateSubject.send(.completed)
+    }
+
+    func simulateFailedUpdate(error: Error) {
+        softwareUpdateSubject.send(.failed(error: error))
+    }
+
+    func simulateCancelableUpdate(onCancel: @escaping () -> Void) {
+        softwareUpdateSubject.send(.started(cancelable: MockFallibleCancelable(onCancel: onCancel)))
+    }
+
+    func simulateUpdateStarted() {
+        softwareUpdateSubject.send(.started(cancelable: nil))
+    }
+}

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

@@ -3,7 +3,6 @@ import XCTest
 @testable import WooCommerce
 
 final class CardReaderSettingsConnectedViewModelTests: XCTestCase {
-
     func test_did_change_should_show_returns_false_if_no_connected_readers() {
         let mockStoresManager = MockCardPresentPaymentsStoresManager(
             connectedReaders: [],
@@ -160,4 +159,132 @@ final class CardReaderSettingsConnectedViewModelTests: XCTestCase {
         // Then
         wait(for: [expectation], timeout: Constants.expectationTimeout)
     }
+
+    func test_startCardReaderUpdate_ViewModel_LogsTracksEvent_cardReaderSoftwareUpdateTapped() {
+        // Given
+        let mockStoresManager = MockCardPresentPaymentsStoresManager(
+            connectedReaders: [MockCardReader.bbposChipper2XBT()],
+            discoveredReaders: [],
+            sessionManager: SessionManager.testingInstance
+        )
+        ServiceLocator.setStores(mockStoresManager)
+
+        let analytics = MockAnalyticsProvider()
+        ServiceLocator.setAnalytics(WooAnalytics(analyticsProvider: analytics))
+        let viewModel = CardReaderSettingsConnectedViewModel(didChangeShouldShow: nil)
+
+        // When
+        viewModel.startCardReaderUpdate()
+
+        // Then
+        XCTAssert(analytics.receivedEvents.contains(WooAnalyticsStat.cardReaderSoftwareUpdateTapped.rawValue))
+    }
+
+    func test_startCardReaderUpdate_ViewModel_LogsTracksEvent_cardReaderSoftwareUpdateStarted() {
+        // Given
+        let mockStoresManager = MockCardPresentPaymentsStoresManager(
+            connectedReaders: [MockCardReader.bbposChipper2XBT()],
+            discoveredReaders: [],
+            sessionManager: SessionManager.testingInstance
+        )
+        ServiceLocator.setStores(mockStoresManager)
+
+        let analytics = MockAnalyticsProvider()
+        ServiceLocator.setAnalytics(WooAnalytics(analyticsProvider: analytics))
+        let viewModel = CardReaderSettingsConnectedViewModel(didChangeShouldShow: nil)
+
+        // When
+        mockStoresManager.simulateUpdateStarted()
+
+        // Then
+        XCTAssert(analytics.receivedEvents.contains(WooAnalyticsStat.cardReaderSoftwareUpdateStarted.rawValue))
+    }
+
+    func test_WhenStoreSendsUpdateComplete_ViewModel_LogsTracksEvent_cardReaderSoftwareUpdateSuccess() {
+        // Given
+        let mockStoresManager = MockCardPresentPaymentsStoresManager(
+            connectedReaders: [MockCardReader.bbposChipper2XBT()],
+            discoveredReaders: [],
+            sessionManager: SessionManager.testingInstance
+        )
+        ServiceLocator.setStores(mockStoresManager)
+
+        let analytics = MockAnalyticsProvider()
+        ServiceLocator.setAnalytics(WooAnalytics(analyticsProvider: analytics))
+        let viewModel = CardReaderSettingsConnectedViewModel(didChangeShouldShow: nil)
+
+        // When
+        mockStoresManager.simulateSuccessfulUpdate()
+
+        // Then
+        XCTAssert(analytics.receivedEvents.contains(WooAnalyticsStat.cardReaderSoftwareUpdateSuccess.rawValue))
+    }
+
+    func test_WhenStoreSendsUpdateFailed_ViewModel_LogsTracksEvent_cardReaderSoftwareUpdateFailed() {
+        // Given
+        let mockStoresManager = MockCardPresentPaymentsStoresManager(
+            connectedReaders: [MockCardReader.bbposChipper2XBT()],
+            discoveredReaders: [],
+            sessionManager: SessionManager.testingInstance
+        )
+        ServiceLocator.setStores(mockStoresManager)
+
+        let analytics = MockAnalyticsProvider()
+        ServiceLocator.setAnalytics(WooAnalytics(analyticsProvider: analytics))
+        let viewModel = CardReaderSettingsConnectedViewModel(didChangeShouldShow: nil)
+
+        // When
+        let expectedError = CardReaderServiceError.softwareUpdate(underlyingError: .readerSoftwareUpdateFailedBatteryLow,
+                                                                  batteryLevel: 0.4)
+        mockStoresManager.simulateFailedUpdate(error: expectedError)
+
+        // Then
+        XCTAssert(analytics.receivedEvents.contains(WooAnalyticsStat.cardReaderSoftwareUpdateFailed.rawValue))
+    }
+
+    func test_WhenUserCancelsUpdate_ViewModel_LogsTracksEvent_cardReaderSoftwareUpdateCancelTapped() {
+        // Given
+        let mockStoresManager = MockCardPresentPaymentsStoresManager(
+            connectedReaders: [MockCardReader.bbposChipper2XBT()],
+            discoveredReaders: [],
+            sessionManager: SessionManager.testingInstance
+        )
+        ServiceLocator.setStores(mockStoresManager)
+
+        let analytics = MockAnalyticsProvider()
+        ServiceLocator.setAnalytics(WooAnalytics(analyticsProvider: analytics))
+        let viewModel = CardReaderSettingsConnectedViewModel(didChangeShouldShow: nil)
+
+        // When
+        viewModel.cancelCardReaderUpdate()
+
+        // Then
+        XCTAssert(analytics.receivedEvents.contains(WooAnalyticsStat.cardReaderSoftwareUpdateCancelTapped.rawValue))
+    }
+
+    func test_WhenUpdateIsSuccessfullyCanceled_ViewModel_LogsTracksEvent_cardReaderSoftwareUpdateCanceled() {
+        // Given
+        let mockStoresManager = MockCardPresentPaymentsStoresManager(
+            connectedReaders: [MockCardReader.bbposChipper2XBT()],
+            discoveredReaders: [],
+            sessionManager: SessionManager.testingInstance
+        )
+        ServiceLocator.setStores(mockStoresManager)
+
+        let analytics = MockAnalyticsProvider()
+        ServiceLocator.setAnalytics(WooAnalytics(analyticsProvider: analytics))
+        let viewModel = CardReaderSettingsConnectedViewModel(didChangeShouldShow: nil)
+        let expectation = self.expectation(description: #function)
+
+        mockStoresManager.simulateCancelableUpdate {
+            expectation.fulfill()
+        }
+
+        // When
+        viewModel.cancelCardReaderUpdate()
+
+        // Then
+        wait(for: [expectation], timeout: Constants.expectationTimeout)
+        XCTAssert(analytics.receivedEvents.contains(WooAnalyticsStat.cardReaderSoftwareUpdateCanceled.rawValue))
+    }
 }