Tileset profile configuration (#3717)

Udumft · web-flow · commit 55e54cb5c3c9 · 2022-02-17T12:13:21.000+03:00
* vk-1248-tiles-dataset: added setting profile identifier to tileset endpoint configuration; exposed properties for it's configuration; added Navigator property; unit test updated; CHANGELOG updated.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -49,6 +49,8 @@
 * Fixed an issue where changes made to `NavigationViewController.showsReportFeedback`, `NavigationViewController.showsSpeedLimits`, `NavigationViewController.detailedFeedbackEnabled`, `NavigationViewController.floatingButtonsPosition` and `NavigationViewController.floatingButtons` before `NavigationViewController` presentation were not saved. ([#3718](https://github.com/mapbox/mapbox-navigation-ios/pull/3718))
 * Fixed an issue where `SpeechSynthesizing.managesAudioSession` was ignored by `RouteVoiceController`. ([#3572](https://github.com/mapbox/mapbox-navigation-ios/pull/3572))
 * Location tracking and routing resources are now freed if no `RouteController` or `PassiveLocationManager` instance is actively being used. ([#3724](https://github.com/mapbox/mapbox-navigation-ios/pull/3724))
+* Added tileset profile configuration for Free Drive, Active Guidance, `MapboRoutingProvider` and Tileset Descriptors API. Now, `RouteOptions.profileIdentifier` is used to determine which type of tiles should be used for navigation. Please make sure to pay attention to `MapboxRoutingProfider` and `TilesetDescriptorFactory` arguments when configuring `ProfileIdentifier`. ([#3717](https://github.com/mapbox/mapbox-navigation-ios/pull/3717))
+* Added an optional `datasetProfileIdentifier` argument to the `MapboxRoutingProvider(_:settings:datasetProfileIdentifier:)`, `PassiveLocationManager(directions:systemLocationManager:eventsManagerType:userInfo:datasetProfileIdentifier:),` `TilesetDescriptorFactory.getSpecificVersion(version:completionQueue:datasetProfileIdentifier:completion:)`, and `TilesetDescriptorFactory.getLatest(completionQueue:datasetProfileIdentifier:completion:)` methods for obtaining routing tiles optimized for a particular mode of transportation. Make sure to configure `MapboxRoutingProvider` and `TilesetDescriptorFactory` with the correct dataset profile if you customize `Directions.profileIdentifier`. ([#3717](https://github.com/mapbox/mapbox-navigation-ios/pull/3717))
 * Fixed an issue where release builds would crash on invalid navigator initialization. ([#3738](https://github.com/mapbox/mapbox-navigation-ios/pull/3738))
 
 ## v2.2.0
diff --git a/Sources/MapboxCoreNavigation/CoreNavigationNavigator.swift b/Sources/MapboxCoreNavigation/CoreNavigationNavigator.swift
@@ -80,6 +80,14 @@ class Navigator {
     // Used in tests to recreate the navigator
     static func _recreateNavigator() { _navigator = nil }
     
+    /**
+     Profile setting, used for selecting tiles type for navigation.
+     
+     This property can only be modified before creating `Navigator` shared instance, all
+     further changes to this property will have no effect. Defaults to `automobile`.
+     */
+    static var datasetProfileIdentifier: ProfileIdentifier = .automobile
+    
     /**
      Restrict direct initializer access.
      */
@@ -88,7 +96,8 @@ class Navigator {
         let factory = NativeHandlersFactory(tileStorePath: tileStorePath ?? "",
                                             credentials: NavigationSettings.shared.directions.credentials,
                                             tilesVersion: Self.tilesVersion,
-                                            historyDirectoryURL: Self.historyDirectoryURL)
+                                            historyDirectoryURL: Self.historyDirectoryURL,
+                                            datasetProfileIdentifier: Self.datasetProfileIdentifier)
         tileStore = factory.tileStore
         historyRecorder = factory.historyRecorder
         cacheHandle = factory.cacheHandle
@@ -114,7 +123,8 @@ class Navigator {
                                             credentials: NavigationSettings.shared.directions.credentials,
                                             tilesVersion: version ?? Self.tilesVersion,
                                             historyDirectoryURL: Self.historyDirectoryURL,
-                                            targetVersion: version.map { _ in Self.tilesVersion })
+                                            targetVersion: version.map { _ in Self.tilesVersion },
+                                            datasetProfileIdentifier: Self.datasetProfileIdentifier)
         tileStore = factory.tileStore
         historyRecorder = factory.historyRecorder
         cacheHandle = factory.cacheHandle
diff --git a/Sources/MapboxCoreNavigation/HandlerFactory.swift b/Sources/MapboxCoreNavigation/HandlerFactory.swift
@@ -8,6 +8,7 @@ protocol HandlerData {
     var historyDirectoryURL: URL? { get }
     var targetVersion: String? { get }
     var configFactoryType: ConfigFactory.Type { get }
+    var datasetProfileIdentifier: ProfileIdentifier { get }
 }
 
 extension NativeHandlersFactory: HandlerData { }
@@ -27,6 +28,7 @@ class HandlerFactory<HandlerType, Arguments> {
         let historyDirectoryURL: URL?
         let targetVersion: String?
         let configFactoryType: ConfigFactory.Type
+        let datasetProfileIdentifier: ProfileIdentifier
         
         init(data: HandlerData) {
             self.tileStorePath = data.tileStorePath
@@ -35,6 +37,7 @@ class HandlerFactory<HandlerType, Arguments> {
             self.historyDirectoryURL = data.historyDirectoryURL
             self.targetVersion = data.targetVersion
             self.configFactoryType = data.configFactoryType
+            self.datasetProfileIdentifier = data.datasetProfileIdentifier
         }
         
         static func != (lhs: CacheKey, rhs: HandlerData) -> Bool {
@@ -43,7 +46,8 @@ class HandlerFactory<HandlerType, Arguments> {
                 lhs.tilesVersion != rhs.tilesVersion ||
                 lhs.historyDirectoryURL?.absoluteString != rhs.historyDirectoryURL?.absoluteString ||
                 lhs.targetVersion != rhs.targetVersion ||
-                lhs.configFactoryType != rhs.configFactoryType
+                lhs.configFactoryType != rhs.configFactoryType ||
+                lhs.datasetProfileIdentifier != rhs.datasetProfileIdentifier
         }
     }
     
diff --git a/Sources/MapboxCoreNavigation/MapboxRoutingProvider.swift b/Sources/MapboxCoreNavigation/MapboxRoutingProvider.swift
@@ -18,19 +18,12 @@ public class MapboxRoutingProvider: RoutingProvider {
      
      - parameter source: routing engine source to use.
      - parameter settings: settings object, used to get credentials and cache configuration.
+     - parameter datasetProfileIdentifier: profile setting, used for selecting tiles type for navigation. If set to `nil` (default) - will detect the same profile as used for current navigation.
      */
-    public init(_ source: Source = .hybrid, settings: NavigationSettings = .shared) {
+    public init(_ source: Source = .hybrid, settings: NavigationSettings = .shared, datasetProfileIdentifier: ProfileIdentifier? = nil) {
         self.source = source
         self.settings = settings
-        
-        let factory = NativeHandlersFactory(tileStorePath: settings.tileStoreConfiguration.navigatorLocation.tileStoreURL?.path ?? "",
-                                            credentials: settings.directions.credentials,
-                                            tilesVersion: Navigator.tilesVersion,
-                                            historyDirectoryURL: Navigator.historyDirectoryURL)
-        self.router = RouterFactory.build(for: source.nativeSource,
-                                             cache: factory.cacheHandle,
-                                             config: factory.configHandle,
-                                             historyRecorder: factory.historyRecorder)
+        self.datasetProfileIdentifier = datasetProfileIdentifier
     }
     
     // MARK: Configuration
@@ -77,6 +70,11 @@ public class MapboxRoutingProvider: RoutingProvider {
     
     private let settings: NavigationSettings
     
+    /**
+     Profile setting, used for selecting tiles type for navigation.
+     */
+    public let datasetProfileIdentifier: ProfileIdentifier?
+    
     static var __testRoutesStub: ((_: RouteOptions, _: @escaping Directions.RouteCompletionHandler) -> Request?)? = nil
     
     // MARK: Performing and Parsing Requests
@@ -119,7 +117,18 @@ public class MapboxRoutingProvider: RoutingProvider {
     public private(set) var activeRequests: [RequestId : Request] = [:]
     
     private let requestsLock = NSLock()
-    private let router: RouterInterfaceNative
+    
+    private lazy var router: RouterInterfaceNative = {
+        let factory = NativeHandlersFactory(tileStorePath: settings.tileStoreConfiguration.navigatorLocation.tileStoreURL?.path ?? "",
+                                            credentials: settings.directions.credentials,
+                                            tilesVersion: Navigator.tilesVersion,
+                                            historyDirectoryURL: Navigator.historyDirectoryURL,
+                                            datasetProfileIdentifier: datasetProfileIdentifier ?? Navigator.datasetProfileIdentifier)
+        return RouterFactory.build(for: source.nativeSource,
+                                      cache: factory.cacheHandle,
+                                      config: factory.configHandle,
+                                      historyRecorder: factory.historyRecorder)
+    } ()
     
     private func complete(requestId: RequestId, with result: @escaping () -> Void) {
         DispatchQueue.main.async { [self] in
diff --git a/Sources/MapboxCoreNavigation/NativeHandlersFactory.swift b/Sources/MapboxCoreNavigation/NativeHandlersFactory.swift
@@ -19,19 +19,22 @@ class NativeHandlersFactory {
     let historyDirectoryURL: URL?
     let targetVersion: String?
     let configFactoryType: ConfigFactory.Type
+    let datasetProfileIdentifier: ProfileIdentifier
     
     init(tileStorePath: String,
          credentials: Credentials,
          tilesVersion: String = "",
          historyDirectoryURL: URL? = nil,
          targetVersion: String? = nil,
-         configFactoryType: ConfigFactory.Type = ConfigFactory.self) {
+         configFactoryType: ConfigFactory.Type = ConfigFactory.self,
+         datasetProfileIdentifier: ProfileIdentifier = ProfileIdentifier.automobile) {
         self.tileStorePath = tileStorePath
         self.credentials = credentials
         self.tilesVersion = tilesVersion
         self.historyDirectoryURL = historyDirectoryURL
         self.targetVersion = targetVersion
         self.configFactoryType = configFactoryType
+        self.datasetProfileIdentifier = datasetProfileIdentifier
     }
     
     // MARK: - Native Handlers
@@ -79,7 +82,8 @@ class NativeHandlersFactory {
         TileEndpointConfiguration(credentials: credentials,
                                   tilesVersion: tilesVersion,
                                   minimumDaysToPersistVersion: nil,
-                                  targetVersion: targetVersion)
+                                  targetVersion: targetVersion,
+                                  datasetProfileIdentifier: datasetProfileIdentifier)
     }()
     
     lazy var tilesConfig: TilesConfig = {
diff --git a/Sources/MapboxCoreNavigation/PassiveLocationManager.swift b/Sources/MapboxCoreNavigation/PassiveLocationManager.swift
@@ -255,13 +255,19 @@ open class PassiveLocationManager: NSObject {
      - parameter systemLocationManager: The system location manager that provides raw locations for the receiver to match against the road network.
      - parameter eventsManagerType: An optional events manager type to use.
      - parameter userInfo: An optional metadata to be provided as initial value of `NavigationEventsManager.userInfo` property.
+     - parameter datasetProfileIdentifier: custom profile setting, used for selecting tiles type for navigation. If set to `nil` - will not modify current profile setting.
      
      - postcondition: Call `startUpdatingLocation()` afterwards to begin receiving location updates.
      */
     public required init(directions: Directions = NavigationSettings.shared.directions,
                          systemLocationManager: NavigationLocationManager? = nil,
                          eventsManagerType: NavigationEventsManager.Type? = nil,
-                         userInfo: [String: String?]? = nil) {
+                         userInfo: [String: String?]? = nil,
+                         datasetProfileIdentifier: ProfileIdentifier? = nil) {
+        if let datasetProfileIdentifier = datasetProfileIdentifier {
+            Navigator.datasetProfileIdentifier = datasetProfileIdentifier
+        }
+        
         self.directions = directions
         
         self.systemLocationManager = systemLocationManager ?? NavigationLocationManager()
@@ -371,15 +377,16 @@ extension TileEndpointConfiguration {
            - parameter tilesVersion: Routing tile version.
            - parameter minimumDaysToPersistVersion: The minimum age in days that a tile version much reach before a new version can be requested from the tile endpoint.
            - parameter targetVersion: Routing tile version, which navigator would like to eventually switch to if it becomes available
+           - parameter datasetProfileIdentifier: profile setting, used for selecting tiles type for navigation.
      */
-    convenience init(credentials: Credentials, tilesVersion: String, minimumDaysToPersistVersion: Int?, targetVersion: String?) {
+    convenience init(credentials: Credentials, tilesVersion: String, minimumDaysToPersistVersion: Int?, targetVersion: String?, datasetProfileIdentifier: ProfileIdentifier) {
         let host = credentials.host.absoluteString
         guard let accessToken = credentials.accessToken, !accessToken.isEmpty else {
             preconditionFailure("No access token specified in Info.plist")
         }
-
+        
         self.init(host: host,
-                  dataset: "mapbox/driving",
+                  dataset: datasetProfileIdentifier.rawValue,
                   version: tilesVersion,
                   token: accessToken,
                   userAgent: URLSession.userAgent,
diff --git a/Sources/MapboxCoreNavigation/RouteController.swift b/Sources/MapboxCoreNavigation/RouteController.swift
@@ -526,21 +526,6 @@ open class RouteController: NSObject {
         }
     }
     
-    func mode(_ profileIdentifier: ProfileIdentifier) -> ActiveGuidanceMode {
-        switch profileIdentifier {
-        case .automobile:
-            return .driving
-        case .automobileAvoidingTraffic:
-            return .driving
-        case .cycling:
-            return .cycling
-        case .walking:
-            return .walking
-        default:
-            return .driving
-        }
-    }
-    
     // MARK: Handling Lifecycle
     
     @available(*, deprecated, renamed: "init(alongRouteAtIndex:in:options:routingProvider:dataSource:)")
@@ -564,6 +549,8 @@ open class RouteController: NSObject {
             os_log("[BUG] Two simultaneous active navigation sessions. This might happen if there are two NavigationViewController or RouteController instances exists at the same time. Profile the app and make sure that NavigationViewController and RouteController is deallocated once not in use.", log: Self.log, type: .fault)
         }
 
+        Navigator.datasetProfileIdentifier = options.profileIdentifier
+        
         self.routingProvider = routingProvider
         self.indexedRouteResponse = .init(routeResponse: routeResponse, routeIndex: routeIndex)
         self.routeProgress = RouteProgress(route: routeResponse.routes![routeIndex], options: options)
diff --git a/Sources/MapboxCoreNavigation/TilesetDescriptorFactory.swift b/Sources/MapboxCoreNavigation/TilesetDescriptorFactory.swift
@@ -9,13 +9,16 @@ extension TilesetDescriptorFactory {
      - Parameters:
        - version: TilesetDescriptor version.
        - completionQueue: A DispatchQueue on which the completion will be called.
+       - datasetProfileIdentifier: Profile setting, used for selecting tiles type for navigation.
        - completion: A completion that will be used to pass the tileset descriptor.
      */
     public class func getSpecificVersion(version: String,
                                          completionQueue: DispatchQueue = .main,
+                                         datasetProfileIdentifier: ProfileIdentifier = .automobile,
                                          completion: @escaping (TilesetDescriptor) -> Void) {
         let factory = NativeHandlersFactory(tileStorePath: NavigationSettings.shared.tileStoreConfiguration.navigatorLocation.tileStoreURL?.path ?? "",
-                                            credentials: NavigationSettings.shared.directions.credentials)
+                                            credentials: NavigationSettings.shared.directions.credentials,
+                                            datasetProfileIdentifier: datasetProfileIdentifier)
         completionQueue.async {
             completion(getSpecificVersion(forCache: factory.cacheHandle, version: version))
         }
@@ -28,12 +31,15 @@ extension TilesetDescriptorFactory {
 
      - Parameters:
        - completionQueue: A DispatchQueue on which the completion will be called.
+       - datasetProfileIdentifier: Profile setting, used for selecting tiles type for navigation.
        - completion: A completion that will be used to pass the latest tileset descriptor.
      */
     public class func getLatest(completionQueue: DispatchQueue = .main,
+                                datasetProfileIdentifier: ProfileIdentifier = .automobile,
                                 completion: @escaping (_ latestTilesetDescriptor: TilesetDescriptor) -> Void) {
         let factory = NativeHandlersFactory(tileStorePath: NavigationSettings.shared.tileStoreConfiguration.navigatorLocation.tileStoreURL?.path ?? "",
-                                            credentials: NavigationSettings.shared.directions.credentials)
+                                            credentials: NavigationSettings.shared.directions.credentials,
+                                            datasetProfileIdentifier: datasetProfileIdentifier)
         completionQueue.async {
             completion(getLatestForCache(factory.cacheHandle))
         }
diff --git a/Tests/MapboxCoreNavigationTests/TilesetDescriptorFactoryTests.swift b/Tests/MapboxCoreNavigationTests/TilesetDescriptorFactoryTests.swift
@@ -18,7 +18,7 @@ final class TilesetDescriptorFactoryTests: TestCase {
         let navigator = Navigator.shared
 
         let tilesetReceived = expectation(description: "Tileset received")
-        TilesetDescriptorFactory.getLatest(completionQueue: .global()) { latestTilesetDescriptor in
+        TilesetDescriptorFactory.getLatest(completionQueue: .global(), datasetProfileIdentifier: MapboxCoreNavigation.Navigator.datasetProfileIdentifier) { latestTilesetDescriptor in
             tilesetReceived.fulfill()
             XCTAssertEqual(latestTilesetDescriptor,
                            TilesetDescriptorFactory.getLatestForCache(Navigator.shared.cacheHandle))
