WaitingTimeTracker improvements (#15082)

Author: iamgabrielma

WooCommerce/Classes/Analytics/AppStartupWaitingTimeTracker.swift

@@ -5,7 +5,7 @@ import protocol WooFoundation.Analytics
 /// Tracks the waiting time for app startup, allowing to evaluate as analytics
 /// how much time in seconds it took between the init and the final `end(action:)` function call.
 ///
-class AppStartupWaitingTimeTracker: WaitingTimeTracker {
+final class AppStartupWaitingTimeTracker: WaitingTimeTracker {
 
     /// All actions tracked in the app startup waiting time.
     ///
@@ -21,8 +21,8 @@ class AppStartupWaitingTimeTracker: WaitingTimeTracker {
     private(set) var startupActionsPending = StartupAction.allCases
 
     init(analyticsService: Analytics = ServiceLocator.analytics,
-         currentTimeInMillis: @escaping () -> TimeInterval = { Date().timeIntervalSince1970 }) {
-        super.init(trackScenario: .appStartup, analyticsService: analyticsService, currentTime: currentTimeInMillis)
+         currentTimestampSeconds: @escaping () -> TimeInterval = { Date().timeIntervalSince1970 }) {
+        super.init(trackScenario: .appStartup, analyticsService: analyticsService, currentTimestampSeconds: currentTimestampSeconds)
     }
 
     /// Ends the waiting time for the provided startup action.

WooCommerce/Classes/Analytics/WaitingTimeTracker.swift

@@ -7,35 +7,46 @@ import protocol WooFoundation.Analytics
 ///
 class WaitingTimeTracker {
     private let trackScenario: WooAnalyticsEvent.WaitingTime.Scenario
-    private let currentTime: () -> TimeInterval
+    private let currentTimestampSeconds: () -> TimeInterval
     private let analyticsService: Analytics
     private let waitingStartedTimestamp: TimeInterval
 
+    enum TrackingUnit {
+        case seconds
+        case milliseconds
+    }
+
     init(trackScenario: WooAnalyticsEvent.WaitingTime.Scenario,
          analyticsService: Analytics = ServiceLocator.analytics,
-         currentTime: @escaping () -> TimeInterval = { Date().timeIntervalSince1970 }
+         currentTimestampSeconds: @escaping () -> TimeInterval = { Date().timeIntervalSince1970 }
     ) {
         self.trackScenario = trackScenario
         self.analyticsService = analyticsService
-        self.currentTime = currentTime
-        waitingStartedTimestamp = currentTime()
+        self.currentTimestampSeconds = currentTimestampSeconds
+        waitingStartedTimestamp = currentTimestampSeconds()
     }
 
-    /// End the waiting time by evaluating the elapsed time from the init,
-    /// and sending it as an analytics event, in seconds.
+    /// Default `end()` method to preserve interface compatibility. By default, tracks in `.seconds`
     ///
     func end() {
-        let elapsedTime = currentTime() - waitingStartedTimestamp
-        let analyticsEvent = WooAnalyticsEvent.WaitingTime.waitingFinished(scenario: trackScenario, elapsedTime: elapsedTime)
-        analyticsService.track(event: analyticsEvent)
+        end(using: .seconds)
     }
 
     /// End the waiting time by evaluating the elapsed time from the init,
-    /// and sending it as an analytics event, in milliseconds
+    /// and sending it as an analytics event.
     ///
-    func endInMilliseconds() {
-        let elapsedTimeMs = (currentTime() - waitingStartedTimestamp) * 1000
-        let analyticsEvent = WooAnalyticsEvent.WaitingTime.waitingFinished(scenario: trackScenario, elapsedTime: elapsedTimeMs)
+    /// - Parameter trackingUnit: Defines whether the elapsed time should be tracked in `.seconds` or `.milliseconds` (default is `.seconds`).
+    ///
+    func end(using trackingUnit: TrackingUnit = .seconds) {
+        let elapsedTime = calculateElapsedTime(in: trackingUnit)
+        let analyticsEvent = WooAnalyticsEvent.WaitingTime.waitingFinished(scenario: trackScenario, elapsedTime: elapsedTime)
         analyticsService.track(event: analyticsEvent)
     }
+
+    /// Calculates elapsed time in the specified tracking unit.
+    ///
+    private func calculateElapsedTime(in trackingUnit: TrackingUnit) -> TimeInterval {
+        let elapsedTime = currentTimestampSeconds() - waitingStartedTimestamp
+        return trackingUnit == .milliseconds ? elapsedTime * 1000 : elapsedTime
+    }
 }

WooCommerce/Classes/POS/Presentation/CardReaderConnection/UI States/PointOfSaleLoadingView.swift

@@ -31,7 +31,7 @@ private extension PointOfSaleLoadingView {
 
     func trackElapsedTimeOnDisappear() {
         if let waitingTimeTracker = waitingTimeTracker {
-            waitingTimeTracker.endInMilliseconds()
+            waitingTimeTracker.end(using: .milliseconds)
         }
     }
 }

WooCommerce/WooCommerceTests/System/WaitingTimeTrackerTests.swift

@@ -26,7 +26,7 @@ class WaitingTimeTrackerTests: XCTestCase {
 
     func testOrderDetailsTrackScenarioTriggersExpectedAnalyticsStat() {
         // Given
-        let waitingTracker = WaitingTimeTracker(trackScenario: .orderDetails, analyticsService: testAnalytics, currentTime: { 0 })
+        let waitingTracker = WaitingTimeTracker(trackScenario: .orderDetails, analyticsService: testAnalytics, currentTimestampSeconds: { 0 })
 
         // When
         waitingTracker.end()
@@ -39,7 +39,7 @@ class WaitingTimeTrackerTests: XCTestCase {
         // Given
         let waitingTracker = WaitingTimeTracker(trackScenario: .dashboardTopPerformers,
                                                 analyticsService: testAnalytics,
-                                                currentTime: { 0 }
+                                                currentTimestampSeconds: { 0 }
         )
 
         // When
@@ -53,7 +53,7 @@ class WaitingTimeTrackerTests: XCTestCase {
         // Given
         let waitingTracker = WaitingTimeTracker(trackScenario: .dashboardMainStats,
                                                 analyticsService: testAnalytics,
-                                                currentTime: { 0 }
+                                                currentTimestampSeconds: { 0 }
         )
 
         // When
@@ -67,7 +67,7 @@ class WaitingTimeTrackerTests: XCTestCase {
         // Given
         let waitingTracker = WaitingTimeTracker(trackScenario: .analyticsHub,
                                                 analyticsService: testAnalytics,
-                                                currentTime: { 0 }
+                                                currentTimestampSeconds: { 0 }
         )
 
         // When
@@ -81,7 +81,7 @@ class WaitingTimeTrackerTests: XCTestCase {
         // Given
         let waitingTracker = WaitingTimeTracker(trackScenario: .appStartup,
                                                 analyticsService: testAnalytics,
-                                                currentTime: { 0 }
+                                                currentTimestampSeconds: { 0 }
         )
 
         // When
@@ -91,6 +91,36 @@ class WaitingTimeTrackerTests: XCTestCase {
         XCTAssertEqual(testAnalytics.lastReceivedEventName, WooAnalyticsStat.applicationOpenedWaitingTimeLoaded.rawValue)
     }
 
+    func test_timeElapsed_evaluation_in_milliseconds_is_correct() {
+        // Given
+        var currentTimeCallCounter = 0.0
+        let expectedReceivedWaitingTime = 10_000.0 // 10s * 1000 ms
+        let waitingTracker = WaitingTimeTracker(trackScenario: .orderDetails,
+                                                analyticsService: testAnalytics) {
+            currentTimeCallCounter += 1
+            return currentTimeCallCounter * 10
+        }
+
+        // When
+        waitingTracker.end(using: .milliseconds)
+
+        // Then
+        XCTAssertEqual(testAnalytics.lastReceivedWaitingTime, expectedReceivedWaitingTime)
+    }
+
+    func test_track_scenario_triggers_expected_analytics_stat_in_milliseconds() {
+        // Given
+        let waitingTracker = WaitingTimeTracker(trackScenario: .pointOfSaleLoaded,
+                                                analyticsService: testAnalytics,
+                                                currentTimestampSeconds: { 0 })
+
+        // When
+        waitingTracker.end(using: .milliseconds)
+
+        // Then
+        XCTAssertEqual(testAnalytics.lastReceivedEventName, WooAnalyticsStat.pointOfSaleLoaded.rawValue)
+    }
+
     class TestAnalytics: Analytics {
         var lastReceivedEventName: String? = nil
         var lastReceivedWaitingTime: TimeInterval? = nil