NAVAND-842: use initial EV data in EV route refresh

Author: dzinad

CHANGELOG.md

@@ -36,6 +36,7 @@ Mapbox welcomes participation and contributions from everyone.
 - 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)
+- Fixed an issue with EV route refresh failing in cases where EV data updates are not provided. Now, the initial parameters from a route request will be used as a fallback. [#6534](https://github.com/mapbox/mapbox-navigation-android/pull/6534)
 
 ## Mapbox Navigation SDK 2.10.0-alpha.1 - 28 October, 2022
 ### Changelog

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

@@ -77,6 +77,10 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
         Point.fromLngLat(10.3406374, 49.16479)
     )
     private lateinit var routeHandler: MockDirectionsRequestHandler
+    private val initialEnergyConsumptionCurve = "0,300;20,160;80,140;120,180"
+    private val initialInitialCharge = "18000"
+    private val initialAuxiliaryConsumption = "300"
+    private val initialEvPreconditioningTime = "10"
 
     override fun setupMockLocation(): Location = mockLocationUpdatesRule.generateLocationUpdate {
         latitude = twoCoordinates[0].latitude()
@@ -150,20 +154,42 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
             R.raw.ev_route_refresh_response,
             acceptedGeometryIndex = 0
         )
+        refreshHandler.jsonResponseModifier = DynamicResponseModifier()
         val requestedRoutes = requestRoutes(twoCoordinates, electric = true)
 
         mapboxNavigation.startTripSession()
         stayOnInitialPosition()
         mapboxNavigation.setNavigationRoutes(requestedRoutes)
         waitUntilRefresh()
 
-        checkDoesNotHaveParameters(
+        checkHasParameters(
             refreshHandler.handledRequests.first().requestUrl!!,
-            evDataKeys
+            mapOf(
+                KEY_ENGINE to VALUE_ELECTRIC,
+                KEY_ENERGY_CONSUMPTION_CURVE to initialEnergyConsumptionCurve,
+                KEY_EV_INITIAL_CHARGE to initialInitialCharge,
+                KEY_AUXILIARY_CONSUMPTION to initialAuxiliaryConsumption,
+                KEY_EV_PRECONDITIONING_TIME to initialEvPreconditioningTime,
+            )
+        )
+
+        val newInitialCharge = "17900"
+        val newRequestedRoutes = requestRoutes(
+            twoCoordinates,
+            electric = true,
+            initialCharge = newInitialCharge
         )
+        mapboxNavigation.setNavigationRoutes(newRequestedRoutes)
+        waitUntilNewRefresh()
         checkHasParameters(
-            refreshHandler.handledRequests.first().requestUrl!!,
-            mapOf(KEY_ENGINE to VALUE_ELECTRIC)
+            refreshHandler.handledRequests.last().requestUrl!!,
+            mapOf(
+                KEY_ENGINE to VALUE_ELECTRIC,
+                KEY_ENERGY_CONSUMPTION_CURVE to initialEnergyConsumptionCurve,
+                KEY_EV_INITIAL_CHARGE to newInitialCharge,
+                KEY_AUXILIARY_CONSUMPTION to initialAuxiliaryConsumption,
+                KEY_EV_PRECONDITIONING_TIME to initialEvPreconditioningTime,
+            )
         )
     }
 
@@ -212,14 +238,22 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
         mapboxNavigation.setNavigationRoutes(requestedRoutes)
         waitUntilRefresh()
 
-        val noUpdaterRefreshUrl = refreshHandler.handledRequests.first().requestUrl!!
-        checkDoesNotHaveParameters(noUpdaterRefreshUrl, evDataKeys)
-        checkHasParameters(noUpdaterRefreshUrl, mapOf(KEY_ENGINE to VALUE_ELECTRIC))
+        val noDataRefreshUrl = refreshHandler.handledRequests.first().requestUrl!!
+        checkHasParameters(
+            noDataRefreshUrl,
+            mapOf(
+                KEY_ENGINE to VALUE_ELECTRIC,
+                KEY_ENERGY_CONSUMPTION_CURVE to initialEnergyConsumptionCurve,
+                KEY_EV_PRECONDITIONING_TIME to initialEvPreconditioningTime,
+                KEY_EV_INITIAL_CHARGE to initialInitialCharge,
+                KEY_EV_INITIAL_CHARGE to initialInitialCharge,
+            )
+        )
 
-        val consumptionCurve = "0,300;20,120;40,150"
+        val consumptionCurve = "0,301;20,121;40,151"
         val initialCharge = "80"
