ref: Use SPI for SentryUserFeedbackIntegrationDriver (#5516)

noahsmartin · web-flow · commit a2a3bfb93dea · 2025-06-30T13:34:32.000-04:00
* ref: Use SPI for SentryUserFeedbackIntegrationDriver

* PR feedback
diff --git a/Sentry.xcodeproj/project.pbxproj b/Sentry.xcodeproj/project.pbxproj
diff --git a/Sources/Sentry/PrivateSentrySDKOnly.m b/Sources/Sentry/PrivateSentrySDKOnly.m
@@ -21,7 +21,6 @@
 #import <SentryDependencyContainer.h>
 #import <SentryFramesTracker.h>
 #import <SentryScope+Private.h>
-#import <SentryScreenshot.h>
 #import <SentryUser.h>
 
 #if SENTRY_TARGET_PROFILING_SUPPORTED
diff --git a/Sources/Sentry/SentryDependencyContainer.m b/Sources/Sentry/SentryDependencyContainer.m
@@ -46,7 +46,6 @@
 #    import "SentryANRTrackerV2.h"
 #    import "SentryFramesTracker.h"
 #    import "SentryUIApplication.h"
-#    import <SentryScreenshot.h>
 #    import <SentryViewHierarchyProvider.h>
 #    import <SentryWatchdogTerminationBreadcrumbProcessor.h>
 #endif // SENTRY_HAS_UIKIT
diff --git a/Sources/Sentry/SentryDependencyContainerSwiftHelper.m b/Sources/Sentry/SentryDependencyContainerSwiftHelper.m
@@ -0,0 +1,22 @@
+#import "SentryDependencyContainerSwiftHelper.h"
+#import "SentryDependencyContainer.h"
+#import "SentrySwift.h"
+#import "SentryUIApplication.h"
+
+@implementation SentryDependencyContainerSwiftHelper
+
+#if SENTRY_HAS_UIKIT
+
++ (NSArray<UIWindow *> *)windows
+{
+    return SentryDependencyContainer.sharedInstance.application.windows;
+}
+
+#endif // SENTRY_HAS_UIKIT
+
++ (void)dispatchSyncOnMainQueue:(void (^)(void))block
+{
+    [SentryDependencyContainer.sharedInstance.dispatchQueueWrapper dispatchSyncOnMainQueue:block];
+}
+
+@end
diff --git a/Sources/Sentry/SentryScreenshot.m b/Sources/Sentry/SentryScreenshot.m
diff --git a/Sources/Sentry/SentryScreenshotIntegration.m b/Sources/Sentry/SentryScreenshotIntegration.m
@@ -10,6 +10,7 @@
 #    import "SentryHub+Private.h"
 #    import "SentryOptions.h"
 #    import "SentrySDK+Private.h"
+#    import "SentrySwift.h"
 
 #    if SENTRY_HAS_METRIC_KIT
 #        import "SentryMetricKitIntegration.h"
diff --git a/Sources/Sentry/SentryUserFeedbackIntegration.m b/Sources/Sentry/SentryUserFeedbackIntegration.m
@@ -2,7 +2,6 @@
 #import "SentryDependencyContainer.h"
 #import "SentryOptions+Private.h"
 #import "SentrySDK+Private.h"
-#import "SentryScreenshot.h"
 #import "SentrySwift.h"
 
 #if TARGET_OS_IOS && SENTRY_HAS_UIKIT
diff --git a/Sources/Sentry/include/SentryDependencyContainerSwiftHelper.h b/Sources/Sentry/include/SentryDependencyContainerSwiftHelper.h
@@ -0,0 +1,26 @@
+#import "SentryDefines.h"
+#import <Foundation/Foundation.h>
+
+#if SENTRY_HAS_UIKIT
+#    import <UIKit/UIKit.h>
+#endif // SENTRY_HAS_UIKIT
+
+NS_ASSUME_NONNULL_BEGIN
+
+// Some Swift code needs to access SentryDependencyContainer. To
+// make that possible without requiring all of SentryDependencyContainer
+// to be exposed to Swift this class is exposed to Swift
+// and bridges some functionality from SentryDependencyContainer
+@interface SentryDependencyContainerSwiftHelper : NSObject
+
+#if SENTRY_HAS_UIKIT
+
++ (nullable NSArray<UIWindow *> *)windows;
+
+#endif // SENTRY_HAS_UIKIT
+
++ (void)dispatchSyncOnMainQueue:(void (^)(void))block;
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/Sources/Sentry/include/SentryPrivate.h b/Sources/Sentry/include/SentryPrivate.h
@@ -14,6 +14,7 @@
 #import "SentryAsyncLog.h"
 #import "SentryDateUtil.h"
 #import "SentryDateUtils.h"
+#import "SentryDependencyContainerSwiftHelper.h"
 #import "SentryDisplayLinkWrapper.h"
 #import "SentryFileIOTracker.h"
 #import "SentryFileManager.h"
@@ -22,7 +23,6 @@
 #import "SentryNSDictionarySanitize.h"
 #import "SentryProfiler+Private.h"
 #import "SentryRandom.h"
-#import "SentryScreenshot.h"
 #import "SentrySdkInfo.h"
 #import "SentrySerialization.h"
 #import "SentrySession.h"
diff --git a/Sources/Sentry/include/SentryScreenshot.h b/Sources/Sentry/include/SentryScreenshot.h
diff --git a/Sources/Sentry/include/SentryScreenshotIntegration.h b/Sources/Sentry/include/SentryScreenshotIntegration.h
@@ -4,7 +4,6 @@
 
 #    import "SentryBaseIntegration.h"
 #    import "SentryClient+Private.h"
-#    import "SentryScreenshot.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
diff --git a/Sources/Swift/Integrations/UserFeedback/SentryUserFeedbackIntegrationDriver.swift b/Sources/Swift/Integrations/UserFeedback/SentryUserFeedbackIntegrationDriver.swift
@@ -21,7 +21,7 @@ import UIKit
     let screenshotProvider: SentryScreenshot
     weak var customButton: UIButton?
 
-    @_spi(Private) init(configuration: SentryUserFeedbackConfiguration, delegate: any SentryUserFeedbackIntegrationDriverDelegate, screenshotProvider: SentryScreenshot) {
+    @_spi(Private) public init(configuration: SentryUserFeedbackConfiguration, delegate: any SentryUserFeedbackIntegrationDriverDelegate, screenshotProvider: SentryScreenshot) {
         self.configuration = configuration
         self.delegate = delegate
         self.screenshotProvider = screenshotProvider
diff --git a/Sources/Swift/Tools/SentryScreenshot.swift b/Sources/Swift/Tools/SentryScreenshot.swift
@@ -0,0 +1,106 @@
+#if canImport(UIKit) && !SENTRY_NO_UIKIT
+#if os(iOS) || os(tvOS)
+
+@_implementationOnly import _SentryPrivate
+import UIKit
+
+@objcMembers
+@_spi(Private) public class SentryScreenshot: NSObject {
+    private let photographer: SentryViewPhotographer
+    
+    public override init() {
+        photographer = SentryViewPhotographer(
+            renderer: SentryDefaultViewRenderer(),
+            redactOptions: SentryRedactDefaultOptions(),
+            enableMaskRendererV2: false
+        )
+        super.init()
+    }
+    
+    /// Get a screenshot of every open window in the app.
+    /// - Returns: An array of UIImage instances.
+    public func appScreenshotsFromMainThread() -> [UIImage] {
+        var result: [UIImage] = []
+        
+        let takeScreenShot = { result = self.appScreenshots() }
+        
+        SentryDependencyContainerSwiftHelper.dispatchSync(onMainQueue: takeScreenShot)
+        
+        return result
+    }
+    
+    /// Get a screenshot of every open window in the app.
+    /// - Returns: An array of Data instances containing PNG images.
+    public func appScreenshotDatasFromMainThread() -> [Data] {
+        var result: [Data] = []
+        
+        let takeScreenShot = { result = self.appScreenshotsData() }
+        
+        SentryDependencyContainerSwiftHelper.dispatchSync(onMainQueue: takeScreenShot)
+        
+        return result
+    }
+    
+    /// Save the current app screen shots in the given directory.
+    /// If an app has more than one screen, one image for each screen will be saved.
+    /// - Parameter imagesDirectoryPath: The path where the images should be saved.
+    public func saveScreenShots(_ imagesDirectoryPath: String) {
+        // This function does not dispatch the screenshot to the main thread.
+        // The caller should be aware of that.
+        // We did it this way because we use this function to save screenshots
+        // during signal handling, and if we dispatch it to the main thread,
+        // that is probably blocked by the crash event, we freeze the application.
+        let screenshotData = appScreenshotsData()
+        
+        for (index, data) in screenshotData.enumerated() {
+            let name = index == 0 ? "screenshot.png" : "screenshot-\(index + 1).png"
+            let fileName = (imagesDirectoryPath as NSString).appendingPathComponent(name)
+            try? data.write(to: URL(fileURLWithPath: fileName), options: .atomic)
+        }
+    }
+    
+    public func appScreenshots() -> [UIImage] {
+        let windows = SentryDependencyContainerSwiftHelper.windows() ?? []
+        var result: [UIImage] = []
+        result.reserveCapacity(windows.count)
+        
+        for window in windows {
+            let size = window.frame.size
+            if size.width == 0 || size.height == 0 {
+                // avoid API errors reported as e.g.:
+                // [Graphics] Invalid size provided to UIGraphicsBeginImageContext(): size={0, 0},
+                // scale=1.000000
+                continue
+            }
+            
+            let img = photographer.image(view: window)
+            
+            // this shouldn't happen now that we discard windows with either 0 height or 0 width,
+            // but still, we shouldn't send any images with either one.
+            if img.size.width > 0 && img.size.height > 0 {
+                result.append(img)
+            }
+        }
+        return result
+    }
+    
+    public func appScreenshotsData() -> [Data] {
+        let screenshots = appScreenshots()
+        var result: [Data] = []
+        result.reserveCapacity(screenshots.count)
+        
+        for screenshot in screenshots {
+            // this shouldn't happen now that we discard windows with either 0 height or 0 width,
+            // but still, we shouldn't send any images with either one.
+            if screenshot.size.width > 0 && screenshot.size.height > 0 {
+                if let data = screenshot.pngData(), !data.isEmpty {
+                    result.append(data)
+                }
+            }
+        }
+        return result
+    }
+}
+
+#endif // os(iOS) || os(tvOS)
+#endif // canImport(UIKit) && !SENTRY_NO_UIKIT 
diff --git a/Tests/SentryTests/Integrations/Screenshot/TestSentryScreenShot.swift b/Tests/SentryTests/Integrations/Screenshot/TestSentryScreenShot.swift
@@ -1,5 +1,7 @@
 #if os(iOS) || os(tvOS) || targetEnvironment(macCatalyst)
 
+@_spi(Private) @testable import Sentry
+
 class TestSentryScreenshot: SentryScreenshot {
     
     var result: [Data] = []
diff --git a/Tests/SentryTests/SentryScreenShotTests.swift b/Tests/SentryTests/SentryScreenShotTests.swift
diff --git a/Tests/SentryTests/SentryTests-Bridging-Header.h b/Tests/SentryTests/SentryTests-Bridging-Header.h
