vk-1024-hybrid-router: restored NavigationService changes. Tests fixed.

Author: Udumft

Sources/MapboxCoreNavigation/NavigationService.swift

@@ -5,9 +5,9 @@ import MapboxDirections
 /**
  A navigation service coordinates various nonvisual components that track the user as they navigate along a predetermined route. You use `MapboxNavigationService`, which conforms to this protocol, either as part of `NavigationViewController` or by itself as part of a custom user interface. A navigation service calls methods on its `delegate`, which conforms to the `NavigationServiceDelegate` protocol, whenever significant events or decision points occur along the route.
 
- A navigation service controls a `NavigationLocationManager` for determining the user’s location, a `Router` that tracks the user’s progress along the route, a `Directions` service for calculating new routes (only used when rerouting), and a `NavigationEventsManager` for sending telemetry events related to navigation or user feedback.
+ A navigation service controls a `NavigationLocationManager` for determining the user’s location, a `Router` that tracks the user’s progress along the route, a `NavigationRouter` service for calculating new routes (only used when rerouting), and a `NavigationEventsManager` for sending telemetry events related to navigation or user feedback.
 
- `NavigationViewController` comes with a `MapboxNavigationService` by default. You may override it to customize the `Directions` service or simulation mode. After creating the navigation service, pass it into `NavigationOptions(styles:navigationService:voiceController:topBanner:bottomBanner:)`, then pass that object into `NavigationViewController(for:options:)`.
+ `NavigationViewController` comes with a `MapboxNavigationService` by default. You may override it to customize the `NavigationRouter`'s source service or simulation mode. After creating the navigation service, pass it into `NavigationOptions(styles:navigationService:voiceController:topBanner:bottomBanner:)`, then pass that object into `NavigationViewController(for:options:)`.
 
  If you use a navigation service by itself, outside of `NavigationViewController`, call `start()` when the user is ready to begin navigating along the route.
  */
@@ -18,9 +18,14 @@ public protocol NavigationService: CLLocationManagerDelegate, RouterDataSource,
     var locationManager: NavigationLocationManager { get }
 
     /**
-     A reference to a MapboxDirections service. Used for rerouting.
+     Routing source type used to create the route.
+     */
+    var routingSource: NavigationRouter.RouterSource { get }
+    
+    /**
+     Credentials data, used to authorize server requests.
      */
-    var directions: Directions { get }
+    var credentials: DirectionsCredentials { get }
 
     /**
      The router object that tracks the user’s progress as they travel along a predetermined route.
@@ -270,7 +275,7 @@ public class MapboxNavigationService: NSObject, NavigationService {
      - parameter routeOptions: The route options used to get the route.
      */
     convenience init(routeResponse: RouteResponse, routeIndex: Int, routeOptions options: RouteOptions) {
-        self.init(routeResponse: routeResponse, routeIndex: routeIndex, routeOptions: options, directions: nil, locationSource: nil, eventsManagerType: nil)
+        self.init(routeResponse: routeResponse, routeIndex: routeIndex, routeOptions: options, locationSource: nil, eventsManagerType: nil)
     }
 
     /**
@@ -279,7 +284,8 @@ public class MapboxNavigationService: NSObject, NavigationService {
      - parameter routeResponse: `RouteResponse` object, containing selection of routes to follow.
      - parameter routeIndex: The index of the route within the original `RouteResponse` object.
      - parameter routeOptions: The route options used to get the route.
-     - parameter directions: The Directions object that created `route`. If this argument is omitted, the shared value of `NavigationSettings.directions` will be used.
+     - parameter routingSource: `NavigationRouter` source type, used to create route.
+     - parameter credentials: Credentials to authorize additional data requests throughout the route. If this argument is omitted, the shared value of `NavigationSettings.directions` will be used.
      - parameter locationSource: An optional override for the default `NaviationLocationManager`.
      - parameter eventsManagerType: An optional events manager type to use while tracking the route.
      - parameter simulationMode: The simulation mode desired.
@@ -288,13 +294,15 @@ public class MapboxNavigationService: NSObject, NavigationService {
     required public init(routeResponse: RouteResponse,
                          routeIndex: Int,
                          routeOptions: RouteOptions,
-                         directions: Directions? = nil,
+                         routingSource: NavigationRouter.RouterSource = .hybrid,
+                         credentials: DirectionsCredentials = NavigationSettings.shared.directions.credentials,
                          locationSource: NavigationLocationManager? = nil,
                          eventsManagerType: NavigationEventsManager.Type? = nil,
                          simulating simulationMode: SimulationMode? = nil,
                          routerType: Router.Type? = nil) {
         nativeLocationSource = locationSource ?? NavigationLocationManager()
-        self.directions = directions ?? NavigationSettings.shared.directions
+        self.routingSource = routingSource
+        self.credentials = credentials
         self.simulationMode = simulationMode ?? .inTunnels
         super.init()
         resumeNotifications()
@@ -307,12 +315,16 @@ public class MapboxNavigationService: NSObject, NavigationService {
         }
 
         let routerType = routerType ?? DefaultRouter.self
-        _router = routerType.init(alongRouteAtIndex: routeIndex, in: routeResponse, options: routeOptions, directions: self.directions, dataSource: self)
+        _router = routerType.init(alongRouteAtIndex: routeIndex,
+                                  in: routeResponse,
+                                  options: routeOptions,
+                                  routingSource: routingSource,
+                                  dataSource: self)
         NavigationSettings.shared.distanceUnit = routeOptions.locale.usesMetric ? .kilometer : .mile
 
         let eventType = eventsManagerType ?? NavigationEventsManager.self
         _eventsManager = eventType.init(activeNavigationDataSource: self,
-                                        accessToken: self.directions.credentials.accessToken)
+                                        accessToken: self.credentials.accessToken)
         locationManager.activityType = routeOptions.activityType
         bootstrapEvents()
 
@@ -369,9 +381,14 @@ public class MapboxNavigationService: NSObject, NavigationService {
     private var simulatedLocationSource: SimulatedLocationManager?
 
     /**
-     A reference to a MapboxDirections service. Used for rerouting.
+     Routing source type used to create the route.
+     */
+    public var routingSource: NavigationRouter.RouterSource
+    
+    /**
+     Credentials data, used to authorize server requests.
      */
