Fixed leak of CarAppLifecycleOwner (#7669)

Author: VysotskiVadim

changelog/unreleased/bugfixes/7669.md

@@ -0,0 +1 @@
+- Fixed leak of CarAppLifecycleOwner on every copilot start.

libnavigation-copilot/src/main/java/com/mapbox/navigation/copilot/MapboxCopilotImpl.kt

@@ -144,12 +144,18 @@ internal class MapboxCopilotImpl(
             arrivedAtFinalDestination = true
         }
     }
+    private val appLifecycleOwnerCleanupAction: () -> Unit
     private val appLifecycleOwner = if (MapboxNavigationApp.isSetup()) {
+        appLifecycleOwnerCleanupAction = { }
         MapboxNavigationApp.lifecycleOwner
     } else {
         CarAppLifecycleOwner().apply {
             val applicationContext = mapboxNavigation.navigationOptions.applicationContext
-            attachAllActivities(applicationContext as Application)
+            val application = applicationContext as Application
+            attachAllActivities(application)
+            appLifecycleOwnerCleanupAction = {
+                detachAllActivities(application)
+            }
         }
     }
     private val historyFiles = mutableMapOf<File, CopilotMetadata>()
@@ -172,6 +178,7 @@ internal class MapboxCopilotImpl(
     fun stop() {
         unregisterUserFeedbackCallback(userFeedbackCallback)
         appLifecycleOwner.lifecycle.removeObserver(foregroundBackgroundLifecycleObserver)
+        appLifecycleOwnerCleanupAction()
         mapboxNavigation.unregisterHistoryRecordingStateChangeObserver(
             historyRecordingStateChangeObserver
         )

libnavigation-copilot/src/test/java/com/mapbox/navigation/copilot/MapboxCopilotImplTest.kt

@@ -34,6 +34,7 @@ import com.mapbox.navigation.core.internal.telemetry.UserFeedbackCallback
 import com.mapbox.navigation.core.internal.telemetry.registerUserFeedbackCallback
 import com.mapbox.navigation.core.internal.telemetry.unregisterUserFeedbackCallback
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationApp
+import com.mapbox.navigation.testing.LoggingFrontendTestRule
 import com.mapbox.navigation.testing.MainCoroutineRule
 import com.mapbox.navigation.utils.internal.DefaultLifecycleObserver
 import com.mapbox.navigation.utils.internal.logD
@@ -73,6 +74,9 @@ class MapboxCopilotImplTest {
     @get:Rule
     val coroutineRule = MainCoroutineRule()
 
+    @get:Rule
+    val loggingFrontendTestRule = LoggingFrontendTestRule()
+
     @Before
     fun setUp() {
         mockkStatic(SystemClock::elapsedRealtime)
@@ -463,6 +467,30 @@ class MapboxCopilotImplTest {
         verify(exactly = 1) { mockedAppLifecycle.removeObserver(any()) }
     }
 
+    @Test
+    fun `activity Lifecycle Callbacks is unregistered when stop if MapboxNavigationApp is not setup`() {
+        val mockedMapboxNavigation = prepareBasicMockks()
+        val mockedAppLifecycle = prepareCarAppLifecycleOwnerMockk()
+        val historyRecordingStateChangeObserver = slot<HistoryRecordingStateChangeObserver>()
+        every {
+            mockedMapboxNavigation.registerHistoryRecordingStateChangeObserver(
+                capture(historyRecordingStateChangeObserver)
+            )
+        } just Runs
+        val mapboxCopilot = createMapboxCopilotImplementation(mockedMapboxNavigation)
+        mapboxCopilot.start()
+        val activeGuidanceHistoryRecordingSessionState =
+            mockk<HistoryRecordingSessionState.ActiveGuidance>(relaxed = true)
+        historyRecordingStateChangeObserver.captured.onShouldStartRecording(
+            activeGuidanceHistoryRecordingSessionState
+        )
+
+        mapboxCopilot.stop()
+
+        verify(exactly = 1) { anyConstructed<CarAppLifecycleOwner>().attachAllActivities(any()) }
+        verify(exactly = 1) { anyConstructed<CarAppLifecycleOwner>().detachAllActivities(any()) }
+    }
+
     @Test
     fun `unregisterHistoryRecordingStateChangeObserver is called when stop`() {
         val mockedMapboxNavigation = prepareBasicMockks()

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

@@ -173,6 +173,11 @@ class CarAppLifecycleOwner : LifecycleOwner {
         application.registerActivityLifecycleCallbacks(activityLifecycleCallbacks)
     }
 
+    fun detachAllActivities(application: Application) {
+        logI("detachAllActivities", LOG_CATEGORY)
+        application.unregisterActivityLifecycleCallbacks(activityLifecycleCallbacks)
+    }
+
     fun attach(lifecycleOwner: LifecycleOwner) {
         logI("attach", LOG_CATEGORY)
         lifecycleOwner.lifecycle.addObserver(startedReferenceCounter)