[Drop-In UI] Fixed the last audio instruction repeat on the next session (#6662)

* Fixed last audio instruction from previous session becomes the 1st on next session.

* Removed redundant `MapboxVoiceInstructions.tripSessionStateFlow`

* CHANGELOG entry

Author: tomaszrybakiewicz

CHANGELOG.md

@@ -8,6 +8,7 @@ Mapbox welcomes participation and contributions from everyone.
 - Added building highlight on arrival support to `NavigationView`. Added new customization options `ViewOptionsCustomization.enableBuildingHighlightOnArrival` and  `ViewOptionsCustomization.buildingHighlightOptions`. [#6651](https://github.com/mapbox/mapbox-navigation-android/pull/6651)
 - Added `ComponentInstaller` for the `BuildingHighlightComponent` that offers simplified integration of the `MapboxBuildingsApi` and `MapboxBuildingView`. [#6651](https://github.com/mapbox/mapbox-navigation-android/pull/6651)
 #### Bug fixes and improvements
+- Fixed an issue in the `NavigationView` where the last audio instruction from the previous session becomes the 1st on the next session. [#6662](https://github.com/mapbox/mapbox-navigation-android/pull/6662)
 - Fixed crash in `PermissionsLauncherFragment` occurring on device rotation. [#6635](https://github.com/mapbox/mapbox-navigation-android/pull/6635)
 - Fixed a rare `java.lang.IllegalArgumentException: The Path cannot loop back on itself.` exception when using `NavigationLocationProvider`. [#6641](https://github.com/mapbox/mapbox-navigation-android/pull/6641)
 - Started clearing route geometry cache when no routes (neither routes used for Active Guidance nor previewed ones) are available. [#6617](https://github.com/mapbox/mapbox-navigation-android/pull/6617)

libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/internal/MapboxVoiceInstructions.kt

@@ -11,9 +11,6 @@ import com.mapbox.navigation.core.trip.session.VoiceInstructionsObserver
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.flow.distinctUntilChangedBy
-import kotlinx.coroutines.flow.flatMapLatest
-import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.flow.mapLatest
 
 /**
@@ -23,18 +20,22 @@ import kotlinx.coroutines.flow.mapLatest
 class MapboxVoiceInstructions {
 
     private val voiceInstructionsFlow =
-        MutableStateFlow<State>(MapboxVoiceInstructionsState(true, null))
+        MutableStateFlow(MapboxVoiceInstructionsState(true, null))
     private val routesFlow = MutableStateFlow<List<NavigationRoute>>(emptyList())
-    private val tripSessionStateFlow = MutableStateFlow(TripSessionState.STOPPED)
 
     private val voiceInstructionsObserver = VoiceInstructionsObserver {
         voiceInstructionsFlow.value = MapboxVoiceInstructionsState(true, it)
     }
     private val routesObserver = RoutesObserver {
         routesFlow.value = it.navigationRoutes
+        if (it.navigationRoutes.isEmpty()) {
+            voiceInstructionsFlow.value = MapboxVoiceInstructionsState()
+        }
     }
     private val tripSessionStateObserver = TripSessionStateObserver {
-        tripSessionStateFlow.value = it
+        if (it == TripSessionState.STOPPED) {
+            voiceInstructionsFlow.value = MapboxVoiceInstructionsState()
+        }
     }
 
     fun registerObservers(mapboxNavigation: MapboxNavigation) {
@@ -51,38 +52,16 @@ class MapboxVoiceInstructions {
         resetFlows()
     }
 
-    fun voiceInstructions(): Flow<State> {
-        return tripSessionStateFlow
-            .flatMapLatest { tripSessionState ->
-                if (tripSessionState == TripSessionState.STARTED) {
-                    routesUpdatedResultToVoiceInstructions()
-                } else {
-                    flowOf(MapboxVoiceInstructionsState(false, null))
-                }
-            }
-    }
+    fun voiceInstructions(): Flow<State> = voiceInstructionsFlow
 
     fun voiceLanguage(): Flow<String?> {
         return routesFlow
             .mapLatest { it.firstOrNull()?.directionsRoute?.voiceLanguage() }
     }
 
-    private fun routesUpdatedResultToVoiceInstructions(): Flow<State> {
-        return routesFlow
-            .distinctUntilChangedBy { it.isEmpty() }
-            .flatMapLatest { routes ->
-                if (routes.isNotEmpty()) {
-                    voiceInstructionsFlow
-                } else {
-                    flowOf(MapboxVoiceInstructionsState(false, null))
-                }
-            }
-    }
-
     private fun resetFlows() {
         voiceInstructionsFlow.value = MapboxVoiceInstructionsState(true, null)
         routesFlow.value = emptyList()
-        tripSessionStateFlow.value = TripSessionState.STOPPED
     }
 
     interface State {

libnavui-voice/src/test/java/com/mapbox/navigation/ui/voice/internal/impl/MapboxVoiceInstructionsTest.kt

@@ -17,7 +17,9 @@ import io.mockk.mockk
 import io.mockk.slot
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.test.runBlockingTest
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNotNull
 import org.junit.Assert.assertNull
 import org.junit.Assert.assertTrue
 import org.junit.Rule
@@ -30,7 +32,7 @@ class MapboxVoiceInstructionsTest {
     val coroutineRule = MainCoroutineRule()
 
     private val mapboxNavigation = mockk<MapboxNavigation>(relaxUnitFun = true)
-    private val carAppVoiceInstructions = MapboxVoiceInstructions()
+    private val sut = MapboxVoiceInstructions()
 
     @Test
     fun `should emit voice instruction`() = coroutineRule.runBlockingTest {
@@ -53,8 +55,8 @@ class MapboxVoiceInstructionsTest {
             every { announcement() } returns "Left on Broadway"
         }
 
-        carAppVoiceInstructions.registerObservers(mapboxNavigation)
-        val flow = carAppVoiceInstructions.voiceInstructions()
+        sut.registerObservers(mapboxNavigation)
+        val flow = sut.voiceInstructions()
         val initialInstruction = flow.first()
         observerSlot.captured.onNewVoiceInstructions(voiceInstructions)
         val updatedInstruction = flow.first()
@@ -90,10 +92,10 @@ class MapboxVoiceInstructionsTest {
             mapboxNavigation.registerVoiceInstructionsObserver(capture(observerSlot))
         } just Runs
 
-        val flow = carAppVoiceInstructions.voiceInstructions()
+        val flow = sut.voiceInstructions()
         val initialAnnouncement = flow.first().voiceInstructions?.announcement()
 
-        carAppVoiceInstructions.registerObservers(mapboxNavigation)
+        sut.registerObservers(mapboxNavigation)
 
         observerSlot.captured.onNewVoiceInstructions(firstVoiceInstructions)
         val firstAnnouncement = flow.first().voiceInstructions?.announcement()
@@ -121,7 +123,7 @@ class MapboxVoiceInstructionsTest {
             firstArg<RoutesObserver>().onRoutesChanged(result)
         }
 
-        val state = carAppVoiceInstructions.voiceInstructions().first()
+        val state = sut.voiceInstructions().first()
 
         assertNull(state.voiceInstructions?.announcement())
     }
@@ -134,7 +136,7 @@ class MapboxVoiceInstructionsTest {
             )
         }
 
-        val state = carAppVoiceInstructions.voiceInstructions().first()
+        val state = sut.voiceInstructions().first()
 
         assertNull(state.voiceInstructions?.announcement())
     }
@@ -152,9 +154,9 @@ class MapboxVoiceInstructionsTest {
             firstArg<RoutesObserver>().onRoutesChanged(result)
         }
 
-        val flow = carAppVoiceInstructions.voiceLanguage()
+        val flow = sut.voiceLanguage()
         val initialInstruction = flow.first()
-        carAppVoiceInstructions.registerObservers(mapboxNavigation)
+        sut.registerObservers(mapboxNavigation)
         val updatedInstruction = flow.first()
 
         // routesFlow() on start sends empty list to disable sound button  in FreeDrive
@@ -171,17 +173,63 @@ class MapboxVoiceInstructionsTest {
             firstArg<RoutesObserver>().onRoutesChanged(result)
         }
 
-        assertNull(carAppVoiceInstructions.voiceLanguage().first())
+        assertNull(sut.voiceLanguage().first())
     }
 
     @Test
     fun `should emit null voice language before routes are updated`() =
         coroutineRule.runBlockingTest {
             every { mapboxNavigation.registerRoutesObserver(any()) } just Runs
 
-            assertNull(carAppVoiceInstructions.voiceLanguage().first())
+            assertNull(sut.voiceLanguage().first())
         }
 
+    @Test
+    fun `should reset voiceInstructions when empty routes are set`() = runBlockingTest {
+        val firstVoiceInstructions = mockk<VoiceInstructions>()
+        val routesObserver = slot<RoutesObserver>()
+        val instructionsObserver = slot<VoiceInstructionsObserver>()
+        every { mapboxNavigation.registerRoutesObserver(capture((routesObserver))) } returns Unit
+        every {
+            mapboxNavigation.registerVoiceInstructionsObserver(capture(instructionsObserver))
+        } returns Unit
+        sut.registerObservers(mapboxNavigation)
+
+        instructionsObserver.captured.onNewVoiceInstructions(firstVoiceInstructions)
+        val firstState = sut.voiceInstructions().first()
+        routesObserver.captured.onRoutesChanged(
+            mockk {
+                every { navigationRoutes } returns emptyList()
+            }
+        )
+        val secondState = sut.voiceInstructions().first()
+
+        assertNotNull(firstState.voiceInstructions)
+        assertNull(secondState.voiceInstructions)
+    }
+
+    @Test
+    fun `should reset voiceInstructions when TripSession is STOPPED`() = runBlockingTest {
+        val firstVoiceInstructions = mockk<VoiceInstructions>()
+        val instructionsObserver = slot<VoiceInstructionsObserver>()
+        val tripSessionObserver = slot<TripSessionStateObserver>()
+        every {
+            mapboxNavigation.registerVoiceInstructionsObserver(capture(instructionsObserver))
+        } returns Unit
+        every {
+            mapboxNavigation.registerTripSessionStateObserver(capture(tripSessionObserver))
+        } returns Unit
+        sut.registerObservers(mapboxNavigation)
+
+        instructionsObserver.captured.onNewVoiceInstructions(firstVoiceInstructions)
+        val firstState = sut.voiceInstructions().first()
+        tripSessionObserver.captured.onSessionStateChanged(TripSessionState.STOPPED)
+        val secondState = sut.voiceInstructions().first()
+
+        assertNotNull(firstState.voiceInstructions)
+        assertNull(secondState.voiceInstructions)
+    }
+
     private fun createRoute(voiceLanguage: String): NavigationRoute {
         return mockk {
             every { directionsRoute } returns mockk {