- Added Waypoints to NavigationRoute; - RouteOptionsUpdater refactored;

Author: RingerJK

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

@@ -0,0 +1,65 @@
+package com.mapbox.navigation.instrumentation_tests.core
+
+import android.location.Location
+import com.mapbox.api.directions.v5.models.DirectionsResponse
+import com.mapbox.api.directions.v5.models.DirectionsRoute
+import com.mapbox.api.directions.v5.models.RouteOptions
+import com.mapbox.geojson.Point
+import com.mapbox.navigation.base.extensions.applyDefaultNavigationOptions
+import com.mapbox.navigation.base.internal.route.createNavigationRoutes
+import com.mapbox.navigation.base.internal.utils._waypoints
+import com.mapbox.navigation.base.route.NavigationRoute
+import com.mapbox.navigation.base.route.RouterOrigin
+import com.mapbox.navigation.instrumentation_tests.R
+import com.mapbox.navigation.instrumentation_tests.activity.EmptyTestActivity
+import com.mapbox.navigation.instrumentation_tests.utils.readRawFileText
+import com.mapbox.navigation.testing.ui.BaseTest
+import junit.framework.Assert.assertTrue
+import org.junit.Test
+
+class NavigationRouteTests : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.java) {
+
+    override fun setupMockLocation(): Location = mockLocationUpdatesRule.generateLocationUpdate {
+        latitude = 0.0
+        longitude = 0.0
+    }
+
+    @Test
+    fun mapDirectionsResponseToNavigationRoutes() {
+        val jsonResponse = readRawFileText(activity, R.raw.route_response_dc_very_short)
+
+        val navRoutes = NavigationRoute.create(
+            DirectionsResponse.fromJson(jsonResponse),
+            provideRouteOptions(),
+            RouterOrigin.Onboard
+        )
+
+        assertTrue(navRoutes.isNotEmpty())
+        navRoutes.forEach {
+            assertTrue(it._waypoints().isNotEmpty())
+        }
+    }
+
+    @Test
+    fun mapDirectionsRoutesToNavigationRoutes() {
+        val directionsRoute = DirectionsRoute.fromJson(readRawFileText(activity, R.raw.short_route))
+
+        val navRoutes = createNavigationRoutes(
+            listOf(directionsRoute),
+            provideRouteOptions(),
+            RouterOrigin.Onboard,
+        )
+
+        assertTrue(navRoutes.isNotEmpty())
+    }
+
+    private fun provideRouteOptions(): RouteOptions =
+        RouteOptions.builder().applyDefaultNavigationOptions()
+            .coordinatesList(
+                listOf(
+                    Point.fromLngLat(1.1, 2.2),
+                    Point.fromLngLat(3.3, 4.4),
+                )
+            )
+            .build()
+}

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

@@ -12,6 +12,12 @@ interface SDKRouteParser {
         request: String,
         routerOrigin: RouterOrigin,
     ): Expected<String, List<RouteInterface>>
+
+    fun parseDirectionsRoutes(
+        directionsRoutes: String,
+        request: String,
+        routerOrigin: RouterOrigin,
+    ): Expected<String, List<RouteInterface>>
 }
 
 object NativeRouteParserWrapper : SDKRouteParser {
@@ -25,4 +31,15 @@ object NativeRouteParserWrapper : SDKRouteParser {
             request,
             routerOrigin.mapToNativeRouteOrigin()
         )
+
+    override fun parseDirectionsRoutes(
+        directionsRoutes: String,
+        request: String,
+        routerOrigin: RouterOrigin,
+    ): Expected<String, List<RouteInterface>> =
+        RouteParser.parseDirectionsRoutes(
+            directionsRoutes,
+            request,
+            routerOrigin.mapToNativeRouteOrigin()
+        )
 }

libnavigation-base/src/main/java/com/mapbox/navigation/base/internal/extensions/WaypointEx.kt

