Fix the intersections property loss after route refresh. (#4193)

Author: ShanMa1991

CHANGELOG.md

@@ -16,6 +16,7 @@
 * Added the `NavigationViewController(for:routeIndex:navigationOptions:)` initializer to start turn-by-turn navigation using map matching response. ([#4127](https://github.com/mapbox/mapbox-navigation-ios/pull/4127))
 * Fixed an issue where continuous alternative route lines and their corresponding callouts were misplaced on long routes. ([#4176](https://github.com/mapbox/mapbox-navigation-ios/pull/4176))
 * Added `ReplayLocationManager(history:)` and `MapboxNavigationService(history:customRoutingProvider:credentials:eventsManagerType:routerType:customActivityType:)` for replaying trips recorded by a history file. ([#4194](https://github.com/mapbox/mapbox-navigation-ios/pull/4194))
+* Fixed an issue where after route refresh, the `RouteStepProgress.userDistanceToUpcomingIntersection`, `RouteStepProgress.intersectionsIncludingUpcomingManeuverIntersection`, `RouteStepProgress.intersectionDistances` and `RouteStepProgress.intersectionIndex` are all set to default values. ([#4193](https://github.com/mapbox/mapbox-navigation-ios/pull/4193))
 
 ### Map
 

Sources/MapboxCoreNavigation/RouteController.swift

@@ -398,7 +398,7 @@ open class RouteController: NSObject {
         updateSpokenInstructionProgress(status: status, willReRoute: isRerouting)
         updateVisualInstructionProgress(status: status)
         updateRoadName(status: status)
-        updateDistanceToIntersection(from: snappedLocation)
+        routeProgress.updateDistanceToIntersection(from: snappedLocation)
 
         rerouteAfterArrivalIfNeeded(snappedLocation, status: status)
 
@@ -408,37 +408,6 @@ open class RouteController: NSObject {
         }
     }
 
-    func updateDistanceToIntersection(from location: CLLocation) {
-        guard var intersections = routeProgress.currentLegProgress.currentStepProgress.step.intersections else { return }
-        
-        // The intersections array does not include the upcoming maneuver intersection.
-        if let upcomingStep = routeProgress.currentLegProgress.upcomingStep,
-           let upcomingIntersection = upcomingStep.intersections?.first {
-            intersections += [upcomingIntersection]
-        }
-        
-        routeProgress.currentLegProgress.currentStepProgress.intersectionsIncludingUpcomingManeuverIntersection = intersections
-        
-        if let shape = routeProgress.currentLegProgress.currentStepProgress.step.shape,
-           let upcomingIntersection = routeProgress.currentLegProgress.currentStepProgress.upcomingIntersection {
-            routeProgress.currentLegProgress.currentStepProgress.userDistanceToUpcomingIntersection = shape.distance(from: location.coordinate, to: upcomingIntersection.location)
-        }
-        
-        updateIntersectionDistances()
-    }
-    
-    func updateIntersectionDistances() {
-        if routeProgress.currentLegProgress.currentStepProgress.intersectionDistances == nil {
-            routeProgress.currentLegProgress.currentStepProgress.intersectionDistances = [CLLocationDistance]()
-            
-            if let shape = routeProgress.currentLegProgress.currentStep.shape,
-               let intersections = routeProgress.currentLegProgress.currentStep.intersections {
-                let distances: [CLLocationDistance] = intersections.compactMap { shape.distance(from: shape.coordinates.first, to: $0.location) }
-                routeProgress.currentLegProgress.currentStepProgress.intersectionDistances = distances
-            }
-        }
-    }
-    
     @objc func fallbackToOffline(_ notification: Notification) {
         updateNavigator(with: indexedRouteResponse, fromLegIndex: self.routeProgress.legIndex, completion: nil)
     }

Sources/MapboxCoreNavigation/RouteLegProgress.swift

@@ -188,14 +188,14 @@ open class RouteLegProgress: Codable {
      - parameter stepIndex: Current step the user is on.
      - parameter shapeIndex: Index relative to leg shape, representing the point the user is currently located at.
      */
-    public init(leg: RouteLeg, stepIndex: Int = 0, spokenInstructionIndex: Int = 0, shapeIndex: Int = 0) {
+    public init(leg: RouteLeg, stepIndex: Int = 0, spokenInstructionIndex: Int = 0, shapeIndex: Int = 0, intersectionIndex: Int = 0) {
         precondition(leg.steps.indices.contains(stepIndex), "It's not possible to set the stepIndex: \(stepIndex) when it's higher than steps count \(leg.steps.count) or not included.")
 
         self.leg = leg
         self.stepIndex = stepIndex
         self.shapeIndex = shapeIndex
 
-        currentStepProgress = RouteStepProgress(step: leg.steps[stepIndex], spokenInstructionIndex: spokenInstructionIndex)
+        currentStepProgress = RouteStepProgress(step: leg.steps[stepIndex], spokenInstructionIndex: spokenInstructionIndex, intersectionIndex: intersectionIndex)
     }
 
     typealias StepIndexDistance = (index: Int, distance: CLLocationDistance)

Sources/MapboxCoreNavigation/RouteProgress.swift

@@ -159,9 +159,11 @@ open class RouteProgress: Codable {
     private func commonRefreshRoute(at location: CLLocation) {
         currentLegProgress = RouteLegProgress(leg: route.legs[legIndex],
                                               stepIndex: currentLegProgress.stepIndex,
-                                              spokenInstructionIndex: currentLegProgress.currentStepProgress.spokenInstructionIndex)
+                                              spokenInstructionIndex: currentLegProgress.currentStepProgress.spokenInstructionIndex,
+                                              intersectionIndex: currentLegProgress.currentStepProgress.intersectionIndex)
         calculateLegsCongestion()
         updateDistanceTraveled(with: location)
+        updateDistanceToIntersection(from: location)
     }
 
     /**
@@ -188,6 +190,38 @@ open class RouteProgress: Codable {
         }
     }
 
+    /**
+     Update the distance to intersection according to new location specified.
+     - parameter location: Updated user location.
+     */
+    func updateDistanceToIntersection(from location: CLLocation) {
+        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)
+        }
+        
+        updateIntersectionDistances()
+    }
+    
+    func updateIntersectionDistances() {
+        guard currentLegProgress.currentStepProgress.intersectionDistances == nil else { return }
+        
+        currentLegProgress.currentStepProgress.intersectionDistances = [CLLocationDistance]()
+        if let shape = currentLegProgress.currentStep.shape,
+           let intersections = currentLegProgress.currentStep.intersections {
+            let distances: [CLLocationDistance] = intersections.compactMap { shape.distance(from: shape.coordinates.first, to: $0.location) }
+            currentLegProgress.currentStepProgress.intersectionDistances = distances
+        }
+    }
+    
     // MARK: Leg Statistics
 
     /**

Sources/MapboxCoreNavigation/RouteStepProgress.swift

@@ -12,11 +12,11 @@ open class RouteStepProgress: Codable {
 
      - parameter step: Step on a `RouteLeg`.
      */
-    public init(step: RouteStep, spokenInstructionIndex: Int = 0) {
+    public init(step: RouteStep, spokenInstructionIndex: Int = 0, intersectionIndex: Int = 0) {
         self.step = step
         self.userDistanceToManeuverLocation = step.distance
-        self.intersectionIndex = 0
         self.spokenInstructionIndex = spokenInstructionIndex
+        self.intersectionIndex = intersectionIndex
     }
 
     // MARK: Step Stats