Merge pull request #4268 from mapbox/NAVIOS-763

Use the same algorithm for calculating distance to intersection as in distance traveled

Author: S2Ler

CHANGELOG.md

@@ -56,6 +56,7 @@
 * Fixed an issue where the route progress could be incorrectly calculated for folding back route steps. ([#4234](https://github.com/mapbox/mapbox-navigation-ios/pull/4234))
 * `NavigationView.init(frame:tileStoreLocation:navigationMapView:)`, `NavigationView.navigationMapView`, `NavigationView.floatingStackView`, `NavigationView.floatingButtons`, `NavigationView.wayNameView`, `NavigationView.speedLimitView`, `NavigationView.topBannerContainerView` and `NavigationView.bottomBannerContainerView` are now publicly accessible. ([#4249](https://github.com/mapbox/mapbox-navigation-ios/pull/4249))
 * Fixed an issue where empty intersections of the current step could cause a crash. ([#4260](https://github.com/mapbox/mapbox-navigation-ios/pull/4260))
+* Fixed an issue where `RouteProgress.currentLegProgress.currentStepProgress.userDistanceToUpcomingIntersection` could be incorrectly calculated for folding back route steps. ([#4268](https://github.com/mapbox/mapbox-navigation-ios/pull/4268)) 
 * Deprecated `NavigationSettings.initialize(directions:tileStoreConfiguration:routingProviderSource:alternativeRouteDetectionStrategy:utilizeSensorData:navigatorPredictionInterval:liveIncidentsOptions:statusUpdatingSettings:)` method in favor of `NavigationSettings.initialize(with:)`. ([#4275](https://github.com/mapbox/mapbox-navigation-ios/pull/4275))
 * Added new parameter that allows configuring logging level for Mapbox SDKs. Checkout new `NavigationSettings.initialize(with:)` method for more information. ([#4275](https://github.com/mapbox/mapbox-navigation-ios/pull/4275))
 * Fixed an issue where the `UserHaloCourseView` will be shown under reduced location accuracy mode with `NavigationMapview.reducedAccuracyActivatedMode` as `false`. Right now `UserHaloCourseView` will be applied in only one case: when user explicitly sets `NavigationMapView.reducedAccuracyActivatedMode` to `true`, and the `Precise Location` property in the settings of current application is disabled by user. ([#4285](https://github.com/mapbox/mapbox-navigation-ios/pull/4285))

Sources/MapboxCoreNavigation/RouteController.swift

@@ -388,8 +388,7 @@ open class RouteController: NSObject {
         updateSpokenInstructionProgress(status: status, willReRoute: isRerouting)
         updateVisualInstructionProgress(status: status)
         updateRoadName(status: status)
-        routeProgress.updateDistanceToIntersection(from: snappedLocation)
-        
+
         rerouteAfterArrivalIfNeeded(snappedLocation, status: status)
 
         if status.routeState != .complete {
@@ -507,6 +506,7 @@ open class RouteController: NSObject {
 
     private func update(progress: RouteProgress, status: NavigationStatus, with location: CLLocation, rawLocation: CLLocation, upcomingRouteAlerts routeAlerts: [UpcomingRouteAlert], mapMatchingResult: MapMatchingResult, routeShapeIndex: Int) {
         progress.updateDistanceTraveled(navigationStatus: status)
+
         progress.upcomingRouteAlerts = routeAlerts.map { RouteAlert($0) }
         progress.shapeIndex = routeShapeIndex
 

Sources/MapboxCoreNavigation/RouteProgress.swift

@@ -164,7 +164,6 @@ open class RouteProgress: Codable {
                                               intersectionIndex: currentLegProgress.currentStepProgress.intersectionIndex)
         calculateLegsCongestion()
         updateDistanceTraveled(with: location)
-        updateDistanceToIntersection(from: location)
     }
 
     /**
@@ -200,24 +199,31 @@ open class RouteProgress: Codable {
         else {
             updateDistanceTraveled(with: .init(navigationStatus.location))
         }
+        updateDistanceToIntersection()
     }
 
     /**
      Update the distance to intersection according to new location specified.
      - parameter location: Updated user location.
      */
-    func updateDistanceToIntersection(from location: CLLocation) {
+    private func updateDistanceToIntersection() {
         guard var intersections = currentLegProgress.currentStepProgress.step.intersections else { return }
 
         // The intersections array does not include the upcoming maneuver intersection.
         if let upcomingIntersection = currentLegProgress.upcomingStep?.intersections?.first {
             intersections += [upcomingIntersection]
         }
         currentLegProgress.currentStepProgress.intersectionsIncludingUpcomingManeuverIntersection = intersections
-        
+
         if let shape = currentLegProgress.currentStep.shape,
-           let upcomingIntersection = currentLegProgress.currentStepProgress.upcomingIntersection {
-            currentLegProgress.currentStepProgress.userDistanceToUpcomingIntersection = shape.distance(from: location.coordinate, to: upcomingIntersection.location)
+           let upcomingIntersection = currentLegProgress.currentStepProgress.upcomingIntersection,
+           let coordinateOnStep = shape.coordinateFromStart(
+               distance: currentLegProgress.currentStepProgress.distanceTraveled
+           ) {
+            currentLegProgress.currentStepProgress.userDistanceToUpcomingIntersection = shape.distance(
+                from: coordinateOnStep,
+                to: upcomingIntersection.location
+            )
         }
 
         updateIntersectionDistances()

Tests/MapboxCoreNavigationTests/Progress/RouteProgressTests.swift

@@ -6,6 +6,7 @@ import TestHelper
 import struct Polyline.Polyline
 import Turf
 @testable import MapboxCoreNavigation
+import MapboxNavigationNative
 
 class RouteProgressTests: TestCase {
 
@@ -297,6 +298,50 @@ class RouteProgressTests: TestCase {
         legProgress.currentStepProgress.distanceTraveled = lineString.distance(to: coordinates[5])! + (lineString.distance()! - lineString.distance(to: coordinates[5])!) / 2.0
         XCTAssertTrue(legProgress.currentSpeedLimit?.value.isInfinite ?? false)
     }
+
+    func testDistanceToIntersection() {
+        func navigationState(stepDistanceTraveled: CLLocationDistance) -> NavigationStatus {
+            .init(
+                routeState: .tracking,
+                locatedAlternativeRouteId: nil,
+                stale: false,
+                location: .init(.init()),
+                routeIndex: 0,
+                legIndex: 0,
+                step: 0,
+                isFallback: false,
+                inTunnel: false,
+                predicted: 0,
+                geometryIndex: 0,
+                shapeIndex: 0,
+                intersectionIndex: 0,
+                roads: [],
+                voiceInstruction: nil,
+                bannerInstruction: nil,
+                speedLimit: nil,
+                keyPoints: [],
+                mapMatcherOutput: .init(matches: [], isTeleport: false),
+                offRoadProba: 0,
+                activeGuidanceInfo: .init(
+                    routeProgress: .init(distanceTraveled: 0, fractionTraveled: 0, remainingDistance: 0, remainingDuration: 0),
+                    legProgress: .init(distanceTraveled: 0, fractionTraveled: 0, remainingDistance: 0, remainingDuration: 0),
+                    step: .init(distanceTraveled: stepDistanceTraveled, fractionTraveled: 0, remainingDistance: 0, remainingDuration: 0)
+                ),
+                upcomingRouteAlerts: [],
+                nextWaypointIndex: 0,
+                layer: nil
+            )
+        }
+
+        let routeProgress = RouteProgress(route: route, options: routeOptions)
+        routeProgress.updateDistanceTraveled(navigationStatus: navigationState(stepDistanceTraveled: 0))
+        XCTAssertEqual(round(routeProgress.currentLegProgress.currentStepProgress.userDistanceToUpcomingIntersection ?? 0), 81)
+
+        // `updateDistanceTraveled` only reads `activeGuidanceInfo.step.distanceTraveled`, so it is the only valid data
+        // we must provide here.
+        routeProgress.updateDistanceTraveled(navigationStatus: navigationState(stepDistanceTraveled: 50))
+        XCTAssertEqual(round(routeProgress.currentLegProgress.currentStepProgress.userDistanceToUpcomingIntersection ?? 0), 31)
+    }
 
     func testRouteProggressCodable() {
         let routeProgress = RouteProgress(route: route,