NAVAND-1073: fix alternative routes refresh

Author: dzinad

changelog/unreleased/bugfixes/dd.md

@@ -0,0 +1 @@
+- Fixed alternative routes refresh.

instrumentation-tests/src/androidTest/java/com/mapbox/navigation/instrumentation_tests/core/RouteRefreshTest.kt

@@ -26,6 +26,7 @@ import com.mapbox.navigation.instrumentation_tests.utils.coroutines.roadObjectsO
 import com.mapbox.navigation.instrumentation_tests.utils.coroutines.routeProgressUpdates
 import com.mapbox.navigation.instrumentation_tests.utils.coroutines.routesUpdates
 import com.mapbox.navigation.instrumentation_tests.utils.coroutines.sdkTest
+import com.mapbox.navigation.instrumentation_tests.utils.coroutines.setNavigationRoutesAndWaitForAlternativesUpdate
 import com.mapbox.navigation.instrumentation_tests.utils.coroutines.setNavigationRoutesAndWaitForUpdate
 import com.mapbox.navigation.instrumentation_tests.utils.http.FailByRequestMockRequestHandler
 import com.mapbox.navigation.instrumentation_tests.utils.http.MockDirectionsRefreshHandler
@@ -34,6 +35,8 @@ import com.mapbox.navigation.instrumentation_tests.utils.http.MockRoutingTileEnd
 import com.mapbox.navigation.instrumentation_tests.utils.idling.IdlingPolicyTimeoutRule
 import com.mapbox.navigation.instrumentation_tests.utils.location.MockLocationReplayerRule
 import com.mapbox.navigation.instrumentation_tests.utils.readRawFileText
+import com.mapbox.navigation.instrumentation_tests.utils.routes.RoutesProvider
+import com.mapbox.navigation.instrumentation_tests.utils.routes.RoutesProvider.toNavigationRoutes
 import com.mapbox.navigation.testing.ui.BaseTest
 import com.mapbox.navigation.testing.ui.utils.getMapboxAccessTokenFromResources
 import com.mapbox.navigation.testing.ui.utils.runOnMainSync
@@ -424,7 +427,7 @@ class RouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.ja
                 R.raw.route_response_route_refresh,
                 R.raw.route_response_route_refresh_truncated_first_leg,
                 "route_response_route_refresh",
-                acceptedGeometryIndex = 5
+                acceptedGeometryIndex = 3
             )
             val routeOptions = generateRouteOptions(twoCoordinates)
             val requestedRoutes = mapboxNavigation.requestRoutes(routeOptions)
@@ -433,10 +436,10 @@ class RouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.ja
 
             mapboxNavigation.setNavigationRoutes(requestedRoutes)
             mapboxNavigation.startTripSession()
-            // corresponds to currentRouteGeometryIndex = 5
-            stayOnPosition(38.57622, -121.496731)
+            // corresponds to currentRouteGeometryIndex = 3
+            stayOnPosition(38.577344, -121.496248)
             mapboxNavigation.routeProgressUpdates()
-                .filter { it.currentRouteGeometryIndex == 5 }
+                .filter { it.currentRouteGeometryIndex == 3 }
                 .first()
             val refreshedRoutes = mapboxNavigation.routesUpdates()
                 .filter {
@@ -446,12 +449,67 @@ class RouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.ja
                 .navigationRoutes
 
             assertEquals(224.224, requestedRoutes[0].getSumOfDurationAnnotationsFromLeg(0), 0.0001)
-            assertEquals(169.582, refreshedRoutes[0].getSumOfDurationAnnotationsFromLeg(0), 0.0001)
+            assertEquals(172.175, refreshedRoutes[0].getSumOfDurationAnnotationsFromLeg(0), 0.0001)
 
             assertEquals(227.918, requestedRoutes[1].getSumOfDurationAnnotationsFromLeg(0), 0.0001)
-            assertEquals(234.024, refreshedRoutes[1].getSumOfDurationAnnotationsFromLeg(0), 0.0001)
+            assertEquals(235.641, refreshedRoutes[1].getSumOfDurationAnnotationsFromLeg(0), 0.0001)
         }
 
