fix(feedback): user feedback widget in SwiftUI (#5223)

Author: armcknight

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Fixes
 
 - Set handled to false for fatal app hangs (#5514)
+- User feedback widget automatically injects into SwiftUI apps correctly (#5223)
 - Fix crash when SentryFileManger is nil (#5535)
 
 ### Improvements

Samples/iOS-SwiftUI/iOS-SwiftUI-UITests/FeedbackUITests.swift

@@ -0,0 +1,22 @@
+import XCTest
+
+final class FeedbackUITests: XCTestCase {
+    func testWidgetDisplayInSwiftUIApp() throws {
+        let app = XCUIApplication()
+        app.launchArguments.append(contentsOf: [
+            "--io.sentry.feedback.all-defaults"
+        ])
+        app.launch()
+
+        // ensure the widget button is displayed
+        XCTAssert(app.otherElements["Report a Bug"].exists)
+
+        // ensure tapping the widget displays the form
+        app.otherElements["io.sentry.feedback.widget"].tap()
+        XCTAssert(app.staticTexts["Report a Bug"].exists)
+
+        // ensure cancelling the flow hides the form and redisplays the widget
+        app.buttons["io.sentry.feedback.form.cancel"].tap()
+        XCTAssert(app.otherElements["Report a Bug"].exists)
+    }
+}

Samples/iOS-SwiftUI/iOS-SwiftUI/SwiftUIApp.swift

@@ -1,4 +1,5 @@
 import Foundation
+import Sentry
 import SentrySampleShared
 import SwiftUI
 
@@ -34,6 +35,7 @@ class MySceneDelegate: NSObject, UIWindowSceneDelegate, ObservableObject {
     func sceneDidBecomeActive(_ scene: UIScene) {
         guard !initializedSentry else { return }
         SampleAppDebugMenu.shared.display()
+        SentrySDK.feedback.showWidget()
         initializedSentry = true
     }
 }

Sources/Swift/Integrations/UserFeedback/SentryUserFeedbackIntegrationDriver.swift

@@ -42,6 +42,16 @@ import UIKit
         } else if let widgetConfigBuilder = configuration.configureWidget {
             widgetConfigBuilder(configuration.widgetConfig)
             validate(configuration.widgetConfig)
+
+            /*
+             * We cannot currently automatically inject a widget into a SwiftUI application, because at the recommended time to start the Sentry SDK (SwiftUIApp.init) there is nowhere to put a UIWindow overlay. SwiftUI apps must currently declare a UIApplicationDelegateAdaptor that returns a UISceneConfiguration, which we can then extract a connected UIScene from into which we can inject a UIWindow.
+             *
+             * At the time this integration is being installed, if there is no UIApplicationDelegate and no connected UIScene, it is very likely we are in a SwiftUI app, but it's possible we could instead be in a UIKit app that has some nonstandard launch procedure or doesn't call SentrySDK.start in a place we expect/recommend, in which case they will need to manually display the widget when they're ready by calling SentrySDK.feedback.showWidget.
+             */
+            if UIApplication.shared.connectedScenes.isEmpty && UIApplication.shared.delegate == nil {
+                return
+            }
+
             if configuration.widgetConfig.autoInject {
                 widget = SentryUserFeedbackWidget(config: configuration, delegate: self)
             }
@@ -57,9 +67,9 @@ import UIKit
     @objc public func showWidget() {
         if widget == nil {
             widget = SentryUserFeedbackWidget(config: configuration, delegate: self)
-        } else {
-            widget?.rootVC.setWidget(visible: true, animated: configuration.animations)
         }
+
+        widget?.rootVC.setWidget(visible: true, animated: configuration.animations)
     }
 
     @objc public func hideWidget() {

Sources/Swift/Integrations/UserFeedback/SentryUserFeedbackWidget.swift

@@ -16,26 +16,53 @@ final class SentryUserFeedbackWidget {
         let button = SentryUserFeedbackWidgetButtonView(config: config, target: self, selector: #selector(showForm))
         return button
     }()
+
     lazy var rootVC = RootViewController(config: config, button: button)
-    private lazy var window = SentryUserFeedbackWidget.Window(config: config)
+
+    private var window: Window?
+
     let config: SentryUserFeedbackConfiguration
     weak var delegate: (any SentryUserFeedbackWidgetDelegate)?
 
     init(config: SentryUserFeedbackConfiguration, delegate: any SentryUserFeedbackWidgetDelegate) {
         self.config = config
         self.delegate = delegate
+
+        /*
+         * We must have a UIScene in order to display an overlaying UIWindow in a SwiftUI app, which is currently how we display the widget. SentryUserFeedbackIntegrationDriver won't try to initialize this class if there are no connected UIScenes _and_ there is no UIApplicationDelegate at the time the integration is being installed.
+         *
+         * Both UIKit and SwiftUI apps can have connected UIScenes. Here's how we then try to tell the difference:
+         * - If there is no connected UIScene but there is already a UIApplicationDelegate by the time this integration is being installed, then we are either in a UIKit app, or inside a SwiftUI app that for whatever reason delays the call to SentrySDK.start until there is a connected scene. In either case, we'll just grab the first connected UIScene and proceed.
+         * - Otherwise, we're either in a SwiftUI app that _does_ call SentrySDK.start at the recommended time (SwiftUIApp.init), or there is a more complicated initialization procedure in a UIKit app that we can't automatically detect, and the app will need to call SentrySDK.feedback.showWidget() at the appropriate time, the same as how SwiftUI apps must currently do once they've connected a UIScene to their UIApplicationDelegateAdaptor.
+         */
+        let window: Window
+        if let scene = UIApplication.shared.connectedScenes.first as? UIWindowScene {
+            window = SentryUserFeedbackWidget.Window(config: config, windowScene: scene)
+        } else {
+            window = SentryUserFeedbackWidget.Window(config: config)
+        }
         window.rootViewController = rootVC
         window.isHidden = false
+        self.window = window
     }
 
     @objc func showForm() {
         self.delegate?.showForm()
     }
 
     final class Window: UIWindow {
+        private func _init(config: SentryUserFeedbackConfiguration) {
+            windowLevel = config.widgetConfig.windowLevel
+        }
+
+        init(config: SentryUserFeedbackConfiguration, windowScene: UIWindowScene) {
+            super.init(windowScene: windowScene)
+            _init(config: config)
+        }
+
         init(config: SentryUserFeedbackConfiguration) {
             super.init(frame: UIScreen.main.bounds)
-            windowLevel = config.widgetConfig.windowLevel
+            _init(config: config)
         }
 
         required init?(coder: NSCoder) {