Fix attribution dialog presentation (#1982)

MAPSIOS-515: Fix attribution dialog presentation

Apps/Examples/Examples/SwiftUI Examples/SwiftUIRoot.swift

@@ -33,9 +33,12 @@ struct SwiftUIRoot: View {
                     ExampleLink("Puck playground", note: "Display user location using puck.", destination: PuckPlayground())
                     ExampleLink("Annotation Order", destination: AnnotationsOrderTestExample())
                     ExampleLink("Simple Map", note: "Camera observing, automatic dark mode support.", destination: SimpleMapExample())
-                    ExampleLink("AttributionURL open (iOS 13+)", note: "Override attribution url opener.", destination: URLOpenIOS13())
+                    ExampleLink("Attribution url via callback", note: "Works on iOS 13+", destination: AttributionManualURLOpen())
                     if #available(iOS 15.0, *) {
-                        ExampleLink("AttributionURL open (iOS 15+)", note: "Override attribution url opener.", destination: URLOpenIOS15())
+                        ExampleLink("Attribution url open via environment", note: "Works on iOS 15+", destination: AttributionEnvironmentURLOpen())
+                    }
+                    if #available(iOS 16.5, *) {
+                        ExampleLink("Attribution dialog with presented sheet", destination: AttributionDialogueWithSheet())
                     }
 
                 } header: { Text("Testing Examples") }

Apps/Examples/Examples/SwiftUI Examples/URLOpenExamples.swift → Apps/Examples/Examples/SwiftUI Examples/Testing Examples/AttributionDialogueExamples.swift

@@ -3,7 +3,7 @@ import SwiftUI
 
 
 @available(iOS 15, *)