+    @Test
+    fun expect_route_refresh_to_update_annotations_for_new_alternative() = sdkTest {
+        setupMockRequestHandlers(
+            twoCoordinates,
+            R.raw.route_response_single_route_multileg,
+            R.raw.route_response_single_route_multileg_refreshed,
+            "route_response_single_route_multileg",
+            acceptedGeometryIndex = 70
+        )
+        val routeOptions = generateRouteOptions(twoCoordinates)
+        val requestedRoutes = mapboxNavigation.requestRoutes(routeOptions)
+            .getSuccessfulResultOrThrowException()
+            .routes
+        val alternativeRoute =
+            RoutesProvider.alternative_for_multileg(activity).toNavigationRoutes().first()
+
+        mapboxNavigation.setNavigationRoutes(requestedRoutes, initialLegIndex = 1)
+        mapboxNavigation.startTripSession()
+
+        // corresponds to currentRouteGeometryIndex = 70 for primary route and 11 for alternative route
+        stayOnPosition(38.581798, -121.476146)
+        mapboxNavigation.routeProgressUpdates()
+            .filter {
+                it.currentRouteGeometryIndex == 70
+            }
+            .first()
+
+        mockWebServerRule.requestHandlers.add(
+            FailByRequestMockRequestHandler(
+                MockDirectionsRefreshHandler(
+                    "route_response_alternative_for_multileg",
+                    readRawFileText(
+                        activity,
+                        R.raw.route_response_alternative_for_multileg_refreshed
+                    ),
+                    acceptedGeometryIndex = 11
+                )
+            )
+        )
+        mapboxNavigation.setNavigationRoutesAndWaitForAlternativesUpdate(requestedRoutes + alternativeRoute, initialLegIndex = 1)
+
+        val refreshedRoutes = mapboxNavigation.routesUpdates()
+            .filter {
+                it.reason == ROUTES_UPDATE_REASON_REFRESH
+            }
+            .first()
+            .navigationRoutes
+
+        assertEquals(201.673, requestedRoutes[0].getSumOfDurationAnnotationsFromLeg(1), 0.0001)
+        assertEquals( 202.881, refreshedRoutes[0].getSumOfDurationAnnotationsFromLeg(1), 0.0001)
+
+        assertEquals(194.3, alternativeRoute.getSumOfDurationAnnotationsFromLeg(0), 0.0001)
+        assertEquals(187.126, refreshedRoutes[1].getSumOfDurationAnnotationsFromLeg(0), 0.0001)
+    }
+
     @Test
     fun expect_route_refresh_to_update_annotations_incidents_and_closures_for_truncated_next_leg() =
         sdkTest {

instrumentation-tests/src/androidTest/java/com/mapbox/navigation/instrumentation_tests/utils/coroutines/Adapters.kt

@@ -6,6 +6,7 @@ import com.mapbox.api.directions.v5.models.BannerInstructions
 import com.mapbox.api.directions.v5.models.RouteOptions
 import com.mapbox.api.directions.v5.models.VoiceInstructions
 import com.mapbox.bindgen.Expected
+import com.mapbox.bindgen.ExpectedFactory
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.route.NavigationRouterCallback
@@ -22,6 +23,8 @@ import com.mapbox.navigation.core.directions.session.RoutesUpdatedResult
 import com.mapbox.navigation.core.history.MapboxHistoryRecorder
 import com.mapbox.navigation.core.preview.RoutesPreviewObserver
 import com.mapbox.navigation.core.preview.RoutesPreviewUpdate
+import com.mapbox.navigation.core.routealternatives.NavigationRouteAlternativesRequestCallback
+import com.mapbox.navigation.core.routealternatives.RouteAlternativesError
 import com.mapbox.navigation.core.trip.session.BannerInstructionsObserver
 import com.mapbox.navigation.core.trip.session.OffRouteObserver
 import com.mapbox.navigation.core.trip.session.RoadObjectsOnRouteObserver

instrumentation-tests/src/androidTest/java/com/mapbox/navigation/instrumentation_tests/utils/coroutines/TestUtils.kt

@@ -93,10 +93,11 @@ suspend fun MapboxNavigation.setNavigationRoutesAndAwaitError(
 }
 
 suspend fun MapboxNavigation.setNavigationRoutesAndWaitForAlternativesUpdate(
-    routes: List<NavigationRoute>
+    routes: List<NavigationRoute>,
+    initialLegIndex: Int = 0,
 ) =
     withTimeout(MAX_TIME_TO_UPDATE_ROUTE) {
-        setNavigationRoutes(routes)
+        setNavigationRoutes(routes, initialLegIndex)
         waitForAlternativeRoute()
     }
 

instrumentation-tests/src/androidTest/java/com/mapbox/navigation/instrumentation_tests/utils/routes/RoutesProvider.kt

@@ -167,6 +167,27 @@ object RoutesProvider {
         )
     }
 
+    fun alternative_for_multileg(context: Context): MockRoute {
+        val jsonResponse = readRawFileText(context, R.raw.route_response_alternative_for_multileg)
+        val coordinates = listOf(
+            Point.fromLngLat(38.577427, -121.478077),
+            Point.fromLngLat(38.582195, -121.468458)
+        )
+        return MockRoute(
+            jsonResponse,
+            DirectionsResponse.fromJson(jsonResponse),
+            listOf(
+                MockDirectionsRequestHandler(
+                    profile = DirectionsCriteria.PROFILE_DRIVING_TRAFFIC,
+                    jsonResponse = jsonResponse,
+                    expectedCoordinates = coordinates
+                )
+            ),
+            coordinates,
+            emptyList()
+        )
+    }
+
     fun MockRoute.toNavigationRoutes(
         routeOptionsBlock: RouteOptions.Builder.() -> RouteOptions.Builder = { this }
     ) : List<NavigationRoute> {