7853 Track JITM GET request analytic events

Author: joshheald

WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift

@@ -625,8 +625,28 @@ extension WooAnalyticsEvent {
     enum JustInTimeMessage {
         private enum Keys {
             static let source = "source"
+            static let justInTimeMessage = "jitm"
             static let justInTimeMessageID = "jitm_id"
             static let justInTimeMessageGroup = "jitm_group"
+            static let count = "count"
+        }
+
+        static func fetchSuccess(source: String,
+                                 messageID: String,
+                                 count: Int64) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .justInTimeMessageFetchSuccess,
+                              properties: [
+                                Keys.source: source,
+                                Keys.justInTimeMessage: messageID,
+                                Keys.count: count
+                              ])
+        }
+
+        static func fetchFailure(source: String,
+                                 error: Error) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .justInTimeMessageFetchFailure,
+                              properties: [Keys.source: source],
+                              error: error)
         }
 
         static func callToActionTapped(source: String,

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -632,6 +632,8 @@ public enum WooAnalyticsStat: String {
     case justInTimeMessageDismissTapped = "jitm_dismissed"
     case justInTimeMessageDismissSuccess = "jitm_dismiss_success"
     case justInTimeMessageDismissFailure = "jitm_dismiss_failure"
+    case justInTimeMessageFetchSuccess = "jitm_fetch_success"
+    case justInTimeMessageFetchFailure = "jitm_fetch_failure"
 
     // MARK: Simple Payments events
     //

WooCommerce/Classes/ViewRelated/Dashboard/DashboardViewModel.swift

@@ -14,11 +14,14 @@ final class DashboardViewModel {
 
     private let stores: StoresManager
     private let featureFlagService: FeatureFlagService
+    private let analytics: Analytics
 
     init(stores: StoresManager = ServiceLocator.stores,
-         featureFlags: FeatureFlagService = ServiceLocator.featureFlagService) {
+         featureFlags: FeatureFlagService = ServiceLocator.featureFlagService,
+         analytics: Analytics = ServiceLocator.analytics) {
         self.stores = stores
         self.featureFlagService = featureFlags
+        self.analytics = analytics
     }
 
     /// Syncs store stats for dashboard UI.
@@ -155,13 +158,21 @@ final class DashboardViewModel {
                 guard let self = self else { return }
                 switch result {
                 case let .success(.some(message)):
+                    self.analytics.track(event:
+                            .JustInTimeMessage.fetchSuccess(source: Constants.dashboardScreenName,
+                                                            messageID: message.messageID,
+                                                            count: 1))
                     let viewModel = JustInTimeMessageAnnouncementCardViewModel(
                         justInTimeMessage: message,
                         screenName: Constants.dashboardScreenName,
                         siteID: siteID)
                     self.announcementViewModel = viewModel
                     viewModel.$showWebViewSheet.assign(to: &self.$showWebViewSheet)
-                default:
+                case let .failure(error):
+                    self.analytics.track(event:
+                            .JustInTimeMessage.fetchFailure(source: Constants.dashboardScreenName,
+                                                            error: error))
+                case .success(.none):
                     break
                 }
             }

WooCommerce/WooCommerceTests/ViewRelated/Dashboard/DashboardViewModelTests.swift

@@ -9,6 +9,16 @@ import struct Yosemite.JustInTimeMessage
 final class DashboardViewModelTests: XCTestCase {
     private let sampleSiteID: Int64 = 122
 
+    private var analytics: Analytics!
+    private var analyticsProvider: MockAnalyticsProvider!
+    private var stores: MockStoresManager!
+
+    override func setUp() {
+        analyticsProvider = MockAnalyticsProvider()
+        analytics = WooAnalytics(analyticsProvider: analyticsProvider)
+        stores = MockStoresManager(sessionManager: .makeForTesting())
+    }
+
     func test_default_statsVersion_is_v4() {
         // Given
         let viewModel = DashboardViewModel()
@@ -19,7 +29,6 @@ final class DashboardViewModelTests: XCTestCase {
 
     func test_statsVersion_changes_from_v4_to_v3_when_store_stats_sync_returns_noRestRoute_error() {
         // Given
-        let stores = MockStoresManager(sessionManager: .makeForTesting())
         stores.whenReceivingAction(ofType: StatsActionV4.self) { action in
             if case let .retrieveStats(_, _, _, _, _, _, completion) = action {
                 completion(.failure(DotcomError.noRestRoute))
@@ -37,7 +46,6 @@ final class DashboardViewModelTests: XCTestCase {
 
     func test_statsVersion_remains_v4_when_non_store_stats_sync_returns_noRestRoute_error() {
         // Given
-        let stores = MockStoresManager(sessionManager: .makeForTesting())
         stores.whenReceivingAction(ofType: StatsActionV4.self) { action in
             if case let .retrieveStats(_, _, _, _, _, _, completion) = action {
                 completion(.failure(DotcomError.empty))
@@ -61,7 +69,6 @@ final class DashboardViewModelTests: XCTestCase {
 
     func test_statsVersion_changes_from_v3_to_v4_when_store_stats_sync_returns_success() {
         // Given
-        let stores = MockStoresManager(sessionManager: .makeForTesting())
         // `DotcomError.noRestRoute` error indicates the stats are unavailable.
         var storeStatsResult: Result<Void, Error> = .failure(DotcomError.noRestRoute)
         stores.whenReceivingAction(ofType: StatsActionV4.self) { action in
@@ -83,7 +90,6 @@ final class DashboardViewModelTests: XCTestCase {
 
     func test_products_onboarding_announcements_take_precedence() {
         // Given
-        let stores = MockStoresManager(sessionManager: .makeForTesting())
         stores.whenReceivingAction(ofType: ProductAction.self) { action in
             switch action {
             case let .checkProductsOnboardingEligibility(_, completion):
@@ -111,7 +117,18 @@ final class DashboardViewModelTests: XCTestCase {
 
     func test_view_model_syncs_just_in_time_messages_when_ineligible_for_products_onboarding() {
         // Given
-        let stores = MockStoresManager(sessionManager: .makeForTesting())
+        let message = Yosemite.JustInTimeMessage.fake().copy(title: "JITM Message")
+        prepareStoresToShowJustInTimeMessage(.success(message))
+        let viewModel = DashboardViewModel(stores: stores)
+
+        // When
+        viewModel.syncAnnouncements(for: sampleSiteID)
+
+        // Then
+        XCTAssertEqual(viewModel.announcementViewModel?.title, "JITM Message")
+    }
+
+    func prepareStoresToShowJustInTimeMessage(_ response: Result<Yosemite.JustInTimeMessage?, Error>) {
         stores.whenReceivingAction(ofType: ProductAction.self) { action in
             switch action {
             case let .checkProductsOnboardingEligibility(_, completion):
@@ -123,23 +140,15 @@ final class DashboardViewModelTests: XCTestCase {
         stores.whenReceivingAction(ofType: JustInTimeMessageAction.self) { action in
             switch action {
             case let .loadMessage(_, _, _, completion):
-                completion(.success(Yosemite.JustInTimeMessage.fake().copy(title: "JITM Message")))
+                completion(response)
             default:
                 XCTFail("Received unsupported action: \(action)")
             }
         }
-        let viewModel = DashboardViewModel(stores: stores)
-
-        // When
-        viewModel.syncAnnouncements(for: sampleSiteID)
-
-        // Then
-        XCTAssertEqual(viewModel.announcementViewModel?.title, "JITM Message")
     }
 
     func test_no_announcement_to_display_when_no_announcements_are_synced() {
         // Given
-        let stores = MockStoresManager(sessionManager: .makeForTesting())
         stores.whenReceivingAction(ofType: ProductAction.self) { action in
             switch action {
             case let .checkProductsOnboardingEligibility(_, completion):
@@ -192,4 +201,47 @@ final class DashboardViewModelTests: XCTestCase {
         // Then
         XCTAssertNil(viewModel.announcementViewModel)
     }
+
+    func test_fetch_success_analytics_logged_when_just_in_time_message_retrieved() {
+        // Given
+        let message = Yosemite.JustInTimeMessage.fake().copy(messageID: "test-message-id",
+                                                             featureClass: "test-feature-class")
+        prepareStoresToShowJustInTimeMessage(.success(message))
+        let viewModel = DashboardViewModel(stores: stores, analytics: analytics)
+
+        // When
+        viewModel.syncAnnouncements(for: sampleSiteID)
+
+        // Then
+        guard let eventIndex = analyticsProvider.receivedEvents.firstIndex(of: "jitm_fetch_success"),
+              let properties = analyticsProvider.receivedProperties[eventIndex] as? [String: AnyHashable]
+        else {
+            return XCTFail("Expected event was not logged")
+        }
+
+        assertEqual("my_store", properties["source"] as? String)
+        assertEqual("test-message-id", properties["jitm"] as? String)
+        assertEqual(1, properties["count"] as? Int64)
+    }
+
+    func test_fetch_failure_analytics_logged_when_just_in_time_message_errors() {
+        // Given
+        let error = DotcomError.noRestRoute
+        prepareStoresToShowJustInTimeMessage(.failure(error))
+        let viewModel = DashboardViewModel(stores: stores, analytics: analytics)
+
+        // When
+        viewModel.syncAnnouncements(for: sampleSiteID)
+
+        // Then
+        guard let eventIndex = analyticsProvider.receivedEvents.firstIndex(of: "jitm_fetch_failure"),
+              let properties = analyticsProvider.receivedProperties[eventIndex] as? [String: AnyHashable]
+        else {
+            return XCTFail("Expected event was not logged")
+        }
+
+        assertEqual("my_store", properties["source"] as? String)
+        assertEqual("Networking.DotcomError", properties["error_domain"] as? String)
+        assertEqual("Dotcom Invalid REST Route", properties["error_description"] as? String)
+    }
 }