Update NavNative to 124.0

S2Ler · kried · commit dd3187e26bb2 · 2023-01-26T14:39:55.000+01:00
NavNative breaking changes in RoadName structure required adaptation
on SDK side. As part of this: RoadName and Shield was updated to match
native side.
diff --git a/.breakage-allowlist b/.breakage-allowlist
@@ -1,2 +1,5 @@
 Func CarPlayManagerDelegate.carPlayManagerDidCancelPreview(_:) has been added as a protocol requirement
-Constructor MapboxNavigationService.init(history:customRoutingProvider:credentials:eventsManagerType:routerType:customActivityType:) has been removed
+Constructor MapboxNavigationService.init(history:customRoutingProvider:credentials:eventsManagerType:routerType:customActivityType:) has been removed
+EnumElement RoadName.name has been removed
+EnumElement RoadName.code has been removed
+Enum RoadName has been changed to a Struct
diff --git a/Cartfile b/Cartfile
@@ -1,4 +1,4 @@
-binary "https://api.mapbox.com/downloads/v2/carthage/mapbox-common/MapboxCommon.json" ~> 23.2.1
-binary "https://api.mapbox.com/downloads/v2/carthage/mobile-navigation-native/MapboxNavigationNative.xcframework.json" ~> 123.1.0
+binary "https://api.mapbox.com/downloads/v2/carthage/mapbox-common/MapboxCommon.json" == 23.3.0-beta.1
+binary "https://api.mapbox.com/downloads/v2/carthage/mobile-navigation-native/MapboxNavigationNative.xcframework.json" ~> 124.0.0
 github "mapbox/mapbox-directions-swift" == 2.9.0-rc.2
 github "mapbox/mapbox-events-ios" ~> 1.0.0
diff --git a/Cartfile.resolved b/Cartfile.resolved
@@ -1,5 +1,5 @@
-binary "https://api.mapbox.com/downloads/v2/carthage/mapbox-common/MapboxCommon.json" "23.2.1"
-binary "https://api.mapbox.com/downloads/v2/carthage/mobile-navigation-native/MapboxNavigationNative.xcframework.json" "123.1.0"
+binary "https://api.mapbox.com/downloads/v2/carthage/mapbox-common/MapboxCommon.json" "23.3.0-beta.1"
+binary "https://api.mapbox.com/downloads/v2/carthage/mobile-navigation-native/MapboxNavigationNative.xcframework.json" "124.0.0"
 github "mapbox/mapbox-directions-swift" "v2.9.0-rc.2"
 github "mapbox/mapbox-events-ios" "v1.0.10"
 github "mapbox/turf-swift" "v2.6.1"
diff --git a/Example/ViewController+FreeDrive.swift b/Example/ViewController+FreeDrive.swift
@@ -158,14 +158,7 @@ extension ViewController {
         guard let metadata = passiveLocationManager?.roadGraph.edgeMetadata(edgeIdentifier: identifier) else {
             return []
         }
-        let names = metadata.names.map { name -> String in
-            switch name {
-            case .name(let name):
-                return name
-            case .code(let code):
-                return "(\(code))"
-            }
-        }
+        let names = metadata.names.map(\.text)
         
         // If the road is unnamed, fall back to the road class.
         if names.isEmpty {
diff --git a/MapboxCoreNavigation.podspec b/MapboxCoreNavigation.podspec
@@ -44,7 +44,7 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.module_name = "MapboxCoreNavigation"
 
-  s.dependency "MapboxNavigationNative", "~> 123.1"
+  s.dependency "MapboxNavigationNative", "~> 124.0"
   s.dependency "MapboxDirections-pre", "2.9.0-rc.2"
   s.dependency "MapboxMobileEvents", "~> 1.0"
 
diff --git a/MapboxNavigation-SPM.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/MapboxNavigation-SPM.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
diff --git a/MapboxNavigation.podspec b/MapboxNavigation.podspec
@@ -44,7 +44,7 @@ Pod::Spec.new do |s|
   s.module_name = "MapboxNavigation"
 
   s.dependency "MapboxCoreNavigation", "#{s.version.to_s}"
-  s.dependency "MapboxMaps", "~> 10.10"
+  s.dependency "MapboxMaps", "10.11.0-beta.1"
   s.dependency "Solar-dev", "~> 3.0"
   s.dependency "MapboxSpeech", "~> 2.0"
   s.dependency "MapboxMobileEvents", "~> 1.0"
diff --git a/MapboxNavigation.xcodeproj/project.pbxproj b/MapboxNavigation.xcodeproj/project.pbxproj
@@ -225,6 +225,7 @@
 		5A1C075824BDEB44000A6330 /* PassiveLocationProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5A1C075724BDEB44000A6330 /* PassiveLocationProvider.swift */; };
 		5A39B9282498F9890026DFD1 /* PassiveLocationManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5A39B9272498F9890026DFD1 /* PassiveLocationManager.swift */; };
 		5A43FC8B24B488DC00BF7943 /* PassiveLocationManagerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5A43FC8A24B488DC00BF7943 /* PassiveLocationManagerTests.swift */; };
