Display localized road name (#4375)

kried · web-flow · commit 45550b40c96d · 2023-02-21T18:39:36.000+01:00
* Display localized road name

* Update changelog

* Fix code docs for localizedRoadName
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changes to the Mapbox Navigation SDK for iOS
 
+## v2.12.0
+
+### Visual instructions
+* `MapboxRoadNameView` now renders localized road names. ([#4375](https://github.com/mapbox/mapbox-navigation-ios/pull/4375))
+* Added `localizedRoadNameKey` to the user info dictionary of `Notification.Name.passiveLocationManagerDidUpdate` posted by `PassiveLocationManager`, and the `Notification.Name.currentRoadNameDidChange` posted by `RouteController`. The corresponding string value contains localized road name. ([#4375](https://github.com/mapbox/mapbox-navigation-ios/pull/4375))
+
 ## v2.11.0
 
 ### Packaging
diff --git a/MapboxNavigation.xcodeproj/project.pbxproj b/MapboxNavigation.xcodeproj/project.pbxproj
@@ -121,6 +121,7 @@
 		2C9DDBE42934D8FD007F8CFD /* MapboxCoreNavigationIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C58516229252FE20077A558 /* MapboxCoreNavigationIntegrationTests.swift */; };
 		2CAEABD12930D25300DE851A /* MapboxNavigationServiceIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2CAEABD02930D25300DE851A /* MapboxNavigationServiceIntegrationTests.swift */; };
 		2CAEABD32930D87B00DE851A /* RouterSpy.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2CAEABD22930D87B00DE851A /* RouterSpy.swift */; };
+		2CC3043529A3DCDE00A3318F /* NavigationStatusTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2CC3043429A3DCDE00A3318F /* NavigationStatusTests.swift */; };
 		2CDF5C972919628100C41082 /* NavigationLocationManagerSpy.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2CDF5C962919628100C41082 /* NavigationLocationManagerSpy.swift */; };
 		2CE25130291A56D900C0FA15 /* IdleTimerManagerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2CE2512E291A56CE00C0FA15 /* IdleTimerManagerTests.swift */; };
 		2CE89C2B299E6C2A000A2E34 /* InterchangeTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2CE89C2A299E6C2A000A2E34 /* InterchangeTests.swift */; };
@@ -788,6 +789,7 @@
 		2C9DDBE12934C006007F8CFD /* MapboxCoreNavigationTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MapboxCoreNavigationTests.swift; sourceTree = "<group>"; };
 		2CAEABD02930D25300DE851A /* MapboxNavigationServiceIntegrationTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MapboxNavigationServiceIntegrationTests.swift; sourceTree = "<group>"; };
 		2CAEABD22930D87B00DE851A /* RouterSpy.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RouterSpy.swift; sourceTree = "<group>"; };
+		2CC3043429A3DCDE00A3318F /* NavigationStatusTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NavigationStatusTests.swift; sourceTree = "<group>"; };
 		2CDF5C962919628100C41082 /* NavigationLocationManagerSpy.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NavigationLocationManagerSpy.swift; sourceTree = "<group>"; };
 		2CE2512E291A56CE00C0FA15 /* IdleTimerManagerTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IdleTimerManagerTests.swift; sourceTree = "<group>"; };
 		2CE89C2A299E6C2A000A2E34 /* InterchangeTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InterchangeTests.swift; sourceTree = "<group>"; };
@@ -2460,6 +2462,7 @@
 				E2B4B228272A814600FF0F57 /* ReplayLocationManagerTests.swift */,
 				2C2880A0291A82630063E5B7 /* RerouteControllerTests.swift */,
 				2C295AB8299B9E9600FC74E8 /* AccountsTests.swift */,
+				2CC3043429A3DCDE00A3318F /* NavigationStatusTests.swift */,
 			);
 			name = MapboxCoreNavigationTests;
 			path = Tests/MapboxCoreNavigationTests;
