[Drop-In UI] Move fetchRouteIfNeeded to RoutePreviewStateController: (#6638)

* Move `fetchRouteIfNeeded` to `RoutePreviewStateController`:

- Moved RouteOptionsProvider to SharedApp to allow its injection to RoutePreviewStateController.
- Introduced FetchRouteAndShowRoutePreview and FeetchRouteAndStartActivenNavigation actions.
- Removed fetchRouteAnd** thunk actions (replaced by the above)
- Moved fetch route and start preview/active nav. processing to RoutePreviewStateController
- Renamed FetchOptions -> FetchRoute action.
- Updated RoutePreviewStateController to directly use RouteOptionsProvider to generate necessary RouteOptions for fetch route request.

addressing PR review comments

* Unit tests fix.

Author: tomaszrybakiewicz

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

@@ -1,6 +1,5 @@
 package com.mapbox.navigation.ui.app.internal
 
-import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.internal.extensions.attachCreated
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationApp
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
@@ -14,39 +13,29 @@ import com.mapbox.navigation.ui.app.internal.controller.RoutePreviewStateControl
 import com.mapbox.navigation.ui.app.internal.controller.RouteStateController
 import com.mapbox.navigation.ui.app.internal.controller.StateResetController
 import com.mapbox.navigation.ui.app.internal.controller.TripSessionStarterStateController
+import com.mapbox.navigation.ui.app.internal.routefetch.RouteOptionsProvider
 import com.mapbox.navigation.ui.maps.internal.ui.RouteAlternativeComponent
 import com.mapbox.navigation.ui.maps.internal.ui.RouteAlternativeContract
 import java.util.concurrent.atomic.AtomicBoolean
 
-@OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
 object SharedApp {
     private var isSetup = false
 
     val store = Store()
     val state get() = store.state.value
+    val routeOptionsProvider: RouteOptionsProvider = RouteOptionsProvider()
 
     private val ignoreTripSessionUpdates = AtomicBoolean(false)
 
-    /**
-     * These classes are accessible through MapboxNavigationApp.getObserver(..)
-     */
-    val navigationStateController = NavigationStateController(store)
-    val locationStateController = LocationStateController(store)
-    val tripSessionStarterStateController = TripSessionStarterStateController(store)
-    val audioGuidanceStateController = AudioGuidanceStateController(store)
-    val cameraStateController = CameraStateController(store)
-    val destinationStateController = DestinationStateController(store)
-    val routeStateController = RouteStateController(store)
-    val routePreviewStateController = RoutePreviewStateController(store)
     private val navigationObservers: Array<MapboxNavigationObserver> = arrayOf(
-        routeStateController,
-        cameraStateController,
-        locationStateController,
-        navigationStateController,
-        destinationStateController,
-        routePreviewStateController,
-        audioGuidanceStateController,
-        tripSessionStarterStateController,
+        RouteStateController(store),
+        CameraStateController(store),
+        LocationStateController(store),
+        NavigationStateController(store),
+        DestinationStateController(store),
+        RoutePreviewStateController(store, routeOptionsProvider),
+        AudioGuidanceStateController(store),
+        TripSessionStarterStateController(store),
     )
 
     @JvmOverloads

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

@@ -2,40 +2,30 @@ 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
-import com.mapbox.navigation.utils.internal.ifNonNull
-import com.mapbox.navigation.utils.internal.toPoint
-import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.flow.collect
-import kotlinx.coroutines.flow.takeWhile
-import kotlinx.coroutines.launch
 
 /**
  * End Navigation ThunkAction creator.
  */
 fun endNavigation() = ThunkAction { store ->
     store.setRoutes(emptyList())
     store.setPreviewRoutes(emptyList())
-    store.dispatch(DestinationAction.SetDestination(null))
-    store.dispatch(NavigationStateAction.Update(NavigationState.FreeDrive))
+    store.setDestination(null)
+    store.setNavigationState(NavigationState.FreeDrive)
 }
 
 /**
  * Show Destination Preview ThunkAction creator.
  */
 fun showDestinationPreview(point: Point) = ThunkAction { store ->
     store.setDestination(point)
-    store.dispatch(NavigationStateAction.Update(NavigationState.DestinationPreview))
+    store.setNavigationState(NavigationState.DestinationPreview)
 }
 
 /**
@@ -44,15 +34,15 @@ fun showDestinationPreview(point: Point) = ThunkAction { store ->
 fun showRoutePreview(point: Point, routes: List<NavigationRoute>) = ThunkAction { store ->
     store.setDestination(point)
     store.setPreviewRoutes(routes)
-    store.dispatch(NavigationStateAction.Update(NavigationState.RoutePreview))
+    store.setNavigationState(NavigationState.RoutePreview)
 }
 
 /**
  * Start Active Navigation ThunkAction creator.
  */
 fun startActiveNavigation(routes: List<NavigationRoute>) = ThunkAction { store ->
     store.setRoutes(routes)
-    store.dispatch(NavigationStateAction.Update(NavigationState.ActiveNavigation))
+    store.setNavigationState(NavigationState.ActiveNavigation)
 }
 
 /**
@@ -62,7 +52,7 @@ fun startActiveNavigation(point: Point, routes: List<NavigationRoute>) = ThunkAc
     store.setDestination(point)
     store.setPreviewRoutes(routes)
     store.setRoutes(routes)
-    store.dispatch(NavigationStateAction.Update(NavigationState.ActiveNavigation))
+    store.setNavigationState(NavigationState.ActiveNavigation)
 }
 
 /**
@@ -72,78 +62,12 @@ fun startArrival(point: Point, routes: List<NavigationRoute>) = ThunkAction { st
     store.setDestination(point)
     store.setPreviewRoutes(routes)
     store.setRoutes(routes)
-    store.dispatch(NavigationStateAction.Update(NavigationState.Arrival))
+    store.setNavigationState(NavigationState.Arrival)
 }
 
-/**
- * Fetch Route and Show Route Preview ThunkAction creator.
- */
-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(
-    routeOptionsProvider: RouteOptionsProvider,
-    mapboxNavigation: MapboxNavigation,
-) = fetchRouteAndContinue(routeOptionsProvider, mapboxNavigation) { store ->
-    val previewRoutes = store.state.value.previewRoutes
-    if (previewRoutes is RoutePreviewState.Ready) {
-        store.dispatch(startActiveNavigation(previewRoutes.routes))
-    }
-}
-
-// 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.
- * Method returns immediately if already in RoutePreviewState.Ready or RoutePreviewState.Fetching, or if
- * required location or destination data is missing.
- *
- * @return `true` once in RoutePreviewState.Ready state, otherwise `false`
- */
-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?.point
-    ) { lastPoint, destination ->
-        val options = routeOptionsProvider.getOptions(mapboxNavigation, lastPoint, destination)
-        store.dispatch(RoutePreviewAction.FetchOptions(options))
-        store.waitWhileFetching()
-        store.state.value.previewRoutes is RoutePreviewState.Ready
-    } ?: false
-}
-
-private suspend fun Store.waitWhileFetching() {
-    select { it.previewRoutes }.takeWhile { it is RoutePreviewState.Fetching }.collect()
-}
-
-private fun Store.setDestination(point: Point) {
-    dispatch(DestinationAction.SetDestination(Destination(point)))
+private fun Store.setDestination(point: Point?) {
+    val destination = point?.let { Destination(point) }
+    dispatch(DestinationAction.SetDestination(destination))
 }
 
 private fun Store.setPreviewRoutes(routes: List<NavigationRoute>) {
@@ -153,3 +77,7 @@ private fun Store.setPreviewRoutes(routes: List<NavigationRoute>) {
 private fun Store.setRoutes(routes: List<NavigationRoute>) {
     dispatch(RoutesAction.SetRoutes(routes))
 }
+
+private fun Store.setNavigationState(navState: NavigationState) {
+    dispatch(NavigationStateAction.Update(navState))
+}