Fixed ProfileIdentifier comparison for the custom profile identifiers, so that route refresh is enabled for custom automobileAvoidingTraffic profiles. (#4776)

Author: kried

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changes to the Mapbox Navigation SDK for iOS
 
+## v2.18.5
+
+### Packaging
+
+* MapboxCoreNavigation now requires [MapboxDirections v2.14.1](https://github.com/mapbox/mapbox-directions-swift/releases/tag/v2.14.1). ([#4776](https://github.com/mapbox/mapbox-navigation-ios/pull/4776))
+
+### Other changes
+
+* Fixed `ProfileIdentifier` comparison for the custom profile identifiers, so that route refresh is enabled for custom `automobileAvoidingTraffic` profiles.
+
 ## v2.18.4
 
 ### Packaging

Cartfile

@@ -1,3 +1,3 @@
 binary "https://api.mapbox.com/downloads/v2/carthage/mapbox-common/MapboxCommon.json" == 23.9.2
 binary "https://api.mapbox.com/downloads/v2/carthage/mobile-navigation-native/MapboxNavigationNative.xcframework.json" ~> 204.0.1
-github "mapbox/mapbox-directions-swift" ~> 2.12.0
+github "mapbox/mapbox-directions-swift" ~> 2.14.0

Cartfile.resolved

@@ -1,6 +1,6 @@
 binary "https://api.mapbox.com/downloads/v2/carthage/mapbox-common/MapboxCommon.json" "23.9.2"
 binary "https://api.mapbox.com/downloads/v2/carthage/mobile-navigation-native/MapboxNavigationNative.xcframework.json" "204.0.1"
-github "mapbox/mapbox-directions-swift" "v2.12.0"
+github "mapbox/mapbox-directions-swift" "v2.14.1"
 github "mapbox/turf-swift" "v2.8.0"
 github "mattgallagher/CwlPreconditionTesting" "2.2.1"
 github "pointfreeco/swift-snapshot-testing" "1.9.0"

MapboxCoreNavigation.podspec

@@ -45,7 +45,7 @@ Pod::Spec.new do |s|
   s.module_name = "MapboxCoreNavigation"
 
   s.dependency "MapboxNavigationNative", ">= 204.0.1", "< 205.0.0"
-  s.dependency "MapboxDirections", "~> 2.12"
+  s.dependency "MapboxDirections", "~> 2.14"
 
   s.swift_version = "5.5"
 end

MapboxNavigation-SPM.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -22,7 +22,7 @@ let package = Package(
         )
     ],
     dependencies: [
-        .package(name: "MapboxDirections", url: "https://github.com/mapbox/mapbox-directions-swift.git", from: "2.12.0"),
+        .package(name: "MapboxDirections", url: "https://github.com/mapbox/mapbox-directions-swift.git", from: "2.14.1"),
         .package(name: "MapboxNavigationNative", url: "https://github.com/mapbox/mapbox-navigation-native-ios.git", from: "204.0.1"),
         .package(name: "MapboxMaps", url: "https://github.com/mapbox/mapbox-maps-ios.git", from: "10.17.0"),
         .package(name: "Solar", url: "https://github.com/ceeK/Solar.git", from: "3.0.0"),

Package.swift

@@ -272,7 +272,7 @@ open class LegacyRouteController: NSObject, Router, InternalRouter, CLLocationMa
         let options = indexedRouteResponse.validatedRouteOptions
         self.routeProgress = RouteProgress(route: indexedRouteResponse.currentRoute!, options: options)
         self.dataSource = source
-        self.refreshesRoute = options.profileIdentifier == .automobileAvoidingTraffic && options.refreshingEnabled
+        self.refreshesRoute = options.profileIdentifier.isAutomobileAvoidingTraffic && options.refreshingEnabled
         UIDevice.current.isBatteryMonitoringEnabled = true
 
         super.init()

Sources/MapboxCoreNavigation/LegacyRouteController.swift

@@ -462,21 +462,29 @@ public class MapboxRoutingProvider: RoutingProvider {
 }
 
 extension ProfileIdentifier {
-    var nativeProfile: RoutingProfile {
-        var mode: RoutingMode
+    var isCycling: Bool {
+        rawValue.hasSuffix("cycling")
+    }
+
+    var mode: RoutingMode {
         switch self {
-        case .automobile:
-            mode = .driving
-        case .automobileAvoidingTraffic:
-            mode = .drivingTraffic
-        case .cycling:
-            mode = .cycling
-        case .walking:
-            mode = .walking
+        case _ where isAutomobile:
+            return .driving
+        case _ where isAutomobileAvoidingTraffic:
+            return .drivingTraffic
+        case _ where isCycling:
+            return .cycling
+        case _ where isWalking:
+            return .walking
         default:
-            mode = .driving
+            return .driving
         }
-        return RoutingProfile(mode: mode, account: "mapbox")
+    }
+
+    var nativeProfile: RoutingProfile {
+        let accountComponent = rawValue.split(separator: "/").first.map(String.init) ?? ""
+        let account = accountComponent.isEmpty ? "mapbox" : accountComponent
+        return RoutingProfile(mode: mode, account: account)
     }
 }
 

Sources/MapboxCoreNavigation/MapboxRoutingProvider.swift

@@ -26,11 +26,9 @@ open class NavigationRouteOptions: RouteOptions, OptimizedForNavigation {
                    queryItems: queryItems)
         includesAlternativeRoutes = true
         attributeOptions = [.expectedTravelTime, .maximumSpeedLimit]
-        if profileIdentifier == .automobileAvoidingTraffic {
-            attributeOptions.update(with: .numericCongestionLevel)
-        }
         includesExitRoundaboutManeuver = true
-        if profileIdentifier == .automobileAvoidingTraffic {
+        if let profileIdentifier, profileIdentifier.isAutomobileAvoidingTraffic {
+            attributeOptions.update(with: .numericCongestionLevel)
             refreshingEnabled = true
         }
 
@@ -89,11 +87,13 @@ open class NavigationMatchOptions: MatchOptions, OptimizedForNavigation {
                    profileIdentifier: profileIdentifier,
                    queryItems: queryItems)
         attributeOptions = [.expectedTravelTime]
-        if profileIdentifier == .automobileAvoidingTraffic {
-            attributeOptions.update(with: .numericCongestionLevel)
-        }
-        if profileIdentifier == .automobile || profileIdentifier == .automobileAvoidingTraffic {
-            attributeOptions.insert(.maximumSpeedLimit)
+        if let profileIdentifier {
+            if profileIdentifier.isAutomobileAvoidingTraffic {
+                attributeOptions.update(with: .numericCongestionLevel)
+            }
+            if profileIdentifier.isAutomobile || profileIdentifier.isAutomobileAvoidingTraffic {
+                attributeOptions.insert(.maximumSpeedLimit)
+            }
         }
 
         optimizeForNavigation()

Sources/MapboxCoreNavigation/NavigationRouteOptions.swift

@@ -676,7 +676,7 @@ open class RouteController: NSObject {
         let options = indexedRouteResponse.validatedRouteOptions
 
         self.routeProgress = RouteProgress(route: indexedRouteResponse.currentRoute!, options: options)
-        self.refreshesRoute = isRouteOptions && options.profileIdentifier == .automobileAvoidingTraffic && options.refreshingEnabled
+        self.refreshesRoute = isRouteOptions && options.profileIdentifier.isAutomobileAvoidingTraffic && options.refreshingEnabled
 
         super.init()