Use legacy fallback icon for U.S. state road shields first. (#3870)

Author: ShanMa1991

CHANGELOG.md

@@ -20,6 +20,7 @@
 * Fixed an issue where shields disappeared after the application returns to the foreground. ([#3840](https://github.com/mapbox/mapbox-navigation-ios/pull/3840))
 * Fixed an issue where `EndOfRouteCommentView` is using dark style when only light style is allowed. ([#3845](https://github.com/mapbox/mapbox-navigation-ios/pull/3845))
 * Fixed an issue where exit views and generic shields in top banner don't get updated when style changes in active navigation. ([#3864](https://github.com/mapbox/mapbox-navigation-ios/pull/3864))
+* Fixed an issue where the current road name label used a generic white circle instead of the correct shield to represent a state route in the United States. ([#3870](https://github.com/mapbox/mapbox-navigation-ios/pull/3870))
 
 ### CarPlay
 

Sources/MapboxNavigation/InstructionPresenter.swift

@@ -176,31 +176,36 @@ class InstructionPresenter {
                           dataSource: DataSource,
                           onImageDownload: @escaping CompletionHandler) -> NSAttributedString? {
         if let shield = representation.shield {
-            if shield.name == "us-state",
-               let legacyAttributedString = legacyAttributedString(for: representation, in: repository, dataSource: dataSource) {
-                return legacyAttributedString
-            } else if let shieldAttributedString = shieldAttributedString(for: representation, in: repository, dataSource: dataSource) {
+            // For US state road, use the legacy shield first, then fall back to use the generic shield icon.
+            // The shield name for US state road is `circle-white` in Streets source v8 style.
+            // For non US state road, use the generic shield icon first, then fall back to use the legacy shield.
+            if shield.name == "circle-white" {
+                if let legacyIcon = repository.legacyCache.image(forKey: representation.legacyCacheKey) {
+                    return legacyAttributedString(for: legacyIcon, dataSource: dataSource)
+                } else if representation.imageBaseURL != nil {
+                    spriteRepository.updateRepresentation(for: representation, completion: onImageDownload)
+                    return nil
+                }
+            }
+            if let shieldAttributedString = shieldAttributedString(for: representation, in: repository, dataSource: dataSource) {
                 return shieldAttributedString
             }
         }
 
-        if let legacyAttributedString = legacyAttributedString(for: representation, in: repository, dataSource: dataSource) {
-            return legacyAttributedString
+        if let legacyIcon = repository.legacyCache.image(forKey: representation.legacyCacheKey) {
+            return legacyAttributedString(for: legacyIcon, dataSource: dataSource)
         }
 
         // Return nothing in the meantime, triggering downstream behavior (generic shield or text).
         spriteRepository.updateRepresentation(for: representation, completion: onImageDownload)
         return nil
     }
 
-    private func legacyAttributedString(for representation: VisualInstruction.Component.ImageRepresentation,
-                                        in repository: SpriteRepository,
-                                        dataSource: DataSource) -> NSAttributedString? {
-        guard let cachedImage = repository.legacyCache.image(forKey: representation.legacyCacheKey)  else { return nil }
-
+    private func legacyAttributedString(for legacyIcon: UIImage,
+                                        dataSource: DataSource) -> NSAttributedString {
         let attachment = ShieldAttachment()
         attachment.font = dataSource.font
-        attachment.image = cachedImage
+        attachment.image = legacyIcon
         return NSAttributedString(attachment: attachment)
     }
 

Sources/MapboxNavigation/WayNameView.swift

@@ -47,18 +47,14 @@ open class WayNameLabel: StylableLabel {
     // If there's no valid shield image, display the road name only.
     private func setUpWith(roadName: String) {
         if let shield = representation?.shield {
-            // For `us-state` shield, use the legacy shield first, then fall back to use the generic shield icon.
-            // For non `us-state` shield, use the generic shield icon first, then fall back to use the legacy shield.
-            if shield.name == "us-state",
-               setAttributedText(roadName: roadName, cacheKey: representation?.legacyCacheKey) {
-                return
-            } else if setAttributedText(roadName: roadName, shield: shield) {
-                return
-            }
-        }
-        if setAttributedText(roadName: roadName, cacheKey: representation?.legacyCacheKey) {
-            return
+            // For US state road, use the legacy shield first, then fall back to use the generic shield icon.
+            // The shield name for US state road is `circle-white` in Streets source v8 style.
+            // For non US state road, use the generic shield icon first, then fall back to use the legacy shield.
+            if shield.name == "circle-white",
+               setAttributedText(roadName: roadName, cacheKey: representation?.legacyCacheKey) { return }
+            if setAttributedText(roadName: roadName, shield: shield) { return }
         }
+        if setAttributedText(roadName: roadName, cacheKey: representation?.legacyCacheKey) { return }
 
         text = roadName
     }