add option to override route options used by drop-in (#6017)

Author: Zayankovsky

CHANGELOG.md

@@ -4,6 +4,7 @@ Mapbox welcomes participation and contributions from everyone.
 
 ## Unreleased
 #### Features
+- Introduced `NavigationView.setRouteOptionsInterceptor` that allows to override `RouteOptions` used by `NavigationView`. [#6391](https://github.com/mapbox/mapbox-navigation-android/pull/6391)
 #### Bug fixes and improvements
 - Marked `ReplayProgressObserver`, `MapboxReplayer`, `ReplayLocationEngine`, `RerouteController#RoutesCallback`, `NavigationRerouteController#RoutesCallback`, `LocationObserver`, `NavigationSessionStateObserver`, `OffRouteObserver`, `RouteProgressObserver`, `TripSessionStateObserver`, `VoiceInstructionsObserver` methods with `@UiThread` annotation. [#6266](https://github.com/mapbox/mapbox-navigation-android/pull/6266)
 - Fix crash due to multiple DataStores active. [#6392](https://github.com/mapbox/mapbox-navigation-android/pull/6392)

libnavui-app/src/main/java/com/mapbox/navigation/ui/app/internal/ThunkActions.kt

@@ -2,12 +2,14 @@ package com.mapbox.navigation.ui.app.internal
 
 import com.mapbox.geojson.Point
 import com.mapbox.navigation.base.route.NavigationRoute
+import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.ui.app.internal.destination.Destination
 import com.mapbox.navigation.ui.app.internal.destination.DestinationAction
 import com.mapbox.navigation.ui.app.internal.extension.ThunkAction
 import com.mapbox.navigation.ui.app.internal.extension.dispatch
 import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
 import com.mapbox.navigation.ui.app.internal.navigation.NavigationStateAction
+import com.mapbox.navigation.ui.app.internal.routefetch.RouteOptionsProvider
 import com.mapbox.navigation.ui.app.internal.routefetch.RoutePreviewAction
 import com.mapbox.navigation.ui.app.internal.routefetch.RoutePreviewState
 import com.mapbox.navigation.ui.app.internal.routefetch.RoutesAction
@@ -76,28 +78,38 @@ fun startArrival(point: Point, routes: List<NavigationRoute>) = ThunkAction { st
 /**
  * Fetch Route and Show Route Preview ThunkAction creator.
  */
-fun CoroutineScope.fetchRouteAndShowRoutePreview() = fetchRouteAndContinue { store ->
+fun CoroutineScope.fetchRouteAndShowRoutePreview(
+    routeOptionsProvider: RouteOptionsProvider,
+    mapboxNavigation: MapboxNavigation,
+) = fetchRouteAndContinue(routeOptionsProvider, mapboxNavigation) { store ->
     store.dispatch(NavigationStateAction.Update(NavigationState.RoutePreview))
 }
 
 /**
  * Fetch Route and Start Active Navigation ThunkAction creator.
  */
-fun CoroutineScope.fetchRouteAndStartActiveNavigation() = fetchRouteAndContinue { store ->
+fun CoroutineScope.fetchRouteAndStartActiveNavigation(
+    routeOptionsProvider: RouteOptionsProvider,
+    mapboxNavigation: MapboxNavigation,
+) = fetchRouteAndContinue(routeOptionsProvider, mapboxNavigation) { store ->
     val previewRoutes = store.state.value.previewRoutes
     if (previewRoutes is RoutePreviewState.Ready) {
         store.dispatch(startActiveNavigation(previewRoutes.routes))
     }
 }
 
-private fun CoroutineScope.fetchRouteAndContinue(continuation: (Store) -> Unit) =
-    ThunkAction { store ->
-        launch {
-            if (fetchRouteIfNeeded(store)) {
-                continuation(store)
-            }
+// TODO: simplify after :libnavui-app module is merged with :libnavui-dropin
+private fun CoroutineScope.fetchRouteAndContinue(
+    routeOptionsProvider: RouteOptionsProvider,
+    mapboxNavigation: MapboxNavigation,
+    continuation: (Store) -> Unit,
+) = ThunkAction { store ->
+    launch {
+        if (fetchRouteIfNeeded(store, routeOptionsProvider, mapboxNavigation)) {
+            continuation(store)
         }
     }
+}
 
 /**
  * Dispatch FetchPoints action and wait for RoutePreviewState.Ready.
@@ -106,16 +118,21 @@ private fun CoroutineScope.fetchRouteAndContinue(continuation: (Store) -> Unit)
  *
  * @return `true` once in RoutePreviewState.Ready state, otherwise `false`
  */
-private suspend fun fetchRouteIfNeeded(store: Store): Boolean {
+private suspend fun fetchRouteIfNeeded(
+    store: Store,
+    routeOptionsProvider: RouteOptionsProvider,
+    mapboxNavigation: MapboxNavigation,
+): Boolean {
     val storeState = store.state.value
     if (storeState.previewRoutes is RoutePreviewState.Ready) return true
     if (storeState.previewRoutes is RoutePreviewState.Fetching) return false
 
     return ifNonNull(
         storeState.location?.enhancedLocation?.toPoint(),
-        storeState.destination
+        storeState.destination?.point
     ) { lastPoint, destination ->
-        store.dispatch(RoutePreviewAction.FetchPoints(listOf(lastPoint, destination.point)))
+        val options = routeOptionsProvider.getOptions(mapboxNavigation, lastPoint, destination)
+        store.dispatch(RoutePreviewAction.FetchOptions(options))
         store.waitWhileFetching()
         store.state.value.previewRoutes is RoutePreviewState.Ready
     } ?: false

libnavui-app/src/main/java/com/mapbox/navigation/ui/app/internal/controller/RoutePreviewStateController.kt

@@ -1,10 +1,7 @@
 package com.mapbox.navigation.ui.app.internal.controller
 
 import com.mapbox.api.directions.v5.models.RouteOptions
-import com.mapbox.geojson.Point
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
-import com.mapbox.navigation.base.extensions.applyDefaultNavigationOptions
-import com.mapbox.navigation.base.extensions.applyLanguageAndVoiceUnitOptions
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.route.NavigationRouterCallback
 import com.mapbox.navigation.base.route.RouterFailure
@@ -59,7 +56,6 @@ class RoutePreviewStateController(private val store: Store) : StateController()
 
     private fun processRoutesAction(action: RoutePreviewAction): RoutePreviewState {
         return when (action) {
-            is RoutePreviewAction.FetchPoints,
             is RoutePreviewAction.FetchOptions -> {
                 RoutePreviewState.Fetching(0)
             }
@@ -85,13 +81,11 @@ class RoutePreviewStateController(private val store: Store) : StateController()
     private suspend fun MapboxNavigation.fetchRouteSaga() {
         store.actionsFlowable()
             .filter {
-                it is RoutePreviewAction.FetchPoints ||
-                    it is RoutePreviewAction.FetchOptions ||
+                it is RoutePreviewAction.FetchOptions ||
                     it is DestinationAction.SetDestination
             }
             .map {
                 when (it) {
-                    is RoutePreviewAction.FetchPoints -> routeOptions(it.points)
                     is RoutePreviewAction.FetchOptions -> it.options
                     else -> null
                 }
@@ -115,16 +109,6 @@ class RoutePreviewStateController(private val store: Store) : StateController()
             }
     }
 
-    private fun MapboxNavigation.routeOptions(points: List<Point>): RouteOptions {
-        return RouteOptions.builder()
-            .applyDefaultNavigationOptions()
-            .applyLanguageAndVoiceUnitOptions(navigationOptions.applicationContext)
-            .layersList(listOf(getZLevel(), null))
-            .coordinatesList(points)
-            .alternatives(true)
-            .build()
-    }
-
     private suspend fun MapboxNavigation.fetchRoute(
         routeOptions: RouteOptions,
         fetchStarted: (requestId: Long) -> Unit

libnavui-app/src/main/java/com/mapbox/navigation/ui/app/internal/routefetch/RouteOptionsProvider.kt

@@ -0,0 +1,31 @@
+package com.mapbox.navigation.ui.app.internal.routefetch
+
+import com.mapbox.api.directions.v5.models.RouteOptions
+import com.mapbox.geojson.Point
+import com.mapbox.navigation.base.extensions.applyDefaultNavigationOptions
+import com.mapbox.navigation.base.extensions.applyLanguageAndVoiceUnitOptions
+import com.mapbox.navigation.core.MapboxNavigation
+
+class RouteOptionsProvider {
+
+    private var interceptor: (RouteOptions.Builder) -> RouteOptions.Builder = { it }
+
+    fun setInterceptor(interceptor: (RouteOptions.Builder) -> RouteOptions.Builder) {
+        this.interceptor = interceptor
+    }
+
+    fun getOptions(
+        mapboxNavigation: MapboxNavigation,
+        origin: Point,
+        destination: Point,
+    ): RouteOptions {
+        return RouteOptions.builder()
+            .applyDefaultNavigationOptions()
+            .applyLanguageAndVoiceUnitOptions(mapboxNavigation.navigationOptions.applicationContext)
+            .layersList(listOf(mapboxNavigation.getZLevel(), null))
+            .coordinatesList(listOf(origin, destination))
+            .alternatives(true)
+            .let(interceptor)
+            .build()
+    }
+}

libnavui-app/src/main/java/com/mapbox/navigation/ui/app/internal/routefetch/RoutePreviewAction.kt

@@ -1,18 +1,12 @@
 package com.mapbox.navigation.ui.app.internal.routefetch
 
 import com.mapbox.api.directions.v5.models.RouteOptions
-import com.mapbox.geojson.Point
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.route.RouterFailure
 import com.mapbox.navigation.base.route.RouterOrigin
 import com.mapbox.navigation.ui.app.internal.Action
 
 sealed class RoutePreviewAction : Action {
-    /**
-     * The action is used to fetch route based on the list of [points].
-     * @param points list of points
-     */
-    data class FetchPoints(val points: List<Point>) : RoutePreviewAction()
 
     /**
      * The action is used to request and set routes based on [RouteOptions].