Merge pull request #8337 from woocommerce/issue/8323-analytics-hub-used-analytics-event

[Analytics Hub] Add interactions to used analytics event

Author: rachelmcr

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/AnalyticsHubView.swift

@@ -15,8 +15,11 @@ final class AnalyticsHubHostingViewController: UIHostingController<AnalyticsHubV
     ///
     var notice: Notice?
 
-    init(siteID: Int64, timeRange: StatsTimeRangeV4, systemNoticePresenter: NoticePresenter = ServiceLocator.noticePresenter) {
-        let viewModel = AnalyticsHubViewModel(siteID: siteID, statsTimeRange: timeRange)
+    init(siteID: Int64,
+         timeRange: StatsTimeRangeV4,
+         systemNoticePresenter: NoticePresenter = ServiceLocator.noticePresenter,
+         usageTracksEventEmitter: StoreStatsUsageTracksEventEmitter) {
+        let viewModel = AnalyticsHubViewModel(siteID: siteID, statsTimeRange: timeRange, usageTracksEventEmitter: usageTracksEventEmitter)
         self.systemNoticePresenter = systemNoticePresenter
         super.init(rootView: AnalyticsHubView(viewModel: viewModel))
 
@@ -56,6 +59,7 @@ struct AnalyticsHubView: View {
 
     var body: some View {
         RefreshablePlainList(action: {
+            viewModel.trackAnalyticsInteraction()
             await viewModel.updateData()
         }) {
             VStack(alignment: .leading, spacing: Layout.verticalSpacing) {
@@ -114,6 +118,12 @@ struct AnalyticsHubView: View {
             guard let notice else { return }
             dismissWithNotice(notice)
         }
+        .gesture(
+            // Detects when scrolling begins so it can be tracked.
+            DragGesture().onChanged({ _ in
+                viewModel.trackAnalyticsInteraction()
+            })
+        )
     }
 }
 
@@ -135,7 +145,9 @@ private extension AnalyticsHubView {
 struct AnalyticsHubPreview: PreviewProvider {
     static var previews: some View {
         NavigationView {
-            AnalyticsHubView(viewModel: AnalyticsHubViewModel(siteID: 123, statsTimeRange: .thisYear))
+            AnalyticsHubView(viewModel: AnalyticsHubViewModel(siteID: 123,
+                                                              statsTimeRange: .thisYear,
+                                                              usageTracksEventEmitter: StoreStatsUsageTracksEventEmitter()))
         }
     }
 }

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/AnalyticsHubViewModel.swift

@@ -12,8 +12,13 @@ final class AnalyticsHubViewModel: ObservableObject {
 
     private var subscriptions = Set<AnyCancellable>()
 
+    /// Analytics Usage Tracks Event Emitter
+    ///
+    private let usageTracksEventEmitter: StoreStatsUsageTracksEventEmitter
+
     init(siteID: Int64,
          statsTimeRange: StatsTimeRangeV4,
+         usageTracksEventEmitter: StoreStatsUsageTracksEventEmitter,
          stores: StoresManager = ServiceLocator.stores) {
         let selectedType = AnalyticsHubTimeRangeSelection.SelectionType(statsTimeRange)
         let timeRangeSelection = AnalyticsHubTimeRangeSelection(selectionType: selectedType)
@@ -22,7 +27,8 @@ final class AnalyticsHubViewModel: ObservableObject {
         self.stores = stores
         self.timeRangeSelectionType = selectedType
         self.timeRangeSelection = timeRangeSelection
-        self.timeRangeCard = AnalyticsHubViewModel.timeRangeCard(timeRangeSelection: timeRangeSelection)
+        self.timeRangeCard = AnalyticsHubViewModel.timeRangeCard(timeRangeSelection: timeRangeSelection, usageTracksEventEmitter: usageTracksEventEmitter)
+        self.usageTracksEventEmitter = usageTracksEventEmitter
 
         bindViewModelsWithData()
     }
@@ -84,6 +90,12 @@ final class AnalyticsHubViewModel: ObservableObject {
             DDLogWarn("⚠️ Error fetching analytics data: \(error)")
         }
     }
+
+    /// Tracks interactions for analytics usage event
+    ///
+    func trackAnalyticsInteraction() {
+        usageTracksEventEmitter.interacted()
+    }
 }
 
 // MARK: Networking
@@ -189,7 +201,8 @@ private extension AnalyticsHubViewModel {
             .sink { [weak self] newSelectionType in
                 guard let self else { return }
                 self.timeRangeSelection = AnalyticsHubTimeRangeSelection(selectionType: newSelectionType)
-                self.timeRangeCard = AnalyticsHubViewModel.timeRangeCard(timeRangeSelection: self.timeRangeSelection)
+                self.timeRangeCard = AnalyticsHubViewModel.timeRangeCard(timeRangeSelection: self.timeRangeSelection,
+                                                                         usageTracksEventEmitter: self.usageTracksEventEmitter)
                 Task.init {
                     await self.updateData()
                 }
@@ -266,10 +279,12 @@ private extension AnalyticsHubViewModel {
         }
     }
 
-    static func timeRangeCard(timeRangeSelection: AnalyticsHubTimeRangeSelection) -> AnalyticsTimeRangeCardViewModel {
+    static func timeRangeCard(timeRangeSelection: AnalyticsHubTimeRangeSelection,
+                              usageTracksEventEmitter: StoreStatsUsageTracksEventEmitter) -> AnalyticsTimeRangeCardViewModel {
         return AnalyticsTimeRangeCardViewModel(selectedRangeTitle: timeRangeSelection.rangeSelectionDescription,
                                                currentRangeSubtitle: timeRangeSelection.currentRangeDescription,
-                                               previousRangeSubtitle: timeRangeSelection.previousRangeDescription)
+                                               previousRangeSubtitle: timeRangeSelection.previousRangeDescription,
+                                               usageTracksEventEmitter: usageTracksEventEmitter)
     }
 }
 

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/AnalyticsTimeRangeCard.swift

@@ -11,10 +11,13 @@ struct AnalyticsTimeRangeCard: View {
 
     @State private var showTimeRangeSelectionView: Bool = false
 
+    private let usageTracksEventEmitter: StoreStatsUsageTracksEventEmitter
+
     init(viewModel: AnalyticsTimeRangeCardViewModel, selectionType: Binding<AnalyticsHubTimeRangeSelection.SelectionType>) {
         self.timeRangeTitle = viewModel.selectedRangeTitle
         self.currentRangeDescription = viewModel.currentRangeSubtitle
         self.previousRangeDescription = viewModel.previousRangeSubtitle
+        self.usageTracksEventEmitter = viewModel.usageTracksEventEmitter
         self._selectionType = selectionType
     }
 
@@ -25,6 +28,7 @@ struct AnalyticsTimeRangeCard: View {
                               items: AnalyticsHubTimeRangeSelection.SelectionType.allCases,
                               contentKeyPath: \.description,
                               selected: $selectionType) { selection in
+                    usageTracksEventEmitter.interacted()
                     ServiceLocator.analytics.track(event: .AnalyticsHub.dateRangeOptionSelected(selection.rawValue))
                 }
             }
@@ -33,6 +37,7 @@ struct AnalyticsTimeRangeCard: View {
     private func createTimeRangeContent() -> some View {
         VStack(alignment: .leading, spacing: Layout.verticalSpacing) {
             Button(action: {
+                usageTracksEventEmitter.interacted()
                 ServiceLocator.analytics.track(event: .AnalyticsHub.dateRangeButtonTapped())
                 showTimeRangeSelectionView.toggle()
             }, label: {
@@ -104,7 +109,8 @@ struct TimeRangeCard_Previews: PreviewProvider {
     static var previews: some View {
         let viewModel = AnalyticsTimeRangeCardViewModel(selectedRangeTitle: "Month to Date",
                                                         currentRangeSubtitle: "Nov 1 - 23, 2022",
-                                                        previousRangeSubtitle: "Oct 1 - 23, 2022")
+                                                        previousRangeSubtitle: "Oct 1 - 23, 2022",
+                                                        usageTracksEventEmitter: StoreStatsUsageTracksEventEmitter())
         AnalyticsTimeRangeCard(viewModel: viewModel, selectionType: .constant(.monthToDate))
     }
 }

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/AnalyticsTimeRangeCardViewModel.swift

@@ -15,4 +15,8 @@ struct AnalyticsTimeRangeCardViewModel {
     /// Previous Range Subtitle.
     ///
     let previousRangeSubtitle: String
+
+    /// Analytics Usage Tracks Event Emitter
+    ///
+    let usageTracksEventEmitter: StoreStatsUsageTracksEventEmitter
 }

WooCommerce/Classes/ViewRelated/Dashboard/Stats v4/StoreStatsAndTopPerformersPeriodViewController.swift

@@ -358,7 +358,7 @@ private extension StoreStatsAndTopPerformersPeriodViewController {
 
     @objc func seeMoreButtonTapped() {
         ServiceLocator.analytics.track(event: .AnalyticsHub.seeMoreAnalyticsTapped())
-        let analyticsHubVC = AnalyticsHubHostingViewController(siteID: siteID, timeRange: timeRange)
+        let analyticsHubVC = AnalyticsHubHostingViewController(siteID: siteID, timeRange: timeRange, usageTracksEventEmitter: usageTracksEventEmitter)
         show(analyticsHubVC, sender: self)
     }
 }

WooCommerce/Classes/ViewRelated/Dashboard/Stats v4/StoreStatsUsageTracksEventEmitter.swift

@@ -4,15 +4,18 @@ import Foundation
 /// considered as a _usage_ of the UI.
 ///
 /// See p91TBi-6Cl-p2 for more information about the algorithm.
+/// See pe5pgL-153-p2 for background about adding Analytics Hub interactions to the algorithm.
 ///
 /// The UI should call `interacted` when these events happen:
 ///
-/// - Scrolling
-/// - Pull-to-refresh
+/// - Scrolling (My Store or Analytics)
+/// - Pull-to-refresh (My Store or Analytics)
 /// - Tapping on the bars in the chart
 /// - Changing the tab
 /// - Navigating to the My Store tab
 /// - Tapping on a product in the Top Performers list
+/// - Tapping on the Analytics date range
+/// - Selecting an Analytics date range option
 ///
 /// If we ever change the algorithm in the future, we should probably consider renaming the Tracks event to avoid
 /// incorrect comparisons with old events. We should also make sure to change the Android code if we're changing anything
@@ -35,6 +38,8 @@ final class StoreStatsUsageTracksEventEmitter {
     /// - Changing the tab
     /// - Navigating to the My Store tab
     /// - Tapping on a product in the Top Performers list
+    /// - Tapping on the date range in the Analytics Hub
+    /// - Selecting a date range option in the Analytics Hub
     private let interactionsThreshold = 5
 
     /// The maximum number of seconds in between interactions before we will consider the

WooCommerce/WooCommerceTests/ViewRelated/Dashboard/Analytics Hub/AnalyticsHubViewModelTests.swift

@@ -5,14 +5,18 @@ import Yosemite
 final class AnalyticsHubViewModelTests: XCTestCase {
 
     private var stores: MockStoresManager!
+    private var eventEmitter: StoreStatsUsageTracksEventEmitter!
 
     override func setUp() {
         stores = MockStoresManager(sessionManager: .makeForTesting())
+        let analyticsProvider = MockAnalyticsProvider()
+        let analytics = WooAnalytics(analyticsProvider: analyticsProvider)
+        eventEmitter = StoreStatsUsageTracksEventEmitter(analytics: analytics)
     }
 
     func test_cards_viewmodels_show_correct_data_after_updating_from_network() async {
         // Given
-        let vm = AnalyticsHubViewModel(siteID: 123, statsTimeRange: .thisMonth, stores: stores)
+        let vm = AnalyticsHubViewModel(siteID: 123, statsTimeRange: .thisMonth, usageTracksEventEmitter: eventEmitter, stores: stores)
 
         stores.whenReceivingAction(ofType: StatsActionV4.self) { action in
             switch action {
@@ -43,7 +47,7 @@ final class AnalyticsHubViewModelTests: XCTestCase {
 
     func test_cards_viewmodels_show_sync_error_after_getting_error_from_network() async {
         // Given
-        let vm = AnalyticsHubViewModel(siteID: 123, statsTimeRange: .thisMonth, stores: stores)
+        let vm = AnalyticsHubViewModel(siteID: 123, statsTimeRange: .thisMonth, usageTracksEventEmitter: eventEmitter, stores: stores)
         stores.whenReceivingAction(ofType: StatsActionV4.self) { action in
             switch action {
             case let .retrieveCustomStats(_, _, _, _, _, _, completion):
@@ -67,7 +71,7 @@ final class AnalyticsHubViewModelTests: XCTestCase {
 
     func test_cards_viewmodels_redacted_while_updating_from_network() async {
         // Given
-        let vm = AnalyticsHubViewModel(siteID: 123, statsTimeRange: .thisMonth, stores: stores)
+        let vm = AnalyticsHubViewModel(siteID: 123, statsTimeRange: .thisMonth, usageTracksEventEmitter: eventEmitter, stores: stores)
         var loadingRevenueCard: AnalyticsReportCardViewModel?
         var loadingOrdersCard: AnalyticsReportCardViewModel?
         var loadingProductsCard: AnalyticsProductCardViewModel?