-struct URLOpenIOS15: View {
+struct AttributionEnvironmentURLOpen: View {
     @State private var alert: String?
     var body: some View {
         Map()
@@ -16,8 +16,24 @@ struct URLOpenIOS15: View {
     }
 }
 
+@available(iOS 16.4, *)
+struct AttributionDialogueWithSheet: View {
+    @State var sheet = true
+    var body: some View {
+        Map()
+            .additionalSafeAreaInsets(.bottom, 70)
+            .ignoresSafeArea()
+            .sheet(isPresented: $sheet) {
+                Text("Tap attribution info button")
+                    .interactiveDismissDisabled()
+                    .presentationBackgroundInteraction(.enabled(upThrough: .large))
+                    .presentationDetents([.height(80), .medium, .large])
+            }
+        }
+}
+
 @available(iOS 13, *)
-struct URLOpenIOS13: View {
+struct AttributionManualURLOpen: View {
     @State private var alert: String?
     var body: some View {
         Map(urlOpener: { alert = $0.absoluteString}) {}

CHANGELOG.md

@@ -10,6 +10,7 @@ Mapbox welcomes participation and contributions from everyone.
 * Fix glitch in chained camera animations.
 * Make padding optional in `MapboxMap.camera(for:padding:bearing:pitch:maxZoom:offset:)` and `MapboxMap.camera(for:padding:bearing:pitch:)`.
 * Build XCFramework with `SWIFT_SERIALIZE_DEBUGGING_OPTIONS=NO` flag to avoid serialized search paths in Swift modules.
+* Fixed a bug where the attribution dialog does not appear when there is a presented view controller.
 
 ## 11.1.0-rc.1 - 04 January, 2024
 

Sources/MapboxMaps/Foundation/Extensions/UIViewController+Extensions.swift

@@ -0,0 +1,11 @@
+import UIKit
+
+extension UIViewController {
+    var topmostPresentedViewController: UIViewController {
+        var result = self
+        while let presented = result.presentedViewController {
+            result = presented
+        }
+        return result
+    }
+}

Sources/MapboxMaps/Foundation/MapView+Attribution.swift

@@ -2,8 +2,8 @@
 import UIKit
 
 extension MapView: AttributionDialogManagerDelegate {
-    func viewControllerForPresenting(_ attributionDialogManager: AttributionDialogManager) -> UIViewController {
-        return parentViewController!
+    func viewControllerForPresenting(_ attributionDialogManager: AttributionDialogManager) -> UIViewController? {
+        parentViewController?.topmostPresentedViewController
     }
 
     func attributionDialogManager(_ attributionDialogManager: AttributionDialogManager, didTriggerActionFor attribution: Attribution) {

Sources/MapboxMaps/Style/AttributionDialogManager.swift

@@ -4,7 +4,7 @@ internal protocol AttributionDataSource: AnyObject {
 }
 
 internal protocol AttributionDialogManagerDelegate: AnyObject {
-    func viewControllerForPresenting(_ attributionDialogManager: AttributionDialogManager) -> UIViewController
+    func viewControllerForPresenting(_ attributionDialogManager: AttributionDialogManager) -> UIViewController?
     func attributionDialogManager(_ attributionDialogManager: AttributionDialogManager, didTriggerActionFor attribution: Attribution)
 }
 
@@ -121,7 +121,8 @@ extension AttributionDialogManager: InfoButtonOrnamentDelegate {
 
     private func showAttributionDialog(for attributions: [Attribution]) {
         guard let viewController = delegate?.viewControllerForPresenting(self) else {
-            fatalError("No view controller found")
+            Log.error(forMessage: "Failed to present an attribution dialogue: no presenting view controller found.")
+            return
         }
 
         let title = NSLocalizedString("SDK_NAME",

Tests/MapboxMapsTests/Foundation/Extensions/UIViewController+ExtensionsTests.swift

@@ -0,0 +1,28 @@
+@testable import MapboxMaps
+import XCTest
+
+final class UIViewControllerExtensionsTests: XCTestCase {
+    func testTopmostPresentedViewController() {
+        let vc1 = MockViewController()
+        let vc2 = MockViewController()
+        let vc3 = MockViewController()
+
+        XCTAssertIdentical(vc1.topmostPresentedViewController, vc1)
+
+        vc1.simulatePresent(vc2)
+        XCTAssertIdentical(vc1.topmostPresentedViewController, vc2)
+
+        vc2.simulatePresent(vc3)
+        XCTAssertIdentical(vc1.topmostPresentedViewController, vc3)
+    }
+}
+
+private class MockViewController: UIViewController {
+    private var _presentedViewControllerOverride: UIViewController?
+    override var presentedViewController: UIViewController? {
+        return _presentedViewControllerOverride
+    }
+    func simulatePresent(_ vc: UIViewController) {
+        _presentedViewControllerOverride = vc
+    }
+}

Tests/MapboxMapsTests/Ornaments/InfoButton/InfoButtonOrnamentTests.swift

@@ -116,7 +116,7 @@ extension InfoButtonOrnamentTests: AttributionDataSource {
 }
 
 extension InfoButtonOrnamentTests: AttributionDialogManagerDelegate {
-    func viewControllerForPresenting(_ attributionDialogManager: AttributionDialogManager) -> UIViewController {
+    func viewControllerForPresenting(_ attributionDialogManager: AttributionDialogManager) -> UIViewController? {
         return parentViewController
     }
 

Tests/MapboxMapsTests/Style/Mocks/MockAttributionDialogManagerDelegate.swift

@@ -5,7 +5,7 @@ import Foundation
 final class MockAttributionDialogManagerDelegate: AttributionDialogManagerDelegate {
 
     let viewControllerForPresentingStub = Stub<AttributionDialogManager, UIViewController>(defaultReturnValue: UIViewController())
-    func viewControllerForPresenting(_ attributionDialogManager: AttributionDialogManager) -> UIViewController {
+    func viewControllerForPresenting(_ attributionDialogManager: AttributionDialogManager) -> UIViewController? {
         viewControllerForPresentingStub.call(with: attributionDialogManager)
     }