Log skipped tracks event for CoD onboarding screen

joshheald · joshheald · commit 0295e2a20536 · 2022-08-24T15:08:16.000+01:00
diff --git a/WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift b/WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift
@@ -745,6 +745,8 @@ extension WooAnalyticsEvent {
             static let batteryLevel = "battery_level"
             static let cardReaderModel = "card_reader_model"
             static let countryCode = "country"
+            static let reason = "reason"
+            static let remindLater = "remind_later"
             static let gatewayID = "plugin_slug"
             static let errorDescription = "error_description"
             static let paymentMethodType = "payment_method_type"
@@ -1150,7 +1152,23 @@ extension WooAnalyticsEvent {
             WooAnalyticsEvent(statName: .cardPresentOnboardingNotCompleted,
                               properties: [
                                 Keys.countryCode: countryCode,
-                                "reason": reason
+                                Keys.reason: reason
+                              ])
+        }
+
+        /// Tracked when a In-Person Payments onboarding step is skipped by the user.
+        ///
+        /// - Parameters:
+        ///   - reason: the reason why the onboarding step was shown (effectively the name of the step.)
+        ///   - remindLater: whether the user will see this onboarding step again
+        ///   - countryCode: the country code of the store.
+        ///
+        static func cardPresentOnboardingStepSkipped(reason: String, remindLater: Bool, countryCode: String) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .cardPresentOnboardingStepSkipped,
+                              properties: [
+                                Keys.countryCode: countryCode,
+                                Keys.reason: reason,
+                                Keys.remindLater: remindLater
                               ])
         }
 