@@ -0,0 +1,43 @@
+@file:JvmName("WaypointEx")
+
+package com.mapbox.navigation.base.internal.extensions
+
+import com.mapbox.api.directions.v5.models.DirectionsRoute
+import com.mapbox.navigation.base.internal.route.Waypoint
+import com.mapbox.navigation.base.trip.model.RouteProgress
+
+/**
+ * Return waypoints that are requested explicitly
+ */
+fun List<Waypoint>.requestedWaypoints(): List<Waypoint> =
+    this.filter { it.type != Waypoint.EV_CHARGING }
+
+/**
+ * Return waypoints that tracking in [RouteProgress.currentLegProgress]#legIndex and based on
+ * [DirectionsRoute.legs] index
+ */
+fun List<Waypoint>.legsWaypoints(): List<Waypoint> =
+    this.filter { it.type != Waypoint.SILENT }
+
+/**
+ * Return the index of **next requested** coordinate.
+ *
+ * For instance, EV waypoints are not requested explicitly, so they are not taken into account.
+ */
+fun indexOfNextRequestedCoordinate(
+    waypoints: List<Waypoint>,
+    remainingWaypoints: Int,
+): Int? {
+    if (remainingWaypoints > waypoints.size) {
+        return null
+    }
+    val nextRequestedWaypoint = waypoints
+        .subList(waypoints.size - remainingWaypoints, waypoints.size)
+        .requestedWaypoints()
+        .firstOrNull()
+        ?: return null
+
+    return waypoints
+        .requestedWaypoints()
+        .indexOf(nextRequestedWaypoint)
+}

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

@@ -12,6 +12,7 @@ import com.mapbox.api.directions.v5.models.LegAnnotation
 import com.mapbox.api.directions.v5.models.LegStep
 import com.mapbox.api.directions.v5.models.RouteLeg
 import com.mapbox.api.directions.v5.models.RouteOptions
+import com.mapbox.navigation.base.internal.NativeRouteParserWrapper
 import com.mapbox.navigation.base.internal.SDKRouteParser
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.route.toNavigationRoute
@@ -149,6 +150,20 @@ fun createNavigationRoutes(
 ): List<NavigationRoute> =
     NavigationRoute.create(directionsResponse, routeOptions, routeParser, routerOrigin)
 
+@VisibleForTesting
+fun createNavigationRoutes(
+    directionsRoutes: List<DirectionsRoute>,
+    routeOptions: RouteOptions,
+    routerOrigin: com.mapbox.navigation.base.route.RouterOrigin,
+    routeParser: SDKRouteParser = NativeRouteParserWrapper
+): List<NavigationRoute> =
+    NavigationRoute.create(
+        directionsRoutes,
+        routeOptions,
+        routerOrigin,
+        routeParser,
+    )
+
 /**
  * Internal API to create a new [NavigationRoute] from a native peer.
  */

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

@@ -0,0 +1,27 @@
+package com.mapbox.navigation.base.internal.route
+
+import androidx.annotation.IntDef
+import com.mapbox.geojson.Point
+
+data class Waypoint(
+    val location: Point,
+    @Type val type: Int,
+    val name: String,
+    val target: Point?,
+) {
+    companion object {
+        const val REGULAR = 1
+        const val SILENT = 2
+        const val EV_CHARGING = 3
+    }
+
+    @Target(
+        AnnotationTarget.PROPERTY,
+        AnnotationTarget.VALUE_PARAMETER,
+        AnnotationTarget.FUNCTION,
+        AnnotationTarget.TYPE
+    )
+    @Retention(AnnotationRetention.BINARY)
+    @IntDef(REGULAR, SILENT, EV_CHARGING)
+    annotation class Type
+}

libnavigation-base/src/main/java/com/mapbox/navigation/base/internal/utils/DirectionsRouteEx.kt

@@ -4,6 +4,7 @@ package com.mapbox.navigation.base.internal.utils
 
 import com.mapbox.api.directions.v5.models.DirectionsRoute
 import com.mapbox.api.directions.v5.models.LegStep