-    public var directions: Directions
+    public var credentials: DirectionsCredentials
 
 
     // MARK: Managing Route-Related Data

Sources/MapboxCoreNavigation/RouteController.swift

@@ -659,7 +659,7 @@ extension RouteController: Router {
         changeRouteProgress(RouteProgress(route: route, options: routeOptions)) { [weak self] success in
             guard let self = self else { return }
             if success {
-                self.announce(reroute: route, at: self.location, proactive: isProactive)
+                self.announce(reroute: self.route, at: self.location, proactive: isProactive)
                 self.indexedRouteResponse = indexedRouteResponse
             }
             completion?(success)

Sources/MapboxNavigation/NavigationViewController.swift

@@ -89,7 +89,7 @@ open class NavigationViewController: UIViewController, NavigationStatusPresenter
     public var voiceController: RouteVoiceController!
 
     func setupVoiceController() {
-        let credentials = navigationService.directions.credentials
+        let credentials = navigationService.credentials
         voiceController = navigationOptions?.voiceController
             ?? RouteVoiceController(navigationService: navigationService,
                                     accessToken: credentials.accessToken,
@@ -177,13 +177,6 @@ open class NavigationViewController: UIViewController, NavigationStatusPresenter
     var _routeIndex: Int?
     var _routeResponse: RouteResponse?
 
-    /**
-     An instance of `Directions` need for rerouting. See [Mapbox Directions](https://docs.mapbox.com/ios/api/directions/) for further information.
-     */
-    public var directions: Directions {
-        return navigationService.directions
-    }
-    
     /**
      The navigation service that coordinates the view controller’s nonvisual components, tracking the user’s location as they proceed along the route.
      */

Tests/MapboxCoreNavigationTests/BillingHandlerTests.swift

@@ -611,13 +611,10 @@ final class BillingHandlerUnitTests: TestCase {
                 .map { CLLocation(coordinate: $0) }
                 .shiftedToPresent()
 
-            let directions = DirectionsSpy()
-
             let navOptions = NavigationRouteOptions(coordinates: [origin, destination])
             let routeController = RouteController(alongRouteAtIndex: 0,
                                                   in: routeResponse,
                                                   options: navOptions,
-                                                  directions: directions,
                                                   dataSource: self)
 
             let routerDelegateSpy = RouterDelegateSpy()

Tests/MapboxNavigationTests/EndOfRouteFeedbackTests.swift

@@ -16,7 +16,6 @@ final class EndOfRouteFeedbackTests: TestCase {
         let service = MapboxNavigationService(routeResponse: route.response,
                                               routeIndex: 0,
                                               routeOptions: options,
-                                              directions: .mocked,
                                               locationSource: nil,
                                               eventsManagerType: nil,
                                               simulating: .never,