NAVAND-777: expose a class instead of an interface

Author: dzinad

libnavigation-core/api/current.txt

@@ -882,7 +882,7 @@ package com.mapbox.navigation.core.routeoptions {
 
 package com.mapbox.navigation.core.routerefresh {
 
-  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public interface RouteRefreshController {
+  public final class RouteRefreshController {
     method public void registerRouteRefreshStateObserver(com.mapbox.navigation.core.routerefresh.RouteRefreshStatesObserver routeRefreshStatesObserver);
     method public void requestImmediateRouteRefresh();
     method public void unregisterRouteRefreshStateObserver(com.mapbox.navigation.core.routerefresh.RouteRefreshStatesObserver routeRefreshStatesObserver);

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

@@ -85,7 +85,6 @@ import com.mapbox.navigation.core.routealternatives.RouteAlternativesObserver
 import com.mapbox.navigation.core.routealternatives.RouteAlternativesRequestCallback
 import com.mapbox.navigation.core.routeoptions.RouteOptionsUpdater
 import com.mapbox.navigation.core.routerefresh.RouteRefreshController
-import com.mapbox.navigation.core.routerefresh.RouteRefreshControllerImpl
 import com.mapbox.navigation.core.routerefresh.RouteRefreshControllerProvider
 import com.mapbox.navigation.core.telemetry.MapboxNavigationTelemetry
 import com.mapbox.navigation.core.telemetry.events.FeedbackEvent
@@ -267,7 +266,6 @@ class MapboxNavigation @VisibleForTesting internal constructor(
     private val internalOffRouteObserver: OffRouteObserver
     private val internalFallbackVersionsObserver: FallbackVersionsObserver
     private val routeAlternativesController: RouteAlternativesController
-    private val routeRefreshControllerImpl: RouteRefreshControllerImpl
     private val arrivalProgressObserver: ArrivalProgressObserver
     private val electronicHorizonOptions: ElectronicHorizonOptions = ElectronicHorizonOptions(
         navigationOptions.eHorizonOptions.length,
@@ -558,7 +556,8 @@ class MapboxNavigation @VisibleForTesting internal constructor(
             tripSession,
             threadController,
         )
-        routeRefreshControllerImpl = RouteRefreshControllerProvider.createRouteRefreshController(
+        @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
+        routeRefreshController = RouteRefreshControllerProvider.createRouteRefreshController(
             threadController.getMainScopeAndRootJob().scope,
             threadController.getImmediateMainScopeAndRootJob().scope,
             navigationOptions.routeRefreshOptions,
@@ -569,8 +568,7 @@ class MapboxNavigation @VisibleForTesting internal constructor(
             Time.SystemImpl
         )
         @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
-        routeRefreshController = routeRefreshControllerImpl
-        routeRefreshControllerImpl.registerRouteRefreshObserver {
+        routeRefreshController.registerRouteRefreshObserver {
             internalSetNavigationRoutes(
                 it.allRoutesProgressData.map { pair -> pair.first },
                 SetRoutes.RefreshRoutes(it.primaryRouteProgressData)
@@ -1224,7 +1222,8 @@ class MapboxNavigation @VisibleForTesting internal constructor(
         historyRecordingStateHandler.unregisterAllStateChangeObservers()
         historyRecordingStateHandler.unregisterAllCopilotSessionObservers()
         developerMetadataAggregator.unregisterAllObservers()
-        routeRefreshControllerImpl.destroy()
+        @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
+        routeRefreshController.destroy()
         routesPreviewController.unregisterAllRoutesPreviewObservers()
         runInTelemetryContext { telemetry ->
             telemetry.destroy(this@MapboxNavigation)
@@ -1887,7 +1886,8 @@ class MapboxNavigation @VisibleForTesting internal constructor(
     private fun createInternalRoutesObserver() = RoutesObserver { result ->
         latestLegIndex = null
         routeRefreshRequestDataProvider.onNewRoutes()
-        routeRefreshControllerImpl.requestPlannedRouteRefresh(result.navigationRoutes)
+        @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
+        routeRefreshController.requestPlannedRouteRefresh(result.navigationRoutes)
     }
 
     private fun createInternalOffRouteObserver() = OffRouteObserver { offRoute ->

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

@@ -1,7 +1,7 @@
 package com.mapbox.navigation.core
 
 import com.mapbox.navigation.core.reroute.NavigationRerouteController
-import com.mapbox.navigation.core.routerefresh.RouteRefreshControllerImpl
+import com.mapbox.navigation.core.routerefresh.RouteRefreshController
 
 internal sealed class SetRoutes {
 
@@ -37,7 +37,7 @@ internal sealed class SetRoutes {
     /**
      * Triggered when the **routes do not change but are refreshed**.
      *
-     * Currently this can only be trigger internally by a response to [RouteRefreshControllerImpl.refresh].
+     * Currently this can only be trigger internally by a response to [RouteRefreshController.refresh].
      */
     internal data class RefreshRoutes(
         val routeProgressData: RouteProgressData

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

@@ -1,38 +1,61 @@
 package com.mapbox.navigation.core.routerefresh
 
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
-import com.mapbox.navigation.core.directions.session.RoutesObserver
-
-/**
- * This class lets you manage route refreshes.
- */
-@ExperimentalPreviewMapboxNavigationAPI
-interface RouteRefreshController {
-
-    /**
-     * Immediately refresh current navigation routes.
-     * Listen for refreshed routes using [RoutesObserver].
-     *
-     * The on-demand refresh request is not guaranteed to succeed and call the [RoutesObserver],
-     * [requestImmediateRouteRefresh] invocations cannot be coupled with
-     * [RoutesObserver.onRoutesChanged] callbacks for state management.
-     * You can use [registerRouteRefreshStateObserver] to monitor refresh statuses independently.
-     */
-    fun requestImmediateRouteRefresh()
-
-    /**
-     * Register a [RouteRefreshStatesObserver] to be notified of Route refresh state changes.
-     *
-     * @param routeRefreshStatesObserver RouteRefreshStatesObserver
-     */
+import com.mapbox.navigation.base.route.NavigationRoute
+import com.mapbox.navigation.utils.internal.logI
+
+@OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
+class RouteRefreshController internal constructor(
+    private val plannedRouteRefreshController: PlannedRouteRefreshController,
+    private val immediateRouteRefreshController: ImmediateRouteRefreshController,
+    private val stateHolder: RouteRefreshStateHolder,
+    private val refreshObserversManager: RefreshObserversManager,
+    private val routeRefresherResultProcessor: RouteRefresherResultProcessor,
+) {
+
     fun registerRouteRefreshStateObserver(
         routeRefreshStatesObserver: RouteRefreshStatesObserver
-    )
+    ) {
+        stateHolder.registerRouteRefreshStateObserver(routeRefreshStatesObserver)
+    }
 
-    /**
-     * Unregisters a [RouteRefreshStatesObserver].
-     */
     fun unregisterRouteRefreshStateObserver(
         routeRefreshStatesObserver: RouteRefreshStatesObserver
-    )
+    ) {
+        stateHolder.unregisterRouteRefreshStateObserver(routeRefreshStatesObserver)
+    }
+
+    fun requestImmediateRouteRefresh() {
+        val routes = plannedRouteRefreshController.routesToRefresh
+        if (routes.isNullOrEmpty()) {
+            logI("No routes to refresh", RouteRefreshLog.LOG_CATEGORY)
+            stateHolder.onStarted()
+            stateHolder.onFailure("No routes to refresh")
+            return
+        }
+        plannedRouteRefreshController.pause()
+        immediateRouteRefreshController.requestRoutesRefresh(routes) {
+            if (it.value?.success == false) {
+                plannedRouteRefreshController.resume()
+            }
+        }
+    }
+
+    internal fun registerRouteRefreshObserver(observer: RouteRefreshObserver) {
+        refreshObserversManager.registerObserver(observer)
+    }
+
+    internal fun unregisterRouteRefreshObserver(observer: RouteRefreshObserver) {
+        refreshObserversManager.unregisterObserver(observer)
+    }
+
+    internal fun destroy() {
+        refreshObserversManager.unregisterAllObservers()
+        stateHolder.unregisterAllRouteRefreshStateObservers()
+    }
+
+    internal fun requestPlannedRouteRefresh(routes: List<NavigationRoute>) {
+        routeRefresherResultProcessor.reset()
+        plannedRouteRefreshController.startRoutesRefreshing(routes)
+    }
 }

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

@@ -24,7 +24,7 @@ internal object RouteRefreshControllerProvider {
         alternativeMetadataProvider: AlternativeMetadataProvider,
         evDynamicDataHolder: EVDynamicDataHolder,
         timeProvider: Time
-    ): RouteRefreshControllerImpl {
+    ): RouteRefreshController {
         val routeRefresher = RouteRefresher(
             RoutesProgressDataProvider(
                 primaryRouteProgressDataProvider,
@@ -61,7 +61,7 @@ internal object RouteRefreshControllerProvider {
             scope,
             routeRefresherResultProcessor
         )
-        return RouteRefreshControllerImpl(
+        return RouteRefreshController(
             plannedRouteRefreshController,
             immediateRouteRefreshController,
             stateHolder,

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

@@ -27,7 +27,7 @@ import com.mapbox.navigation.core.reroute.RerouteController
 import com.mapbox.navigation.core.reroute.RerouteState
 import com.mapbox.navigation.core.routealternatives.RouteAlternativesController
 import com.mapbox.navigation.core.routealternatives.RouteAlternativesControllerProvider
-import com.mapbox.navigation.core.routerefresh.RouteRefreshControllerImpl
+import com.mapbox.navigation.core.routerefresh.RouteRefreshController
 import com.mapbox.navigation.core.routerefresh.RouteRefreshControllerProvider
 import com.mapbox.navigation.core.telemetry.MapboxNavigationTelemetry
 import com.mapbox.navigation.core.testutil.createRoutesUpdatedResult
@@ -87,7 +87,7 @@ internal open class MapboxNavigationBaseTest {
     val locationEngine: LocationEngine = mockk(relaxUnitFun = true)
     val distanceFormatterOptions: DistanceFormatterOptions = mockk(relaxed = true)
     val routingTilesOptions: RoutingTilesOptions = mockk(relaxed = true)
-    val routeRefreshController: RouteRefreshControllerImpl = mockk(relaxed = true)
+    val routeRefreshController: RouteRefreshController = mockk(relaxed = true)
     val evDynamicDataHolder: EVDynamicDataHolder = mockk(relaxed = true)
     val routeAlternativesController: RouteAlternativesController = mockk(relaxed = true)
     val routeProgress: RouteProgress = mockk(relaxed = true)

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

@@ -15,7 +15,7 @@ import org.junit.Rule
 import org.junit.Test
 
 @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
-class RouteRefreshControllerImplTest {
+class RouteRefreshControllerTest {
 
     private val logger = mockk<LoggerFrontend>(relaxed = true)
 
@@ -28,7 +28,7 @@ class RouteRefreshControllerImplTest {
     private val stateHolder = mockk<RouteRefreshStateHolder>(relaxed = true)
     private val refreshObserversManager = mockk<RefreshObserversManager>(relaxed = true)
     private val resultProcessor = mockk<RouteRefresherResultProcessor>(relaxed = true)
-    private val sut = RouteRefreshControllerImpl(
+    private val sut = RouteRefreshController(
         plannedRouteRefreshController,
         immediateRouteRefreshController,
         stateHolder,

…efresh/RouteRefreshControllerImplTest.kt …uterefresh/RouteRefreshControllerTest.ktlibnavigation-core/src/test/java/com/mapbox/navigation/core/routerefresh/RouteRefreshControllerImplTest.kt renamed to libnavigation-core/src/test/java/com/mapbox/navigation/core/routerefresh/RouteRefreshControllerTest.kt libnavigation-core/src/test/java/com/mapbox/navigation/core/routerefresh/RouteRefreshControllerImplTest.kt renamed to libnavigation-core/src/test/java/com/mapbox/navigation/core/routerefresh/RouteRefreshControllerTest.kt

@@ -63,7 +63,7 @@ open internal class RouteRefreshIntegrationTest {
         tripSession,
         threadController
     )
-    lateinit var routeRefreshController: RouteRefreshControllerImpl
+    lateinit var routeRefreshController: RouteRefreshController
     val stateObserver = TestStateObserver()
     val refreshObserver = TestRefreshObserver()
     val testDispatcher = TestCoroutineDispatcher()
@@ -111,7 +111,7 @@ open internal class RouteRefreshIntegrationTest {
     }
 
 
-    fun createRefreshController(refreshInternal: Long): RouteRefreshControllerImpl {
+    fun createRefreshController(refreshInternal: Long): RouteRefreshController {
         val options = RouteRefreshOptions.Builder().intervalMillis(refreshInternal).build()
         return RouteRefreshControllerProvider.createRouteRefreshController(
             testScope,