make reroute controller in MapboxNavigation#setRerouteController nullable

Author: dzinad

CHANGELOG.md

@@ -6,6 +6,7 @@ Mapbox welcomes participation and contributions from everyone.
 #### Features
 
 #### Bug fixes and improvements
+- Made `rerouteController` argument in `MapboxNavigation#setRerouteController` nullable. Null can be passed to disable automatic rerouting. [#5977](https://github.com/mapbox/mapbox-navigation-android/pull/5977)
 
 ## Mapbox Navigation SDK 2.7.0-alpha.2 - July 1, 2022
 ### Changelog

libnavigation-core/api/current.txt

@@ -53,7 +53,7 @@ package com.mapbox.navigation.core {
     method public void setArrivalController();
     method public void setNavigationRoutes(java.util.List<com.mapbox.navigation.base.route.NavigationRoute> routes, int initialLegIndex = 0);
     method public void setNavigationRoutes(java.util.List<com.mapbox.navigation.base.route.NavigationRoute> routes);
-    method public void setRerouteController(com.mapbox.navigation.core.reroute.RerouteController rerouteController);
+    method public void setRerouteController(com.mapbox.navigation.core.reroute.RerouteController? rerouteController);
     method public void setRerouteController(com.mapbox.navigation.core.reroute.NavigationRerouteController? rerouteController = com.mapbox.navigation.core.MapboxNavigation.defaultRerouteController);
     method public void setRerouteController();
     method public void setRerouteOptionsAdapter(com.mapbox.navigation.core.reroute.RerouteOptionsAdapter? rerouteOptionsAdapter);

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

@@ -1114,11 +1114,13 @@ class MapboxNavigation @VisibleForTesting internal constructor(
     /**
      * Set [RerouteController] that's automatically invoked when user is off-route.
      *
-     * By default uses [MapboxRerouteController].
+     * By default [MapboxRerouteController] is used.
+     * Pass `null` to disable automatic reroute.
+     * A user will stay in `OFF_ROUTE` state until a new route is set or the user gets back to the route.
      */
-    fun setRerouteController(rerouteController: RerouteController) {
+    fun setRerouteController(rerouteController: RerouteController?) {
         setRerouteController(
-            LegacyRerouteControllerAdapter(rerouteController) as NavigationRerouteController?
+            rerouteController?.let { LegacyRerouteControllerAdapter(it) }
         )
     }
 

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

@@ -55,8 +55,8 @@ internal class MapboxNavigationRerouteInterruptionTest(
             }
         } else null
         val newController = mockk<RerouteController>(relaxed = true)
-
         oldController?.let { mapboxNavigation.setRerouteController(it) }
+
         mapboxNavigation.setRerouteController(newController)
 
         if (oldController != null) {
@@ -65,6 +65,23 @@ internal class MapboxNavigationRerouteInterruptionTest(
         verify(exactly = expectedNumberOfInterruptions) { newController.reroute(any()) }
     }
 
+    @Test
+    fun setNullRerouteController() {
+        val oldController = if (previousState != null) {
+            mockk<RerouteController>(relaxed = true) {
+                every { state } returns previousState
+            }
+        } else null
+        val newController: RerouteController? = null
+        oldController?.let { mapboxNavigation.setRerouteController(it) }
+
+        mapboxNavigation.setRerouteController(newController)
+
+        if (oldController != null) {
+            verify(exactly = expectedNumberOfInterruptions) { oldController.interrupt() }
+        }
+    }
+
     @Test
     fun setNavigationRerouteController() {
         val oldController = if (previousState != null) {
@@ -73,11 +90,11 @@ internal class MapboxNavigationRerouteInterruptionTest(
             }
         } else null
         val newController = mockk<NavigationRerouteController>(relaxed = true)
-
         oldController?.let {
-            mapboxNavigation.setRerouteController(it as NavigationRerouteController?)
+            mapboxNavigation.setRerouteController(it)
         }
-        mapboxNavigation.setRerouteController(newController as NavigationRerouteController?)
+
+        mapboxNavigation.setRerouteController(newController)
 
         if (oldController != null) {
             verify(exactly = expectedNumberOfInterruptions) { oldController.interrupt() }
@@ -86,4 +103,23 @@ internal class MapboxNavigationRerouteInterruptionTest(
             newController.reroute(any<NavigationRerouteController.RoutesCallback>())
         }
     }
+
+    @Test
+    fun setNullNavigationRerouteController() {
+        val oldController = if (previousState != null) {
+            mockk<NavigationRerouteController>(relaxed = true) {
+                every { state } returns previousState
+            }
+        } else null
+        val newController: NavigationRerouteController? = null
+        oldController?.let {
+            mapboxNavigation.setRerouteController(it)
+        }
+
+        mapboxNavigation.setRerouteController(newController)
+
+        if (oldController != null) {
+            verify(exactly = expectedNumberOfInterruptions) { oldController.interrupt() }
+        }
+    }
 }

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

@@ -1198,6 +1198,38 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
         assertFalse(mapboxNavigation.getRerouteController() === oldRerouteController)
     }
 
+    @Test
+    fun `set null reroute controller`() = coroutineRule.runBlockingTest {
+        val oldController: RerouteController = mockk(relaxed = true)
+        val newController: RerouteController? = null
+        createMapboxNavigation()
+        mapboxNavigation.setRerouteController(oldController)
+
+        mapboxNavigation.setRerouteController(newController)
+
+        assertNull(mapboxNavigation.getRerouteController())
+    }
+
+    @Test
+    fun `set navigation reroute controller`() = coroutineRule.runBlockingTest {
+        val navigationRerouteController: NavigationRerouteController = mockk(relaxed = true)
+        createMapboxNavigation()
+        mapboxNavigation.setRerouteController(navigationRerouteController)
+        assertEquals(navigationRerouteController, mapboxNavigation.getRerouteController())
+    }
+
+    @Test
+    fun `set null navigation reroute controller`() = coroutineRule.runBlockingTest {
+        val oldController: NavigationRerouteController = mockk(relaxed = true)
+        val newController: NavigationRerouteController? = null
+        createMapboxNavigation()
+        mapboxNavigation.setRerouteController(oldController)
+
+        mapboxNavigation.setRerouteController(newController)
+
+        assertNull(mapboxNavigation.getRerouteController())
+    }
+
     @Test
     fun `when telemetry is enabled custom event is posted`() = coroutineRule.runBlockingTest {
         createMapboxNavigation()
@@ -1231,12 +1263,4 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
 
         unmockkStatic(TelemetryEnabler::class)
     }
-
-    @Test
-    fun `set navigation reroute controller`() = coroutineRule.runBlockingTest {
-        val navigationRerouteController: NavigationRerouteController? = mockk(relaxed = true)
-        createMapboxNavigation()
-        mapboxNavigation.setRerouteController(navigationRerouteController)
-        assertEquals(navigationRerouteController, mapboxNavigation.getRerouteController())
-    }
 }