Add ability to check configuration changing

Author: kmadsen

CHANGELOG.md

@@ -584,6 +584,10 @@ This release depends on, and has been tested with, the following Mapbox dependen
 - Mapbox Core Common `v23.1.0-rc.2`
 - Mapbox Java `v6.8.0` ([release notes](https://github.com/mapbox/mapbox-java/releases/tag/v6.8.0))
 - Mapbox Android Core `v5.0.2` ([release notes](https://github.com/mapbox/mapbox-events-android/releases/tag/core-5.0.2))
+- Add ability to check when `NavigationOptions` are changing with `MapboxNavigationApp.isOptionsChanging`. [#6484](https://github.com/mapbox/mapbox-navigation-android/pull/6484)
+- Add ability to check when Lifecycle events are triggered by configuration changes with `MapboxNavigationApp.isConfigurationChanging`. [#6484](https://github.com/mapbox/mapbox-navigation-android/pull/6484)
+- Added ability to check when `NavigationOptions` are changing with `MapboxNavigationApp.isOptionsChanging`. [#6484](https://github.com/mapbox/mapbox-navigation-android/pull/6484)
+- Added ability to check when Lifecycle events are triggered by configuration changes with `MapboxNavigationApp.isConfigurationChanging`. [#6484](https://github.com/mapbox/mapbox-navigation-android/pull/6484)
 
 ## Mapbox Navigation SDK 2.9.0-beta.2 - 14 October, 2022
 ### Changelog

libnavigation-core/build.gradle

@@ -61,6 +61,7 @@ dependencies {
     testImplementation project(':libtesting-utils')
     testImplementation project(':libtesting-navigation-base')
     testImplementation project(':libtesting-navigation-util')
+    testImplementation(dependenciesList.androidXLifecycleTesting)
     apply from: "${rootDir}/gradle/unit-testing-dependencies.gradle"
     testImplementation dependenciesList.commonsIO
 

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,31 @@ internal class MapboxNavigationAppDelegate {
 
     val lifecycleOwner: LifecycleOwner by lazy { carAppLifecycleOwner }
 
+    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 isConfigurationChanging(): Boolean {
+        return carAppLifecycleOwner.isConfigurationChanging()
+    }
+
     fun attachAllActivities(application: Application) {
         carAppLifecycleOwner.attachAllActivities(application)
     }

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

@@ -8,8 +8,7 @@ import androidx.fragment.app.Fragment
 import androidx.fragment.app.FragmentActivity
 import androidx.lifecycle.DefaultLifecycleObserver
 import androidx.lifecycle.Lifecycle
-import androidx.lifecycle.LifecycleOwner
-import androidx.lifecycle.LifecycleRegistry
+import androidx.lifecycle.testing.TestLifecycleOwner
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.testing.LoggingFrontendTestRule
 import io.mockk.every
@@ -405,8 +404,8 @@ class CarAppLifecycleOwnerTest {
         val testLifecycleOwner = TestLifecycleOwner()
         carAppLifecycleOwner.attach(testLifecycleOwner)
 
-        testLifecycleOwner.lifecycleRegistry.currentState = Lifecycle.State.RESUMED
-        testLifecycleOwner.lifecycleRegistry.currentState = Lifecycle.State.DESTROYED
+        testLifecycleOwner.handleLifecycleEvent(Lifecycle.Event.ON_RESUME)
+        testLifecycleOwner.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY)
 
         verify(exactly = 1) { testLifecycleObserver.onCreate(any()) }
         verify(exactly = 1) { testLifecycleObserver.onStart(any()) }
@@ -422,10 +421,10 @@ class CarAppLifecycleOwnerTest {
         carAppLifecycleOwner.attach(testLifecycleOwnerA)
         carAppLifecycleOwner.attach(testLifecycleOwnerB)
 
-        testLifecycleOwnerA.lifecycleRegistry.currentState = Lifecycle.State.RESUMED
-        testLifecycleOwnerB.lifecycleRegistry.currentState = Lifecycle.State.RESUMED
-        testLifecycleOwnerA.lifecycleRegistry.currentState = Lifecycle.State.DESTROYED
-        testLifecycleOwnerB.lifecycleRegistry.currentState = Lifecycle.State.DESTROYED
+        testLifecycleOwnerA.handleLifecycleEvent(Lifecycle.Event.ON_RESUME)
+        testLifecycleOwnerB.handleLifecycleEvent(Lifecycle.Event.ON_RESUME)
+        testLifecycleOwnerA.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY)
+        testLifecycleOwnerB.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY)
 
         verify(exactly = 1) { testLifecycleObserver.onCreate(any()) }
         verify(exactly = 1) { testLifecycleObserver.onStart(any()) }
@@ -441,10 +440,10 @@ class CarAppLifecycleOwnerTest {
         carAppLifecycleOwner.attach(testLifecycleOwnerA)
         carAppLifecycleOwner.attach(testLifecycleOwnerB)
 
-        testLifecycleOwnerA.lifecycleRegistry.currentState = Lifecycle.State.RESUMED
-        testLifecycleOwnerB.lifecycleRegistry.currentState = Lifecycle.State.STARTED
-        testLifecycleOwnerA.lifecycleRegistry.currentState = Lifecycle.State.DESTROYED
-        testLifecycleOwnerB.lifecycleRegistry.currentState = Lifecycle.State.DESTROYED
+        testLifecycleOwnerA.handleLifecycleEvent(Lifecycle.Event.ON_RESUME)
+        testLifecycleOwnerB.handleLifecycleEvent(Lifecycle.Event.ON_RESUME)
+        testLifecycleOwnerA.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY)
+        testLifecycleOwnerB.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY)
 
         verify(exactly = 1) { testLifecycleObserver.onCreate(any()) }
         verify(exactly = 1) { testLifecycleObserver.onStart(any()) }
@@ -458,7 +457,7 @@ class CarAppLifecycleOwnerTest {
         val testLifecycleOwner = TestLifecycleOwner()
 
         carAppLifecycleOwner.attach(testLifecycleOwner)
-        testLifecycleOwner.lifecycleRegistry.currentState = Lifecycle.State.RESUMED
+        testLifecycleOwner.handleLifecycleEvent(Lifecycle.Event.ON_RESUME)
         carAppLifecycleOwner.detach(testLifecycleOwner)
 
         verify(exactly = 1) { testLifecycleObserver.onCreate(any()) }
@@ -468,13 +467,6 @@ class CarAppLifecycleOwnerTest {
         verify(exactly = 0) { testLifecycleObserver.onDestroy(any()) }
     }
 
-    class TestLifecycleOwner : LifecycleOwner {
-        val lifecycleRegistry = LifecycleRegistry(this)
-            .also { it.currentState = Lifecycle.State.INITIALIZED }
-
-        override fun getLifecycle(): Lifecycle = lifecycleRegistry
-    }
-
     private fun mockActivity(isChangingConfig: Boolean = false): FragmentActivity = mockk {
         every { isChangingConfigurations } returns isChangingConfig
     }