NAVAND-777: add route refresh on demand #6610
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| - Added `RouteRefreshController` interface to manage route refreshes. Retrieve it via `MapboxNavigation#routeRefreshController`. | ||
| - Added `RouteRefreshController#requestImmediateRouteRefresh` to trigger route refresh request immediately. | ||
| - Moved `MapboxNavigation#registerRouteRefreshStateObserver` to `RouteRefreshController#registerRouteRefreshStateObserver`. To migrate, change: | ||
| ```kotlin | ||
| mapboxNavigation.registerRouteRefreshStateObserver(observer) | ||
|
There was a problem hiding this comment. Maybe it makes sense to leave There was a problem hiding this comment. Idk, I'd like to avoid duplicating API. What's more, we will probably forget to delete it. And when it's not experimental anymore, it won't be possible. |
||
| ``` | ||
| to | ||
| ```kotlin | ||
| mapboxNavigation.routeRefreshController.registerRouteRefreshStateObserver(observer) | ||
| ``` | ||
| - Moved `MapboxNavigation#unregisterRouteRefreshStateObserver` to `RouteRefreshController#unregisterRouteRefreshStateObserver`. To migrate, change: | ||
| ```kotlin | ||
| mapboxNavigation.unregisterRouteRefreshStateObserver(observer) | ||
| ``` | ||
| to | ||
| ```kotlin | ||
| mapboxNavigation.routeRefreshController.unregisterRouteRefreshStateObserver(observer) | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,245 @@ | ||
| package com.mapbox.navigation.instrumentation_tests.core | ||
|
|
||
| import android.location.Location | ||
| import com.mapbox.api.directions.v5.DirectionsCriteria | ||
| import com.mapbox.api.directions.v5.models.RouteOptions | ||
| import com.mapbox.geojson.Point | ||
| import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI | ||
| import com.mapbox.navigation.base.extensions.applyDefaultNavigationOptions | ||
| import com.mapbox.navigation.base.options.NavigationOptions | ||
| import com.mapbox.navigation.base.options.RoutingTilesOptions | ||
| import com.mapbox.navigation.base.route.NavigationRoute | ||
| import com.mapbox.navigation.base.route.RouteRefreshOptions | ||
| import com.mapbox.navigation.core.MapboxNavigation | ||
| import com.mapbox.navigation.core.MapboxNavigationProvider | ||
| import com.mapbox.navigation.core.directions.session.RoutesExtra | ||
| import com.mapbox.navigation.core.directions.session.RoutesUpdatedResult | ||
| import com.mapbox.navigation.core.routerefresh.RouteRefreshExtra | ||
| import com.mapbox.navigation.instrumentation_tests.R | ||
| import com.mapbox.navigation.instrumentation_tests.activity.EmptyTestActivity | ||
| import com.mapbox.navigation.instrumentation_tests.utils.DynamicResponseModifier | ||
| import com.mapbox.navigation.instrumentation_tests.utils.MapboxNavigationRule | ||
| import com.mapbox.navigation.instrumentation_tests.utils.coroutines.getSuccessfulResultOrThrowException | ||
| import com.mapbox.navigation.instrumentation_tests.utils.coroutines.requestRoutes | ||
| import com.mapbox.navigation.instrumentation_tests.utils.coroutines.routesUpdates | ||
| import com.mapbox.navigation.instrumentation_tests.utils.coroutines.sdkTest | ||
| import com.mapbox.navigation.instrumentation_tests.utils.coroutines.setNavigationRoutesAndWaitForUpdate | ||
| import com.mapbox.navigation.instrumentation_tests.utils.http.MockDirectionsRefreshHandler | ||
| import com.mapbox.navigation.instrumentation_tests.utils.http.MockDirectionsRequestHandler | ||
| import com.mapbox.navigation.instrumentation_tests.utils.http.MockRoutingTileEndpointErrorRequestHandler | ||
| import com.mapbox.navigation.instrumentation_tests.utils.http.NthAttemptHandler | ||
| import com.mapbox.navigation.instrumentation_tests.utils.location.MockLocationReplayerRule | ||
| import com.mapbox.navigation.instrumentation_tests.utils.readRawFileText | ||
| import com.mapbox.navigation.testing.ui.BaseTest | ||
| import com.mapbox.navigation.testing.ui.http.MockRequestHandler | ||
| import com.mapbox.navigation.testing.ui.utils.getMapboxAccessTokenFromResources | ||
| import kotlinx.coroutines.delay | ||
| import kotlinx.coroutines.flow.filter | ||
| import kotlinx.coroutines.flow.first | ||
| import kotlinx.coroutines.flow.take | ||
| import kotlinx.coroutines.flow.toList | ||
| import org.junit.Assert.assertEquals | ||
| import org.junit.Before | ||
| import org.junit.Rule | ||
| import org.junit.Test | ||
| import java.net.URI | ||
| import java.util.concurrent.TimeUnit | ||
|
|
||
| @OptIn(ExperimentalPreviewMapboxNavigationAPI::class) | ||
| class RouteRefreshOnDemandTest : BaseTest<EmptyTestActivity>(EmptyTestActivity::class.java) { | ||
|
|
||
| @get:Rule | ||
| val mapboxNavigationRule = MapboxNavigationRule() | ||
|
|
||
| @get:Rule | ||
| val mockLocationReplayerRule = MockLocationReplayerRule(mockLocationUpdatesRule) | ||
|
|
||
| private lateinit var baseRefreshHandler: MockDirectionsRefreshHandler | ||
| private lateinit var mapboxNavigation: MapboxNavigation | ||
| private val twoCoordinates = listOf( | ||
| Point.fromLngLat(-121.496066, 38.577764), | ||
| Point.fromLngLat(-121.480279, 38.57674) | ||
| ) | ||
|
|
||
| @Before | ||
| fun setUp() { | ||
| baseRefreshHandler = MockDirectionsRefreshHandler( | ||
| "route_response_single_route_refresh", | ||
| readRawFileText(activity, R.raw.route_response_route_refresh_annotations), | ||
| ) | ||
| } | ||
|
|
||
| override fun setupMockLocation(): Location = mockLocationUpdatesRule.generateLocationUpdate { | ||
| latitude = twoCoordinates[0].latitude() | ||
| longitude = twoCoordinates[0].longitude() | ||
| bearing = 190f | ||
| } | ||
|
|
||
| @Test | ||
| fun immediate_route_refresh_before_planned() = sdkTest { | ||
| val observer = TestObserver() | ||
| val routeRefreshes = mutableListOf<RoutesUpdatedResult>() | ||
| setupMockRequestHandlers(baseRefreshHandler) | ||
| baseRefreshHandler.jsonResponseModifier = DynamicResponseModifier() | ||
| createMapboxNavigation(createRouteRefreshOptionsWithInvalidInterval(5000)) | ||
| val routeOptions = generateRouteOptions(twoCoordinates) | ||
| val requestedRoutes = mapboxNavigation.requestRoutes(routeOptions) | ||
| .getSuccessfulResultOrThrowException() | ||
| .routes | ||
| mapboxNavigation.routeRefreshController.registerRouteRefreshStateObserver(observer) | ||
| mapboxNavigation.startTripSession() | ||
| stayOnInitialPosition() | ||
| mapboxNavigation.registerRoutesObserver { | ||
| if (it.reason == RoutesExtra.ROUTES_UPDATE_REASON_REFRESH) { | ||
| routeRefreshes.add(it) | ||
| } | ||
| } | ||
| mapboxNavigation.setNavigationRoutesAndWaitForUpdate(requestedRoutes) | ||
| delay(2500) | ||
|
|
||
| mapboxNavigation.routeRefreshController.requestImmediateRouteRefresh() | ||
| val refreshedRoutes = mapboxNavigation.routesUpdates() | ||
| .filter { it.reason == RoutesExtra.ROUTES_UPDATE_REASON_REFRESH } | ||
| .first() | ||
| assertEquals(1, routeRefreshes.size) | ||
| assertEquals( | ||
| 224.2239, | ||
| requestedRoutes[0].getSumOfDurationAnnotationsFromLeg(0), | ||
| 0.0001 | ||
| ) | ||
| assertEquals( | ||
| 258.767, | ||
| refreshedRoutes.navigationRoutes[0].getSumOfDurationAnnotationsFromLeg(0), | ||
| 0.0001 | ||
| ) | ||
|
|
||
| // no route refresh 4 seconds after refresh on demand | ||
| delay(4000) | ||
| assertEquals(1, routeRefreshes.size) | ||
|
|
||
| delay(1000) | ||
| // has new refresh 5 seconds after refresh on demand | ||
| mapboxNavigation.routesUpdates() | ||
| .filter { it.reason == RoutesExtra.ROUTES_UPDATE_REASON_REFRESH } | ||
| .take(2) | ||
| .toList() | ||
|
|
||
| assertEquals( | ||
| listOf( | ||
| RouteRefreshExtra.REFRESH_STATE_STARTED, | ||
| RouteRefreshExtra.REFRESH_STATE_FINISHED_SUCCESS, | ||
| RouteRefreshExtra.REFRESH_STATE_STARTED, | ||
| RouteRefreshExtra.REFRESH_STATE_FINISHED_SUCCESS, | ||
| ), | ||
| observer.getStatesSnapshot() | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun route_refresh_on_demand_between_planned_attempts() = sdkTest { | ||
| val observer = TestObserver() | ||
| baseRefreshHandler.jsonResponseModifier = DynamicResponseModifier() | ||
| setupMockRequestHandlers( | ||
| NthAttemptHandler(baseRefreshHandler, 1) | ||
| ) | ||
|
|
||
| createMapboxNavigation(createRouteRefreshOptionsWithInvalidInterval(5_000)) | ||
| mapboxNavigation.routeRefreshController.registerRouteRefreshStateObserver(observer) | ||
| mapboxNavigation.startTripSession() | ||
| val routeOptions = generateRouteOptions(twoCoordinates) | ||
| val requestedRoutes = mapboxNavigation.requestRoutes(routeOptions) | ||
| .getSuccessfulResultOrThrowException() | ||
| .routes | ||
| mapboxNavigation.setNavigationRoutesAndWaitForUpdate(requestedRoutes) | ||
| delay(8000) // refresh interval + accuracy | ||
|
|
||
| mapboxNavigation.routeRefreshController.requestImmediateRouteRefresh() | ||
|
|
||
| // one from immediate and the next planned | ||
| mapboxNavigation.routesUpdates() | ||
| .filter { it.reason == RoutesExtra.ROUTES_UPDATE_REASON_REFRESH } | ||
| .take(2) | ||
| .toList() | ||
|
|
||
| assertEquals( | ||
| listOf( | ||
| RouteRefreshExtra.REFRESH_STATE_STARTED, | ||
| RouteRefreshExtra.REFRESH_STATE_CANCELED, | ||
| RouteRefreshExtra.REFRESH_STATE_STARTED, | ||
| RouteRefreshExtra.REFRESH_STATE_FINISHED_SUCCESS, | ||
| RouteRefreshExtra.REFRESH_STATE_STARTED, | ||
| RouteRefreshExtra.REFRESH_STATE_FINISHED_SUCCESS, | ||
| ), | ||
| observer.getStatesSnapshot() | ||
| ) | ||
| } | ||
|
|
||
| private fun createMapboxNavigation(routeRefreshOptions: RouteRefreshOptions) { | ||
| mapboxNavigation = MapboxNavigationProvider.create( | ||
| NavigationOptions.Builder(activity) | ||
| .accessToken(getMapboxAccessTokenFromResources(activity)) | ||
| .routeRefreshOptions(routeRefreshOptions) | ||
| .routingTilesOptions( | ||
| RoutingTilesOptions.Builder() | ||
| .tilesBaseUri(URI(mockWebServerRule.baseUrl)) | ||
| .build() | ||
| ) | ||
| .navigatorPredictionMillis(0L) | ||
| .build() | ||
| ) | ||
| } | ||
|
|
||
| private fun stayOnInitialPosition() { | ||
| mockLocationReplayerRule.loopUpdate( | ||
| mockLocationUpdatesRule.generateLocationUpdate { | ||
| latitude = twoCoordinates[0].latitude() | ||
| longitude = twoCoordinates[0].longitude() | ||
| bearing = 190f | ||
| }, | ||
| times = 120 | ||
| ) | ||
| } | ||
|
|
||
| private fun generateRouteOptions(coordinates: List<Point>): RouteOptions { | ||
| return RouteOptions.builder().applyDefaultNavigationOptions() | ||
| .profile(DirectionsCriteria.PROFILE_DRIVING_TRAFFIC) | ||
| .alternatives(true) | ||
| .coordinatesList(coordinates) | ||
| .baseUrl(mockWebServerRule.baseUrl) // Comment out to test a real server | ||
| .build() | ||
| } | ||
|
|
||
| private fun setupMockRequestHandlers( | ||
| refreshHandler: MockRequestHandler, | ||
| ) { | ||
| mockWebServerRule.requestHandlers.clear() | ||
| mockWebServerRule.requestHandlers.add( | ||
| MockDirectionsRequestHandler( | ||
| "driving-traffic", | ||
| readRawFileText(activity, R.raw.route_response_single_route_refresh), | ||
| twoCoordinates | ||
| ) | ||
| ) | ||
| mockWebServerRule.requestHandlers.add(refreshHandler) | ||
| mockWebServerRule.requestHandlers.add(MockRoutingTileEndpointErrorRequestHandler()) | ||
| } | ||
|
|
||
| private fun NavigationRoute.getSumOfDurationAnnotationsFromLeg(legIndex: Int): Double = | ||
| directionsRoute.legs()?.get(legIndex) | ||
| ?.annotation() | ||
| ?.duration() | ||
| ?.sum()!! | ||
|
|
||
| private fun createRouteRefreshOptionsWithInvalidInterval( | ||
| intervalMillis: Long | ||
| ): RouteRefreshOptions { | ||
| val routeRefreshOptions = RouteRefreshOptions.Builder() | ||
| .intervalMillis(TimeUnit.SECONDS.toMillis(30)) | ||
| .build() | ||
| RouteRefreshOptions::class.java.getDeclaredField("intervalMillis").apply { | ||
| isAccessible = true | ||
| set(routeRefreshOptions, intervalMillis) | ||
| } | ||
| return routeRefreshOptions | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does exposing
RouteRefreshControllermakes our SDK easier to harder to change?I found myself in a complex situations with reroute logic a few times. It was very hard to change its structure, because we exposed it to the users in our API. Maybe exposing
MapboxNavigation#refreshRoute()leaves us more flexibility for future changes? 🤔There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's just an interface that accumulates refresh-related API.