[Android Auto] Remove MapboxNavigation from CarNavigationInfoObserver constructor (#6263)

* Remove dependencies from CarNavigationInfoObserver

* simplify

Author: kmadsen

libnavui-androidauto/CHANGELOG.md

@@ -6,6 +6,7 @@ Mapbox welcomes participation and contributions from everyone.
 #### Features
 #### Bug fixes and improvements
 - Remove experimental from `MapboxCarNavigationManager` and showcase java. [#6292](https://github.com/mapbox/mapbox-navigation-android/pull/6292)
+- Removed `MapboxNavigation` from `CarNavigationInfoObserver` constructor, and rename to `CarNavigationInfoProvider`. Removed dependencies from `CarActiveGuidanceCarContext` that require `MapboxNavigation`. [#6224](https://github.com/mapbox/mapbox-navigation-android/pull/6224)
 
 ## androidauto-v0.10.0 - Sep 9, 2022
 ### Changelog

libnavui-androidauto/api/current.txt

@@ -56,22 +56,20 @@ package com.mapbox.androidauto.car {
     method public androidx.car.app.CarContext getCarContext();
     method public com.mapbox.androidauto.car.search.CarPlaceSearchOptions getCarPlaceSearchOptions();
     method public com.mapbox.androidauto.car.settings.CarSettingsStorage getCarSettingsStorage();
-    method public com.mapbox.navigation.base.formatter.DistanceFormatter getDistanceFormatter();
+    method @Deprecated public com.mapbox.navigation.base.formatter.DistanceFormatter getDistanceFormatter();
     method public com.mapbox.androidauto.car.feedback.core.CarFeedbackPollProvider getFeedbackPollProvider();
-    method public com.mapbox.navigation.utils.internal.JobControl getJobControl();
-    method public com.mapbox.navigation.ui.maneuver.api.MapboxManeuverApi getManeuverApi();
+    method @Deprecated public com.mapbox.navigation.utils.internal.JobControl getJobControl();
     method public com.mapbox.maps.extension.androidauto.MapboxCarMap getMapboxCarMap();
-    method public com.mapbox.navigation.core.MapboxNavigation getMapboxNavigation();
+    method @Deprecated public com.mapbox.navigation.core.MapboxNavigation getMapboxNavigation();
     method public com.mapbox.androidauto.car.preview.CarRouteOptionsInterceptor getRouteOptionsInterceptor();
     method public kotlinx.coroutines.flow.MutableStateFlow<com.mapbox.androidauto.car.navigation.speedlimit.SpeedLimitOptions> getSpeedLimitOptions();
     property public final androidx.car.app.CarContext carContext;
     property public final com.mapbox.androidauto.car.search.CarPlaceSearchOptions carPlaceSearchOptions;
     property public final com.mapbox.androidauto.car.settings.CarSettingsStorage carSettingsStorage;
-    property public final com.mapbox.navigation.base.formatter.DistanceFormatter distanceFormatter;
+    property @Deprecated public final com.mapbox.navigation.base.formatter.DistanceFormatter distanceFormatter;
     property public final com.mapbox.androidauto.car.feedback.core.CarFeedbackPollProvider feedbackPollProvider;
-    property public final com.mapbox.navigation.ui.maneuver.api.MapboxManeuverApi maneuverApi;
     property public final com.mapbox.maps.extension.androidauto.MapboxCarMap mapboxCarMap;
-    property public final com.mapbox.navigation.core.MapboxNavigation mapboxNavigation;
+    property @Deprecated public final com.mapbox.navigation.core.MapboxNavigation mapboxNavigation;
     property public final com.mapbox.androidauto.car.preview.CarRouteOptionsInterceptor routeOptionsInterceptor;
     property public final kotlinx.coroutines.flow.MutableStateFlow<com.mapbox.androidauto.car.navigation.speedlimit.SpeedLimitOptions> speedLimitOptions;
   }
@@ -324,19 +322,13 @@ package com.mapbox.androidauto.car.navigation {
     method public androidx.car.app.CarContext getCarContext();
     method public com.mapbox.navigation.base.formatter.DistanceFormatter getDistanceFormatter();
     method public com.mapbox.androidauto.car.MainCarContext getMainCarContext();
-    method public com.mapbox.navigation.ui.maneuver.api.MapboxManeuverApi getManeuverApi();
     method public com.mapbox.maps.extension.androidauto.MapboxCarMap getMapboxCarMap();
     method public com.mapbox.navigation.core.MapboxNavigation getMapboxNavigation();
-    method public com.mapbox.androidauto.car.navigation.CarNavigationInfoMapper getNavigationInfoMapper();
-    method public com.mapbox.androidauto.car.navigation.CarNavigationEtaMapper getTripProgressMapper();
     property public final androidx.car.app.CarContext carContext;
     property public final com.mapbox.navigation.base.formatter.DistanceFormatter distanceFormatter;
     property public final com.mapbox.androidauto.car.MainCarContext mainCarContext;
-    property public final com.mapbox.navigation.ui.maneuver.api.MapboxManeuverApi maneuverApi;
     property public final com.mapbox.maps.extension.androidauto.MapboxCarMap mapboxCarMap;
     property public final com.mapbox.navigation.core.MapboxNavigation mapboxNavigation;
-    property public final com.mapbox.androidauto.car.navigation.CarNavigationInfoMapper navigationInfoMapper;
-    property public final com.mapbox.androidauto.car.navigation.CarNavigationEtaMapper tripProgressMapper;
   }
 
   public enum CarCameraMode {
@@ -380,23 +372,29 @@ package com.mapbox.androidauto.car.navigation {
 
   public final class CarNavigationEtaMapper {
     ctor public CarNavigationEtaMapper(com.mapbox.androidauto.car.navigation.CarDistanceFormatter carDistanceFormatter, com.mapbox.navigation.ui.tripprogress.api.MapboxTripProgressApi tripProgressApi);
-    method public androidx.car.app.navigation.model.TravelEstimate from(com.mapbox.navigation.base.trip.model.RouteProgress routeProgress);
+    method public androidx.car.app.navigation.model.TravelEstimate getDestinationTravelEstimate(com.mapbox.navigation.base.trip.model.RouteProgress routeProgress);
+  }
+
+  public final class CarNavigationInfo {
+    method public androidx.car.app.navigation.model.TravelEstimate? getDestinationTravelEstimate();
+    method public androidx.car.app.navigation.model.NavigationTemplate.NavigationInfo? getNavigationInfo();
+    property public final androidx.car.app.navigation.model.TravelEstimate? destinationTravelEstimate;
+    property public final androidx.car.app.navigation.model.NavigationTemplate.NavigationInfo? navigationInfo;
   }
 
   public final class CarNavigationInfoMapper {
     ctor public CarNavigationInfoMapper(android.content.Context context, com.mapbox.androidauto.car.navigation.maneuver.CarManeuverInstructionRenderer carManeuverInstructionRenderer, com.mapbox.androidauto.car.navigation.maneuver.CarManeuverIconRenderer carManeuverIconRenderer, com.mapbox.androidauto.car.navigation.lanes.CarLanesImageRenderer carLanesImageGenerator, com.mapbox.androidauto.car.navigation.CarDistanceFormatter carDistanceFormatter);
     method public androidx.car.app.navigation.model.NavigationTemplate.NavigationInfo? mapNavigationInfo(com.mapbox.bindgen.Expected<com.mapbox.navigation.ui.maneuver.model.ManeuverError,java.util.List<com.mapbox.navigation.ui.maneuver.model.Maneuver>> expectedManeuvers, java.util.List<? extends com.mapbox.navigation.ui.shield.model.RouteShield> routeShields, com.mapbox.navigation.base.trip.model.RouteProgress routeProgress);
   }
 
-  public final class CarNavigationInfoObserver {
-    ctor public CarNavigationInfoObserver(com.mapbox.androidauto.car.navigation.CarActiveGuidanceCarContext carActiveGuidanceCarContext);
-    method public androidx.car.app.navigation.model.NavigationTemplate.NavigationInfo? getNavigationInfo();
-    method public androidx.car.app.navigation.model.TravelEstimate? getTravelEstimateInfo();
-    method public void setTravelEstimateInfo(androidx.car.app.navigation.model.TravelEstimate?);
-    method public void start(kotlin.jvm.functions.Function0<kotlin.Unit> onNavigationInfoChanged);
-    method public void stop();
-    property public final androidx.car.app.navigation.model.NavigationTemplate.NavigationInfo? navigationInfo;
-    property public final androidx.car.app.navigation.model.TravelEstimate? travelEstimateInfo;
+  @com.mapbox.maps.MapboxExperimental public final class CarNavigationInfoProvider implements com.mapbox.maps.extension.androidauto.MapboxCarMapObserver {
+    ctor public CarNavigationInfoProvider();
+    method public kotlinx.coroutines.flow.StateFlow<com.mapbox.androidauto.car.navigation.CarNavigationInfo> getCarNavigationInfo();
+    method public com.mapbox.androidauto.car.navigation.CarNavigationInfoProvider invalidateOnChange(androidx.car.app.Screen screen);
+    method public void onAttached(com.mapbox.maps.extension.androidauto.MapboxCarMapSurface mapboxCarMapSurface);
+    method public void onDetached(com.mapbox.maps.extension.androidauto.MapboxCarMapSurface mapboxCarMapSurface);
+    method public androidx.car.app.navigation.model.NavigationTemplate.Builder setNavigationInfo(androidx.car.app.navigation.model.NavigationTemplate.Builder builder);
+    property public final kotlinx.coroutines.flow.StateFlow<com.mapbox.androidauto.car.navigation.CarNavigationInfo> carNavigationInfo;
   }
 
   public final class MapUserStyleObserver implements com.mapbox.maps.extension.androidauto.MapboxCarMapObserver {

libnavui-androidauto/build.gradle

@@ -62,6 +62,7 @@ dependencies {
     apply from: "${rootDir}/gradle/unit-testing-dependencies.gradle"
     testImplementation(project(':libtesting-utils'))
     testImplementation(dependenciesList.androidXArchCoreTesting)
+    testImplementation(dependenciesList.androidXLifecycleTesting)
 
     // Needed for the instrumentation tests in the androidTest module
     androidTestImplementation(dependenciesList.testRunner)

libnavui-androidauto/src/main/java/com/mapbox/androidauto/car/MainCarContext.kt

@@ -12,7 +12,6 @@ import com.mapbox.navigation.base.formatter.DistanceFormatter
 import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.core.MapboxNavigationProvider
 import com.mapbox.navigation.core.formatter.MapboxDistanceFormatter
-import com.mapbox.navigation.ui.maneuver.api.MapboxManeuverApi
 import com.mapbox.navigation.utils.internal.JobControl
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
@@ -29,22 +28,21 @@ class MainCarContext(
 ) {
     val carSettingsStorage = CarSettingsStorage(carContext)
 
+    @Deprecated(message = "This is being removed, replaced with MapboxNavigationApp")
     val mapboxNavigation: MapboxNavigation by lazy {
         MapboxNavigationProvider.retrieve()
     }
 
+    @Deprecated(message = "This is being removed. You can construct one using MapboxNavigationApp")
     val distanceFormatter: DistanceFormatter by lazy {
         MapboxDistanceFormatter(
             mapboxNavigation.navigationOptions.distanceFormatterOptions
         )
     }
 
-    val maneuverApi: MapboxManeuverApi by lazy {
-        MapboxManeuverApi(distanceFormatter)
-    }
-
     val speedLimitOptions = MutableStateFlow(SpeedLimitOptions.Builder().build())
 
+    @Deprecated(message = "This will be removed")
     fun getJobControl(): JobControl {
         val supervisorJob = SupervisorJob()
         val scope = CoroutineScope(supervisorJob + Dispatchers.Main)

libnavui-androidauto/src/main/java/com/mapbox/androidauto/car/navigation/ActiveGuidanceScreen.kt

@@ -52,7 +52,8 @@ class ActiveGuidanceScreen(
         alternativeCarCameraMode = CarCameraMode.OVERVIEW,
     )
     private val roadLabelSurfaceLayer = RoadLabelSurfaceLayer(carContext)
-    private val carRouteProgressObserver = CarNavigationInfoObserver(carActiveGuidanceContext)
+    private val navigationInfoProvider = CarNavigationInfoProvider()
+        .invalidateOnChange(this)
     private val mapActionStripBuilder = MainMapActionStrip(this, carNavigationCamera)
 
     private val arrivalObserver = object : ArrivalObserver {
@@ -108,6 +109,7 @@ class ActiveGuidanceScreen(
 
     init {
         logAndroidAuto("ActiveGuidanceScreen constructor")
+
         lifecycle.addObserver(object : DefaultLifecycleObserver {
 
             override fun onCreate(owner: LifecycleOwner) {
@@ -126,9 +128,7 @@ class ActiveGuidanceScreen(
                 )
                 carActiveGuidanceContext.mapboxCarMap.registerObserver(carRouteLine)
                 carActiveGuidanceContext.mapboxCarMap.registerObserver(surfaceListener)
-                carRouteProgressObserver.start {
-                    invalidate()
-                }
+                carActiveGuidanceContext.mapboxCarMap.registerObserver(navigationInfoProvider)
             }
 
             override fun onPause(owner: LifecycleOwner) {
@@ -140,7 +140,7 @@ class ActiveGuidanceScreen(
                 carActiveGuidanceContext.mapboxCarMap.setGestureHandler(null)
                 carActiveGuidanceContext.mapboxCarMap.unregisterObserver(carRouteLine)
                 carActiveGuidanceContext.mapboxCarMap.unregisterObserver(surfaceListener)
-                carRouteProgressObserver.stop()
+                carActiveGuidanceContext.mapboxCarMap.unregisterObserver(navigationInfoProvider)
             }
 
             override fun onDestroy(owner: LifecycleOwner) {
@@ -171,20 +171,13 @@ class ActiveGuidanceScreen(
                     }.build()
             )
         }.build()
-        val builder = NavigationTemplate.Builder()
+
+        return NavigationTemplate.Builder()
             .setBackgroundColor(CarColor.PRIMARY)
             .setActionStrip(actionStrip)
             .setMapActionStrip(mapActionStripBuilder.build())
-
-        carRouteProgressObserver.navigationInfo?.let {
-            builder.setNavigationInfo(it)
-        }
-
-        carRouteProgressObserver.travelEstimateInfo?.let {
-            builder.setDestinationTravelEstimate(it)
-        }
-
-        return builder.build()
+            .apply { navigationInfoProvider.setNavigationInfo(this) }
+            .build()
     }
 
     private fun stopNavigation() {

libnavui-androidauto/src/main/java/com/mapbox/androidauto/car/navigation/CarActiveGuidanceCarContext.kt

@@ -1,12 +1,6 @@
 package com.mapbox.androidauto.car.navigation
 
 import com.mapbox.androidauto.car.MainCarContext
-import com.mapbox.androidauto.car.navigation.lanes.CarLanesImageRenderer
-import com.mapbox.androidauto.car.navigation.maneuver.CarManeuverIconOptions
-import com.mapbox.androidauto.car.navigation.maneuver.CarManeuverIconRenderer
-import com.mapbox.androidauto.car.navigation.maneuver.CarManeuverInstructionRenderer
-import com.mapbox.navigation.ui.tripprogress.api.MapboxTripProgressApi
-import com.mapbox.navigation.ui.tripprogress.model.TripProgressUpdateFormatter
 
 class CarActiveGuidanceCarContext(
     val mainCarContext: MainCarContext
@@ -16,22 +10,4 @@ class CarActiveGuidanceCarContext(
     val mapboxCarMap = mainCarContext.mapboxCarMap
     val mapboxNavigation = mainCarContext.mapboxNavigation
     val distanceFormatter = mainCarContext.distanceFormatter
-
-    /** NavigationCarContext **/
-    private val carDistanceFormatter = CarDistanceFormatter(
-        mapboxNavigation.navigationOptions.distanceFormatterOptions.unitType
-    )
-    private val carLaneImageGenerator = CarLanesImageRenderer(carContext)
-    val navigationInfoMapper = CarNavigationInfoMapper(
-        carContext.applicationContext,
-        CarManeuverInstructionRenderer(),
-        CarManeuverIconRenderer(CarManeuverIconOptions.Builder(carContext).build()),
-        carLaneImageGenerator,
-        carDistanceFormatter
-    )
-    val maneuverApi = mainCarContext.maneuverApi
-    val tripProgressMapper = CarNavigationEtaMapper(
-        carDistanceFormatter,
-        MapboxTripProgressApi(TripProgressUpdateFormatter.Builder(carContext).build()),
-    )
 }

libnavui-androidauto/src/main/java/com/mapbox/androidauto/car/navigation/CarNavigationEtaMapper.kt

@@ -14,7 +14,7 @@ class CarNavigationEtaMapper(
     private val tripProgressApi: MapboxTripProgressApi,
 ) {
 
-    fun from(routeProgress: RouteProgress): TravelEstimate {
+    fun getDestinationTravelEstimate(routeProgress: RouteProgress): TravelEstimate {
         val result = tripProgressApi.getTripProgress(routeProgress)
         val distance = carDistanceFormatter.carDistance(result.distanceRemaining)
         val zonedDateTime =

libnavui-androidauto/src/main/java/com/mapbox/androidauto/car/navigation/CarNavigationInfo.kt

@@ -0,0 +1,21 @@
+package com.mapbox.androidauto.car.navigation
+
+import androidx.car.app.navigation.model.NavigationTemplate
+import androidx.car.app.navigation.model.TravelEstimate
+
+/**
+ * Contains data needed to populate the [NavigationTemplate].
+ *
+ * @see [CarNavigationInfoProvider]
+ */
+class CarNavigationInfo internal constructor(
+    /**
+     * Contains the current [NavigationTemplate.NavigationInfo] that is used with the
+     * [NavigationTemplate].
+     */
+    val navigationInfo: NavigationTemplate.NavigationInfo? = null,
+    /**
+     * Contains the current [TravelEstimate] that is used with the [NavigationTemplate].
+     */
+    val destinationTravelEstimate: TravelEstimate? = null,
+)