Merge pull request #4606 from mapbox/chizhavko/update-delegate-method…

…s-for-carplay

Add support for carplay to hide waypoints from route line

.breakage-allowlist

@@ -1,2 +1,6 @@
 Constructor NavigationEventsManager.init(activeNavigationDataSource:passiveNavigationDataSource:accessToken:mobileEventsManager:) has been removed
-Import MapboxMobileEvents has been removed
+Import MapboxMobileEvents has been removed
+Func CarPlayManagerDelegate.carPlayManager(_:waypointCircleLayerWithIdentifier:sourceIdentifier:) has been added as a protocol requirement
+Func CarPlayManagerDelegate.carPlayManager(_:waypointSymbolLayerWithIdentifier:sourceIdentifier:) has been added as a protocol requirement
+Func CarPlayNavigationViewControllerDelegate.carPlayNavigationViewController(_:waypointCircleLayerWithIdentifier:sourceIdentifier:) has been added as a protocol requirement
+Func CarPlayNavigationViewControllerDelegate.carPlayNavigationViewController(_:waypointSymbolLayerWithIdentifier:sourceIdentifier:) has been added as a protocol requirement

CHANGELOG.md

@@ -98,6 +98,7 @@
 
 * Fixed an issue where starting navigation while connected to CarPlay but not having window active resulted in CarPlay view to be stuck at preview screen. ([#4477](https://github.com/mapbox/mapbox-navigation-ios/pull/4477))
 * Fixed an issue where maneuver arrow was not changing color following day/night style automatic toggling. ([#4482](https://github.com/mapbox/mapbox-navigation-ios/pull/4482))
+* Added the ability to configure waypoints via `CarPlayManagerDelegate` object. ([#4482](https://github.com/mapbox/mapbox-navigation-ios/pull/4606))
 
 ### Routing
 * Fixed an issue where `NavigationSettings.tileStoreConfiguration.navigatorLocation.tileStoreURL` was used as a base url for route refresh requests instead of `NavigationSettings.directions.credentials.host`. ([#4483](https://github.com/mapbox/mapbox-navigation-ios/pull/4483))

Sources/MapboxNavigation/CarPlayManager.swift

@@ -1144,6 +1144,17 @@ extension CarPlayManager: CPMapTemplateDelegate {
 // MARK: CarPlayNavigationViewControllerDelegate Methods
 
 extension CarPlayManager: CarPlayNavigationViewControllerDelegate {
+    public func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController, 
+                                                waypointCircleLayerWithIdentifier identifier: String,
+                                                sourceIdentifier: String) -> MapboxMaps.CircleLayer? {
+        delegate?.carPlayManager(self, waypointCircleLayerWithIdentifier: identifier, sourceIdentifier: sourceIdentifier)
+    }
+
+    public func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController, 
+                                                waypointSymbolLayerWithIdentifier identifier: String,
+                                                sourceIdentifier: String) -> SymbolLayer? {
+        delegate?.carPlayManager(self, waypointSymbolLayerWithIdentifier: identifier, sourceIdentifier: sourceIdentifier)
+    }
 
     public func carPlayNavigationViewControllerWillDismiss(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                                            byCanceling canceled: Bool) {

Sources/MapboxNavigation/CarPlayManagerDelegate.swift

@@ -293,6 +293,32 @@ public protocol CarPlayManagerDelegate: AnyObject, UnimplementedLogging, CarPlay
                         to parentViewController: UIViewController,
                         pointAnnotationManager: PointAnnotationManager)
 
+    /**
+     Asks the receiver to return a `SymbolLayer` for waypoint symbols, given an identifier and source.
+     This method is invoked any time waypoints are added or shown.
+
+     - parameter carPlayManager: The `CarPlayManager` object.
+     - parameter identifier: The `SymbolLayer` identifier.
+     - parameter sourceIdentifier: Identifier of the source, which contains the waypoint data that this method would style.
+     - returns: A `SymbolLayer` that the map applies to all waypoint symbols.
+     */
+    func carPlayManager(_ carPlayManager: CarPlayManager,
+                        waypointSymbolLayerWithIdentifier identifier: String,
+                        sourceIdentifier: String) -> SymbolLayer?
+
+    /**
+     Asks the receiver to return a `CircleLayer` for waypoints, given an identifier and source.
+     This method is invoked any time waypoints are added or shown.
+
+     - parameter carPlayManager: The `CarPlayManager` object.
+     - parameter identifier: The `CircleLayer` identifier.
+     - parameter sourceIdentifier: Identifier of the source, which contains the waypoint data that this method would style.
+     - returns: A `CircleLayer` that the map applies to all waypoints.
+     */
+    func carPlayManager(_ carPlayManager: CarPlayManager,
+                        waypointCircleLayerWithIdentifier identifier: String,
+                        sourceIdentifier: String) -> CircleLayer?
+
     // MARK: Transitioning Between Templates
 
     /**
@@ -692,6 +718,26 @@ public extension CarPlayManagerDelegate {
         logUnimplemented(protocolType: CarPlayManagerDelegate.self, level: .debug)
     }
 
+    /**
+     `UnimplementedLogging` prints a warning to standard output the first time this method is called.
+     */
+    func carPlayManager(_ carPlayManager: CarPlayManager,
+                        waypointSymbolLayerWithIdentifier identifier: String,
+                        sourceIdentifier: String) -> SymbolLayer? {
+        logUnimplemented(protocolType: CarPlayManagerDelegate.self, level: .debug)
+        return nil
+    }
+
+    /**
+     `UnimplementedLogging` prints a warning to standard output the first time this method is called.
+     */
+    func carPlayManager(_ carPlayManager: CarPlayManager,
+                        waypointCircleLayerWithIdentifier identifier: String,
+                        sourceIdentifier: String) -> CircleLayer? {
+        logUnimplemented(protocolType: CarPlayManagerDelegate.self, level: .debug)
+        return nil
+    }
+
     /**
      `UnimplementedLogging` prints a warning to standard output the first time this method is called.
      */

Sources/MapboxNavigation/CarPlayNavigationViewController.swift

@@ -1156,6 +1156,22 @@ extension CarPlayNavigationViewController: NavigationServiceDelegate {
 
 extension CarPlayNavigationViewController: NavigationMapViewDelegate {
 
+    public func navigationMapView(_ navigationMapView: NavigationMapView, 
+                                  waypointCircleLayerWithIdentifier identifier: String,
+                                  sourceIdentifier: String) -> CircleLayer? {
+        delegate?.carPlayNavigationViewController(self,
+                                                  waypointCircleLayerWithIdentifier: identifier,
+                                                  sourceIdentifier: sourceIdentifier)
+    }
+
+    public func navigationMapView(_ navigationMapView: NavigationMapView, 
+                                  waypointSymbolLayerWithIdentifier identifier: String,
+                                  sourceIdentifier: String) -> SymbolLayer? {
+        delegate?.carPlayNavigationViewController(self,
+                                                  waypointSymbolLayerWithIdentifier: identifier,
+                                                  sourceIdentifier: sourceIdentifier)
+    }
+
     public func navigationMapView(_ navigationMapView: NavigationMapView,
                                   didAdd finalDestinationAnnotation: PointAnnotation,
                                   pointAnnotationManager: PointAnnotationManager) {

Sources/MapboxNavigation/CarPlayNavigationViewControllerDelegate.swift

@@ -58,7 +58,33 @@ public protocol CarPlayNavigationViewControllerDelegate: AnyObject, Unimplemente
     func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                          routeLineLayerWithIdentifier identifier: String,
                                          sourceIdentifier: String) -> LineLayer?
-
+
+    /**
+     Asks the receiver to return a `SymbolLayer` for waypoint symbols, given an identifier and source.
+     This method is invoked any time waypoints are added or shown.
+
+     - parameter carPlayNavigationViewController: The `CarPlayNavigationViewController` object.
+     - parameter identifier: The `SymbolLayer` identifier.
+     - parameter sourceIdentifier: Identifier of the source, which contains the waypoint data that this method would style.
+     - returns: A `SymbolLayer` that the map applies to all waypoint symbols.
+     */
+    func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
+                                         waypointSymbolLayerWithIdentifier identifier: String,
+                                         sourceIdentifier: String) -> SymbolLayer?
+
+    /**
+     Asks the receiver to return a `CircleLayer` for waypoints, given an identifier and source.
+     This method is invoked any time waypoints are added or shown.
+
+     - parameter carPlayNavigationViewController: The `CarPlayNavigationViewController` object.
+     - parameter identifier: The `CircleLayer` identifier.
+     - parameter sourceIdentifier: Identifier of the source, which contains the waypoint data that this method would style.
+     - returns: A `CircleLayer` that the map applies to all waypoints.
+     */
+    func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
+                                         waypointCircleLayerWithIdentifier identifier: String,
+                                         sourceIdentifier: String) -> CircleLayer?
+
     /**
      Asks the receiver to return a `LineLayer` for the casing layer that surrounds route line,
      given a layer identifier and a source identifier.
@@ -133,7 +159,27 @@ public extension CarPlayNavigationViewControllerDelegate {
                                          pointAnnotationManager: PointAnnotationManager) {
         logUnimplemented(protocolType: CarPlayNavigationViewControllerDelegate.self, level: .debug)
     }
-
+
+    /**
+     `UnimplementedLogging` prints a warning to standard output the first time this method is called.
+     */
+    func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
+                                         waypointSymbolLayerWithIdentifier identifier: String,
+                                         sourceIdentifier: String) -> SymbolLayer? {
+        logUnimplemented(protocolType: CarPlayNavigationViewControllerDelegate.self, level: .debug)
+        return nil
+    }
+
+    /**
+     `UnimplementedLogging` prints a warning to standard output the first time this method is called.
+     */
+    func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
+                                         waypointCircleLayerWithIdentifier identifier: String,
+                                         sourceIdentifier: String) -> CircleLayer? {
+        logUnimplemented(protocolType: CarPlayNavigationViewControllerDelegate.self, level: .debug)
+        return nil
+    }
+
     /**
      `UnimplementedLogging` prints a warning to standard output the first time this method is called.
      */

Tests/MapboxNavigationTests/CarPlayManagerTests.swift

@@ -6,6 +6,7 @@ import CwlPreconditionTesting
 @testable import TestHelper
 @testable import MapboxNavigation
 @testable import MapboxCoreNavigation
+import MapboxMaps
 
 class CarPlayManagerTests: TestCase {
     var carPlayManager: CarPlayManager!
@@ -60,7 +61,23 @@ class CarPlayManagerTests: TestCase {
         simulateCarPlayDisconnection(carPlayManager)
         XCTAssertTrue(eventsManagerSpy.sendCarPlayDisconnectEventCalled)
     }
-
+
+    func testReturnSourceCircleLayer() {
+        let id = "test"
+        let layer = CircleLayer(id: id)
+        delegate.circleLayer = layer
+        let expectedLayerId = delegate.carPlayManager(carPlayManager, waypointCircleLayerWithIdentifier: id, sourceIdentifier: id)?.id
+        XCTAssertEqual(layer.id, expectedLayerId)
+    }
+
+    func testReturnSourceSymbolLayer() {
+        let id = "test"
+        let layer = SymbolLayer(id: id)
+        delegate.symbolLayer = layer
+        let expectedLayerId = delegate.carPlayManager(carPlayManager, waypointSymbolLayerWithIdentifier: id, sourceIdentifier: id)?.id
+        XCTAssertEqual(layer.id, expectedLayerId)
+    }
+
     func testWindowAndIntefaceControllerAreSetUpWithSearchWhenConnected() {
         let searchDelegate = TestCarPlaySearchControllerDelegate()
         let searchButtonHandler: ((CPBarButton) -> Void) = { [weak self] _ in

Tests/MapboxNavigationTests/CarPlayUtils.swift

@@ -4,9 +4,11 @@ import CarPlay
 @testable import MapboxNavigation
 @testable import MapboxCoreNavigation
 @testable import MapboxDirections
+import MapboxMaps
 import CarPlayTestHelper
 import TestHelper
 
+
 func simulateCarPlayConnection(_ carPlayManager: CarPlayManager) {
     let interfaceController = FakeCPInterfaceController(context: #function)
     let window = CPWindow()
@@ -92,6 +94,20 @@ class CarPlayManagerDelegateSpy: CarPlayManagerDelegate {
     var returnedLeadingBarButtons: [CPBarButton]?
     var returnedTrailingBarButtons: [CPBarButton]?
     var returnedMapButtons: [CPMapButton]?
+    var symbolLayer: SymbolLayer?
+    var circleLayer: CircleLayer?
+
+    func carPlayManager(_ carPlayManager: CarPlayManager, 
+                        waypointCircleLayerWithIdentifier identifier: String,
+                        sourceIdentifier: String) -> CircleLayer? {
+        circleLayer
+    }
+
+    func carPlayManager(_ carPlayManager: CarPlayManager, 
+                        waypointSymbolLayerWithIdentifier identifier: String,
+                        sourceIdentifier: String) -> SymbolLayer? {
+        symbolLayer
+    }
 
     func carPlayManager(_ carPlayManager: CarPlayManager,
                         willPreview trip: CPTrip) -> CPTrip {