NN: start and stop nav session

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

@@ -1992,8 +1992,11 @@ class MapboxNavigation @VisibleForTesting internal constructor(
             navigatorConfig,
         )
         historyRecorderHandles = createHistoryRecorderHandles(config)
+
+        val navSessionState = navigator.restoreNavigationSession()
         mainJobController.scope.launch {
             navigator.recreate(
+                navSessionState,
                 config,
                 historyRecorderHandles.composite,
                 createTilesConfig(isFallback, tilesVersion),

libnavigation-core/src/main/java/com/mapbox/navigation/core/trip/session/MapboxTripSession.kt

@@ -325,6 +325,7 @@ internal class MapboxTripSession(
     override fun start(withTripService: Boolean, withReplayEnabled: Boolean) {
         if (state != TripSessionState.STARTED) {
             navigator.addNavigatorObserver(navigatorObserver)
+            navigator.startNavigationSession()
             if (withTripService) {
                 tripService.startService()
             }
@@ -364,6 +365,7 @@ internal class MapboxTripSession(
         if (state == TripSessionState.STOPPED) {
             return
         }
+        navigator.stopNavigationSession()
         navigator.removeNavigatorObserver(navigatorObserver)
         tripService.stopService()
         tripSessionLocationEngine.stopLocationUpdates()

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

@@ -46,6 +46,7 @@ import com.mapbox.navigation.testing.factories.createDirectionsRoute
 import com.mapbox.navigation.testing.factories.createNavigationRoute
 import com.mapbox.navigation.testing.factories.createRouteOptions
 import com.mapbox.navigator.FallbackVersionsObserver
+import com.mapbox.navigator.NavigationSessionState
 import com.mapbox.navigator.NavigatorConfig
 import com.mapbox.navigator.RouteAlternative
 import com.mapbox.navigator.RouteInterface
@@ -1162,7 +1163,7 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
     }
 
     @Test
-    fun `verify tile config tilesVersion and isFallback on fallback`() {
+    fun `verify tile config tilesVersion, isFallback, and restoreNavigationSession invoke on fallback`() {
         threadController.cancelAllUICoroutines()
 
         val fallbackObserverSlot = slot<FallbackVersionsObserver>()
@@ -1174,12 +1175,15 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
             RoutesExtra.ROUTES_UPDATE_REASON_CLEAN_UP
         )
         every { tripSession.getRouteProgress() } returns mockk()
+        val mockkNavSessionState = mockk<NavigationSessionState>()
+        every { navigator.restoreNavigationSession() } returns mockkNavSessionState
 
         mapboxNavigation = MapboxNavigation(navigationOptions, threadController)
 
         val tileConfigSlot = slot<TilesConfig>()
         every {
             navigator.recreate(
+                mockkNavSessionState,
                 any(),
                 any(),
                 capture(tileConfigSlot),
@@ -1196,10 +1200,14 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
 
         assertEquals(latestTilesVersion, tileConfigSlot.captured.endpointConfig?.version)
         assertTrue(tileConfigSlot.captured.endpointConfig?.isFallback!!)
+        verifyOrder {
+            navigator.restoreNavigationSession()
+            navigator.recreate(any(), any(), any(), any(), any(), any())
+        }
     }
 
     @Test
-    fun `verify tile config tilesVersion and isFallback on return to latest tiles version`() =
+    fun `verify tile config tilesVersion, isFallback, and restoreNavigationSession invoke on return to latest tiles version`() =
         runBlocking {
             threadController.cancelAllUICoroutines()
 
@@ -1214,12 +1222,15 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
                 directionsSession.routes
             } returns listOf(mockPrimaryNavigationRoute, mockAlternativeNavigationRoute)
             every { tripSession.getRouteProgress()?.currentLegProgress?.legIndex } returns index
+            val mockkNavSessionState = mockk<NavigationSessionState>()
+            every { navigator.restoreNavigationSession() } returns mockkNavSessionState
 
             mapboxNavigation = MapboxNavigation(navigationOptions, threadController)
 
             val tileConfigSlot = slot<TilesConfig>()
             every {
                 navigator.recreate(
+                    mockkNavSessionState,
                     any(),
                     any(),
                     capture(tileConfigSlot),
@@ -1240,6 +1251,10 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
                     SetRoutesReason.RESTORE_TO_ONLINE,
                 )
             }
+            verifyOrder {
+                navigator.restoreNavigationSession()
+                navigator.recreate(any(), any(), any(), any(), any(), any())
+            }
         }
 
     @Test
@@ -1263,6 +1278,7 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
         coEvery { navigator.setRoutes(any(), any(), any(), any()) } answers {
             createSetRouteResult()
         }
+        every { navigator.restoreNavigationSession() } returns mockk()
 
         mapboxNavigation = MapboxNavigation(navigationOptions, threadController)
 

libnavigation-core/src/test/java/com/mapbox/navigation/core/trip/session/MapboxTripSessionTest.kt

@@ -220,8 +220,12 @@ class MapboxTripSessionTest {
         tripSession.start(true)
 
         assertTrue(tripSession.isRunningWithForegroundService())
-        verify { tripService.startService() }
-        verify { tripSessionLocationEngine.startLocationUpdates(any(), any()) }
+
+        verifyOrder {
+            navigator.startNavigationSession()
+            tripService.startService()
+            tripSessionLocationEngine.startLocationUpdates(any(), any())
+        }
 
         tripSession.stop()
     }
@@ -234,7 +238,10 @@ class MapboxTripSessionTest {
 
         assertFalse(tripSession.isRunningWithForegroundService())
         verify(exactly = 0) { tripService.startService() }
-        verify { tripSessionLocationEngine.startLocationUpdates(any(), any()) }
+        verifyOrder {
+            navigator.startNavigationSession()
+            tripSessionLocationEngine.startLocationUpdates(any(), any())
+        }
 
         tripSession.stop()
     }
@@ -249,9 +256,11 @@ class MapboxTripSessionTest {
 
         verifyOrder {
             navigator.addNavigatorObserver(any())
+            navigator.startNavigationSession()
             tripService.startService()
             tripSessionLocationEngine.startLocationUpdates(any(), any())
             tripSessionLocationEngine.startLocationUpdates(any(), any())
+            navigator.stopNavigationSession()
             navigator.removeNavigatorObserver(any())
             tripSession.stop()
             tripSessionLocationEngine.stopLocationUpdates()
@@ -267,10 +276,12 @@ class MapboxTripSessionTest {
 
         verifyOrder {
             navigator.addNavigatorObserver(any())
+            navigator.startNavigationSession()
             tripService.startService()
             tripSessionLocationEngine.startLocationUpdates(false, any())
             tripSessionLocationEngine.startLocationUpdates(true, any())
             tripSessionLocationEngine.startLocationUpdates(false, any())
+            navigator.stopNavigationSession()
             navigator.removeNavigatorObserver(any())
             tripSession.stop()
             tripSessionLocationEngine.stopLocationUpdates()
@@ -286,6 +297,15 @@ class MapboxTripSessionTest {
         verify { tripService.stopService() }
     }
 
+    @Test
+    fun stopSessionStoppingNativeNavigationSession() {
+        tripSession.start(true)
+
+        tripSession.stop()
+
+        verify(exactly = 1) { navigator.stopNavigationSession() }
+    }
+
     @Test
     fun stopSessionCallsLocationEngineRemoveLocationUpdates() {
         tripSession.start(true)
@@ -1444,31 +1464,45 @@ class MapboxTripSessionTest {
     }
 
     @Test
-    fun `routeProgress updates ignored while primary route is being set`() = coroutineRule.runBlockingTest {
-        val primary = mockNavigationRoute()
-        val alternative = mockNavigationRoute()
-        coEvery { navigator.setRoutes(primary, legIndex, listOf(alternative), any()) } coAnswers {
-            delay(100)
-            createSetRouteResult()
-        }
+    fun `routeProgress updates ignored while primary route is being set`() =
+        coroutineRule.runBlockingTest {
+            val primary = mockNavigationRoute()
+            val alternative = mockNavigationRoute()
+            coEvery {
+                navigator.setRoutes(
+                    primary,
+                    legIndex,
+                    listOf(alternative),
+                    any()
+                )
+            } coAnswers {
+                delay(100)
+                createSetRouteResult()
+            }
 
-        val observer = mockk<RouteProgressObserver>(relaxUnitFun = true)
+            val observer = mockk<RouteProgressObserver>(relaxUnitFun = true)
 
-        val tripSession = buildTripSession()
-        tripSession.registerRouteProgressObserver(observer)
-        tripSession.start(withTripService = true)
+            val tripSession = buildTripSession()
+            tripSession.registerRouteProgressObserver(observer)
+            tripSession.start(withTripService = true)
 
-        pauseDispatcher {
-            launch { tripSession.setRoutes(listOf(primary, alternative), setRoutesInfo) }
-            runCurrent()
-            advanceTimeBy(delayTimeMillis = 50)
-            navigatorObserverImplSlot.captured.onStatus(navigationStatusOrigin, navigationStatus)
-            verify(exactly = 0) { observer.onRouteProgressChanged(any()) }
-            advanceTimeBy(delayTimeMillis = 100)
-            navigatorObserverImplSlot.captured.onStatus(navigationStatusOrigin, navigationStatus)
-            verify(exactly = 1) { observer.onRouteProgressChanged(any()) }
+            pauseDispatcher {
+                launch { tripSession.setRoutes(listOf(primary, alternative), setRoutesInfo) }
+                runCurrent()
+                advanceTimeBy(delayTimeMillis = 50)
+                navigatorObserverImplSlot.captured.onStatus(
+                    navigationStatusOrigin,
+                    navigationStatus
+                )
+                verify(exactly = 0) { observer.onRouteProgressChanged(any()) }
+                advanceTimeBy(delayTimeMillis = 100)
+                navigatorObserverImplSlot.captured.onStatus(
+                    navigationStatusOrigin,
+                    navigationStatus
+                )
+                verify(exactly = 1) { observer.onRouteProgressChanged(any()) }
+            }
         }
-    }
 
     @Test
     fun `routeProgress updates not ignored while only alternative route is being set`() =

libnavigator/src/main/java/com/mapbox/navigation/navigator/internal/MapboxNativeNavigator.kt

@@ -16,6 +16,7 @@ import com.mapbox.navigator.FallbackVersionsObserver
 import com.mapbox.navigator.FixLocation
 import com.mapbox.navigator.GraphAccessor
 import com.mapbox.navigator.HistoryRecorderHandle
+import com.mapbox.navigator.NavigationSessionState
 import com.mapbox.navigator.NavigationStatus
 import com.mapbox.navigator.NavigatorObserver
 import com.mapbox.navigator.PredictiveCacheController
@@ -49,6 +50,7 @@ interface MapboxNativeNavigator {
      * Reinitialize the navigator with a device profile
      */
     fun recreate(
+        navigationSessionState: NavigationSessionState,
         config: ConfigHandle,
         historyRecorderComposite: HistoryRecorderHandle?,
         tilesConfig: TilesConfig,
@@ -58,6 +60,12 @@ interface MapboxNativeNavigator {
 
     suspend fun resetRideSession()
 
+    fun startNavigationSession()
+
+    fun stopNavigationSession()
+
+    fun restoreNavigationSession(): NavigationSessionState
+
     // Route following
 
     /**

libnavigator/src/main/java/com/mapbox/navigation/navigator/internal/MapboxNativeNavigatorImpl.kt

@@ -27,6 +27,7 @@ import com.mapbox.navigator.FallbackVersionsObserver
 import com.mapbox.navigator.FixLocation
 import com.mapbox.navigator.GraphAccessor
 import com.mapbox.navigator.HistoryRecorderHandle
+import com.mapbox.navigator.NavigationSessionState
 import com.mapbox.navigator.NavigationStatus
 import com.mapbox.navigator.Navigator
 import com.mapbox.navigator.NavigatorObserver
@@ -109,13 +110,15 @@ object MapboxNativeNavigatorImpl : MapboxNativeNavigator {
      * Recreate native objects and notify listeners.
      */
     override fun recreate(
+        navigationSessionState: NavigationSessionState,
         config: ConfigHandle,
         historyRecorderComposite: HistoryRecorderHandle?,
         tilesConfig: TilesConfig,
         accessToken: String,
-        router: RouterInterface,
+        router: RouterInterface
     ) {
         create(config, historyRecorderComposite, tilesConfig, accessToken, router)
+        navigator!!.restoreNavigationSession(navigationSessionState)
         nativeNavigatorRecreationObservers.forEach {
             it.onNativeNavigatorRecreated()
         }
@@ -127,6 +130,17 @@ object MapboxNativeNavigatorImpl : MapboxNativeNavigator {
         }
     }
 
+    override fun startNavigationSession() {
+        navigator!!.startNavigationSession()
+    }
+
+    override fun stopNavigationSession() {
+        navigator!!.stopNavigationSession()
+    }
+
+    override fun restoreNavigationSession(): NavigationSessionState =
+        navigator!!.storeNavigationSession()
+
     /**
      * Passes in the current raw location of the user.
      *