[CarPlay] Add Delegate Method Before CarPlayNavigationViewController Presented (#4379)

* Add delegate method for accessing navigation vc before presenting

This allows the end user to modify the view before it is visible, for setting up UI elements such as the user location style

* Addstest for willPresentNavigationViewController delegate method

* CHANGELOG updated; accepted breaking changes

---------

Co-authored-by: Jack Moseley <[email protected]>

Author: Udumft

.breakage-allowlist

@@ -0,0 +1 @@
+Func CarPlayManagerDelegate.carPlayManager(_:willPresent:) has been added as a protocol requirement

CHANGELOG.md

@@ -25,6 +25,7 @@
 * Added the ability to pan a map view on CarPlay. ([#4288](https://github.com/mapbox/mapbox-navigation-ios/pull/4288))
 * Added a new configuration property `CarPlayManager.startFreeDriveAutomatically` that controls whether `CarPlayManager` starts a Free Drive session automatically on map load. If you set this property to false, you can start a Free Drive session using `CarPlayMapViewController.startFreeDriveNavigation()` method. ([#4352](https://github.com/mapbox/mapbox-navigation-ios/pull/4352))
 * Added new `CarPlayManagerDelegate` methods `carPlayManager(_:didBeginPanGesture:)`, `carPlayManager(_:didEndPanGesture:)`, `carPlayManager(_:didShowPanningInterface:)`, `carPlayManager(_:willDismissPanningInterface:)`, and `carPlayManager(_:didDismissPanningInterface:)` to notify about pan gesture events. ([#4368](https://github.com/mapbox/mapbox-navigation-ios/pull/4368))
+* Added `CarPlayManagerDelegate.carPlayManager(_:willPresent:)` method to allow developers to query or customize properties of the `CarPlayNavigationViewController` before it is presented. ([#4376](https://github.com/mapbox/mapbox-navigation-ios/pull/4376))
 
 ### Electronic horizon
 

Sources/MapboxNavigation/CarPlayManager.swift

@@ -809,6 +809,9 @@ extension CarPlayManager: CPMapTemplateDelegate {
         carPlayNavigationViewController.delegate = self
         carPlayNavigationViewController.modalPresentationStyle = .fullScreen
         self.carPlayNavigationViewController = carPlayNavigationViewController
+        
+        carPlayNavigationViewController.loadViewIfNeeded()
+        delegate?.carPlayManager(self, willPresent: carPlayNavigationViewController)
 
         carPlayMapViewController.present(carPlayNavigationViewController, animated: true) { [weak self] in
             guard let self = self else { return }

Sources/MapboxNavigation/CarPlayManagerDelegate.swift

@@ -235,6 +235,21 @@ public protocol CarPlayManagerDelegate: AnyObject, UnimplementedLogging, CarPlay
      and enable when disconnected.
      */
     func carPlayManagerShouldDisableIdleTimer(_ carPlayManager: CarPlayManager) -> Bool
+    
+    /**
+     Called when the CarPlayManager creates a new CarPlayNavigationViewController upon start of a
+     navigation session.
+     
+     Implementing this method will allow developers to query or customize properties of the
+     CarPlayNavigationViewController before it is presented. For example, a developer may wish to perform custom map styling
+     on the presented NavigationMapView.
+     
+     - parameter carPlayManager: The CarPlay manager instance.
+     - parameter navigationViewController: The CarPlayNavigationViewController that will be presented
+     on the CarPlay display.
+     */
+    func carPlayManager(_ carPlayManager: CarPlayManager,
+                        willPresent navigationViewController: CarPlayNavigationViewController)
 
     /**
      Called when the CarPlayManager presents a new CarPlayNavigationViewController upon start of a
@@ -628,6 +643,14 @@ public extension CarPlayManagerDelegate {
         logUnimplemented(protocolType: CarPlayManagerDelegate.self, level: .debug)
         return true
     }
+    
+    /**
+     `UnimplementedLogging` prints a warning to standard output the first time this method is called.
+     */
+    func carPlayManager(_ carPlayManager: CarPlayManager,
+                        willPresent navigationViewController: CarPlayNavigationViewController) {
+        logUnimplemented(protocolType: CarPlayManagerDelegate.self, level: .debug)
+    }
 
     /**
      `UnimplementedLogging` prints a warning to standard output the first time this method is called.

Tests/MapboxNavigationTests/CarPlayManagerTests.swift

@@ -224,6 +224,13 @@ class CarPlayManagerTests: TestCase {
         XCTAssertEqual(mapTemplateSpy.passedTripPreviews?.first, customTrip)
         XCTAssertEqual(mapTemplateSpy.passedPreviewTextConfiguration?.startButtonTitle, startButtonTitle)
     }
+    
+    func testWillPresentNavigationViewController() {
+        startNavigation()
+        
+        XCTAssertTrue(delegate.willPresentCalled)
+        XCTAssertEqual(delegate.passedWillPresentNavigationViewController, carPlayManager.carPlayNavigationViewController)
+    }
 
     func testStartWhenConfiguredToSimulate() {
         carPlayManager.simulatesLocations = true

Tests/MapboxNavigationTests/CarPlayUtils.swift

@@ -72,6 +72,7 @@ class CarPlayManagerDelegateSpy: CarPlayManagerDelegate {
     var didBeginNavigationCalled = false
     var didEndNavigationCalled = false
     var legacyDidEndNavigationCalled = false
+    var willPresentCalled = false
     var didPresentCalled = false
     var didFailToFetchRouteCalled = false
     var didBeginPanGestureCalled = false
@@ -84,6 +85,7 @@ class CarPlayManagerDelegateSpy: CarPlayManagerDelegate {
     var passedError: DirectionsError?
     var passedTemplate: CPMapTemplate?
     var passedNavigationEndedByCanceling = false
+    var passedWillPresentNavigationViewController: CarPlayNavigationViewController?
 
     var returnedTripPreviewTextConfiguration: CPTripPreviewTextConfiguration?
     var returnedTrip: CPTrip?
@@ -118,6 +120,11 @@ class CarPlayManagerDelegateSpy: CarPlayManagerDelegate {
         XCTAssertTrue(didBeginNavigationCalled)
         legacyDidEndNavigationCalled = true
     }
+    
+    func carPlayManager(_ carPlayManager: CarPlayManager, willPresent navigationViewController: CarPlayNavigationViewController) {
+        willPresentCalled = true
+        passedWillPresentNavigationViewController = navigationViewController
+    }
 
     func carPlayManager(_ carPlayManager: CarPlayManager, didPresent navigationViewController: CarPlayNavigationViewController) {
         didPresentCalled = true