-        val preconditioningTime = "10"
-        val auxiliaryConsumption = "300"
+        val preconditioningTime = "11"
+        val auxiliaryConsumption = "299"
         val firstEvData = mapOf(
             KEY_ENERGY_CONSUMPTION_CURVE to consumptionCurve,
             KEY_EV_INITIAL_CHARGE to initialCharge,
@@ -236,10 +270,7 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
 
         val newInitialCharge = "60"
         mapboxNavigation.onEVDataUpdated(
-            mapOf(
-                KEY_EV_INITIAL_CHARGE to newInitialCharge,
-                KEY_EV_PRECONDITIONING_TIME to null,
-            )
+            mapOf(KEY_EV_INITIAL_CHARGE to newInitialCharge)
         )
         waitUntilNewRefresh()
 
@@ -250,10 +281,10 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
                 KEY_ENGINE to VALUE_ELECTRIC,
                 KEY_ENERGY_CONSUMPTION_CURVE to consumptionCurve,
                 KEY_EV_INITIAL_CHARGE to newInitialCharge,
-                KEY_AUXILIARY_CONSUMPTION to auxiliaryConsumption
+                KEY_AUXILIARY_CONSUMPTION to auxiliaryConsumption,
+                KEY_EV_PRECONDITIONING_TIME to preconditioningTime,
             )
         )
-        checkDoesNotHaveParameters(urlWithTwiceUpdatedData, setOf(KEY_EV_PRECONDITIONING_TIME))
 
         mapboxNavigation.onEVDataUpdated(emptyMap())
         waitUntilNewRefresh()
@@ -265,10 +296,10 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
                 KEY_ENGINE to VALUE_ELECTRIC,
                 KEY_ENERGY_CONSUMPTION_CURVE to consumptionCurve,
                 KEY_EV_INITIAL_CHARGE to newInitialCharge,
-                KEY_AUXILIARY_CONSUMPTION to auxiliaryConsumption
+                KEY_AUXILIARY_CONSUMPTION to auxiliaryConsumption,
+                KEY_EV_PRECONDITIONING_TIME to preconditioningTime,
             )
         )
-        checkDoesNotHaveParameters(urlAfterEmptyUpdate, setOf(KEY_EV_PRECONDITIONING_TIME))
     }
 
     @Test
@@ -279,7 +310,7 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
         )
         val requestedRoutes = requestRoutes(twoCoordinates, electric = true)
         val evData = mapOf(
-            KEY_ENERGY_CONSUMPTION_CURVE to "0,300;20,160;80,140;120,180",
+            KEY_ENERGY_CONSUMPTION_CURVE to initialEnergyConsumptionCurve,
             KEY_EV_INITIAL_CHARGE to "17000",
             KEY_EV_PRECONDITIONING_TIME to "10",
             KEY_AUXILIARY_CONSUMPTION to "300"
@@ -328,7 +359,7 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
             )
             val requestedRoutes = requestRoutes(twoCoordinates, electric = true)
             val evData = mapOf(
-                KEY_ENERGY_CONSUMPTION_CURVE to "0,300;20,160;80,140;120,180",
+                KEY_ENERGY_CONSUMPTION_CURVE to initialEnergyConsumptionCurve,
                 KEY_EV_INITIAL_CHARGE to "17000",
                 KEY_EV_PRECONDITIONING_TIME to "10",
                 KEY_AUXILIARY_CONSUMPTION to "300"
@@ -379,7 +410,7 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
         )
         val requestedRoutes = requestRoutes(twoCoordinates, electric = true)
         val evData = mapOf(
-            KEY_ENERGY_CONSUMPTION_CURVE to "0,300;20,160;80,140;120,180",
+            KEY_ENERGY_CONSUMPTION_CURVE to initialEnergyConsumptionCurve,
             KEY_EV_INITIAL_CHARGE to "17000",
             KEY_EV_PRECONDITIONING_TIME to "10",
             KEY_AUXILIARY_CONSUMPTION to "300"
@@ -434,7 +465,7 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
             minChargeAtDestination = 35000
         )
         val evData = mapOf(
-            KEY_ENERGY_CONSUMPTION_CURVE to "0,300;20,160;80,140;120,180",
+            KEY_ENERGY_CONSUMPTION_CURVE to initialEnergyConsumptionCurve,
             KEY_EV_INITIAL_CHARGE to "30000",
             KEY_EV_PRECONDITIONING_TIME to "10",
             KEY_AUXILIARY_CONSUMPTION to "300"
@@ -512,6 +543,7 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
         coordinates: List<Point>,
         electric: Boolean,
         minChargeAtDestination: Int,
+        initialCharge: String,
     ): RouteOptions {
         return RouteOptions.builder().applyDefaultNavigationOptions()
             .profile(DirectionsCriteria.PROFILE_DRIVING_TRAFFIC)
@@ -525,19 +557,18 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
                     unrecognizedProperties(
                         mapOf(
                             KEY_ENGINE to VALUE_ELECTRIC,
-                            KEY_EV_INITIAL_CHARGE to "18000",
-                            KEY_ENERGY_CONSUMPTION_CURVE to "0,300;20,160;80,140;120,180",
-                            KEY_EV_PRECONDITIONING_TIME to "10",
+                            KEY_EV_INITIAL_CHARGE to initialCharge,
+                            KEY_ENERGY_CONSUMPTION_CURVE to initialEnergyConsumptionCurve,
+                            KEY_EV_PRECONDITIONING_TIME to initialEvPreconditioningTime,
+                            KEY_AUXILIARY_CONSUMPTION to initialAuxiliaryConsumption,
                             "ev_min_charge_at_charging_station" to "6000",
                             "ev_min_charge_at_destination" to "$minChargeAtDestination",
                             "ev_max_charge" to "60000",
                             "ev_connector_types" to "ccs_combo_type1,ccs_combo_type2",
-                            "energy_consumption_curve" to "0,300;20,160;80,140;120,180",
                             "ev_charging_curve" to "0,100000;40000,70000;60000,30000;80000,10000",
                             "ev_max_ac_charging_power" to "14400",
                             "ev_unconditioned_charging_curve" to
                                 "0,50000;42000,35000;60000,15000;80000,5000",
-                            "auxiliary_consumption" to "300",
                         )
                     )
                 }
