fixed an issue where DirectionsResponse#waypoints list was cleared after a successful non-EV route refresh

Author: Łukasz Paczos

CHANGELOG.md

@@ -35,6 +35,7 @@ Mapbox welcomes participation and contributions from everyone.
 - Fixed an issue where "silent waypoints" (not regular waypoints that define legs) had markers added on the map when route line was drawn with `MapboxRouteLineApi` and `MapboxRouteLineView`. [#6526](https://github.com/mapbox/mapbox-navigation-android/pull/6526)
 - Slightly improved performance of updates to the traveled portion of the route in MapboxRouteLineView. [#6528](https://github.com/mapbox/mapbox-navigation-android/pull/6528)
 - Fixed an issue with `NavigationView` that caused road label position to not update in some cases. [#6531](https://github.com/mapbox/mapbox-navigation-android/pull/6531)
+- Fixed an issue where `DirectionsResponse#waypoints` list was cleared after a successful non-EV route refresh. [#6539](https://github.com/mapbox/mapbox-navigation-android/pull/6539)
 
 ## Mapbox Navigation SDK 2.10.0-alpha.1 - 28 October, 2022
 ### Changelog

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

@@ -265,6 +265,14 @@ class RouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.ja
                 refreshedRoutes[1].directionsRoute.legs()!!.first().duration()!!,
                 0.0001
             )
+            assertEquals(
+                requestedRoutes[0].directionsResponse.waypoints(),
+                refreshedRoutes[0].directionsResponse.waypoints()
+            )
+            assertEquals(
+                requestedRoutes[1].directionsResponse.waypoints(),
+                refreshedRoutes[1].directionsResponse.waypoints()
+            )
         }
 
     @Test
@@ -508,6 +516,16 @@ class RouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.ja
                 ),
                 refreshedRoutes[0].directionsRoute.legs()!![1].closures()
             )
+
+            // waypoints
+            assertEquals(
+                requestedRoutes[0].directionsResponse.waypoints(),
+                refreshedRoutes[0].directionsResponse.waypoints()
+            )
+            assertEquals(
+                requestedRoutes[1].directionsResponse.waypoints(),
+                refreshedRoutes[1].directionsResponse.waypoints()
+            )
         }
 
     @Test
@@ -584,6 +602,12 @@ class RouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.ja
                 ),
                 refreshedRoutes[0].directionsRoute.legs()!![1].closures()
             )
+
+            // waypoints
+            assertEquals(
+                requestedRoutes[0].directionsResponse.waypoints(),
+                refreshedRoutes[0].directionsResponse.waypoints()
+            )
         }
 
     private fun List<Incident>.extract(vararg extractors: Incident.() -> Any?): List<List<Any?>> {

libnavigation-base/src/main/java/com/mapbox/navigation/base/internal/route/NavigationRouteEx.kt

@@ -198,21 +198,11 @@ private fun DirectionsResponse.Builder.updateWaypoints(
     oldWaypoints: List<DirectionsWaypoint>?,
     updatedWaypoints: List<DirectionsWaypoint?>?,
 ): DirectionsResponse.Builder {
-    if (oldWaypoints == null) {
+    if (oldWaypoints == null || updatedWaypoints == null) {
         return this
     }
-    val newWaypoints = mutableListOf<DirectionsWaypoint>()
-    if (updatedWaypoints != null) {
-        oldWaypoints.forEachIndexed { index, oldWaypoint ->
-            if (index < updatedWaypoints.size) {
-                val updatedWaypoint = updatedWaypoints[index]
-                if (updatedWaypoint == null) {
-                    newWaypoints.add(oldWaypoint)
-                } else {
-                    newWaypoints.add(updatedWaypoint)
-                }
-            }
-        }
+    val newWaypoints = oldWaypoints.mapIndexed { index, oldWaypoint ->
+        updatedWaypoints.getOrNull(index) ?: oldWaypoint
     }
     return waypoints(newWaypoints)
 }

libnavigation-base/src/test/java/com/mapbox/navigation/base/internal/route/NavigationRouteExTest.kt

@@ -350,7 +350,7 @@ class NavigationRouteExTest {
                         listOf(provideDefaultLegAnnotation(), null),
                         listOf(provideDefaultIncidents(), null),
                         listOf(provideDefaultClosures(), null),
-                        emptyList(),
+                        waypoints,
                         0
                     ),
                 )
@@ -375,7 +375,7 @@ class NavigationRouteExTest {
                         listOf(provideDefaultLegAnnotation(), null),
                         listOf(provideDefaultIncidents(), null),
                         listOf(provideDefaultClosures(), null),
-                        emptyList(),
+                        waypoints,
                         0
                     ),
                 )
@@ -404,7 +404,7 @@ class NavigationRouteExTest {
                         listOf(provideDefaultLegAnnotation(), null),
                         listOf(provideDefaultIncidents(), null),
                         listOf(provideDefaultClosures(), null),
-                        listOf(createWaypoint("name3")),
+                        listOf(createWaypoint("name3"), createWaypoint("name2")),
                         0
                     ),
                 )
@@ -500,7 +500,6 @@ class NavigationRouteExTest {
                     ),
                 )
             },
-
             run {
                 val refreshedWaypoints = listOf(
                     createWaypoint("name11"),
@@ -751,6 +750,11 @@ class NavigationRouteExTest {
                     result.newWaypoints,
                     updatedNavRoute.directionsResponse.waypoints()
                 )
+                assertEquals(
+                    description,
+                    navRoute.directionsResponse.waypoints()?.size,
+                    updatedNavRoute.directionsResponse.waypoints()?.size
+                )
 
                 val capturedOldAnnotations = mutableListOf<LegAnnotation?>()
                 val capturedNewAnnotations = mutableListOf<LegAnnotation?>()