[maps-ios] fix display link not running for CarPlay Dashboard/Instrument Cluster scenes (#11181)

Cache the connected scene of map view (scene contains map view's window
that is activated) to correctly determine display link pause/resume
state if the current window does not have reference to `windowScene`
(i.e CarPlay dashboard scene)

After mapbox/mapbox-sdk#5770 which introduced
Display link tweak, it was changed from `shouldPauseDisplayLink` which
would never pause for window of CarPlay dashboard scene, to
`shouldRunDisplayLink` which would never run for same scene

MAPSIOS-2130

The issue can be reproduced with our CarPlay example
- Run Examples app on CarPlay in split screen mode (dashboard)
- On the left panel, tap on `Start` and `Stop` button; observe that on
main branch the map would not perform any camera animation

**Before**

https://github.com/user-attachments/assets/ce6f8f67-ecfe-4c30-b8a7-d3c1c70d18f4

**After**

https://github.com/user-attachments/assets/7943b4ca-d05c-402e-ba29-662fd3ca4f9e

cc @mapbox/maps-ios

GitOrigin-RevId: ab46d0b02e8bdb9ab15f53ac3c37c76dffa4ac13

Author: maios

Sources/MapboxMaps/Foundation/Extensions/UIWindow+ParentScene.swift

@@ -5,20 +5,6 @@ import UIKit
 
 extension UIWindow {
 
-    /// The `UIScene` containing this window.
-    internal var parentScene: UIScene? {
-#if canImport(CarPlay)
-        switch self {
-        case let carPlayWindow as CPWindow:
-            return carPlayWindow.templateApplicationScene
-        default:
-            return windowScene
-        }
-#else
-        return windowScene
-#endif
-    }
-
     var isCarPlay: Bool {
 #if canImport(CarPlay)
         return self is CPWindow

Sources/MapboxMaps/Foundation/MapView.swift

@@ -117,11 +117,17 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
         didSet {
             // cache activation state for efficiency
             permissibleActivationStates = displayState.sceneActivationStates
-            displayLink?.isRunning = shouldRunDisplayLink(for: window?.parentScene)
+            displayLink?.isRunning = shouldRunDisplayLink(for: window?.windowScene)
         }
     }
     private var permissibleActivationStates: Set<UIScene.ActivationState> = [.foregroundActive, .foregroundInactive]
 
+    /// The scene that is currently connected to this map view.
+    ///
+    /// This property is set when a scene containing the map view's window becomes activated,
+    /// and reset to `nil` when that scene becomes deactivated.
+    private weak var connectedScene: UIScene?
+
     /// The `gestures` object will be responsible for all gestures on the map.
     public private(set) var gestures: GestureManager!
 
@@ -543,26 +549,28 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
         notificationCenter.addObserver(self,
                                         selector: #selector(sceneDidEnterBackground(_:)),
                                         name: UIScene.didEnterBackgroundNotification,
-                                        object: window?.parentScene)
+                                        object: window?.windowScene)
         notificationCenter.addObserver(self,
                                         selector: #selector(sceneWillDeactivate(_:)),
                                         name: UIScene.willDeactivateNotification,
-                                        object: window?.parentScene)
+                                        object: window?.windowScene)
         notificationCenter.addObserver(self,
                                         selector: #selector(sceneDidActivate(_:)),
                                         name: UIScene.didActivateNotification,
-                                        object: window?.parentScene)
+                                        object: window?.windowScene)
     }
 
     @objc private func sceneDidActivate(_ notification: Notification) {
         guard let scene = notification.object as? UIScene, let window = window, scene.allWindows.contains(window) else { return }
 
+        connectedScene = scene
         displayLink?.isRunning = true
     }
 
     @objc private func sceneWillDeactivate(_ notification: Notification) {
         guard let scene = notification.object as? UIScene, let window = window, scene.allWindows.contains(window) else { return }
 
+        connectedScene = nil
         displayLink?.isRunning = displayState.shouldRunDisplayLinkWhenInactive
     }
 
@@ -694,7 +702,7 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
 
     @_spi(Metrics) public var metricsReporter: MapViewMetricsReporter?
     private func updateFromDisplayLink(displayLink: CADisplayLink) {
-        if !shouldRunDisplayLink(for: window?.parentScene) {
+        if !shouldRunDisplayLink(for: window?.windowScene) {
             displayLink.isPaused = true
             return
         }
@@ -786,7 +794,7 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
         subscribeSceneToLifecycleNotifications()
 
         // make sure that the display link is (de)activated for a current app/scene state
-        displayLink.isRunning = shouldRunDisplayLink(for: window.parentScene)
+        displayLink.isRunning = shouldRunDisplayLink(for: window.windowScene)
 
         displayLink.add(to: .current, forMode: .common)
     }
@@ -799,8 +807,8 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
         displayLink?.isRunning = true
     }
 
-    private func shouldRunDisplayLink(for scene: UIScene?) -> Bool {
-        if let scene, permissibleActivationStates.contains(scene.activationState) {
+    private func shouldRunDisplayLink(for scene: UIScene? = nil) -> Bool {
+        if let scene = scene ?? connectedScene, permissibleActivationStates.contains(scene.activationState) {
             return true
         }
 

Tests/MapboxMapsTests/Foundation/Extensions/UIWindow+ParentSceneTests.swift

@@ -407,21 +407,21 @@ final class MapViewTestsWithScene: XCTestCase {
     func testDisplayLinkResumedWhenSceneDidActivate() throws {
         displayLink.$isPausedStub.setStub.reset()
 
-        notificationCenter.post(name: UIScene.didActivateNotification, object: window.parentScene)
+        notificationCenter.post(name: UIScene.didActivateNotification, object: window.windowScene)
 
         XCTAssertEqual(displayLink.$isPausedStub.setStub.invocations.map(\.parameters), [false])
     }
 
     func testDisplayLinkRunningWhenSceneWillDeactivate() throws {
         displayLink.$isPausedStub.setStub.reset()
 
-        notificationCenter.post(name: UIScene.willDeactivateNotification, object: window.parentScene)
+        notificationCenter.post(name: UIScene.willDeactivateNotification, object: window.windowScene)
 
         XCTAssertEqual(displayLink.$isPausedStub.setStub.invocations.map(\.parameters), [false])
     }
 
     func testReleaseDrawablesInvokedWhenSceneMovingToBackground() throws {
-        notificationCenter.post(name: UIScene.didEnterBackgroundNotification, object: window.parentScene)
+        notificationCenter.post(name: UIScene.didEnterBackgroundNotification, object: window.windowScene)
 
         XCTAssertEqual(metalView.releaseDrawablesStub.invocations.count, 1)
     }