Add the ability to show guidance view images on CarPlay. (#4324)

Author: MaximAlien

CHANGELOG.md

@@ -45,6 +45,10 @@
 
 * Fixed a rare crash that could happen during route simulation. ([#4153](https://github.com/mapbox/mapbox-navigation-ios/pull/4153))
 
+### CarPlay
+
+* Added the ability to display a junction image for the maneuver on CarPlay. ([#4324](https://github.com/mapbox/mapbox-navigation-ios/pull/4324))
+
 ### Other changes
 
 * Fixed potential issue when rerouting and route refreshing happen simultaneously which could lead to old route restoration or even a crash. ([#4238](https://github.com/mapbox/mapbox-navigation-ios/pull/4238))

Example/ViewController+FreeDrive.swift

@@ -153,6 +153,7 @@ extension ViewController {
     }
 
     func edgeNames(identifier: RoadGraph.Edge.Identifier) -> [String] {
+        if navigationMapView == nil { return [] }
         let passiveLocationManager = (navigationMapView.mapView.location.locationProvider as? PassiveLocationProvider)?.locationManager
         guard let metadata = passiveLocationManager?.roadGraph.edgeMetadata(edgeIdentifier: identifier) else {
             return []

Sources/MapboxNavigation/CarPlayNavigationViewController.swift

@@ -916,6 +916,10 @@ open class CarPlayNavigationViewController: UIViewController, BuildingHighlighti
             primaryManeuver.symbolSet = visualInstruction.primaryInstruction.maneuverImageSet(side: visualInstruction.drivingSide)
         }
 
+        let junctionImage = guidanceViewManeuverRepresentation(for: visualInstruction,
+                                                               navigationService: navigationService)
+        primaryManeuver.junctionImage = junctionImage
+        
         // Estimating the width of Apple's maneuver view
         let bounds: () -> (CGRect) = {
             let widthOfManeuverView = min(self.view.bounds.width - self.view.safeArea.left,
@@ -1006,6 +1010,42 @@ open class CarPlayNavigationViewController: UIViewController, BuildingHighlighti
         carSession.upcomingManeuvers = maneuvers
     }
 
+    /**
+     Returns guidance view image representation if it's present in the current visual instruction.
+     Since CarPlay doesn't support asynchronous maneuvers update, in case if guidance view image is
+     not present in cache - download guidance image first and after that trigger maneuvers update.
+     In case if image is present in cache - update primary maneuver right away.
+     */
+    func guidanceViewManeuverRepresentation(for visualInstruction: VisualInstructionBanner?,
+                                            navigationService: NavigationService) -> UIImage? {
+        guard let quaternaryInstruction = visualInstruction?.quaternaryInstruction,
+              let guidanceView = quaternaryInstruction.components.first,
+              let cacheKey = guidanceView.cacheKey else {
+            return nil
+        }
+        
+        if let cachedImage = ImageRepository.shared.cachedImageForKey(cacheKey) {
+            return cachedImage
+        } else {
+            guard case let .guidanceView(guidanceViewImageRepresentation, _, _) = guidanceView,
+                  let guidanceImageURL = guidanceViewImageRepresentation.imageURL,
+                  let accessToken = navigationService.credentials.accessToken,
+                  let guidanceViewImageURL = URL(string: guidanceImageURL.absoluteString + "&access_token=" + accessToken) else {
+                return nil
+            }
+            
+            ImageRepository.shared.imageWithURL(guidanceViewImageURL,
+                                                cacheKey: cacheKey) { [weak self] _ in
+                DispatchQueue.main.async {
+                    guard let self = self else { return }
+                    self.updateManeuvers(navigationService.routeProgress)
+                }
+            }
+            
+            return nil
+        }
+    }
+    
     func presentWaypointArrivalUI(for waypoint: Waypoint) {
         var title = NSLocalizedString("CARPLAY_ARRIVED",
                                       bundle: .mapboxNavigation,