Telemetry events: migrating to NavNative

Author: RingerJK

libnavigation-copilot/src/main/java/com/mapbox/navigation/copilot/MapboxCopilotImpl.kt

@@ -122,7 +122,7 @@ internal class MapboxCopilotImpl(
      * start
      */
     fun start() {
-        registerUserFeedbackCallback(userFeedbackCallback)
+        registerUserFeedbackCallback(mapboxNavigation, userFeedbackCallback)
         if (isMapboxNavigationAppSetup) {
             MapboxNavigationApp.lifecycleOwner.lifecycle.addObserver(
                 foregroundBackgroundLifecycleObserver
@@ -139,7 +139,7 @@ internal class MapboxCopilotImpl(
      * stop
      */
     fun stop() {
-        unregisterUserFeedbackCallback(userFeedbackCallback)
+        unregisterUserFeedbackCallback(mapboxNavigation, userFeedbackCallback)
         if (isMapboxNavigationAppSetup) {
             MapboxNavigationApp.lifecycleOwner.lifecycle.removeObserver(
                 foregroundBackgroundLifecycleObserver

libnavigation-core/src/main/java/com/mapbox/navigation/core/MapboxNavigation.kt

@@ -57,7 +57,9 @@ import com.mapbox.navigation.core.history.MapboxHistoryReader
 import com.mapbox.navigation.core.history.MapboxHistoryRecorder
 import com.mapbox.navigation.core.internal.ReachabilityService
 import com.mapbox.navigation.core.internal.telemetry.CustomEvent
+import com.mapbox.navigation.core.internal.telemetry.TelemetryAndroidAutoInterface
 import com.mapbox.navigation.core.internal.telemetry.UserFeedbackCallback
+import com.mapbox.navigation.core.internal.telemetry.UserFeedbackSubscriber
 import com.mapbox.navigation.core.internal.utils.InternalUtils
 import com.mapbox.navigation.core.internal.utils.ModuleParams
 import com.mapbox.navigation.core.internal.utils.isInternalImplementation
@@ -87,7 +89,8 @@ import com.mapbox.navigation.core.routeoptions.RouteOptionsUpdater
 import com.mapbox.navigation.core.routerefresh.RouteRefreshController
 import com.mapbox.navigation.core.routerefresh.RouteRefreshControllerProvider
 import com.mapbox.navigation.core.routerefresh.RouteRefreshStatesObserver
-import com.mapbox.navigation.core.telemetry.MapboxNavigationTelemetry
+import com.mapbox.navigation.core.telemetry.ApplicationLifecycleMonitor
+import com.mapbox.navigation.core.telemetry.NavigationTelemetry
 import com.mapbox.navigation.core.telemetry.events.FeedbackEvent
 import com.mapbox.navigation.core.telemetry.events.FeedbackHelper
 import com.mapbox.navigation.core.telemetry.events.FeedbackMetadata
@@ -118,7 +121,6 @@ import com.mapbox.navigation.core.trip.session.eh.GraphAccessor
 import com.mapbox.navigation.core.trip.session.eh.RoadObjectMatcher
 import com.mapbox.navigation.core.trip.session.eh.RoadObjectsStore
 import com.mapbox.navigation.metrics.MapboxMetricsReporter
-import com.mapbox.navigation.metrics.internal.TelemetryUtilsDelegate
 import com.mapbox.navigation.navigator.internal.MapboxNativeNavigator
 import com.mapbox.navigation.navigator.internal.NavigatorLoader
 import com.mapbox.navigation.navigator.internal.router.RouterInterfaceAdapter
@@ -250,6 +252,11 @@ class MapboxNavigation @VisibleForTesting internal constructor(
     private val mainJobController = threadController.getMainScopeAndRootJob()
     private val directionsSession: DirectionsSession
     private var navigator: MapboxNativeNavigator
+    private var navigationTelemetry: NavigationTelemetry
+    internal val telemetryAndroidAutoInterface: TelemetryAndroidAutoInterface
+        get() = navigationTelemetry
+    internal val userFeedbackSubscriber: UserFeedbackSubscriber
+        get() = navigationTelemetry
     private var historyRecorderHandles: NavigatorLoader.HistoryRecorderHandles
     private val tripService: TripService
     private val tripSession: TripSession
@@ -458,6 +465,11 @@ class MapboxNavigation @VisibleForTesting internal constructor(
             } else {
                 RouterInterfaceAdapter(moduleRouter, ::getNavigationRoutes)
             },
+            NavigationComponentProvider.createEventsMetadataInterface(
+                navigationOptions.applicationContext,
+                ApplicationLifecycleMonitor(navigationOptions.applicationContext),
+                navigationOptions.eventsAppMetadata
+            ),
         )
         assignHistoryRecorders()
         navigationSession = NavigationComponentProvider.createNavigationSession()
@@ -524,24 +536,19 @@ class MapboxNavigation @VisibleForTesting internal constructor(
             arrivalProgressObserver
         )
 
+        navigationTelemetry = NavigationTelemetry(tripSession) { navigator.telemetry }
+
         ifNonNull(accessToken) { token ->
-            runInTelemetryContext { telemetry ->
-                logD(
-                    "MapboxMetricsReporter.init from MapboxNavigation main",
-                    telemetry.LOG_CATEGORY
-                )
-                MapboxMetricsReporter.init(
-                    navigationOptions.applicationContext,
-                    token,
-                    obtainUserAgent()
-                )
-                MapboxMetricsReporter.toggleLogging(navigationOptions.isDebugLoggingEnabled)
-                telemetry.initialize(
-                    this,
-                    navigationOptions,
-                    MapboxMetricsReporter,
-                )
-            }
+            logD(
+                "MapboxMetricsReporter.init from MapboxNavigation main",
+                LOG_CATEGORY
+            )
+            MapboxMetricsReporter.init(
+                navigationOptions.applicationContext,
+                token,
+                obtainUserAgent()
+            )
+            MapboxMetricsReporter.toggleLogging(navigationOptions.isDebugLoggingEnabled)
         }
 
         val routeOptionsProvider = RouteOptionsUpdater()
@@ -1208,9 +1215,6 @@ class MapboxNavigation @VisibleForTesting internal constructor(
         historyRecordingStateHandler.unregisterAllStateChangeObservers()
         historyRecordingStateHandler.unregisterAllCopilotSessionObservers()
         developerMetadataAggregator.unregisterAllObservers()
-        runInTelemetryContext { telemetry ->
-            telemetry.destroy(this@MapboxNavigation)
-        }
         threadController.cancelAllNonUICoroutines()
         threadController.cancelAllUICoroutines()
         ifNonNull(reachabilityObserverId) {
@@ -1617,17 +1621,15 @@ class MapboxNavigation @VisibleForTesting internal constructor(
         feedbackMetadata: FeedbackMetadata?,
         userFeedbackCallback: UserFeedbackCallback?,
     ) {
-        runInTelemetryContext { telemetry ->
-            telemetry.postUserFeedback(
-                feedbackType,
-                description,
-                feedbackSource,
-                screenshot,
-                feedbackSubType,
-                feedbackMetadata,
-                userFeedbackCallback,
-            )
-        }
+        navigationTelemetry.postUserFeedback(
+            feedbackType,
+            description,
+            feedbackSource,
+            screenshot,
+            feedbackSubType,
+            feedbackMetadata,
+            userFeedbackCallback
+        )
     }
 
     @ExperimentalPreviewMapboxNavigationAPI
@@ -1636,30 +1638,21 @@ class MapboxNavigation @VisibleForTesting internal constructor(
         @CustomEvent.Type customEventType: String,
         customEventVersion: String,
     ) {
-        runInTelemetryContext { telemetry ->
-            telemetry.postCustomEvent(
-                payload = payload,
-                customEventType = customEventType,
-                customEventVersion = customEventVersion
-            )
-        }
+        navigationTelemetry.postCustomEvent(
+            customEventType,
+            customEventVersion,
+            payload,
+        )
     }
 
     /**
-     * Provides wrapper of [FeedbackMetadata]. [FeedbackMetadata] is used to send deferred
+     * Provides [FeedbackMetadata], that is used to send deferred
      * feedback attached to passed location. It contains data (like location, time) when method is
      * invoked.
-     *
-     * Note: method throws [IllegalStateException] if trips session is not
-     * started ([startTripSession]) or telemetry is disabled.
      */
     @ExperimentalPreviewMapboxNavigationAPI
     fun provideFeedbackMetadataWrapper(): FeedbackMetadataWrapper =
-        runInTelemetryContext { telemetry ->
-            telemetry.provideFeedbackMetadataWrapper()
-        } ?: throw java.lang.IllegalStateException(
-            "To get FeedbackMetadataWrapper Telemetry must be enabled"
-        )
+        navigationTelemetry.provideFeedbackMetadataWrapper()
 
     /**
      * Start observing alternatives routes for a trip session via [RouteAlternativesObserver].
@@ -1967,6 +1960,11 @@ class MapboxNavigation @VisibleForTesting internal constructor(
                 } else {
                     RouterInterfaceAdapter(moduleRouter, ::getNavigationRoutes)
                 },
+                NavigationComponentProvider.createEventsMetadataInterface(
+                    navigationOptions.applicationContext,
+                    ApplicationLifecycleMonitor(navigationOptions.applicationContext),
+                    navigationOptions.eventsAppMetadata
+                ),
             )
             assignHistoryRecorders()
 
@@ -1994,12 +1992,8 @@ class MapboxNavigation @VisibleForTesting internal constructor(
         }
     }
 
-    private inline fun <T> runInTelemetryContext(func: (MapboxNavigationTelemetry) -> T): T? {
-        return if (TelemetryUtilsDelegate.getEventsCollectionState()) {
-            func(MapboxNavigationTelemetry)
-        } else {
-            null
-        }
+    private fun cancelReroute() {
+        rerouteController?.interrupt()
     }
 
     private fun obtainUserAgent(): String {

libnavigation-core/src/main/java/com/mapbox/navigation/core/NavigationComponentProvider.kt

@@ -2,6 +2,7 @@ package com.mapbox.navigation.core
 
 import android.content.Context
 import com.mapbox.navigation.base.internal.NavigationRouterV2
+import com.mapbox.navigation.base.options.EventsAppMetadata
 import com.mapbox.navigation.base.options.NavigationOptions
 import com.mapbox.navigation.base.trip.notification.TripNotification
 import com.mapbox.navigation.core.accounts.BillingController
@@ -11,6 +12,8 @@ import com.mapbox.navigation.core.directions.session.MapboxDirectionsSession
 import com.mapbox.navigation.core.ev.EVDynamicDataHolder
 import com.mapbox.navigation.core.preview.NativeRoutesDataParser
 import com.mapbox.navigation.core.preview.RoutesPreviewController
+import com.mapbox.navigation.core.telemetry.ApplicationLifecycleMonitor
+import com.mapbox.navigation.core.telemetry.EventsMetadataInterfaceImpl
 import com.mapbox.navigation.core.trip.service.MapboxTripService
 import com.mapbox.navigation.core.trip.service.TripService
 import com.mapbox.navigation.core.trip.session.MapboxTripSession
@@ -22,6 +25,7 @@ import com.mapbox.navigation.navigator.internal.MapboxNativeNavigator
 import com.mapbox.navigation.navigator.internal.MapboxNativeNavigatorImpl
 import com.mapbox.navigation.utils.internal.ThreadController
 import com.mapbox.navigator.ConfigHandle
+import com.mapbox.navigator.EventsMetadataInterface
 import com.mapbox.navigator.HistoryRecorderHandle
 import com.mapbox.navigator.RouterInterface
 import com.mapbox.navigator.TilesConfig
@@ -39,12 +43,14 @@ internal object NavigationComponentProvider {
         tilesConfig: TilesConfig,
         accessToken: String,
         router: RouterInterface,
+        eventsMetadataInterface: EventsMetadataInterface,
     ): MapboxNativeNavigator = MapboxNativeNavigatorImpl.create(
         config,
         historyRecorderComposite,
         tilesConfig,
         accessToken,
         router,
+        eventsMetadataInterface,
     )
 
     fun createTripService(
@@ -116,4 +122,14 @@ internal object NavigationComponentProvider {
     fun createEVDynamicDataHolder(): EVDynamicDataHolder = EVDynamicDataHolder()
 
     fun createRoutesCacheClearer(): RoutesCacheClearer = RoutesCacheClearer()
+
+    fun createEventsMetadataInterface(
+        appContext: Context,
+        lifecycleMonitor: ApplicationLifecycleMonitor,
+        eventsAppMetadata: EventsAppMetadata?,
+    ): EventsMetadataInterface = EventsMetadataInterfaceImpl(
+        appContext,
+        lifecycleMonitor,
+        eventsAppMetadata
+    )
 }

libnavigation-core/src/main/java/com/mapbox/navigation/core/internal/telemetry/TelemetryAndroidAutoInterface.kt

@@ -0,0 +1,7 @@
+package com.mapbox.navigation.core.internal.telemetry
+
+import com.mapbox.navigation.core.internal.telemetry.event.AndroidAutoEvent
+
+interface TelemetryAndroidAutoInterface {
+    fun postAndroidAutoEvent(event: AndroidAutoEvent)
+}

libnavigation-core/src/main/java/com/mapbox/navigation/core/internal/telemetry/TelemetryEx.kt

@@ -2,54 +2,33 @@
 
 package com.mapbox.navigation.core.internal.telemetry
 
-import android.location.Location
-import android.os.Build
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.MapboxNavigation
-import com.mapbox.navigation.core.telemetry.MapboxNavigationTelemetry
 import com.mapbox.navigation.core.telemetry.events.FeedbackEvent
 import com.mapbox.navigation.core.telemetry.events.FeedbackHelper
 import com.mapbox.navigation.core.telemetry.events.FeedbackMetadata
 import com.mapbox.navigation.core.telemetry.events.FeedbackMetadataWrapper
-import com.mapbox.navigation.core.telemetry.events.TelemetryLocation
-
-internal fun List<Location>.toTelemetryLocations(): Array<TelemetryLocation> {
-    return Array(size) { get(it).toTelemetryLocation() }
-}
-
-internal fun Location.toTelemetryLocation(): TelemetryLocation {
-    return TelemetryLocation(
-        latitude,
-        longitude,
-        speed,
-        bearing,
-        altitude,
-        time.toString(),
-        accuracy,
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
-            verticalAccuracyMeters
-        } else {
-            0f
-        },
-    )
-}
 
 /**
  * Register a [UserFeedbackCallback] to be notified when a new user feedback is posted.
  *
  * @param userFeedbackCallback UserFeedbackCallback
  */
-fun registerUserFeedbackCallback(userFeedbackCallback: UserFeedbackCallback) {
-    MapboxNavigationTelemetry.registerUserFeedbackCallback(userFeedbackCallback)
+fun registerUserFeedbackCallback(
+    mapboxNavigation: MapboxNavigation, userFeedbackCallback: UserFeedbackCallback
+) {
+    mapboxNavigation.userFeedbackSubscriber.registerUserFeedbackCallback(userFeedbackCallback)
 }
 
 /**
  * Unregisters a [UserFeedbackCallback].
  *
  * @param userFeedbackCallback UserFeedbackCallback
  */
-fun unregisterUserFeedbackCallback(userFeedbackCallback: UserFeedbackCallback) {
-    MapboxNavigationTelemetry.unregisterUserFeedbackCallback(userFeedbackCallback)
+fun unregisterUserFeedbackCallback(
+    mapboxNavigation: MapboxNavigation, userFeedbackCallback: UserFeedbackCallback
+) {
+    mapboxNavigation.userFeedbackSubscriber.unregisterUserFeedbackCallback(userFeedbackCallback)
 }
 
 /**
@@ -104,3 +83,6 @@ fun MapboxNavigation.sendCustomEvent(
 ) {
     postCustomEvent(payload, customEventType, customEventVersion)
 }
+
+fun MapboxNavigation.telemetryAndroidAutoInterface(): TelemetryAndroidAutoInterface =
+    telemetryAndroidAutoInterface

libnavigation-core/src/main/java/com/mapbox/navigation/core/internal/telemetry/UserFeedbackSubscriber.kt

@@ -0,0 +1,8 @@
+package com.mapbox.navigation.core.internal.telemetry
+
+interface UserFeedbackSubscriber {
+
+    fun registerUserFeedbackCallback(userFeedbackCallback: UserFeedbackCallback)
+
+    fun unregisterUserFeedbackCallback(userFeedbackCallback: UserFeedbackCallback)
+}

libnavigation-core/src/main/java/com/mapbox/navigation/core/internal/telemetry/event/AndroidAutoEvent.kt

@@ -0,0 +1,6 @@
+package com.mapbox.navigation.core.internal.telemetry.event
+
+enum class AndroidAutoEvent {
+    Connected,
+    Disconnected,
+}