Add ability to check configuration changing

Author: kmadsen

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

@@ -77,6 +77,25 @@ object MapboxNavigationApp {
     @JvmStatic
     fun isSetup(): Boolean = mapboxNavigationAppDelegate.isSetup
 
+    /**
+     * When calling [setup] multiple times, all registered [MapboxNavigationObserver] will be
+     * detached from the instance of [MapboxNavigation] that is being destroyed. This is needed for
+     * maintaining state across options changes. You do not need to clear the state when
+     * [isOptionsChanging] is true.
+     */
+    @UiThread
+    @JvmStatic
+    fun isOptionsChanging(): Boolean = mapboxNavigationAppDelegate.isOptionsChanging()
+
+    /**
+     * When observing [MapboxNavigation] from a [Lifecycle], the [Lifecycle.Event] may be triggered
+     * because of a configuration change. This will help you know if the lifecycle events are
+     * triggered events like mobile device orientation changes.
+     */
+    @UiThread
+    @JvmStatic
+    fun isConfigurationChanging(): Boolean = mapboxNavigationAppDelegate.isConfigurationChanging()
+
     /**
      * Call [MapboxNavigationApp.setup] to provide the application with [NavigationOptions].
      *

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

@@ -16,22 +16,35 @@ internal class MapboxNavigationAppDelegate {
 
     val lifecycleOwner: LifecycleOwner by lazy { carAppLifecycleOwner }
 
+    private var isOptionsChanging = false
+        private set
+
     var isSetup = false
+        private set
 
     fun setup(navigationOptionsProvider: NavigationOptionsProvider) = apply {
         if (carAppLifecycleOwner.isConfigurationChanging()) {
             return this
         }
 
         if (isSetup) {
+            isOptionsChanging = true
             disable()
         }
-
         mapboxNavigationOwner.setup(navigationOptionsProvider)
         carAppLifecycleOwner.lifecycle.addObserver(mapboxNavigationOwner.carAppLifecycleObserver)
+        isOptionsChanging = false
         isSetup = true
     }
 
+    fun isOptionsChanging(): Boolean {
+        return isOptionsChanging
+    }
+
+    fun isConfigurationChanging(): Boolean {
+        return carAppLifecycleOwner.isConfigurationChanging()
+    }
+
     fun attachAllActivities(application: Application) {
         carAppLifecycleOwner.attachAllActivities(application)
     }

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

@@ -20,6 +20,7 @@ import io.mockk.unmockkAll
 import io.mockk.verify
 import io.mockk.verifyOrder
 import org.junit.After
+import org.junit.Assert.assertArrayEquals
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNotNull
 import org.junit.Assert.assertNull
@@ -476,6 +477,62 @@ class MapboxNavigationAppDelegateTest {
         assertEquals(retrieved, retrievedJava)
     }
 
+    @Test
+    fun `verify isConfigurationChanging is false for setup changes`() {
+        mockMultiMapboxNavigation()
+        mapboxNavigationApp.setup { navigationOptions }
+        val testLifecycleOwner = CarAppLifecycleOwnerTest.TestLifecycleOwner()
+        testLifecycleOwner.lifecycleRegistry.currentState = Lifecycle.State.RESUMED
+        mapboxNavigationApp.attach(testLifecycleOwner)
+
+        val onAttachedSlot = mutableListOf<Boolean>()
+        val onDetachedSlot = mutableListOf<Boolean>()
+        val observerFirst = object : MapboxNavigationObserver {
+            override fun onAttached(mapboxNavigation: MapboxNavigation) {
+                onAttachedSlot.add(mapboxNavigationApp.isConfigurationChanging())
+            }
+
+            override fun onDetached(mapboxNavigation: MapboxNavigation) {
+                onDetachedSlot.add(mapboxNavigationApp.isConfigurationChanging())
+            }
+        }
+        mapboxNavigationApp.registerObserver(observerFirst)
+        mapboxNavigationApp.setup { mockk { every { accessToken } returns "test_access_token_1" } }
+        mapboxNavigationApp.setup { mockk { every { accessToken } returns "test_access_token_2" } }
+
+        assertArrayEquals(onAttachedSlot.toBooleanArray(), booleanArrayOf(false, false, false))
+        assertArrayEquals(onDetachedSlot.toBooleanArray(), booleanArrayOf(false, false))
+    }
+
+    @Test
+    fun `verify isOptionsChanging is true while the setup changes`() {
+        mockMultiMapboxNavigation()
+        mapboxNavigationApp.setup { navigationOptions }
+        val testLifecycleOwner = CarAppLifecycleOwnerTest.TestLifecycleOwner()
+        testLifecycleOwner.lifecycleRegistry.currentState = Lifecycle.State.RESUMED
+        mapboxNavigationApp.attach(testLifecycleOwner)
+
+        val onAttachedSlot = mutableListOf<Boolean>()
+        val onDetachedSlot = mutableListOf<Boolean>()
+        val observerFirst = object : MapboxNavigationObserver {
+            override fun onAttached(mapboxNavigation: MapboxNavigation) {
+                onAttachedSlot.add(mapboxNavigationApp.isOptionsChanging())
+            }
+
+            override fun onDetached(mapboxNavigation: MapboxNavigation) {
+                onDetachedSlot.add(mapboxNavigationApp.isOptionsChanging())
+            }
+        }
+        mapboxNavigationApp.registerObserver(observerFirst)
+        mapboxNavigationApp.setup { mockk { every { accessToken } returns "test_access_token_1" } }
+        mapboxNavigationApp.setup { mockk { every { accessToken } returns "test_access_token_2" } }
+
+        assertEquals(3, onAttachedSlot.size)
+        assertEquals(2, onDetachedSlot.size)
+        assertArrayEquals(onAttachedSlot.toBooleanArray(), booleanArrayOf(false, true, true))
+        assertArrayEquals(onDetachedSlot.toBooleanArray(), booleanArrayOf(true, true))
+    }
+
     private fun mockActivityLifecycle(): Pair<ComponentActivity, LifecycleRegistry> {
         val activity = mockk<ComponentActivity> {
             every { isChangingConfigurations } returns false
@@ -486,6 +543,14 @@ class MapboxNavigationAppDelegateTest {
         return Pair(activity, lifecycle)
     }
 
+    private fun mockMultiMapboxNavigation() {
+        every { MapboxNavigationProvider.create(any()) } answers {
+            mockk {
+                every { navigationOptions } returns firstArg()
+            }
+        }
+    }
+
     /**
      * Used for the [MapboxNavigationApp.getObserver] tests because they require a class definition.
      */