NAVAND-713: simplify API

Author: dzinad

CHANGELOG.md

@@ -5,6 +5,7 @@ Mapbox welcomes participation and contributions from everyone.
 ## Unreleased
 #### Features
 - Added support for EV route refresh. [#6511](https://github.com/mapbox/mapbox-navigation-android/pull/6511)
+- Added `MapboxNavigation#onEVDataUpdated` method to be invoked by the end user to notify Navigation SDK of EV data changes so that it can be used in refresh requests. [#6511](https://github.com/mapbox/mapbox-navigation-android/pull/6511)
 #### Bug fixes and improvements
 - Improved experience in tunnels and reduced the likelihood of losing road edge matching candidates. [#6510](https://github.com/mapbox/mapbox-navigation-android/pull/6510)
 - Fixed an issue with `NavigationView` that caused road label position to not update in some cases. [#6508](https://github.com/mapbox/mapbox-navigation-android/pull/6508)

libnavigation-core/api/current.txt

@@ -10,15 +10,6 @@ package com.mapbox.navigation.core {
     method public void onDeveloperMetadataChanged(com.mapbox.navigation.core.DeveloperMetadata metadata);
   }
 
-  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public fun interface EVDataObserver {
-    method public void onEVDataUpdated(java.util.Map<java.lang.String,java.lang.String> data);
-  }
-
-  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public interface EVDataUpdater {
-    method public void registerEVDataObserver(com.mapbox.navigation.core.EVDataObserver observer);
-    method public void unregisterEVDataObserver(com.mapbox.navigation.core.EVDataObserver observer);
-  }
-
   @UiThread public final class MapboxNavigation {
     ctor public MapboxNavigation(com.mapbox.navigation.base.options.NavigationOptions navigationOptions);
     method public void cancelRouteRequest(long requestId);
@@ -42,6 +33,7 @@ package com.mapbox.navigation.core {
     method public boolean isRunningForegroundService();
     method public void navigateNextRouteLeg(com.mapbox.navigation.core.trip.session.LegIndexUpdatedCallback callback);
     method public void onDestroy();
+    method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public void onEVDataUpdated(java.util.Map<java.lang.String,java.lang.String> data);
     method public void postUserFeedback(String feedbackType, String description, @com.mapbox.navigation.core.telemetry.events.FeedbackEvent.Source String feedbackSource, String screenshot, String![]? feedbackSubType = emptyArray());
     method public void postUserFeedback(String feedbackType, String description, @com.mapbox.navigation.core.telemetry.events.FeedbackEvent.Source String feedbackSource, String screenshot);
     method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public void postUserFeedback(String feedbackType, String description, @com.mapbox.navigation.core.telemetry.events.FeedbackEvent.Source String feedbackSource, String screenshot, String![]? feedbackSubType = emptyArray(), com.mapbox.navigation.core.telemetry.events.FeedbackMetadata feedbackMetadata);
@@ -72,7 +64,6 @@ package com.mapbox.navigation.core {
     method public void resetTripSession();
     method public void setArrivalController(com.mapbox.navigation.core.arrival.ArrivalController? arrivalController = com.mapbox.navigation.core.arrival.AutoArrivalController());
     method public void setArrivalController();
-    method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public void setEVDataUpdater(com.mapbox.navigation.core.EVDataUpdater? updater);
     method public void setNavigationRoutes(java.util.List<com.mapbox.navigation.base.route.NavigationRoute> routes, int initialLegIndex = 0, com.mapbox.navigation.core.RoutesSetCallback? callback = null);
     method public void setNavigationRoutes(java.util.List<com.mapbox.navigation.base.route.NavigationRoute> routes, int initialLegIndex = 0);
     method public void setNavigationRoutes(java.util.List<com.mapbox.navigation.base.route.NavigationRoute> routes);

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

@@ -1057,7 +1057,6 @@ class MapboxNavigation @VisibleForTesting internal constructor(
             reachabilityObserverId = null
         }
         routeRefreshController.unregisterAllRouteRefreshStateObservers()
-        routeRefreshRequestDataProvider.destroy()
 
         isDestroyed = true
         hasInstance = false
@@ -1667,16 +1666,35 @@ class MapboxNavigation @VisibleForTesting internal constructor(
     }
 
     /**
-     * Provide a [EVDataUpdater] that will notify Nav SDK of EV data updates
-     * to be used in route refresh requests.
-     * Set to null to stop providing updates.
-     * NOTE: after setting the updater to null the last saved state will be used in refresh requests.
+     * Invoke when any component of EV data is changed so that it can be used in refresh requests.
+     * Pass **only changed** components of EV data via [data].
+     * Example: if you previously invoked this method with the following map:
+     * ```
+     *     mapOf(
+     *         "ev_initial_charge" to "90",
+     *         "energy_consumption_curve" to "0,300;20,120;40,150",
+     *         "auxiliary_consumption" to "300"
+     *     )
+     * ```
+     * and then the charge changes to 80, you can invoke this method with only
+     * ```
+     *     mapOf("ev_initial_charge" to "80")
+     * ```
+     * as an argument. This way "ev_initial_charge" will be updated and the following parameters
+     * will be used from the previous invocation.
+     * 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 updater [EVDataUpdater] that will notify Nav SDK of EV data updates
+     * @param data Map describing the changed EV data
      */
     @ExperimentalPreviewMapboxNavigationAPI
-    fun setEVDataUpdater(updater: EVDataUpdater?) {
-        routeRefreshRequestDataProvider.setEVDataUpdater(updater)
+    fun onEVDataUpdated(data: Map<String, String?>) {
+        routeRefreshRequestDataProvider.onEVDataUpdated(data)
     }
 
     private fun startSession(withTripService: Boolean, withReplayEnabled: Boolean) {

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

@@ -19,7 +19,6 @@ internal data class RouteProgressData(
 /**
  * Accumulates and provides route refresh model data from different sources.
  */
-@OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
 @MainThread
 internal class RouteRefreshRequestDataProvider(
     private val evDataHolder: EVDataHolder = EVDataHolder()
@@ -28,7 +27,6 @@ internal class RouteRefreshRequestDataProvider(
     private val defaultRouteProgressData = RouteProgressData(0, 0, null)
     private var routeProgressData: RouteProgressData? = null
     private var continuation: CancellableContinuation<RouteProgressData>? = null
-    private var evDataUpdater: EVDataUpdater? = null
 
     /**
      * Returns either last saved value (if has one) or waits for the next update.
@@ -51,14 +49,8 @@ internal class RouteRefreshRequestDataProvider(
         routeProgressData = null
     }
 
-    fun destroy() {
-        evDataUpdater?.unregisterEVDataObserver(evDataHolder)
-    }
-
-    fun setEVDataUpdater(updater: EVDataUpdater?) {
-        evDataUpdater?.unregisterEVDataObserver(evDataHolder)
-        evDataUpdater = updater
-        updater?.registerEVDataObserver(evDataHolder)
+    fun onEVDataUpdated(data: Map<String, String?>) {
+        evDataHolder.onEVDataUpdated(data)
     }
 
     override fun onRouteProgressChanged(routeProgress: RouteProgress) {

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

@@ -1,15 +1,11 @@
 package com.mapbox.navigation.core.routerefresh
 
-import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
-import com.mapbox.navigation.core.EVDataObserver
-
-@OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
-internal class EVDataHolder : EVDataObserver {
+internal class EVDataHolder {
 
     private val currentData = mutableMapOf<String, String>()
 
     @Synchronized
-    override fun onEVDataUpdated(data: Map<String, String?>) {
+    fun onEVDataUpdated(data: Map<String, String?>) {
         data.forEach { (key, value) ->
             if (value == null) {
                 currentData.remove(key)

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

@@ -1734,25 +1734,14 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
     }
 
     @Test
-    fun setEVDataUpdater() {
-        val updater = mockk<EVDataUpdater>(relaxed = true)
+    fun onEVDataChanged() {
+        val data = mapOf("aaa" to "bbb")
         createMapboxNavigation()
 
-        mapboxNavigation.setEVDataUpdater(updater)
+        mapboxNavigation.onEVDataUpdated(data)
 
         verify(exactly = 1) {
-            routeRefreshRequestDataProvider.setEVDataUpdater(updater)
-        }
-    }
-
-    @Test
-    fun onDestroyDestroysRouteRefreshRequestDataProvider() {
-        createMapboxNavigation()
-
-        mapboxNavigation.onDestroy()
-
-        verify(exactly = 1) {
-            routeRefreshRequestDataProvider.destroy()
+            routeRefreshRequestDataProvider.onEVDataUpdated(data)
         }
     }
 }

libnavigation-core/src/test/java/com/mapbox/navigation/core/MapboxNavigationTest.kt

@@ -1,6 +1,5 @@
 package com.mapbox.navigation.core
 
-import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.base.internal.RouteRefreshRequestData
 import com.mapbox.navigation.base.trip.model.RouteProgress
 import com.mapbox.navigation.core.routerefresh.EVDataHolder
@@ -207,36 +206,11 @@ class RouteRefreshRequestDataProviderTest {
         assertEquals(expected, provider.getRouteRefreshRequestDataOrWait())
     }
 
-    @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
     @Test
-    fun setEVDataUpdater() {
-        val firstUpdater = mockk<EVDataUpdater>(relaxed = true)
-        val secondUpdater = mockk<EVDataUpdater>(relaxed = true)
-        provider.setEVDataUpdater(firstUpdater)
+    fun onEVDataUpdated() {
+        val data = mapOf("aaa" to "bbb")
+        provider.onEVDataUpdated(data)
 
-        verify(exactly = 1) { firstUpdater.registerEVDataObserver(evDataHolder) }
-
-        provider.setEVDataUpdater(secondUpdater)
-
-        verify(exactly = 1) {
-            firstUpdater.unregisterEVDataObserver(evDataHolder)
-            secondUpdater.registerEVDataObserver(evDataHolder)
-        }
-    }
-
-    @Test
-    fun destroyWithoutUpdater() {
-        provider.destroy()
-    }
-
-    @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
-    @Test
-    fun destroyWithUpdater() {
-        val updater = mockk<EVDataUpdater>(relaxed = true)
-        provider.setEVDataUpdater(updater)
-
-        provider.destroy()
-
-        verify { updater.unregisterEVDataObserver(evDataHolder) }
+        verify(exactly = 1) { evDataHolder.onEVDataUpdated(data) }
     }
 }