vk-1024-hybrid-router: CHANGELOG updated.

Author: Udumft

CHANGELOG.md

@@ -182,6 +182,7 @@
 * Removed the `NavigationViewController.origin` property. ([#2808](https://github.com/mapbox/mapbox-navigation-ios/pull/2808))
 * Fixed a potential memory leak when using `MultiplexedSpeechSynthesizer`. ([#3005](https://github.com/mapbox/mapbox-navigation-ios/pull/3005))
 * Fixed a thread-safety issue in `UnimplementedLogging` protocol implementation. ([#3024](https://github.com/mapbox/mapbox-navigation-ios/pull/3024))
+* Replaced `Directions.calculateWithCache(options:completionHandler:)` and `Directions.calculateOffline(options:completionHandler)` functionality with `NavigationRouter`. It is now recommended to use `NavigationRouter` to request or refresh routes instead of `Directions` object. ([#3261](https://github.com/mapbox/mapbox-navigation-ios/pull/3261))
 * Fixed an issue where `UIApplication.shared.isIdleTimerDisabled` was not properly set in some cases. ([#3245](https://github.com/mapbox/mapbox-navigation-ios/pull/3245))
 
 ## v1.4.1

Sources/MapboxCoreNavigation/CacheHandlerFactory.swift

@@ -4,7 +4,7 @@ import MapboxNavigationNative
 protocol CacheHandlerData {
     var tileStorePath: String { get }
     var credentials: DirectionsCredentials { get }
-    var tilesVersion: String? { get }
+    var tilesVersion: String { get }
     var historyDirectoryURL: URL? { get }
     var targetVersion: String? { get }
     var configFactoryType: ConfigFactory.Type { get }
@@ -17,7 +17,7 @@ enum CacheHandlerFactory {
     private struct CacheKey: CacheHandlerData {
         let tileStorePath: String
         let credentials: DirectionsCredentials
-        let tilesVersion: String?
+        let tilesVersion: String
         let historyDirectoryURL: URL?
         let targetVersion: String?
         let configFactoryType: ConfigFactory.Type
@@ -31,12 +31,21 @@ enum CacheHandlerFactory {
             self.configFactoryType = data.configFactoryType
         }
 
+        private static func optionalsAreNotEqual<T: Comparable>(_ lhs: T?, _ rhs: T?) -> Bool{
+            if let firstVal = lhs, let secondVal = rhs {
+                return firstVal != secondVal
+            }
+            else {
+                return lhs != nil || rhs != nil
+           }
+        }
+        
         static func != (lhs: CacheKey, rhs: CacheHandlerData) -> Bool {
             return lhs.tileStorePath != rhs.tileStorePath ||
                 lhs.credentials != rhs.credentials ||
-                lhs.tilesVersion != rhs.tilesVersion ||
-                lhs.historyDirectoryURL != rhs.historyDirectoryURL ||
-                lhs.targetVersion != rhs.targetVersion ||
+                optionalsAreNotEqual(lhs.tilesVersion, rhs.tilesVersion) ||
+                optionalsAreNotEqual(lhs.historyDirectoryURL?.absoluteString, rhs.historyDirectoryURL?.absoluteString) ||
+                optionalsAreNotEqual(lhs.targetVersion, rhs.targetVersion) ||
                 lhs.configFactoryType != rhs.configFactoryType
         }
     }

Sources/MapboxCoreNavigation/NativeHandlersFactory.swift

@@ -14,14 +14,14 @@ class NativeHandlersFactory {
 
     let tileStorePath: String
     let credentials: DirectionsCredentials
-    let tilesVersion: String?
+    let tilesVersion: String
     let historyDirectoryURL: URL?
     let targetVersion: String?
     let configFactoryType: ConfigFactory.Type
 
     init(tileStorePath: String,
          credentials: DirectionsCredentials,
-         tilesVersion: String? = nil,
+         tilesVersion: String = "",
          historyDirectoryURL: URL? = nil,
          targetVersion: String? = nil,
          configFactoryType: ConfigFactory.Type = ConfigFactory.self) {
@@ -71,7 +71,7 @@ class NativeHandlersFactory {
 
     lazy var endpointConfig: TileEndpointConfiguration = {
         TileEndpointConfiguration(credentials: credentials,
-                                  tilesVersion: tilesVersion ?? "",
+                                  tilesVersion: tilesVersion,
                                   minimumDaysToPersistVersion: nil,
                                   targetVersion: targetVersion)
     }()

Sources/MapboxCoreNavigation/NavigationRouter.swift

@@ -33,7 +33,7 @@ public class NavigationRouter {
          Cancels the request if it is still active.
          */
         public func cancel() {
-            router.finish(request: id)
+            router.router.cancelRequest(forToken: id)
         }
     }
 
@@ -208,19 +208,15 @@ public class NavigationRouter {
 
     // MARK: - Private methods
 
-    fileprivate func finish(request id: RequestId) {
-        requestsLock.lock(); defer {
-            requestsLock.unlock()
-        }
-        
-        router.cancelRequest(forToken: id)
-        activeRequests[id] = nil
-    }
-    
     fileprivate func complete(requestId: RequestId, with result: @escaping () -> Void) {
-        DispatchQueue.main.async {
+        DispatchQueue.main.async { [self] in
             result()
-            self.finish(request: requestId)
+            
+            requestsLock.lock(); defer {
+                requestsLock.unlock()
+            }
+            
+            activeRequests[requestId] = nil
         }
     }
 
@@ -286,7 +282,7 @@ public class NavigationRouter {
 
     fileprivate func doRequest<ResponseType: Codable>(options: DirectionsOptions,
                                                       completion: @escaping (Result<ResponseType, DirectionsError>) -> Void) -> RequestId {
-        let directionsUri = settings.directions.url(forCalculating: options).absoluteString
+        let directionsUri = settings.directions.url(forCalculating: options).removingSKU().absoluteString
         var requestId: RequestId!
         requestsLock.lock()
         requestId = router.getRouteForDirectionsUri(directionsUri) { [weak self] (result, _) in
@@ -307,6 +303,28 @@ public class NavigationRouter {
 
 extension DirectionsProfileIdentifier {
     var nativeProfile: RoutingProfile {
-        return RoutingProfile(profile: rawValue)
+        var mode: RoutingMode
+        switch self {
+        case .automobile:
+            mode = .driving
+        case .automobileAvoidingTraffic:
+            mode = .drivingTraffic
+        case .cycling:
+            mode = .cycling
+        case .walking:
+            mode = .walking
+        default:
+            mode = .driving
+        }
+        return RoutingProfile(mode: mode, account: "mapbox")
+    }
+}
+
+extension URL {
+    func removingSKU() -> URL {
+        var urlComponents = URLComponents(string: self.absoluteString)!
+        let filteredItems = urlComponents.queryItems?.filter { $0.name != "sku" }
+        urlComponents.queryItems = filteredItems
+        return urlComponents.url!
     }
 }

Tests/MapboxCoreNavigationTests/RouteControllerTests.swift

@@ -121,25 +121,11 @@ class RouteControllerTests: TestCase {
         }
 
         NavigationRouter.__testRoutesStub = { (options, completionHandler) in
+            DispatchQueue.main.async {
+                completionHandler(Directions.Session(options, .mocked),
+                                  .success(routeResponse))
+            }
             calculateRouteCalled.fulfill()
-            let currentCoordinate = locationManager.location!.coordinate
-            
-            let originWaypoint = Waypoint(coordinate: currentCoordinate)
-            let destinationWaypoint = Waypoint(coordinate: destination)
-            
-            let waypoints = [
-                originWaypoint,
-                destinationWaypoint
-            ]
-            
-            completionHandler(Directions.Session(options, DirectionsCredentials()),
-                              .success(RouteResponse(httpResponse: nil,
-                                                     identifier: nil,
-                                                     routes: [Fixture.route(between: currentCoordinate,
-                                                                            and: destination).route],
-                                                     waypoints: waypoints,
-                                                     options: .route(options),
-                                                     credentials: .mocked)))
             return 0
         }