Route Origin handling (#3945)

* vk-1655-route-origin: added internal router origin value to IndexedRouteResponse to forward it to NN when setting a route.

Author: Udumft

Sources/MapboxCoreNavigation/AlternativeRoute.swift

@@ -47,8 +47,9 @@ public struct AlternativeRoute: Identifiable {
         }
 
         self.indexedRouteResponse = .init(routeResponse: decoded.routeResponse,
-                                          routeIndex: Int(nativeRouteAlternative.route.getRouteIndex()))
-
+                                          routeIndex: Int(nativeRouteAlternative.route.getRouteIndex()),
+                                          responseOrigin: nativeRouteAlternative.route.getRouterOrigin())
+        
         var legIndex = Int(nativeRouteAlternative.mainRouteFork.legIndex)
         var segmentIndex = Int(nativeRouteAlternative.mainRouteFork.segmentIndex)
 

Sources/MapboxCoreNavigation/RerouteController.swift

@@ -94,7 +94,8 @@ extension RerouteController: RerouteObserver {
         delegate?.rerouteControllerWantsSwitchToAlternative(self,
                                                             response: decoded.routeResponse,
                                                             routeIndex: Int(route.getRouteIndex()),
-                                                            options: decoded.routeOptions)
+                                                            options: decoded.routeOptions,
+                                                            routeOrigin: route.getRouterOrigin())
     }
 
     func onRerouteDetected(forRouteRequest routeRequest: String) -> Bool {
@@ -116,7 +117,8 @@ extension RerouteController: RerouteObserver {
            decodedRequest.routeOptions == latestRouteResponse.options {
             delegate?.rerouteControllerDidRecieveReroute(self,
                                                          response: latestRouteResponse.response,
-                                                         options: latestRouteResponse.options)
+                                                         options: latestRouteResponse.options,
+                                                         routeOrigin: origin)
             self.latestRouteResponse = nil
         } else {
             guard let decodedResponse = Self.decode(routeResponse: routeResponse,
@@ -128,7 +130,8 @@ extension RerouteController: RerouteObserver {
 
             delegate?.rerouteControllerDidRecieveReroute(self,
                                                          response: decodedResponse,
-                                                         options: decodedRequest.routeOptions)
+                                                         options: decodedRequest.routeOptions,
+                                                         routeOrigin: origin)
         }
     }
 

Sources/MapboxCoreNavigation/RerouteControllerDelegate.swift

@@ -7,9 +7,10 @@ protocol ReroutingControllerDelegate: AnyObject {
     func rerouteControllerWantsSwitchToAlternative(_ rerouteController: RerouteController,
                                                    response: RouteResponse,
                                                    routeIndex: Int,
-                                                   options: RouteOptions)
+                                                   options: RouteOptions,
+                                                   routeOrigin: RouterOrigin)
     func rerouteControllerDidDetectReroute(_ rerouteController: RerouteController) -> Bool
-    func rerouteControllerDidRecieveReroute(_ rerouteController: RerouteController, response: RouteResponse, options: RouteOptions)
+    func rerouteControllerDidRecieveReroute(_ rerouteController: RerouteController, response: RouteResponse, options: RouteOptions, routeOrigin: RouterOrigin)
     func rerouteControllerDidCancelReroute(_ rerouteController: RerouteController)
     func rerouteControllerDidFailToReroute(_ rerouteController: RerouteController, with error: DirectionsError)
 }

Sources/MapboxCoreNavigation/RouteController.swift

@@ -287,7 +287,8 @@ open class RouteController: NSObject {
         }
 
         let parsedRoutes = RouteParser.parseDirectionsResponse(forResponse: routeJSONString,
-                                                               request: routeRequest, routeOrigin: RouterOrigin.custom)
+                                                               request: routeRequest,
+                                                               routeOrigin: indexedRouteResponse.responseOrigin)
         if parsedRoutes.isValue(),
            var routes = parsedRoutes.value as? [RouteInterface],
            routes.count > indexedRouteResponse.routeIndex {
@@ -875,10 +876,11 @@ extension RouteController: ReroutingControllerDelegate {
     func rerouteControllerWantsSwitchToAlternative(_ rerouteController: RerouteController,
                                                    response: RouteResponse,
                                                    routeIndex: Int,
-                                                   options: RouteOptions) {
+                                                   options: RouteOptions,
+                                                   routeOrigin: RouterOrigin) {
         let newRouteResponse = IndexedRouteResponse(routeResponse: response,
-                                                    routeIndex: routeIndex)
-                                                    
+                                                    routeIndex: routeIndex,
+                                                    responseOrigin: routeOrigin)
         guard let newMainRoute = newRouteResponse.currentRoute else {
             return
         }
@@ -927,9 +929,11 @@ extension RouteController: ReroutingControllerDelegate {
         }
     }
 
-    func rerouteControllerDidRecieveReroute(_ rerouteController: RerouteController, response: RouteResponse, options: RouteOptions) {
-        updateRoute(with: IndexedRouteResponse(routeResponse: response,
-                                               routeIndex: 0),
+    func rerouteControllerDidRecieveReroute(_ rerouteController: RerouteController, response: RouteResponse, options: RouteOptions, routeOrigin: RouterOrigin) {
+        let indexedRouteResponse = IndexedRouteResponse(routeResponse: response,
+                                                        routeIndex: 0,
+                                                        responseOrigin: routeOrigin)
+        updateRoute(with: indexedRouteResponse,
                     routeOptions: options,
                     isProactive: false) { [weak self] _ in
             self?.isRerouting = false

Sources/MapboxCoreNavigation/Router.swift

@@ -1,6 +1,7 @@
 import Foundation
 import CoreLocation
 import MapboxDirections
+import MapboxNavigationNative
 
 /**
  A router data source, also known as a location manager, supplies location data to a `Router` instance. For example, a `MapboxNavigationService` supplies location data to a `RouteController` or `LegacyRouteController`.
@@ -43,8 +44,24 @@ public struct IndexedRouteResponse {
      - parameter routeIndex: Selected route index in an array.
      */
     public init(routeResponse: RouteResponse, routeIndex: Int) {
+        self.init(routeResponse: routeResponse,
+                  routeIndex: routeIndex,
+                  responseOrigin: .custom)
+    }
+    
+    /**
+     Describes the origin of current route response.
+     
+     Used by `Navigator` for better understanding current state and various features functioning.
+     */
+    internal let responseOrigin: RouterOrigin
+    
+    init(routeResponse: RouteResponse,
+         routeIndex: Int,
+         responseOrigin: RouterOrigin) {
         self.routeResponse = routeResponse
         self.routeIndex = routeIndex
+        self.responseOrigin = responseOrigin
     }
 }