NAVAND-899: introduce MapboxNavigation#moveRoutesFromPreviewToNavigator

Author: dzinad

CHANGELOG.md

@@ -46,6 +46,9 @@ This release depends on, and has been tested with, the following Mapbox dependen
 
 - Added `DecodeUtils#clearCache` to allow trigger route geometry cache clearing in order to reduce memory usage.
 - Started clearing route geometry cache when no routes (neither routes used for Active Guidance nor previewed ones) are available.
+- Added `DecodeUtils#clearCache` to allow trigger route geometry cache clearing in order to reduce memory usage. [#6617](https://github.com/mapbox/mapbox-navigation-android/pull/6617)
+- Started clearing route geometry cache when no routes (neither routes used for Active Guidance nor previewed ones) are available. [#6617](https://github.com/mapbox/mapbox-navigation-android/pull/6617)
+- Added convenience `MapboxNavigation#moveRoutesFromPreviewToNavigator` method to simplify transition from Routes Preview state to Active Guidance state. [#6617](https://github.com/mapbox/mapbox-navigation-android/pull/6617)
 
 ## Mapbox Navigation SDK 2.9.1 - 11 November, 2022
 ### Changelog

libnavigation-base/src/main/java/com/mapbox/navigation/base/utils/DecodeUtils.kt

@@ -122,6 +122,10 @@ object DecodeUtils {
         return stepsGeometryDecodeCache.getOrDecode(legStep.geometry(), precision)
     }
 
+    /**
+     * Clears the caches that were filled by invoking
+     * [stepGeometryToPoints], [completeGeometryToPoints], etc.
+     */
     @JvmStatic
     fun clearCache() {
         synchronized(stepsGeometryDecodeCache) {

libnavigation-core/api/current.txt

@@ -33,6 +33,7 @@ package com.mapbox.navigation.core {
     method public Integer? getZLevel();
     method public boolean isDestroyed();
     method public boolean isRunningForegroundService();
+    method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI @kotlin.jvm.Throws(exceptionClasses=IllegalArgumentException::class) public void moveRoutesFromPreviewToNavigator() throws java.lang.IllegalArgumentException;
     method public void navigateNextRouteLeg(com.mapbox.navigation.core.trip.session.LegIndexUpdatedCallback callback);
     method public void onDestroy();
     method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public void onEVDataUpdated(java.util.Map<java.lang.String,java.lang.String> data);

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

@@ -896,6 +896,27 @@ class MapboxNavigation @VisibleForTesting internal constructor(
         routesPreviewController.changeRoutesPreviewPrimaryRoute(newPrimaryRoute)
     }
 
+    /**
+     * Convenience method that takes previewed routes and sets them to Navigator,
+     * clearing the previewed routes afterwards.
+     * Equivalent to:
+     * ```
+     * mapboxNavigation.setNavigationRoutes(mapboxNavigation.getRoutesPreview()!!.routesList)
+     * mapboxNavigation.setRoutesPreview(emptyList())
+     * ```
+     * @throws IllegalArgumentException when previewed routes are empty.
+     */
+    @Throws(IllegalArgumentException::class)
+    @ExperimentalPreviewMapboxNavigationAPI
+    fun moveRoutesFromPreviewToNavigator() {
+        val preview = getRoutesPreview()
+        requireNotNull(preview) {
+            "Can't move routes from preview to navigator as no previewed routes are available"
+        }
+        setNavigationRoutes(preview.routesList)
+        setRoutesPreview(emptyList())
+    }
+
     /***
      * Registers [RoutesPreviewObserver] to be notified when routes preview state changes.
      * [observer] is immediately called with current preview state

libnavigation-core/src/test/java/com/mapbox/navigation/core/MapboxNavigationTest.kt

@@ -21,6 +21,7 @@ import com.mapbox.navigation.core.internal.extensions.registerHistoryRecordingSt
 import com.mapbox.navigation.core.internal.extensions.unregisterHistoryRecordingStateChangeObserver
 import com.mapbox.navigation.core.internal.telemetry.NavigationCustomEventType
 import com.mapbox.navigation.core.navigator.CacheHandleWrapper
+import com.mapbox.navigation.core.preview.RoutesPreview
 import com.mapbox.navigation.core.reroute.NavigationRerouteController
 import com.mapbox.navigation.core.reroute.RerouteController
 import com.mapbox.navigation.core.reroute.RerouteState
@@ -1768,4 +1769,28 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
             evDataHolder.updateData(data)
         }
     }
+
+    @Test(expected = IllegalArgumentException::class)
+    fun moveRoutesFromPreviewToNavigatorNoPreviewedRoutes() {
+        createMapboxNavigation()
+        every { routesPreviewController.getRoutesPreview() } returns null
+
+        mapboxNavigation.moveRoutesFromPreviewToNavigator()
+    }
+
+    @Test
+    fun moveRoutesFromPreviewToNavigatorHasPreviewedRoutes() = coroutineRule.runBlockingTest {
+        val routes = listOf<NavigationRoute>(mockk())
+        createMapboxNavigation()
+        every {
+            routesPreviewController.getRoutesPreview()
+        } returns RoutesPreview(routes, emptyList(), listOf(mockk()), 0)
+
+        mapboxNavigation.moveRoutesFromPreviewToNavigator()
+
+        coVerifyOrder {
+            tripSession.setRoutes(routes, any())
+            routesPreviewController.previewNavigationRoutes(emptyList())
+        }
+    }
 }

qa-test-app/src/main/java/com/mapbox/navigation/qa_test_app/view/RoutesPreviewActivity.kt

@@ -485,16 +485,15 @@ class RoutesPreviewActivity : AppCompatActivity() {
             visibility = View.VISIBLE
             setOnClickListener {
                 visibility = View.GONE
-                setRouteAndStartNavigation(mapboxNavigation.getRoutesPreview()!!.routesList)
-                mapboxNavigation.setRoutesPreview(emptyList())
+                setRouteAndStartNavigation()
             }
         }
         mapboxNavigation.setRoutesPreview(routes)
     }
 
-    private fun setRouteAndStartNavigation(route: List<NavigationRoute>) {
+    private fun setRouteAndStartNavigation() {
         // set route
-        mapboxNavigation.setNavigationRoutes(route)
+        mapboxNavigation.moveRoutesFromPreviewToNavigator()
 
         // show UI elements
         binding.soundButton.visibility = View.VISIBLE