Logging functionality for CarPlay #3653
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ import CarPlay | |
| import MapboxCoreNavigation | ||
| import MapboxDirections | ||
| import MapboxMaps | ||
| import os.log | ||
|
|
||
| /** | ||
| `CarPlayManager` is the main object responsible for orchestrating interactions with a Mapbox map on CarPlay. | ||
|
|
@@ -77,6 +78,7 @@ public class CarPlayManager: NSObject { | |
|
|
||
| private weak var navigationService: NavigationService? | ||
| private var idleTimerCancellable: IdleTimerManager.Cancellable? | ||
| private let logger: OSLog = .init(subsystem: "com.mapbox.navigation", category: "CarPlayManager") | ||
|
There was a problem hiding this comment. Should we add a factory for loggers? So that we don't duplicate There was a problem hiding this comment. Or we can go with a simpler way: creating an internal constant for the log subsystem. There was a problem hiding this comment. We could use something like |
||
|
|
||
| /** | ||
| Programatically begins a CarPlay turn-by-turn navigation session. | ||
|
|
@@ -93,6 +95,7 @@ public class CarPlayManager: NSObject { | |
| locationProvider.stopUpdatingHeading() | ||
| if let passiveLocationProvider = locationProvider as? PassiveLocationProvider { | ||
| passiveLocationProvider.locationManager.pauseTripSession() | ||
| os_log("Trip session paused", log: logger, type: .debug) | ||
|
There was a problem hiding this comment. It'd be good to go through all methods in |
||
| } | ||
| } | ||
|
|
||
|
|
@@ -143,6 +146,7 @@ public class CarPlayManager: NSObject { | |
| routingProvider: RoutingProvider, | ||
| eventsManager: NavigationEventsManager? = nil, | ||
| carPlayNavigationViewControllerClass: CarPlayNavigationViewController.Type? = nil) { | ||
|
|
||
| self.styles = styles ?? [DayStyle(), NightStyle()] | ||
| self.routingProvider = routingProvider | ||
| self.eventsManager = eventsManager ?? .init(activeNavigationDataSource: nil, | ||
|
|
@@ -160,22 +164,39 @@ public class CarPlayManager: NSObject { | |
| selector: #selector(navigationCameraStateDidChange(_:)), | ||
| name: .navigationCameraStateDidChange, | ||
| object: carPlayMapViewController?.navigationMapView.navigationCamera) | ||
| os_log("CarPlayManager subscribed for notifications.", log: logger, type: .info) | ||
| } | ||
|
|
||
| func unsubscribeFromNotifications() { | ||
| NotificationCenter.default.removeObserver(self, | ||
| name: .navigationCameraStateDidChange, | ||
| object: carPlayMapViewController?.navigationMapView.navigationCamera) | ||
| os_log("CarPlayManager suspended notifications.", log: logger, type: .info) | ||
| } | ||
|
|
||
| @available(iOS 15.0, *) | ||
| func getLogEntries() throws -> [OSLogEntryLog] { | ||
|
There was a problem hiding this comment. Is it for debugging? If so, don't forget to remove this There was a problem hiding this comment. This is for retrieving log entries if you want to see them printed to a file instead of looking at the log via the Console. This functionality is only available via iOS 15. There was a problem hiding this comment. I think there are several build errors because of |
||
| let logStore = try OSLogStore(scope: .currentProcessIdentifier) | ||
| let oneHourAgo = logStore.position(date: Date().addingTimeInterval(-3600)) | ||
| let allEntries = try logStore.getEntries(at: oneHourAgo) | ||
|
|
||
| return allEntries | ||
| .compactMap { $0 as? OSLogEntryLog } | ||
| .filter { $0.category == "CarPlay" } | ||
| } | ||
|
|
||
|
|
||
| @objc func navigationCameraStateDidChange(_ notification: Notification) { | ||
| guard let state = notification.userInfo?[NavigationCamera.NotificationUserInfoKey.state] as? NavigationCameraState else { return } | ||
| switch state { | ||
| case .idle: | ||
| os_log("Camera state: idle", log: logger, type: .info) | ||
| carPlayMapViewController?.recenterButton.isHidden = false | ||
| case .transitionToFollowing, .following: | ||
| os_log("Camera state: following", log: logger, type: .info) | ||
| carPlayMapViewController?.recenterButton.isHidden = true | ||
| case .transitionToOverview, .overview: | ||
| os_log("Camera state: overview", log: logger, type: .info) | ||
| break | ||
| } | ||
| } | ||
|
|
@@ -333,6 +354,7 @@ extension CarPlayManager: CPApplicationDelegate { | |
| interfaceController.setRootTemplate(mapTemplate, animated: false) | ||
|
|
||
| eventsManager.sendCarPlayConnectEvent() | ||
| os_log("CarInterfaceController did connect to window.", log: logger, type: .info) | ||
|
There was a problem hiding this comment. I think that |
||
|
|
||
| subscribeForNotifications() | ||
| } | ||
|
|
@@ -351,6 +373,7 @@ extension CarPlayManager: CPApplicationDelegate { | |
| carWindow = nil | ||
|
|
||
| eventsManager.sendCarPlayDisconnectEvent() | ||
| os_log("CarInterfaceController did disconnect from window.", log: logger, type: .info) | ||
|
|
||
| idleTimerCancellable = nil | ||
|
|
||
|
|
@@ -362,6 +385,7 @@ extension CarPlayManager: CPApplicationDelegate { | |
| mapTemplate.mapDelegate = self | ||
|
|
||
| let currentActivity: CarPlayActivity = .browsing | ||
| os_log("CarPlayActivity changed to browsing", log: logger, type: .debug) | ||
| mapTemplate.userInfo = [ | ||
| CarPlayManager.currentActivityKey: currentActivity | ||
| ] | ||
|
|
@@ -392,7 +416,6 @@ extension CarPlayManager: CPApplicationDelegate { | |
| } else if let mapButtons = browsingMapButtons(for: mapTemplate) { | ||
| mapTemplate.mapButtons = mapButtons | ||
| } | ||
| return mapTemplate | ||
| } | ||
|
|
||
|
|
@@ -407,7 +430,6 @@ extension CarPlayManager: CPApplicationDelegate { | |
| } else if let mapButtons = browsingMapButtons(for: mapTemplate) { | ||
| mapTemplate.mapButtons = mapButtons | ||
| } | ||
| mapTemplate.dismissPanningInterface(animated: false) | ||
| } | ||
| } | ||
|
|
@@ -447,9 +469,12 @@ extension CarPlayManager: CPInterfaceControllerDelegate { | |
| if let userInfo = template.userInfo as? Dictionary<String, Any>, | ||
| let currentActivity = userInfo[CarPlayManager.currentActivityKey] as? CarPlayActivity { | ||
| self.currentActivity = currentActivity | ||
| os_log("CarPlayActivity changed", log: logger, type: .debug) | ||
| } else { | ||
| self.currentActivity = nil | ||
| os_log("CarPlayActivity is nil", log: logger, type: .debug) | ||
| } | ||
| os_log("CarPlayManagerDelegate: template will appear", log: logger, type: .debug) | ||
| } | ||
|
|
||
| public func templateDidAppear(_ template: CPTemplate, animated: Bool) { | ||
|
|
@@ -462,6 +487,7 @@ extension CarPlayManager: CPInterfaceControllerDelegate { | |
| let navigationMapView = carPlayMapViewController.navigationMapView | ||
| navigationMapView.removeRoutes() | ||
| navigationMapView.removeWaypoints() | ||
| os_log("CarPlayManagerDelegate: template did disappear", log: logger, type: .debug) | ||
| } | ||
|
|
||
| public func templateWillDisappear(_ template: CPTemplate, animated: Bool) { | ||
|
|
@@ -473,10 +499,12 @@ extension CarPlayManager: CPInterfaceControllerDelegate { | |
| interfaceController.templates.count == 1 else { return } | ||
|
|
||
| navigationMapView?.navigationCamera.follow() | ||
| os_log("CarPlayManagerDelegate: template will disappear", log: logger, type: .debug) | ||
| } | ||
|
|
||
| public func templateDidDisappear(_ template: CPTemplate, animated: Bool) { | ||
| delegate?.carPlayManager(self, templateDidDisappear: template, animated: animated) | ||
| os_log("CarPlayManagerDelegate: template did disappear", log: logger, type: .debug) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -561,6 +589,7 @@ extension CarPlayManager { | |
|
|
||
| switch result { | ||
| case let .failure(error): | ||
| os_log("Failed to calculate routes.", log: logger, type: .error) | ||
| guard let delegate = delegate, | ||
| let alert = delegate.carPlayManager(self, | ||
| didFailToFetchRouteBetween: routeOptions.waypoints, | ||
|
|
@@ -681,6 +710,7 @@ extension CarPlayManager: CPMapTemplateDelegate { | |
| mapTemplate.mapDelegate = self | ||
|
|
||
| let currentActivity: CarPlayActivity = .navigating | ||
| os_log("CarPlayActivity changed to navigating", log: logger, type: .debug) | ||
| mapTemplate.userInfo = [ | ||
| CarPlayManager.currentActivityKey: currentActivity | ||
| ] | ||
|
|
@@ -749,6 +779,7 @@ extension CarPlayManager: CPMapTemplateDelegate { | |
| navigationMapView.removeWaypoints() | ||
| if let passiveLocationProvider = navigationMapView.mapView.location.locationProvider as? PassiveLocationProvider { | ||
| passiveLocationProvider.locationManager.resumeTripSession() | ||
| os_log("PassiveLocationProvider trip session resumed.", log: logger, type: .info) | ||
| } | ||
| delegate?.carPlayManagerDidEndNavigation(self) | ||
| } | ||
|
|
@@ -775,9 +806,11 @@ extension CarPlayManager: CPMapTemplateDelegate { | |
| if let carPlayNavigationViewController = carPlayNavigationViewController { | ||
| currentActivity = .panningInNavigationMode | ||
| traitCollection = carPlayNavigationViewController.traitCollection | ||
| os_log("CarPlayActivity changed to panning in navigation mode", log: logger, type: .debug) | ||
| } else if let carPlayMapViewController = self.carPlayMapViewController { | ||
| currentActivity = .panningInBrowsingMode | ||
| traitCollection = carPlayMapViewController.traitCollection | ||
| os_log("CarPlayActivity changed to panning in browsing mode", log: logger, type: .debug) | ||
| } else { | ||
| assertionFailure("Panning interface is only supported for free-drive or active-guidance navigation.") | ||
| return | ||
|
|
@@ -909,6 +942,7 @@ extension CarPlayManager: CarPlayNavigationViewControllerDelegate { | |
| interfaceController.dismissTemplate(animated: true) | ||
| // Unset existing main map template (fixes an issue with the buttons) | ||
| mainMapTemplate = nil | ||
| os_log("CarPlayManager did dismiss arrival UI.", log: logger, type: .info) | ||
|
|
||
| // Then (re-)create and assign new map template | ||
| let mapTemplate = previewMapTemplate() | ||
|
|
@@ -919,6 +953,7 @@ extension CarPlayManager: CarPlayNavigationViewControllerDelegate { | |
|
|
||
| if let passiveLocationProvider = navigationMapView?.mapView.location.locationProvider as? PassiveLocationProvider { | ||
| passiveLocationProvider.locationManager.resumeTripSession() | ||
| os_log("PassiveLocationProvider trip session resumed.", log: logger, type: .info) | ||
| } | ||
|
|
||
| self.carPlayNavigationViewController = nil | ||
|
|
@@ -1003,6 +1038,7 @@ extension CarPlayManager { | |
| interfaceController.setRootTemplate(mapTemplate, animated: false) | ||
|
|
||
| eventsManager.sendCarPlayConnectEvent() | ||
| os_log("CarPlayManager did connect InterfaceController.", log: logger, type: .info) | ||
|
|
||
| subscribeForNotifications() | ||
| } | ||
|
|
@@ -1023,6 +1059,7 @@ extension CarPlayManager { | |
| eventsManager.sendCarPlayDisconnectEvent() | ||
|
|
||
| idleTimerCancellable = nil | ||
| os_log("CarPlayManager did disconnect InterfaceController.", log: logger, type: .info) | ||
|
|
||
| unsubscribeFromNotifications() | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll need to add logging for
CPTemplatelifecycle callbacks inCarPlayManagerDelegate:carPlayManager(_:templateWillAppear:animated:)carPlayManager(_:templateDidAppear:animated:)carPlayManager(_:templateWillDisappear:animated:)carPlayManager(_:templateDidDisappear:animated:)