+		7E6CAE392976B346001D749D /* RoadShield.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7E6CAE382976B346001D749D /* RoadShield.swift */; };
 		8A0155E828F8EC72009E299C /* BannerPresentationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A0155E728F8EC72009E299C /* BannerPresentationTests.swift */; };
 		8A0155EA28F8EC85009E299C /* StackTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A0155E928F8EC85009E299C /* StackTests.swift */; };
 		8A0155EC28F8ED38009E299C /* PreviewViewControllerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A0155EB28F8ED38009E299C /* PreviewViewControllerTests.swift */; };
@@ -897,6 +898,7 @@
 		5A1C075724BDEB44000A6330 /* PassiveLocationProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PassiveLocationProvider.swift; sourceTree = "<group>"; };
 		5A39B9272498F9890026DFD1 /* PassiveLocationManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PassiveLocationManager.swift; sourceTree = "<group>"; };
 		5A43FC8A24B488DC00BF7943 /* PassiveLocationManagerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PassiveLocationManagerTests.swift; sourceTree = "<group>"; };
+		7E6CAE382976B346001D749D /* RoadShield.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = RoadShield.swift; sourceTree = "<group>"; };
 		8A0155E728F8EC72009E299C /* BannerPresentationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BannerPresentationTests.swift; sourceTree = "<group>"; };
 		8A0155E928F8EC85009E299C /* StackTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StackTests.swift; sourceTree = "<group>"; };
 		8A0155EB28F8ED38009E299C /* PreviewViewControllerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PreviewViewControllerTests.swift; sourceTree = "<group>"; };
@@ -2465,6 +2467,7 @@
 				DA5F44F325F07D3A00F573EC /* RoadObjectStoreDelegate.swift */,
 				DA5F44F425F07D3B00F573EC /* RoadObjectStore.swift */,
 				414119FE26C5269A00402B5D /* RoadSubgraphEdge.swift */,
+				7E6CAE382976B346001D749D /* RoadShield.swift */,
 			);
 			path = EHorizon;
 			sourceTree = "<group>";
@@ -3382,6 +3385,7 @@
 				353E68FC1EF0B7F8007B2AE5 /* NavigationLocationManager.swift in Sources */,
 				2BE7013D25359C7B00F46E4E /* RouteAlert.swift in Sources */,
 				2C04E467290A8C6B0067FDCF /* PredictiveCacheNavigationOptions.swift in Sources */,
+				7E6CAE392976B346001D749D /* RoadShield.swift in Sources */,
 				2B2DC69928F479DE0019232C /* HistoryEvent.swift in Sources */,
 				353E68FE1EF0B985007B2AE5 /* BundleAdditions.swift in Sources */,
 				2EFAE005264C1F9200B618C4 /* RoadObjectLocation.swift in Sources */,
