Track enable Cash on Delivery result events

Author: joshheald

WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift

@@ -1186,6 +1186,32 @@ extension WooAnalyticsEvent {
                               ])
         }
 
+        /// Tracked when the Cash on Delivery Payment Gateway is successfully enabled, e.g. from the IPP onboarding flow.
+        ///
+        /// - Parameters:
+        ///   - countryCode: the country code of the store.
+        ///
+        static func enableCashOnDeliverySuccess(countryCode: String) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .enableCashOnDeliverySuccess,
+                              properties: [
+                                Keys.countryCode: countryCode
+                              ])
+        }
+
+        /// Tracked when the Cash on Delivery Payment Gateway enabling fails, e.g. from the IPP onboarding flow.
+        ///
+        /// - Parameters:
+        ///   - countryCode: the country code of the store.
+        ///
+        static func enableCashOnDeliveryFailed(countryCode: String,
+                                               error: Error?) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .enableCashOnDeliveryFailed,
+                              properties: [
+                                Keys.countryCode: countryCode
+                              ],
+                              error: error)
+        }
+
         /// Tracked when the user taps on the "See Receipt" button to view a receipt.
         /// - Parameter countryCode: the country code of the store.
         ///

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -187,6 +187,10 @@ public enum WooAnalyticsStat: String {
     case cardPresentOnboardingStepSkipped = "card_present_onboarding_step_skipped"
     case cardPresentOnboardingCtaTapped = "card_present_onboarding_cta_tapped"
 
+    // MARK: Cash on Delivery Enable events
+    case enableCashOnDeliverySuccess = "enable_cash_on_delivery_success"
+    case enableCashOnDeliveryFailed = "enable_cash_on_delivery_failed"
+
     // MARK: Payment Gateways selection
     case cardPresentPaymentGatewaySelected = "card_present_payment_gateway_selected"
 

WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/Onboarding Errors/InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel.swift

@@ -79,9 +79,11 @@ final class InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel: Obser
                 DDLogError("💰 Could not update Payment Gateway: \(String(describing: result.failure))")
                 self.awaitingResponse = false
                 self.displayEnableCashOnDeliveryFailureNotice()
+                self.trackEnableCashOnDeliveryFailed(error: result.failure)
                 return
             }
 
+            self.trackEnableCashOnDeliverySuccess()
             self.completion()
         }
         stores.dispatch(action)
@@ -128,6 +130,17 @@ private extension InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel
                                                          countryCode: cardPresentPaymentsConfiguration.countryCode)
         analytics.track(event: event)
     }
+
+    func trackEnableCashOnDeliverySuccess() {
+        let event = Event.enableCashOnDeliverySuccess(countryCode: cardPresentPaymentsConfiguration.countryCode)
+        analytics.track(event: event)
+    }
+
+    func trackEnableCashOnDeliveryFailed(error: Error?) {
+        let event = Event.enableCashOnDeliveryFailed(countryCode: cardPresentPaymentsConfiguration.countryCode,
+                                                     error: error)
+        analytics.track(event: event)
+    }
 }
 
 private enum Localization {

WooCommerce/WooCommerceTests/ViewRelated/Dashboard/Settings/In-Person Payments/Onboarding Errors/InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModelTests.swift

@@ -149,16 +149,70 @@ final class InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModelTests:
         assertEqual(AnalyticProperties.cashOnDeliveryDisabledReason, eventProperties[AnalyticProperties.reasonKey] as? String)
         assertEqual("US", eventProperties[AnalyticProperties.countryCodeKey] as? String)
     }
+
+    func test_enable_success_logs_enable_success_event() throws {
+        // Given
+        assertEmpty(analyticsProvider.receivedEvents)
+        stores.whenReceivingAction(ofType: PaymentGatewayAction.self) { action in
+            switch action {
+            case let .updatePaymentGateway(paymentGateway, onCompletion):
+                onCompletion(.success(paymentGateway))
+            default:
+                break
+            }
+        }
+
+        let _: Void = waitFor { promise in
+            let sut = InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(dependencies: self.dependencies,
+                                                                                    configuration: self.configuration,
+                                                                                    completion: {
+                promise(())
+            })
+            // When
+            sut.enableTapped()
+        }
+
+        // Then
+        assertNotEmpty(analyticsProvider.receivedEvents)
+        let indexOfEvent = try XCTUnwrap(analyticsProvider.receivedEvents.firstIndex(where: { $0 == AnalyticEvents.enableCashOnDeliverySuccess }))
+        let eventProperties = try XCTUnwrap(analyticsProvider.receivedProperties[indexOfEvent])
+        assertEqual("US", eventProperties[AnalyticProperties.countryCodeKey] as? String)
+    }
+
+    func test_enable_failure_logs_enable_failure_event() throws {
+        // Given
+        stores.whenReceivingAction(ofType: PaymentGatewayAction.self) { action in
+            switch action {
+            case let .updatePaymentGateway(_, onCompletion):
+                onCompletion(.failure(DotcomError.noRestRoute))
+            default:
+                break
+            }
+        }
+
+        // When
+        sut.enableTapped()
+
+        // Then
+        assertNotEmpty(analyticsProvider.receivedEvents)
+        let indexOfEvent = try XCTUnwrap(analyticsProvider.receivedEvents.firstIndex(where: { $0 == AnalyticEvents.enableCashOnDeliveryFailed }))
+        let eventProperties = try XCTUnwrap(analyticsProvider.receivedProperties[indexOfEvent])
+        assertEqual("US", eventProperties[AnalyticProperties.countryCodeKey] as? String)
+        assertEqual("Dotcom Invalid REST Route", eventProperties[AnalyticProperties.errorDescriptionKey] as? String)
+    }
 }
 
 private enum AnalyticEvents {
     static let skippedEvent = "card_present_onboarding_step_skipped"
     static let ctaTappedEvent = "card_present_onboarding_cta_tapped"
+    static let enableCashOnDeliverySuccess = "enable_cash_on_delivery_success"
+    static let enableCashOnDeliveryFailed = "enable_cash_on_delivery_failed"
 }
 
 private enum AnalyticProperties {
     static let reasonKey = "reason"
     static let cashOnDeliveryDisabledReason = "cash_on_delivery_disabled"
     static let remindLaterKey = "remind_later"
     static let countryCodeKey = "country"
+    static let errorDescriptionKey = "error_description"
 }