+import com.mapbox.navigation.base.internal.route.Waypoint
 import com.mapbox.navigation.base.utils.ifNonNull
 
 /**
@@ -36,3 +37,21 @@ private fun DirectionsRoute.stepsNamesAsString(): String? =
         ?.joinToString { leg ->
             leg.steps()?.joinToString { step -> step.name() ?: "" } ?: ""
         }
+
+internal fun List<com.mapbox.navigator.Waypoint>.mapToSkd(): List<Waypoint> =
+    map { nativeWaypoint ->
+        Waypoint(
+            location = nativeWaypoint.location,
+            type = nativeWaypoint.type.mapToSdk(),
+            name = nativeWaypoint.name,
+            target = nativeWaypoint.target,
+        )
+    }
+
+@Waypoint.Type
+private fun com.mapbox.navigator.WaypointType.mapToSdk(): Int =
+    when (this) {
+        com.mapbox.navigator.WaypointType.REGULAR -> Waypoint.REGULAR
+        com.mapbox.navigator.WaypointType.SILENT -> Waypoint.SILENT
+        com.mapbox.navigator.WaypointType.EV_CHARGING -> Waypoint.EV_CHARGING
+    }

libnavigation-base/src/main/java/com/mapbox/navigation/base/internal/utils/RouterEx.kt

@@ -1,5 +1,7 @@
 package com.mapbox.navigation.base.internal.utils
 
+import com.mapbox.navigation.base.internal.route.Waypoint
+import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigator.RouterOrigin
 
 fun RouterOrigin.mapToSdkRouteOrigin(): com.mapbox.navigation.base.route.RouterOrigin =
@@ -15,3 +17,5 @@ fun com.mapbox.navigation.base.route.RouterOrigin.mapToNativeRouteOrigin(): Rout
         com.mapbox.navigation.base.route.RouterOrigin.Onboard -> RouterOrigin.ONBOARD
         is com.mapbox.navigation.base.route.RouterOrigin.Custom -> RouterOrigin.CUSTOM
     }
+
+fun NavigationRoute._waypoints(): List<Waypoint> = waypoints

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

@@ -2,6 +2,7 @@
 
 package com.mapbox.navigation.base.route
 
+import com.google.gson.Gson
 import com.mapbox.api.directions.v5.models.DirectionsResponse
 import com.mapbox.api.directions.v5.models.DirectionsRoute
 import com.mapbox.api.directions.v5.models.DirectionsWaypoint
@@ -17,8 +18,11 @@ import com.mapbox.navigation.base.internal.NativeRouteParserWrapper
 import com.mapbox.navigation.base.internal.SDKRouteParser
 import com.mapbox.navigation.base.internal.factory.RoadObjectFactory.toUpcomingRoadObjects
 import com.mapbox.navigation.base.internal.route.RouteCompatibilityCache
+import com.mapbox.navigation.base.internal.route.Waypoint
+import com.mapbox.navigation.base.internal.route.toNavigationRoute
 import com.mapbox.navigation.base.internal.utils.DirectionsRouteMissingConditionsCheck
 import com.mapbox.navigation.base.internal.utils.mapToSdkRouteOrigin
+import com.mapbox.navigation.base.internal.utils.mapToSkd
 import com.mapbox.navigation.base.trip.model.roadobject.UpcomingRoadObject
 import com.mapbox.navigation.utils.internal.ThreadController
 import com.mapbox.navigation.utils.internal.logD
@@ -27,6 +31,7 @@ import com.mapbox.navigation.utils.internal.logI
 import com.mapbox.navigator.RouteInterface
 import kotlinx.coroutines.async
 import kotlinx.coroutines.coroutineScope
+import org.json.JSONArray
 import java.net.URL
 
 /**
@@ -203,6 +208,38 @@ class NavigationRoute internal constructor(
             }
         }
 
+        internal fun create(
+            directionsRoutes: List<DirectionsRoute>,
+            routeOptions: RouteOptions,
+            routerOrigin: RouterOrigin,
+            routeParser: SDKRouteParser = NativeRouteParserWrapper
+        ): List<NavigationRoute> {
+            val directionsRoutesJson = Gson()
+                .toJson(JSONArray(directionsRoutes.map { it.toJson() }))
+                .replaceFirst("values", "routes")
+            return create(
+                directionsRoutesJson,
+                routeOptions.toUrl("").toString(),
+                routerOrigin,
+                routeParser
+            )
+        }
+
+        private fun create(
+            directionsRoutesJson: String,
+            routeOptionsUrlString: String,
+            routerOrigin: RouterOrigin,
+            routeParser: SDKRouteParser = NativeRouteParserWrapper
+        ): List<NavigationRoute> {
+            return routeParser.parseDirectionsRoutes(
+                directionsRoutesJson,
+                routeOptionsUrlString,
+                routerOrigin
+            ).run {
+                create(this)
+            }
+        }
+
         internal fun create(
             directionsResponse: DirectionsResponse,
             routeOptions: RouteOptions,
@@ -255,6 +292,19 @@ class NavigationRoute internal constructor(
                 )
             }.cache()
         }
+
+        private fun create(
+            expected: Expected<String, List<RouteInterface>>
+        ): List<NavigationRoute> {
+            return expected.fold({ error ->
+                logE("NavigationRoute", "Failed to parse a route. Reason: $error")
+                listOf()
+            }, { value ->
+                value
+            }).map { routeInterface ->
+                routeInterface.toNavigationRoute()
+            }.cache()
+        }
     }
 
     /**
@@ -293,6 +343,8 @@ class NavigationRoute internal constructor(
      */
     val upcomingRoadObjects = nativeRoute.routeInfo.alerts.toUpcomingRoadObjects()
 
+    internal val waypoints: List<Waypoint> by lazy { nativeRoute.waypoints.mapToSkd() }
+
     /**
      * Indicates whether some other object is "equal to" this one.
      *