diff --git a/Package.resolved b/Package.resolved
diff --git a/Package.swift b/Package.swift
@@ -24,8 +24,8 @@ let package = Package(
     dependencies: [
         .package(name: "MapboxDirections", url: "https://github.com/mapbox/mapbox-directions-swift.git", .exact("2.9.0-rc.2")),
         .package(name: "MapboxMobileEvents", url: "https://github.com/mapbox/mapbox-events-ios.git", from: "1.0.0"),
-        .package(name: "MapboxNavigationNative", url: "https://github.com/mapbox/mapbox-navigation-native-ios.git", from: "123.1.0"),
-        .package(name: "MapboxMaps", url: "https://github.com/mapbox/mapbox-maps-ios.git", from: "10.10.1"),
+        .package(name: "MapboxNavigationNative", url: "https://github.com/mapbox/mapbox-navigation-native-ios.git", from: "124.0.0"),
+        .package(name: "MapboxMaps", url: "https://github.com/mapbox/mapbox-maps-ios.git", .exact("10.11.0-beta.1")),
         .package(name: "Solar", url: "https://github.com/ceeK/Solar.git", from: "3.0.0"),
         .package(name: "MapboxSpeech", url: "https://github.com/mapbox/mapbox-speech-swift.git", from: "2.0.0"),
         .package(name: "CwlPreconditionTesting", url: "https://github.com/mattgallagher/CwlPreconditionTesting.git", from: "2.1.0"),
diff --git a/Sources/MapboxCoreNavigation/EHorizon/RoadGraphEdgeMetadata.swift b/Sources/MapboxCoreNavigation/EHorizon/RoadGraphEdgeMetadata.swift
@@ -160,7 +160,7 @@ extension RoadGraph.Edge {
             self.roadClasses = roadClasses
             
             isBridge = native.isBridge
-            names = native.names.map(RoadName.init)
+            names = native.names.compactMap(RoadName.init)
             laneCount = native.laneCount as? UInt
             altitude = native.meanElevation as? Double
             curvature = UInt(native.curvature)
diff --git a/Sources/MapboxCoreNavigation/EHorizon/RoadName.swift b/Sources/MapboxCoreNavigation/EHorizon/RoadName.swift
@@ -1,31 +1,42 @@
 import Foundation
 import MapboxNavigationNative
 
-/**
- A human-readable name or route reference code that identifies a road.
- 
- - note: The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of the level of use of the feature.
- */
-public enum RoadName {
-    /**
-     A road name.
-     
-     If you display a name to the user, you may need to abbreviate common words like “East” or “Boulevard” to ensure that it fits in the allotted space.
-     */
-    case name(_ name: String)
-    
-    /**
-     A route reference code assigned to a road.
-     
-     A route reference code commonly consists of an alphabetic network code, a space or hyphen, and a route number. You should not assume that the network code is globally unique: for example, a network code of “NH” may indicate a “National Highway” or “New Hampshire”. Moreover, a route number may not even uniquely identify a route within a given network.
-     */
-    case code(_ code: String)
+/// Road information, like Route number, street name, shield information, etc.
+///
+/// - note: The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta
+/// and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions
+/// in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at
+/// any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of
+/// the level of use of the feature.
+public struct RoadName: Equatable {
+    /// The name of the road.
+    ///
+    /// If you display a name to the user, you may need to abbreviate common words like “East” or “Boulevard” to ensure
+    /// that it fits in the allotted space.
+    public let text: String
 
-    init(_ native: MapboxNavigationNative.RoadName) {
-        if native.isShielded {
-            self = .code(native.name)
-        } else {
-            self = .name(native.name)
-        }
+    /// 2 letters language code or "Unspecified" or empty string
+    public let language: String
+
+    /// Shield information of the road
+    public let shield: RoadShield?
+
+    /// Creates a new `RoadName` instance.
+    /// - Parameters:
+    ///   - text: The name of the road.
+    ///   - language: 2 letters language code or "Unspecified" or empty string
+    ///   - shield: Shield information of the road
+    public init(text: String, language: String, shield: RoadShield? = nil) {
+        self.text = text
+        self.language = language
+        self.shield = shield
+    }
+
+    init?(_ native: MapboxNavigationNative.RoadName) {
+        guard native.text != "/" else { return nil }
+
+        self.shield = native.shield.map(RoadShield.init)
+        self.text = native.text
+        self.language = native.language
     }
 }
diff --git a/Sources/MapboxCoreNavigation/EHorizon/RoadShield.swift b/Sources/MapboxCoreNavigation/EHorizon/RoadShield.swift
@@ -0,0 +1,42 @@
+import MapboxNavigationNative
+
+/// Describes a road shield information.
+///
+/// - note: The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta
+/// and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions
+/// in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at
+/// any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of
+/// the level of use of the feature.
+public struct RoadShield: Equatable {
+    /// The base url for a shield image.
+    public let baseUrl: String
+
+    /// The shield display reference.
+    public let displayRef: String
+
+    /// The shield text.
+    public let name: String
+
+    /// The shield text color.
+    public let textColor: String
+
+    /// Creates a new `Shield` instance.
+    /// - Parameters:
+    ///   - baseUrl: The base url for a shield image.
+    ///   - displayRef: The shield display reference.
+    ///   - name: The shield text.
+    ///   - textColor: The shield text color.
+    public init(baseUrl: String, displayRef: String, name: String, textColor: String) {
+        self.baseUrl = baseUrl
+        self.displayRef = displayRef
+        self.name = name
+        self.textColor = textColor
+    }
+
+    init(_ native: MapboxNavigationNative.Shield) {
+        self.baseUrl = native.baseUrl
+        self.name = native.name
+        self.displayRef = native.displayRef
+        self.textColor = native.textColor
+    }
+}
diff --git a/Sources/TestHelper/NavNative/TestNavigationStatusProvider.swift b/Sources/TestHelper/NavNative/TestNavigationStatusProvider.swift
@@ -19,7 +19,7 @@ public final class TestNavigationStatusProvider {
                                               activeGuidanceInfo: ActiveGuidanceInfo? = nil) -> NavigationStatus {
         let fixLocation = FixLocation(location ?? CLLocation(latitude: 37.788443, longitude: -122.4020258))
         let shield = Shield(baseUrl: "shield_url", displayRef: "ref", name: "shield", textColor: "")
-        let road = MapboxNavigationNative.Road(text: "name", imageBaseUrl: "base_image_url", shield: shield)
+        let road = MapboxNavigationNative.RoadName(text: "name", language: "lang", imageBaseUrl: "base_image_url", shield: shield)
         let mapMatch = MapMatch(position: .init(edgeId: 0, percentAlong: 0), proba: 42)
         let mapMatcherOutput = MapMatcherOutput(matches: [mapMatch], isTeleport: false)
         return .init(routeState: routeState,
diff --git a/Tests/CocoaPodsTest/PodInstall/Podfile.lock b/Tests/CocoaPodsTest/PodInstall/Podfile.lock
@@ -5,13 +5,13 @@ PODS:
   - MapboxCoreNavigation (2.11.0-alpha.1):
     - MapboxDirections-pre (= 2.9.0-rc.2)
     - MapboxMobileEvents (~> 1.0)
-    - MapboxNavigationNative (~> 123.1)
+    - MapboxNavigationNative (~> 124.0)
   - MapboxDirections-pre (2.9.0-rc.2):
     - Polyline (~> 5.0)
     - Turf (~> 2.6.1)
-  - MapboxMaps (10.10.1):
-    - MapboxCommon (= 23.2.1)
-    - MapboxCoreMaps (= 10.10.0)
+  - MapboxMaps (10.11.0-beta.1):
+    - MapboxCommon (= 23.3.0-beta.1)
+    - MapboxCoreMaps (= 10.11.0-beta.1)
     - MapboxMobileEvents (= 1.0.10)
     - Turf (~> 2.0)
   - MapboxMobileEvents (1.0.10)
@@ -56,7 +56,7 @@ SPEC CHECKSUMS:
   MapboxCoreMaps: 4075a9e415b9b3ab6229d09623fef5f791826a5b
   MapboxCoreNavigation: f0d375dd649f6c2703d84b0b0a42412dacea9985
   MapboxDirections-pre: 140113d2251ca97dac655b5244f857f1eafd562e
-  MapboxMaps: 0c2f7722016bc56aa27b5e6bcf72ae4df7a98670
+  MapboxMaps: fcf19ee46a2dbf1b39a8c205f6cd045f4a83a213
   MapboxMobileEvents: de50b3a4de180dd129c326e09cd12c8adaaa46d6
   MapboxNavigation: 91ef8a89c412700e0ce51e3d7a42c8989033ddfb
   MapboxNavigationNative: c653ab9ec695989dc948f96d4cb6a554c9c86f96