@@ -3539,6 +3542,7 @@
 				2C9DDBE32934C457007F8CFD /* RouteControllerTests.swift in Sources */,
 				359574AA1F28CCBB00838209 /* LocationTests.swift in Sources */,
 				E2814D982693412E000AD987 /* BillingHandlerTests.swift in Sources */,
+				2CC3043529A3DCDE00A3318F /* NavigationStatusTests.swift in Sources */,
 				C582BA2C2073E77E00647DAA /* StringTests.swift in Sources */,
 				352762A4225B751A0015B632 /* OptionsTests.swift in Sources */,
 				DA7A97CF26A7613D001B6A9A /* RouteOptionsTests.swift in Sources */,
diff --git a/Sources/MapboxCoreNavigation/CoreConstants.swift b/Sources/MapboxCoreNavigation/CoreConstants.swift
@@ -147,7 +147,9 @@ public extension Notification.Name {
     /**
      Posted when `PassiveLocationManager` receives a user location update representing movement along the expected route.
      
-     The user info dictionary contains the keys `PassiveLocationManager.NotificationUserInfoKey.locationKey`, `PassiveLocationManager.NotificationUserInfoKey.rawLocationKey`, `PassiveLocationManager.NotificationUserInfoKey.matchesKey`,  `PassiveLocationManager.NotificationUserInfoKey.roadNameKey`, `PassiveLocationManager.NotificationUserInfoKey.mapMatchingResultKey` and `PassiveLocationManager.NotificationUserInfoKey.routeShieldRepresentationKey`.
+     The user info dictionary contains the keys `PassiveLocationManager.NotificationUserInfoKey.locationKey`, `PassiveLocationManager.NotificationUserInfoKey.rawLocationKey`, `PassiveLocationManager.NotificationUserInfoKey.matchesKey`,  `PassiveLocationManager.NotificationUserInfoKey.roadNameKey`,
+     `PassiveLocationManager.NotificationUserInfoKey.localizedRoadNameKey`,
+     `PassiveLocationManager.NotificationUserInfoKey.mapMatchingResultKey` and `PassiveLocationManager.NotificationUserInfoKey.routeShieldRepresentationKey`.
      
      - seealso: `routeControllerProgressDidUpdate`
      */
@@ -253,7 +255,8 @@ public extension Notification.Name {
     /**
      Posted when `RouteController` detects the road name.
      
-     The user info dictionary contains the key `RouteController.NotificationUserInfoKey.roadNameKey` and `RouteController.NotificationUserInfoKey.routeShieldRepresentationKey`.
+     The user info dictionary contains the key `RouteController.NotificationUserInfoKey.roadNameKey`,
+     `RouteController.NotificationUserInfoKey.roadNameKey`, and `RouteController.NotificationUserInfoKey.routeShieldRepresentationKey`.
      */
     static let currentRoadNameDidChange: Notification.Name = .init(rawValue: "CurrentRoadNameDidChange")
     
@@ -327,11 +330,16 @@ extension RouteController {
          A key in the user info dictionary of a `Notification.Name.routeControllerProgressDidChange` notification. The corresponding value is a `MapMatchingResult` object representing the map matching state.
          */
         public static let mapMatchingResultKey: NotificationUserInfoKey = .init(rawValue: "mapMatchingResult")
-        
+
         /**
          A key in the user info dictionary of a `Notification.Name.currentRoadNameDidChange` notification. The corresponding value is a `NSString` object representing the current road name.
          */
         public static let roadNameKey: NotificationUserInfoKey = .init(rawValue: "roadName")
+
+        /**
+         A key in the user info dictionary of a `Notification.Name.currentRoadNameDidChange` notification. The corresponding value is a `NSString` object representing the localized current road name.
+         */
+        public static let localizedRoadNameKey: NotificationUserInfoKey = .init(rawValue: "localizedRoadName")
         
         /**
          A key in the user info dictionary of a `Notification.Name.currentRoadNameDidChange` notification. The corresponding value is a `MapboxDirections.VisualInstruction.Component.ImageRepresentation` object representing the road shield the user is currently traveling on.
@@ -429,10 +437,15 @@ extension PassiveLocationManager {
         
         /**
          A key in the user info dictionary of a `Notification.Name.passiveLocationManagerDidUpdate` notification. The corresponding value is a string representing the name of the road the user is currently traveling on.
-         
-         - seealso: `WayNameView`
          */
         public static let roadNameKey: NotificationUserInfoKey = .init(rawValue: "roadName")
+
+        /**
+         A key in the user info dictionary of a `Notification.Name.passiveLocationManagerDidUpdate` notification. The corresponding value is a string representing the full name of the road the user is currently traveling on. It might include road names in the local language and the device language.
+
+         - seealso: `WayNameView`
+         */
+        public static let localizedRoadNameKey: NotificationUserInfoKey = .init(rawValue: "localizedRoadName")
         
         /**
          A key in the user info dictionary of a `Notification.Name.passiveLocationManagerDidUpdate` notification. The corresponding value is a `MapboxDirections.VisualInstruction.Component.ImageRepresentation` object representing the road shield the user is currently traveling on.
diff --git a/Sources/MapboxCoreNavigation/NavigationStatus.swift b/Sources/MapboxCoreNavigation/NavigationStatus.swift
@@ -3,9 +3,18 @@ import MapboxNavigationNative
 import MapboxDirections
 
 extension NavigationStatus {
+    private static let nameDelimeter = "/"
+
     /// Legacy `roadName` property that returns first road name based on the `roads` array.
     var roadName: String {
-        roads.map({ $0.text }).prefix(while: { $0 != "/" }).joined(separator: " ")
+        roads.map({ $0.text }).prefix(while: { $0 != NavigationStatus.nameDelimeter }).joined(separator: " ")
+    }
+
+    /// Returns the localized road name.
+    /// - Parameter locale: The locale that determines the chosen language.
+    /// - Returns: The localized road name.
+    func localizedRoadName(locale: Locale = .nationalizedCurrent) -> String {
+        roads.first { $0.language == locale.languageCode }?.text ?? roadName
     }
     
     // This `routeShieldRepresentation` property returns the image representation of current road shield based on the `roads` array as the `VisualInstruction.Component.ImageRepresentation`.
diff --git a/Sources/MapboxCoreNavigation/PassiveLocationManager.swift b/Sources/MapboxCoreNavigation/PassiveLocationManager.swift
@@ -240,6 +240,7 @@ open class PassiveLocationManager: NSObject {
             .rawLocationKey: rawLocation,
             .matchesKey: matches,
             .roadNameKey: status.roadName,
+            .localizedRoadNameKey: status.localizedRoadName(),
             .routeShieldRepresentationKey: status.routeShieldRepresentation
         ]
         if let speedLimit = speedLimit {
diff --git a/Sources/MapboxCoreNavigation/RouteController.swift b/Sources/MapboxCoreNavigation/RouteController.swift
@@ -467,6 +467,7 @@ open class RouteController: NSObject {
     func updateRoadName(status: NavigationStatus) {
         let userInfo: [NotificationUserInfoKey: Any] = [
             NotificationUserInfoKey.roadNameKey: status.roadName,
+            NotificationUserInfoKey.localizedRoadNameKey: status.localizedRoadName(),
             NotificationUserInfoKey.routeShieldRepresentationKey: status.routeShieldRepresentation
         ]
         NotificationCenter.default.post(name: .currentRoadNameDidChange, object: self, userInfo: userInfo)
diff --git a/Sources/MapboxNavigation/CarPlayMapViewController.swift b/Sources/MapboxNavigation/CarPlayMapViewController.swift
@@ -316,7 +316,7 @@ open class CarPlayMapViewController: UIViewController {
         speedLimitView.signStandard = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.signStandardKey] as? SignStandard
         speedLimitView.speedLimit = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.speedLimitKey] as? Measurement<UnitSpeed>
         
-        let roadNameFromStatus = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.roadNameKey] as? String
+        let roadNameFromStatus = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.localizedRoadNameKey] as? String
         if let roadName = roadNameFromStatus?.nonEmptyString {
             let representation = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.routeShieldRepresentationKey] as? VisualInstruction.Component.ImageRepresentation
             wayNameView.label.updateRoad(roadName: roadName, representation: representation, idiom: .carPlay)
diff --git a/Sources/MapboxNavigation/CarPlayNavigationViewController.swift b/Sources/MapboxNavigation/CarPlayNavigationViewController.swift
@@ -866,7 +866,7 @@ open class CarPlayNavigationViewController: UIViewController, BuildingHighlighti
     }
     
     @objc func didUpdateRoadNameFromStatus(_ notification: Notification) {
-        let roadNameFromStatus = notification.userInfo?[RouteController.NotificationUserInfoKey.roadNameKey] as? String
+        let roadNameFromStatus = notification.userInfo?[RouteController.NotificationUserInfoKey.localizedRoadNameKey] as? String
         if let roadName = roadNameFromStatus?.nonEmptyString {
             let representation = notification.userInfo?[RouteController.NotificationUserInfoKey.routeShieldRepresentationKey] as? VisualInstruction.Component.ImageRepresentation
             wayNameView.label.updateRoad(roadName: roadName, representation: representation, idiom: .carPlay)
diff --git a/Sources/MapboxNavigation/OrnamentsController.swift b/Sources/MapboxNavigation/OrnamentsController.swift
@@ -167,7 +167,7 @@ class OrnamentsController: NavigationComponent, NavigationComponentDelegate {
     var labelRoadNameCompletionHandler: (LabelRoadNameCompletionHandler)?
     
     @objc func didUpdateRoadNameFromStatus(_ notification: Notification) {
-        let roadNameFromStatus = notification.userInfo?[RouteController.NotificationUserInfoKey.roadNameKey] as? String
+        let roadNameFromStatus = notification.userInfo?[RouteController.NotificationUserInfoKey.localizedRoadNameKey] as? String
         if let roadName = roadNameFromStatus?.nonEmptyString {
             let representation = notification.userInfo?[RouteController.NotificationUserInfoKey.routeShieldRepresentationKey] as? VisualInstruction.Component.ImageRepresentation
             navigationView.wayNameView.label.updateRoad(roadName: roadName, representation: representation)
diff --git a/Sources/MapboxNavigation/PreviewViewController.swift b/Sources/MapboxNavigation/PreviewViewController.swift
@@ -211,7 +211,7 @@ public class PreviewViewController: UIViewController {
         navigationView.speedLimitView.speedLimit = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.speedLimitKey] as? Measurement<UnitSpeed>
         
         // Update current road name. In case if road name is not available `WayNameView` is hidden.
-        let roadNameFromStatus = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.roadNameKey] as? String
+        let roadNameFromStatus = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.localizedRoadNameKey] as? String
         if let roadName = roadNameFromStatus?.nonEmptyString {
             let representation = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.routeShieldRepresentationKey] as? VisualInstruction.Component.ImageRepresentation
             navigationView.wayNameView.label.updateRoad(roadName: roadName, representation: representation)
diff --git a/Sources/TestHelper/NavNative/TestNavigationStatusProvider.swift b/Sources/TestHelper/NavNative/TestNavigationStatusProvider.swift
@@ -13,13 +13,15 @@ public final class TestNavigationStatusProvider {
                                               geometryIndex: UInt32 = 0,
                                               shapeIndex: UInt32 = 0,
                                               intersectionIndex: UInt32 = 0,
+                                              roads: [MapboxNavigationNative.RoadName]? = nil,
                                               voiceInstruction: VoiceInstruction? = nil,
                                               bannerInstruction: BannerInstruction? = nil,
                                               speedLimit: SpeedLimit? = nil,
                                               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.RoadName(text: "name", language: "lang", imageBaseUrl: "base_image_url", shield: shield)
+        let roadNames = roads ?? [road]
         let mapMatch = MapMatch(position: .init(edgeId: 0, percentAlong: 0), proba: 42)
         let mapMatcherOutput = MapMatcherOutput(matches: [mapMatch], isTeleport: false)
         return .init(routeState: routeState,
@@ -35,7 +37,7 @@ public final class TestNavigationStatusProvider {
                      geometryIndex: geometryIndex,
                      shapeIndex: shapeIndex,
                      intersectionIndex: intersectionIndex,
-                     roads: [road],
+                     roads: roadNames,
                      voiceInstruction: voiceInstruction,
                      bannerInstruction: bannerInstruction,
                      speedLimit: speedLimit,
diff --git a/Tests/MapboxCoreNavigationTests/NavigationStatusTests.swift b/Tests/MapboxCoreNavigationTests/NavigationStatusTests.swift
@@ -0,0 +1,80 @@
+import XCTest
+import TestHelper
+@testable import MapboxNavigationNative
+@testable import MapboxCoreNavigation
+
+final class NavigationStatusTests: TestCase {
+    var roadNonLocalizedAndShield: MapboxNavigationNative.RoadName!
+    var roadNonLocalized: MapboxNavigationNative.RoadName!
+    var roadDelimeter: MapboxNavigationNative.RoadName!
+    var roadLocalizedRu: MapboxNavigationNative.RoadName!
+    var roadLocalizedRu2: MapboxNavigationNative.RoadName!
+    var roadLocalizedEn: MapboxNavigationNative.RoadName!
+
+
+    override func setUp() {
+        super.setUp()
+
+        let shield = Shield(baseUrl: "shield_url", displayRef: "ref", name: "shield", textColor: "")
+        roadNonLocalizedAndShield = RoadName(text: "name",
+                                             language: "",
+                                             imageBaseUrl: "base_image_url",
+                                             shield: shield)
+        roadNonLocalized = RoadName(text: "name",
+                                    language: "",
+                                    imageBaseUrl: "base_image_url",
+                                    shield: nil)
+        roadDelimeter = RoadName(text: "/",
+                                 language: "",
+                                 imageBaseUrl: nil,
+                                 shield: nil)
+        roadLocalizedRu = RoadName(text: "ru name",
+                                   language: "ru",
+                                   imageBaseUrl: nil,
+                                   shield: nil)
+        roadLocalizedRu2 = RoadName(text: "ru name 2",
+                                    language: "ru",
+                                    imageBaseUrl: nil,
+                                    shield: nil)
+        roadLocalizedEn = RoadName(text: "en name",
+                                   language: "en",
+                                   imageBaseUrl: nil,
+                                   shield: nil)
+    }
+
+    func testReturnRoadName() {
+        let status1 = status(with: [roadNonLocalizedAndShield])
+        XCTAssertEqual(status1.roadName, "name")
+
+        let status2 = status(with: [roadNonLocalizedAndShield, roadLocalizedRu])
+        XCTAssertEqual(status2.roadName, "name ru name")
+
+        let status3 = status(with: [roadNonLocalizedAndShield, roadDelimeter, roadLocalizedRu])
+        XCTAssertEqual(status3.roadName, "name")
+
+        let status4 = status(with: [roadNonLocalizedAndShield, roadLocalizedRu, roadDelimeter, roadLocalizedEn])
+        XCTAssertEqual(status4.roadName, "name ru name")
+
+        let status5 = status(with: [roadNonLocalized])
+        XCTAssertEqual(status5.roadName, "name")
+    }
+
+    func testReturnLocalizedRoadName() {
+        let locale = Locale(identifier: "ru-RU")
+        let status1 = status(with: [roadNonLocalized])
+        XCTAssertEqual(status1.localizedRoadName(locale: locale), "name")
+
+        let status2 = status(with: [roadNonLocalized, roadLocalizedRu, roadLocalizedEn])
+        XCTAssertEqual(status2.localizedRoadName(locale: locale), "ru name")
+
+        let status3 = status(with: [roadLocalizedRu, roadDelimeter, roadLocalizedEn])
+        XCTAssertEqual(status3.localizedRoadName(locale: Locale(identifier: "en-US")), "en name")
+
+        let status4 = status(with: [roadLocalizedRu, roadDelimeter, roadLocalizedEn])
+        XCTAssertEqual(status4.localizedRoadName(locale: Locale(identifier: "it-CH")), status4.roadName)
+    }
+
+    func status(with roads: [MapboxNavigationNative.RoadName]) -> NavigationStatus {
+        TestNavigationStatusProvider.createNavigationStatus(roads: roads)
+    }
+}
diff --git a/Tests/MapboxCoreNavigationTests/PassiveLocationManagerTests.swift b/Tests/MapboxCoreNavigationTests/PassiveLocationManagerTests.swift
diff --git a/Tests/MapboxCoreNavigationTests/RouteControllerTests.swift b/Tests/MapboxCoreNavigationTests/RouteControllerTests.swift

Original file line number	Diff line number	Diff line change
`@@ -240,6 +240,7 @@ open class PassiveLocationManager: NSObject {`
`240`	`240`	`.rawLocationKey: rawLocation,`
`241`	`241`	`.matchesKey: matches,`
`242`	`242`	`.roadNameKey: status.roadName,`
	`243`	`+ .localizedRoadNameKey: status.localizedRoadName(),`
`243`	`244`	`.routeShieldRepresentationKey: status.routeShieldRepresentation`
`244`	`245`	`]`
`245`	`246`	`if let speedLimit = speedLimit {`
Original file line number	Diff line number	Diff line change
`@@ -467,6 +467,7 @@ open class RouteController: NSObject {`
`467`	`467`	`func updateRoadName(status: NavigationStatus) {`
`468`	`468`	`let userInfo: [NotificationUserInfoKey: Any] = [`
`469`	`469`	`NotificationUserInfoKey.roadNameKey: status.roadName,`
	`470`	`+ NotificationUserInfoKey.localizedRoadNameKey: status.localizedRoadName(),`
`470`	`471`	`NotificationUserInfoKey.routeShieldRepresentationKey: status.routeShieldRepresentation`
`471`	`472`	`]`
`472`	`473`	`NotificationCenter.default.post(name: .currentRoadNameDidChange, object: self, userInfo: userInfo)`
Original file line number	Diff line number	Diff line change
`@@ -866,7 +866,7 @@ open class CarPlayNavigationViewController: UIViewController, BuildingHighlighti`
`866`	`866`	`}`
`867`	`867`
`868`	`868`	`@objc func didUpdateRoadNameFromStatus(_ notification: Notification) {`
`869`		`- let roadNameFromStatus = notification.userInfo?[RouteController.NotificationUserInfoKey.roadNameKey] as? String`
	`869`	`+ let roadNameFromStatus = notification.userInfo?[RouteController.NotificationUserInfoKey.localizedRoadNameKey] as? String`
`870`	`870`	`if let roadName = roadNameFromStatus?.nonEmptyString {`
`871`	`871`	`let representation = notification.userInfo?[RouteController.NotificationUserInfoKey.routeShieldRepresentationKey] as? VisualInstruction.Component.ImageRepresentation`
`872`	`872`	`wayNameView.label.updateRoad(roadName: roadName, representation: representation, idiom: .carPlay)`