- Added Waypoints to NavigationRoute; - RouteOptionsUpdater refactored. (#6005)

Author: RingerJK

CHANGELOG.md

@@ -5,6 +5,9 @@ Mapbox welcomes participation and contributions from everyone.
 ## Unreleased
 #### Features
 #### Bug fixes and improvements
+- Fixed an issue where re-routes could have failed for EV routes. [#6005](https://github.com/mapbox/mapbox-navigation-android/pull/6005)
+
+:warning: `RouteProgress#remainingWaypoints` defines the amount of all remaining waypoints, including explicit (requested with `RouteOptions#coordinatesList`) and implicit (added on the fly, like Electric Vehicle waypoints - [see](https://docs.mapbox.com/api/navigation/directions/#electric-vehicle-routing)) ones.
 
 ## Mapbox Navigation SDK 2.9.0-rc.1 - 28 October, 2022
 ### Changelog
@@ -24,7 +27,6 @@ This release depends on, and has been tested with, the following Mapbox dependen
 - Mapbox Java `v6.9.0-beta.1` ([release notes](https://github.com/mapbox/mapbox-java/releases/tag/v6.9.0-beta.1))
 - Mapbox Android Core `v5.0.2` ([release notes](https://github.com/mapbox/mapbox-events-android/releases/tag/core-5.0.2))
 
-
 ## Mapbox Navigation SDK 2.9.0-beta.3 - 21 October, 2022
 ### Changelog
 [Changes between v2.9.0-beta.2 and v2.9.0-beta.3](https://github.com/mapbox/mapbox-navigation-android/compare/v2.9.0-beta.2...v2.9.0-beta.3)

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

@@ -0,0 +1,52 @@
+package com.mapbox.navigation.base.internal.extensions
+
+import com.mapbox.api.directions.v5.models.DirectionsRoute
+import com.mapbox.api.directions.v5.models.RouteOptions
+import com.mapbox.navigation.base.internal.route.Waypoint
+import com.mapbox.navigation.base.trip.model.RouteProgress
+
+/**
+ * Return true if the waypoint is requested explicitly. False otherwise.
+ */
+fun Waypoint.isRequestedWaypoint(): Boolean =
+    when (this.internalType) {
+        Waypoint.InternalType.Regular,
+        Waypoint.InternalType.Silent -> true
+        Waypoint.InternalType.EvCharging -> false
+    }
+
+/**
+ * Return true if the waypoint is tracked in [RouteProgress.currentLegProgress]#legIndex, based on
+ * [DirectionsRoute.legs] index. False otherwise.
+ */
+fun Waypoint.isLegWaypoint(): Boolean =
+    when (this.internalType) {
+        Waypoint.InternalType.Regular,
+        Waypoint.InternalType.EvCharging -> true
+        Waypoint.InternalType.Silent -> false
+    }
+
+/**
+ * Return the index of **next requested** coordinate. See [RouteOptions.coordinatesList]
+ *
+ * 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 nextWaypointIndex = waypoints.size - remainingWaypoints
+    var requestedIndex = 0
+    waypoints.forEachIndexed { index, waypoint ->
+        if (waypoint.isRequestedWaypoint()) {
+            if (index >= nextWaypointIndex) {
+                return requestedIndex
+            }
+            requestedIndex++
+        }
+    }
+    return null
+}

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

@@ -0,0 +1,67 @@
+package com.mapbox.navigation.base.internal.route
+
+import androidx.annotation.IntDef
+import com.mapbox.geojson.Point
+
+class Waypoint internal constructor(
+    val location: Point,
+    val name: String,
+    val target: Point?,
+    internal val internalType: InternalType
+) {
+
+    @Type
+    val type: Int = when (internalType) {
+        InternalType.Regular -> REGULAR
+        InternalType.Silent -> SILENT
+        InternalType.EvCharging -> EV_CHARGING
+    }
+
+    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
+
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as Waypoint
+
+        if (location != other.location) return false
+        if (type != other.type) return false
+        if (name != other.name) return false
+        if (target != other.target) return false
+
+        return true
+    }
+
+    override fun hashCode(): Int {
+        var result = location.hashCode()
+        result = 31 * result + type
+        result = 31 * result + name.hashCode()
+        result = 31 * result + target.hashCode()
+        return result
+    }
+
+    override fun toString(): String {
+        return "Waypoint(location=$location, type=$type, name='$name', target=$target)"
+    }
+
+    internal enum class InternalType {
+        Regular,
+        Silent,
+        EvCharging,
+    }
+}

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

@@ -4,6 +4,8 @@ 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.internal.route.Waypoint.Companion.REGULAR
 import com.mapbox.navigation.base.utils.ifNonNull
 
 /**
@@ -36,3 +38,20 @@ private fun DirectionsRoute.stepsNamesAsString(): String? =
         ?.joinToString { leg ->
             leg.steps()?.joinToString { step -> step.name() ?: "" } ?: ""
         }
+
+internal fun List<com.mapbox.navigator.Waypoint>.mapToSdk(): List<Waypoint> =
+    map { nativeWaypoint ->
+        Waypoint(
+            location = nativeWaypoint.location,
+            internalType = nativeWaypoint.type.mapToSdk(),
+            name = nativeWaypoint.name,
+            target = nativeWaypoint.target,
+        )
+    }
+
+private fun com.mapbox.navigator.WaypointType.mapToSdk(): Waypoint.InternalType =
+    when (this) {
+        com.mapbox.navigator.WaypointType.REGULAR -> Waypoint.InternalType.Regular
+        com.mapbox.navigator.WaypointType.SILENT -> Waypoint.InternalType.Silent
+        com.mapbox.navigator.WaypointType.EV_CHARGING -> Waypoint.InternalType.EvCharging
+    }

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.internalWaypoints(): List<Waypoint> = waypoints

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

@@ -0,0 +1,27 @@
+package com.mapbox.navigation.base.internal.utils
+
+import androidx.annotation.VisibleForTesting
+import com.mapbox.geojson.Point
+import com.mapbox.navigation.base.internal.route.Waypoint
+import org.jetbrains.annotations.TestOnly
+
+@VisibleForTesting
+object WaypointFactory {
+    @TestOnly
+    fun provideWaypoint(
+        location: Point,
+        name: String,
+        target: Point?,
+        @Waypoint.Type type: Int,
+    ): Waypoint = Waypoint(
+        location,
+        name,
+        target,
+        when (type) {
+            Waypoint.REGULAR -> Waypoint.InternalType.Regular
+            Waypoint.SILENT -> Waypoint.InternalType.Silent
+            Waypoint.EV_CHARGING -> Waypoint.InternalType.EvCharging
+            else -> throw IllegalStateException("Unknown waypoint type $type")
+        },
+    )
+}

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

@@ -17,7 +17,10 @@ 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.mapToSdk
 import com.mapbox.navigation.base.internal.utils.mapToSdkRouteOrigin
 import com.mapbox.navigation.base.trip.model.roadobject.UpcomingRoadObject
 import com.mapbox.navigation.utils.internal.ThreadController
@@ -293,6 +296,8 @@ class NavigationRoute internal constructor(
      */
     val upcomingRoadObjects = nativeRoute.routeInfo.alerts.toUpcomingRoadObjects()
 
+    internal val waypoints: List<Waypoint> by lazy { nativeRoute.waypoints.mapToSdk() }
+
     /**
      * Indicates whether some other object is "equal to" this one.
      *

libnavigation-base/src/main/java/com/mapbox/navigation/base/trip/model/RouteProgress.kt

@@ -33,7 +33,9 @@ import com.mapbox.navigation.base.trip.model.roadobject.UpcomingRoadObject
  * @param durationRemaining [Double] seconds time remaining until the route destination is reached.
  * @param fractionTraveled [Float] fraction traveled along the current route. This value is
  * between 0 and 1 and isn't guaranteed to reach 1 before the user reaches the end of the route.
- * @param remainingWaypoints [Int] number of waypoints remaining on the current route.
+ * @param remainingWaypoints [Int] number of waypoints remaining on the current route. The waypoints number can be different
+ * with number of requested coordinates. For instance, [EV routing](https://docs.mapbox.com/api/navigation/directions/#electric-vehicle-routing)
+ * is adding additional waypoints, that are not requested explicitly.
  * @param upcomingRoadObjects list of upcoming road objects.
  * @param stale `true` if there were no location updates for a significant amount which causes
  * a lack of confidence in the progress updates being sent.