diff --git a/WooCommerce/Classes/Analytics/WooAnalyticsStat.swift b/WooCommerce/Classes/Analytics/WooAnalyticsStat.swift
@@ -184,6 +184,7 @@ public enum WooAnalyticsStat: String {
     // MARK: Card-Present Payments Onboarding
     case cardPresentOnboardingLearnMoreTapped = "card_present_onboarding_learn_more_tapped"
     case cardPresentOnboardingNotCompleted = "card_present_onboarding_not_completed"
+    case cardPresentOnboardingStepSkipped = "card_present_onboarding_step_skipped"
 
     // MARK: Payment Gateways selection
     case cardPresentPaymentGatewaySelected = "card_present_payment_gateway_selected"
diff --git a/WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/InPersonPaymentsViewModel.swift b/WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/InPersonPaymentsViewModel.swift
@@ -11,7 +11,8 @@ final class InPersonPaymentsViewModel: ObservableObject {
     let stores: StoresManager
 
     lazy var codStepViewModel: InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel = {
-        InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(completion: refresh)
+        InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(configuration: useCase.configurationLoader.configuration,
+                                                                      completion: refresh)
     }()
 
     /// Initializes the view model for a specific site
diff --git a/WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/Onboarding Errors/InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpView.swift b/WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/Onboarding Errors/InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpView.swift
@@ -1,4 +1,5 @@
 import SwiftUI
+import Yosemite
 
 struct InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpView: View {
     @ObservedObject var viewModel: InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel
@@ -35,7 +36,8 @@ struct InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpView: View {
 
 struct InPersonPaymentsCodPaymentGatewayNotSetUp_Previews: PreviewProvider {
     static var previews: some View {
-        let viewModel = InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(completion: {})
+        let viewModel = InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(configuration: CardPresentPaymentsConfiguration(country: "US"),
+                                                                                      completion: {})
         return InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpView(viewModel: viewModel)
     }
 }
diff --git a/WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/Onboarding Errors/InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel.swift b/WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/Onboarding Errors/InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel.swift
@@ -5,6 +5,8 @@ final class InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel: Obser
     let completion: () -> Void
     private let stores: StoresManager
     private let noticePresenter: NoticePresenter
+    private let analytics: Analytics
+    private let cardPresentPaymentsConfiguration: CardPresentPaymentsConfiguration
 
     @Published var awaitingResponse = false
 
@@ -14,13 +16,19 @@ final class InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel: Obser
 
     init(stores: StoresManager = ServiceLocator.stores,
          noticePresenter: NoticePresenter = ServiceLocator.noticePresenter,
+         analytics: Analytics = ServiceLocator.analytics,
+         configuration: CardPresentPaymentsConfiguration,
          completion: @escaping () -> Void) {
         self.stores = stores
         self.noticePresenter = noticePresenter
+        self.analytics = analytics
+        self.cardPresentPaymentsConfiguration = configuration
         self.completion = completion
     }
 
     func skipTapped() {
+        trackSkipTapped()
+
         guard let siteID = siteID else {
             return completion()
         }
@@ -72,6 +80,22 @@ final class InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel: Obser
     }
 }
 
+// MARK: - Analytics
+private extension InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel {
+    private typealias Event = WooAnalyticsEvent.InPersonPayments
+
+    private var reason: String {
+        CardPresentPaymentOnboardingState.codPaymentGatewayNotSetUp.reasonForAnalytics ?? ""
+    }
+
+    private func trackSkipTapped() {
+        let event = Event.cardPresentOnboardingStepSkipped(reason: reason,
+                                                           remindLater: false,
+                                                           countryCode: cardPresentPaymentsConfiguration.countryCode)
+        analytics.track(event: event)
+    }
+}
+
 private enum Localization {
     static let cashOnDeliveryCheckoutTitle = NSLocalizedString(
         "Pay in Person",
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Dashboard/Settings/In-Person Payments/Onboarding Errors/InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Dashboard/Settings/In-Person Payments/Onboarding Errors/InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModelTests.swift
@@ -10,21 +10,34 @@ final class InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModelTests:
 
     private var noticePresenter: MockNoticePresenter!
 
+    private var analyticsProvider: MockAnalyticsProvider!
+    private var analytics: Analytics!
+
+    private var configuration: CardPresentPaymentsConfiguration!
+
     private var sut: InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel!
 
     override func setUp() {
         stores = MockStoresManager(sessionManager: .makeForTesting())
         stores.sessionManager.setStoreId(12345)
         noticePresenter = MockNoticePresenter()
-        sut = InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(stores: stores, noticePresenter: noticePresenter, completion: {})
+        analyticsProvider = MockAnalyticsProvider()
+        analytics = WooAnalytics(analyticsProvider: analyticsProvider)
+        configuration = CardPresentPaymentsConfiguration.init(country: "US")
+        sut = InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(stores: stores,
+                                                                            noticePresenter: noticePresenter,
+                                                                            analytics: analytics,
+                                                                            configuration: configuration,
+                                                                            completion: {})
     }
 
     func test_skip_always_calls_completion() {
         // Given
         let completionCalled: Bool = waitFor { promise in
             let sut = InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(stores: self.stores,
-                                                                         noticePresenter: self.noticePresenter,
-                                                                         completion: {
+                                                                                    noticePresenter: self.noticePresenter,
+                                                                                    configuration: self.configuration,
+                                                                                    completion: {
                 promise(true)
             })
 
@@ -69,8 +82,9 @@ final class InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModelTests:
 
         let completionCalled: Bool = waitFor { promise in
             let sut = InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(stores: self.stores,
-                                                                          noticePresenter: self.noticePresenter,
-                                                                          completion: {
+                                                                                    noticePresenter: self.noticePresenter,
+                                                                                    configuration: self.configuration,
+                                                                                    completion: {
                 promise(true)
             })
             // When
@@ -100,4 +114,32 @@ final class InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModelTests:
         let expectedTitle = "Failed to enable Pay in Person. Please try again later."
         assertEqual(expectedTitle, notice.title)
     }
+
+    // MARK: - Analytics tests
+    func test_skip_tapped_logs_onboarding_step_skipped_event() throws {
+        // Given
+        assertEmpty(analyticsProvider.receivedEvents)
+
+        // When
+        sut.skipTapped()
+
+        // Then
+        assertNotEmpty(analyticsProvider.receivedEvents)
+        let indexOfEvent = try XCTUnwrap(analyticsProvider.receivedEvents.firstIndex(where: { $0 == AnalyticEvents.skippedEvent }))
+        let eventProperties = try XCTUnwrap(analyticsProvider.receivedProperties[indexOfEvent])
+        assertEqual(AnalyticProperties.cashOnDeliveryDisabledReason, eventProperties[AnalyticProperties.reasonKey] as? String)
+        assertEqual(false, eventProperties[AnalyticProperties.remindLaterKey] as? Bool)
+        assertEqual("US", eventProperties[AnalyticProperties.countryCodeKey] as? String)
+    }
+}
+
+private enum AnalyticEvents {
+    static let skippedEvent = "card_present_onboarding_step_skipped"
+}
+
+private enum AnalyticProperties {
+    static let reasonKey = "reason"
+    static let cashOnDeliveryDisabledReason = "cash_on_delivery_disabled"
+    static let remindLaterKey = "remind_later"
+    static let countryCodeKey = "country"
 }
diff --git a/Yosemite/Yosemite/Model/Enums/CardPresentPaymentsOnboardingState.swift b/Yosemite/Yosemite/Model/Enums/CardPresentPaymentsOnboardingState.swift
@@ -115,7 +115,7 @@ extension CardPresentPaymentOnboardingState {
         case .stripeAccountRejected:
             return "account_rejected"
         case .codPaymentGatewayNotSetUp:
-            return "cod_not_set_up"
+            return "cash_on_delivery_disabled"
         case .genericError:
             return "generic_error"
         case .noConnectionError:

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import SwiftUI`
	`2`	`+import Yosemite`
`2`	`3`
`3`	`4`	`struct InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpView: View {`
`4`	`5`	`@ObservedObject var viewModel: InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel`
`@@ -35,7 +36,8 @@ struct InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpView: View {`
`35`	`36`
`36`	`37`	`struct InPersonPaymentsCodPaymentGatewayNotSetUp_Previews: PreviewProvider {`
`37`	`38`	`static var previews: some View {`
`38`		`- let viewModel = InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(completion: {})`
	`39`	`+ let viewModel = InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpViewModel(configuration: CardPresentPaymentsConfiguration(country: "US"),`
	`40`	`+ completion: {})`
`39`	`41`	`return InPersonPaymentsCashOnDeliveryPaymentGatewayNotSetUpView(viewModel: viewModel)`
`40`	`42`	`}`
`41`	`43`	`}`