Merge pull request #8010 from woocommerce/issue/7853-retrieval-and-view-jitm-analytics

joshheald · web-flow · commit 7ef4a7cc9b95 · 2022-11-04T11:24:45.000Z
[Just In Time Messages] GET request and view analytic events
diff --git a/WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift b/WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift
@@ -625,8 +625,39 @@ 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 messageDisplayed(source: String,
+                                     messageID: String,
+                                     featureClass: String) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .justInTimeMessageDisplayed,
+                              properties: [
+                                Keys.source: source,
+                                Keys.justInTimeMessageID: messageID,
+                                Keys.justInTimeMessageGroup: featureClass
+                              ])
         }
 
         static func callToActionTapped(source: String,
diff --git a/WooCommerce/Classes/Analytics/WooAnalyticsStat.swift b/WooCommerce/Classes/Analytics/WooAnalyticsStat.swift
@@ -635,6 +635,9 @@ 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"
+    case justInTimeMessageDisplayed = "jitm_displayed"
 
     // MARK: Simple Payments events
     //
diff --git a/WooCommerce/Classes/ViewModels/Feature Announcement Cards/JustInTimeMessageAnnouncementCardViewModel.swift b/WooCommerce/Classes/ViewModels/Feature Announcement Cards/JustInTimeMessageAnnouncementCardViewModel.swift
@@ -71,7 +71,9 @@ final class JustInTimeMessageAnnouncementCardViewModel: AnnouncementCardViewMode
 
     // MARK: - AnnouncementCardViewModelProtocol methods
     func onAppear() {
-        // No-op
+        analytics.track(event: .JustInTimeMessage.messageDisplayed(source: screenName,
+                                                                   messageID: messageID,
+                                                                   featureClass: featureClass))
     }
 
     func ctaTapped() {
diff --git a/WooCommerce/Classes/ViewRelated/Dashboard/DashboardViewModel.swift b/WooCommerce/Classes/ViewRelated/Dashboard/DashboardViewModel.swift
@@ -15,11 +15,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,15 +158,24 @@ final class DashboardViewModel {
             hook: .adminNotices) { [weak self] result in
                 guard let self = self else { return }
                 switch result {
-                case let .success(.some(message)):
+                case let .success(messages):
+                    guard let message = messages.first else {
+                        return
+                    }
+                    self.analytics.track(event:
+                            .JustInTimeMessage.fetchSuccess(source: Constants.dashboardScreenName,
+                                                            messageID: message.messageID,
+                                                            count: Int64(messages.count)))
                     let viewModel = JustInTimeMessageAnnouncementCardViewModel(
                         justInTimeMessage: message,
                         screenName: Constants.dashboardScreenName,
                         siteID: siteID)
                     self.announcementViewModel = viewModel
                     viewModel.$showWebViewSheet.assign(to: &self.$showWebViewSheet)
-                default:
-                    break
+                case let .failure(error):
+                    self.analytics.track(event:
+                            .JustInTimeMessage.fetchFailure(source: Constants.dashboardScreenName,
+                                                            error: error))
                 }
             }
         stores.dispatch(action)
diff --git a/WooCommerce/WooCommerceTests/ViewModels/Feature Announcement Cards/JustInTimeMessageAnnouncementCardViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewModels/Feature Announcement Cards/JustInTimeMessageAnnouncementCardViewModelTests.swift
@@ -159,6 +159,17 @@ final class JustInTimeMessageAnnouncementCardViewModelTests: XCTestCase {
         assertAnalyticEventLogged(name: "jitm_dismiss_failure", message: message, error: expectedError)
     }
 
+    func test_onAppear_tracks_just_in_time_message_displayed_analytic_event() {
+        let message = Yosemite.JustInTimeMessage.fake().copy(messageID: "test-message-id", featureClass: "test-feature-class")
+        setUp(with: message)
+
+        // When
+        sut.onAppear()
+
+        // Then
+        assertAnalyticEventLogged(name: "jitm_displayed", message: message)
+    }
+
     private func assertAnalyticEventLogged(name: String, message: Yosemite.JustInTimeMessage) {
         let expectedProperties = ["jitm_id": message.messageID,
                                   "jitm_group": message.featureClass,
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Dashboard/DashboardViewModelTests.swift b/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
@@ -84,7 +91,6 @@ final class DashboardViewModelTests: XCTestCase {
     func test_products_onboarding_announcements_take_precedence() {
         // Given
         MockABTesting.setVariation(.treatment(nil), for: .productsOnboardingBanner)
-        let stores = MockStoresManager(sessionManager: .makeForTesting())
         stores.whenReceivingAction(ofType: ProductAction.self) { action in
             switch action {
             case let .checkProductsOnboardingEligibility(_, completion):
@@ -96,7 +102,7 @@ final class DashboardViewModelTests: XCTestCase {
         stores.whenReceivingAction(ofType: JustInTimeMessageAction.self) { action in
             switch action {
             case let .loadMessage(_, _, _, completion):
-                completion(.success(Yosemite.JustInTimeMessage.fake()))
+                completion(.success([Yosemite.JustInTimeMessage.fake()]))
             default:
                 XCTFail("Received unsupported action: \(action)")
             }
@@ -112,7 +118,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):
@@ -124,23 +141,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):
@@ -152,7 +161,7 @@ final class DashboardViewModelTests: XCTestCase {
         stores.whenReceivingAction(ofType: JustInTimeMessageAction.self) { action in
             switch action {
             case let .loadMessage(_, _, _, completion):
-                completion(.success(nil))
+                completion(.success([]))
             default:
                 XCTFail("Received unsupported action: \(action)")
             }
@@ -165,4 +174,65 @@ final class DashboardViewModelTests: XCTestCase {
         // Then
         XCTAssertNil(viewModel.announcementViewModel)
     }
+
+    func test_fetch_success_analytics_logged_when_just_in_time_messages_retrieved() {
+        // Given
+        let message = Yosemite.JustInTimeMessage.fake().copy(messageID: "test-message-id",
+                                                             featureClass: "test-feature-class")
+
+        let secondMessage = Yosemite.JustInTimeMessage.fake().copy(messageID: "test-message-id-2",
+                                                                   featureClass: "test-feature-class-2")
+        prepareStoresToShowJustInTimeMessage(.success([message, secondMessage]))
+        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(2, properties["count"] as? Int64)
+    }
+
+    func test_when_two_messages_are_received_only_the_first_is_displayed() {
+        // Given
+        let message = Yosemite.JustInTimeMessage.fake().copy(title: "Higher priority JITM")
+
+        let secondMessage = Yosemite.JustInTimeMessage.fake().copy(title: "Lower priority JITM")
+        prepareStoresToShowJustInTimeMessage(.success([message, secondMessage]))
+        let viewModel = DashboardViewModel(stores: stores, analytics: analytics)
+
+        // When
+        viewModel.syncAnnouncements(for: sampleSiteID)
+
+        // Then
+        XCTAssertEqual(viewModel.announcementViewModel?.title, "Higher priority JITM")
+    }
+
+    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)
+    }
 }
diff --git a/Yosemite/Yosemite/Actions/JustInTimeMessageAction.swift b/Yosemite/Yosemite/Actions/JustInTimeMessageAction.swift
@@ -8,7 +8,7 @@ public enum JustInTimeMessageAction: Action {
     case loadMessage(siteID: Int64,
                      screen: String,
                      hook: JustInTimeMessageHook,
-                     completion: (Result<JustInTimeMessage?, Error>) -> ())
+                     completion: (Result<[JustInTimeMessage], Error>) -> ())
 
     /// Dismisses a `JustInTimeMessage` and others for the same `featureClass`
     ///
diff --git a/Yosemite/Yosemite/Stores/JustInTimeMessageStore.swift b/Yosemite/Yosemite/Stores/JustInTimeMessageStore.swift
@@ -44,25 +44,22 @@ private extension JustInTimeMessageStore {
     func loadMessage(for siteID: Int64,
                      screen: String,
                      hook: JustInTimeMessageHook,
-                     completion: @escaping (Result<JustInTimeMessage?, Error>) -> ()) {
+                     completion: @escaping (Result<[JustInTimeMessage], Error>) -> ()) {
         Task {
             let result = await remote.loadAllJustInTimeMessages(
                     for: siteID,
                     messagePath: .init(app: .wooMobile,
                                        screen: screen,
                                        hook: hook))
-            let displayResult = result.map(topDisplayMessage(_:))
+            let displayResult = result.map(displayMessages(_:))
             await MainActor.run {
                 completion(displayResult)
             }
         }
     }
 
-    func topDisplayMessage(_ messages: [Networking.JustInTimeMessage]) -> JustInTimeMessage? {
-        guard let topMessage = messages.first else {
-            return nil
-        }
-        return JustInTimeMessage(message: topMessage)
+    func displayMessages(_ messages: [Networking.JustInTimeMessage]) -> [JustInTimeMessage] {
+        return messages.map { JustInTimeMessage(message: $0) }
     }
 
     func dismissMessage(_ message: JustInTimeMessage,
diff --git a/Yosemite/YosemiteTests/Stores/JustInTimeMessageStoreTests.swift b/Yosemite/YosemiteTests/Stores/JustInTimeMessageStoreTests.swift
@@ -26,7 +26,7 @@ final class JustInTimeMessageStoreTests: XCTestCase {
         sut = JustInTimeMessageStore(dispatcher: Dispatcher(), storageManager: storageManager, network: network)
     }
 
-    func test_loadMessage_then_it_returns_nil_upon_successful_empty_response() throws {
+    func test_loadMessage_then_it_returns_empty_array_upon_successful_empty_response() throws {
         // Given
         network.simulateResponse(requestUrlSuffix: "jetpack/v4/jitm", filename: "empty-data-array")
 
@@ -43,7 +43,7 @@ final class JustInTimeMessageStoreTests: XCTestCase {
 
         // Then
         XCTAssert(result.isSuccess)
-        XCTAssertNil(try result.get())
+        XCTAssert(try result.get().isEmpty)
     }
 
     func test_loadMessage_then_it_returns_the_Just_In_Time_Message_upon_successful_response() throws {
@@ -72,37 +72,7 @@ final class JustInTimeMessageStoreTests: XCTestCase {
 
         // Then
         XCTAssert(result.isSuccess)
-        let recievedMessage = try XCTUnwrap(result.get())
-        assertEqual(expectedJustInTimeMessage, recievedMessage)
-    }
-
-    func test_loadMessage_then_it_returns_the_first_Just_In_Time_Message_upon_successful_response_with_multiple_jitms() throws {
-        // Given
-        network.simulateResponse(requestUrlSuffix: "jetpack/v4/jitm", filename: "just-in-time-message-list-multiple")
-
-        // When
-        let result = waitFor { promise in
-            let action = JustInTimeMessageAction.loadMessage(
-                siteID: self.sampleSiteID,
-                screen: "my_store",
-                hook: .adminNotices) { result in
-                    promise(result)
-                }
-            self.sut.onAction(action)
-        }
-
-        let expectedJustInTimeMessage = JustInTimeMessage(
-            siteID: sampleSiteID,
-            messageID: "woomobile_onboarding_add_product",
-            featureClass: "woomobile_onboarding_products",
-            title: "Add some products",
-            detail: "Get started selling your products: add them easily using the Products tab",
-            buttonTitle: "Add product",
-            url: "woocommerce://products/add")
-
-        // Then
-        XCTAssert(result.isSuccess)
-        let recievedMessage = try XCTUnwrap(result.get())
+        let recievedMessage = try XCTUnwrap(result.get().first)
         assertEqual(expectedJustInTimeMessage, recievedMessage)
     }
 

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,9 @@ final class JustInTimeMessageAnnouncementCardViewModel: AnnouncementCardViewMode`
`71`	`71`
`72`	`72`	`// MARK: - AnnouncementCardViewModelProtocol methods`
`73`	`73`	`func onAppear() {`
`74`		`- // No-op`
	`74`	`+ analytics.track(event: .JustInTimeMessage.messageDisplayed(source: screenName,`
	`75`	`+ messageID: messageID,`
	`76`	`+ featureClass: featureClass))`
`75`	`77`	`}`
`76`	`78`
`77`	`79`	`func ctaTapped() {`