@@ -562,10 +593,11 @@ class EVRouteRefreshTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.
     private suspend fun requestRoutes(
         coordinates: List<Point>,
         electric: Boolean,
-        minChargeAtDestination: Int = 6000
+        minChargeAtDestination: Int = 6000,
+        initialCharge: String = initialInitialCharge
     ): List<NavigationRoute> {
         return mapboxNavigation.requestRoutes(
-            generateRouteOptions(coordinates, electric, minChargeAtDestination)
+            generateRouteOptions(coordinates, electric, minChargeAtDestination, initialCharge)
         )
             .getSuccessfulResultOrThrowException()
             .routes

libnavigation-core/src/main/java/com/mapbox/navigation/core/MapboxNavigation.kt

@@ -1697,18 +1697,11 @@ class MapboxNavigation @VisibleForTesting internal constructor(
      *         "auxiliary_consumption" to "300"
      *     )
      * ```
-     * If you want to remove a parameter, pass `null` for the corresponding key.
-     * Example: for the case above if you want to remove "auxiliary_consumption", invoke this method
-     * with
-     * ```
-     *     mapOf("auxiliary_consumption" to null)
-     * ```
-     * as an argument.
      *
      * @param data Map describing the changed EV data
      */
     @ExperimentalPreviewMapboxNavigationAPI
-    fun onEVDataUpdated(data: Map<String, String?>) {
+    fun onEVDataUpdated(data: Map<String, String>) {
         routeRefreshRequestDataProvider.onEVDataUpdated(data)
     }
 
@@ -1739,7 +1732,7 @@ class MapboxNavigation @VisibleForTesting internal constructor(
 
     private fun createInternalRoutesObserver() = RoutesObserver { result ->
         latestLegIndex = null
-        routeRefreshRequestDataProvider.onNewRoute()
+        routeRefreshRequestDataProvider.onNewRoutes()
         if (result.navigationRoutes.isNotEmpty()) {
             routeScope.launch {
                 val refreshed = routeRefreshController.refresh(

libnavigation-core/src/main/java/com/mapbox/navigation/core/RouteRefreshRequestDataProvider.kt

@@ -1,6 +1,7 @@
 package com.mapbox.navigation.core
 
 import androidx.annotation.MainThread
+import com.mapbox.api.directions.v5.models.RouteOptions
 import com.mapbox.navigation.base.internal.RouteRefreshRequestData
 import com.mapbox.navigation.base.trip.model.RouteProgress
 import com.mapbox.navigation.core.routerefresh.EVDataHolder
@@ -30,26 +31,25 @@ internal class RouteRefreshRequestDataProvider(
     /**
      * Returns either last saved value (if has one) or waits for the next update.
      */
-    suspend fun getRouteRefreshRequestDataOrWait(): RouteRefreshRequestData {
+    suspend fun getRouteRefreshRequestDataOrWait(
+        routeOptions: RouteOptions
+    ): RouteRefreshRequestData {
         return (routeProgressData ?: suspendCancellableCoroutine { continuation = it }).let {
             RouteRefreshRequestData(
                 it.legIndex,
                 it.routeGeometryIndex,
                 it.legGeometryIndex,
-                evDataHolder.currentData()
+                evDataHolder.currentData(routeOptions.unrecognizedJsonProperties)
             )
         }
     }
 
-    /**
-     * Resets saved route data info to null.
-     */
-    fun onNewRoute() {
+    fun onNewRoutes() {
         routeProgressData = null
     }
 
-    fun onEVDataUpdated(data: Map<String, String?>) {
-        evDataHolder.onEVDataUpdated(data)
+    fun onEVDataUpdated(data: Map<String, String>) {
+        evDataHolder.updateData(data)
     }
 
     override fun onRouteProgressChanged(routeProgress: RouteProgress) {

libnavigation-core/src/main/java/com/mapbox/navigation/core/routerefresh/EVDataHolder.kt

@@ -1,20 +1,63 @@
 package com.mapbox.navigation.core.routerefresh
 
+import com.google.gson.JsonElement
+
 internal class EVDataHolder {
 
+    private val evRefreshKeys = setOf(
+        "energy_consumption_curve",
+        "ev_initial_charge",
+        "auxiliary_consumption",
+        "ev_pre_conditioning_time",
+    )
     private val currentData = mutableMapOf<String, String>()
 
     @Synchronized
-    fun onEVDataUpdated(data: Map<String, String?>) {
-        data.forEach { (key, value) ->
-            if (value == null) {
-                currentData.remove(key)
-            } else {
-                currentData[key] = value
+    fun updateData(data: Map<String, String>) {
+        currentData.putAll(data)
+    }
+
+    @Synchronized
+    fun currentData(initialData: Map<String, JsonElement>?): Map<String, String> = mergeEvData(
+        initialData,
+        HashMap(currentData)
+    )
+
+    private fun mergeEvData(
+        unrecognizedProperties: Map<String, JsonElement>?,
+        latestUpdate: Map<String, String>
+    ): Map<String, String> {
+        val result = HashMap<String, String>(latestUpdate)
+        val fallbackData = extractEvRefreshData(unrecognizedProperties)
+        fallbackData.forEach { (key, value) ->
+            if (key !in result.keys) {
+                result[key] = value
             }
         }
+        return result
     }
 
-    @Synchronized
-    fun currentData(): Map<String, String> = HashMap(currentData)
+    private fun extractEvRefreshData(
+        unrecognizedProperties: Map<String, JsonElement>?
+    ): Map<String, String> {
+        val result = mutableMapOf<String, String>()
+        if (unrecognizedProperties != null) {
+            val engine = unrecognizedProperties["engine"]
+                ?.asStringOrNull()
+            if (engine == "electric") {
+                evRefreshKeys.forEach { key ->
+                    unrecognizedProperties[key]?.asStringOrNull()?.let { value ->
+                        result[key] = value
+                    }
+                }
+            }
+        }
+        return result
+    }
+
+    private fun JsonElement.asStringOrNull(): String? = try {
+        asString
+    } catch (ex: Throwable) {
+        null
+    }
 }

libnavigation-core/src/main/java/com/mapbox/navigation/core/routerefresh/RouteRefreshController.kt

@@ -142,7 +142,7 @@ internal class RouteRefreshController(
     }
 
     private suspend fun refreshRoutesWithRetry(
-        routes: List<NavigationRoute>
+        routes: List<NavigationRoute> // non-empty
     ): RefreshedRouteInfo = coroutineScope {
         var timeUntilNextAttempt = async { delay(routeRefreshOptions.intervalMillis) }
         try {
@@ -153,7 +153,7 @@ internal class RouteRefreshController(
                 }
                 timeUntilNextAttempt = async { delay(routeRefreshOptions.intervalMillis) }
                 val routeRefreshRequestData = routeRefreshRequestDataProvider
-                    .getRouteRefreshRequestDataOrWait()
+                    .getRouteRefreshRequestDataOrWait(routes.first().routeOptions)
                 val refreshedRoutes = refreshRoutesOrNull(routes, routeRefreshRequestData)
                 if (refreshedRoutes.any { it != null }) {
                     onNewState(RouteRefreshExtra.REFRESH_STATE_FINISHED_SUCCESS)
@@ -169,7 +169,8 @@ internal class RouteRefreshController(
             timeUntilNextAttempt.cancel() // otherwise current coroutine will wait for its child
         }
         onNewState(RouteRefreshExtra.REFRESH_STATE_FINISHED_FAILED)
-        val requestData = routeRefreshRequestDataProvider.getRouteRefreshRequestDataOrWait()
+        val requestData = routeRefreshRequestDataProvider
+            .getRouteRefreshRequestDataOrWait(routes.first().routeOptions)
         RefreshedRouteInfo(
             routes.map { removeExpiringDataFromRoute(it, requestData.legIndex) },
             requestData