Feat: Add custom redact modifier for SwiftUI

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Custom redact modifier for SwiftUI ()
+
 ## 8.37.0-beta.1
 
 ### Features
@@ -16,8 +22,8 @@
 
 - Resumes replay when the app becomes active (#4303)
 - Session replay redact view with transformation (#4308)
-- Correct redact UIView with higher zPosition (#4309) 
 - Don't redact clipped views (#4325)
+- Correct redact UIView with higher zPosition (#4309) 
 - Session replay for crash not created because of a race condition (#4314)
 - Double-quoted include, expected angle-bracketed instead (#4298)
 - Discontinue use of NSApplicationSupportDirectory in favor of NSCachesDirectory (#4335)

Samples/iOS-Swift/iOS13-Swift/SwiftUIView.swift

@@ -1,7 +1,7 @@
 import SentrySwiftUI
 import SwiftUI
 
-struct SwiftUIView: View {
+struct SwiftUIView: View {    
     var body: some View {
         SentryTracedView("SwiftUI View") {
             Text("SwiftUI!")

Samples/iOS-Swift/iOS13-Swift/SwiftUIViewController.swift

@@ -9,7 +9,7 @@ class SwiftUIViewController: UIViewController {
 
     override func viewDidLoad() {
         super.viewDidLoad()
-
+        
         addChild(swiftUIView)
         view.addSubview(swiftUIView.view)
 

Samples/iOS-SwiftUI/iOS-SwiftUI/ContentView.swift

@@ -163,7 +163,6 @@ struct ContentView: View {
                             Button(action: captureTransactionAction) {
                                 Text("Capture Transaction")
                             }
-
                         }
                         VStack(spacing: 16) {
                             Button(action: {
@@ -200,6 +199,7 @@ struct ContentView: View {
                                 Text("Form Screen")
                             }
                         }
+                        .replayRedact()
                     }
                     SecondView()
                 }

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

@@ -10,6 +10,9 @@ struct SwiftUIApp: App {
             options.debug = true
             options.tracesSampleRate = 1.0
             options.profilesSampleRate = 1.0
+            options.experimental.sessionReplay.sessionSampleRate = 1.0
+            options.experimental.sessionReplay.redactAllImages = false
+            options.experimental.sessionReplay.redactAllText = false
             options.initialScope = { scope in
                 scope.injectGitInformation()
                 return scope

Sentry.xcodeproj/project.pbxproj

@@ -882,6 +882,7 @@
 		D8918B222849FA6D00701F9A /* SentrySDKIntegrationTestsBase.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8918B212849FA6D00701F9A /* SentrySDKIntegrationTestsBase.swift */; };
 		D8A3649C2C91AA3300AC569B /* SentryReplayApi.m in Sources */ = {isa = PBXBuildFile; fileRef = D8A3649B2C91AA3300AC569B /* SentryReplayApi.m */; };
 		D8A3649D2C91AA3300AC569B /* SentryReplayApi.h in Headers */ = {isa = PBXBuildFile; fileRef = D8A3649A2C91AA3300AC569B /* SentryReplayApi.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		D8A65B5D2C98656800974B74 /* SentryReplayView.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8A65B5C2C98656000974B74 /* SentryReplayView.swift */; };
 		D8AB40DB2806EC1900E5E9F7 /* SentryScreenshotIntegration.h in Headers */ = {isa = PBXBuildFile; fileRef = D8AB40DA2806EC1900E5E9F7 /* SentryScreenshotIntegration.h */; };
 		D8ACE3C72762187200F5A213 /* SentryNSDataSwizzling.m in Sources */ = {isa = PBXBuildFile; fileRef = D8ACE3C42762187200F5A213 /* SentryNSDataSwizzling.m */; };
 		D8ACE3C82762187200F5A213 /* SentryNSDataTracker.m in Sources */ = {isa = PBXBuildFile; fileRef = D8ACE3C52762187200F5A213 /* SentryNSDataTracker.m */; };
@@ -1964,6 +1965,7 @@
 		D8918B212849FA6D00701F9A /* SentrySDKIntegrationTestsBase.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentrySDKIntegrationTestsBase.swift; sourceTree = "<group>"; };
 		D8A3649A2C91AA3300AC569B /* SentryReplayApi.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryReplayApi.h; path = Public/SentryReplayApi.h; sourceTree = "<group>"; };
 		D8A3649B2C91AA3300AC569B /* SentryReplayApi.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryReplayApi.m; sourceTree = "<group>"; };
+		D8A65B5C2C98656000974B74 /* SentryReplayView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryReplayView.swift; sourceTree = "<group>"; };
 		D8AB40DA2806EC1900E5E9F7 /* SentryScreenshotIntegration.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryScreenshotIntegration.h; path = include/SentryScreenshotIntegration.h; sourceTree = "<group>"; };
 		D8ACE3C42762187200F5A213 /* SentryNSDataSwizzling.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SentryNSDataSwizzling.m; sourceTree = "<group>"; };
 		D8ACE3C52762187200F5A213 /* SentryNSDataTracker.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SentryNSDataTracker.m; sourceTree = "<group>"; };
@@ -3727,6 +3729,7 @@
 				D8199DB529376ECC0074249E /* SentrySwiftUI.h */,
 				D88D25E92B8E0BAC0073C3D5 /* module.modulemap */,
 				D8199DB629376ECC0074249E /* SentryTracedView.swift */,
+				D8A65B5C2C98656000974B74 /* SentryReplayView.swift */,
 			);
 			path = SentrySwiftUI;
 			sourceTree = "<group>";
@@ -5209,6 +5212,7 @@
 			files = (
 				D8199DC129376EEC0074249E /* SentryTracedView.swift in Sources */,
 				D8199DBF29376EE20074249E /* SentryInternal.m in Sources */,
+				D8A65B5D2C98656800974B74 /* SentryReplayView.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

Sources/SentrySwiftUI/SentryReplayView.swift

@@ -0,0 +1,44 @@
+#if SENTRY_NO_UIKIT
+import SentryWithoutUIKit
+#else
+import Sentry
+#endif
+#if canImport(UIKit)
+import SwiftUI
+import UIKit
+
+@available(iOS 13, macOS 10.15, tvOS 13, watchOS 6.0, *)
+struct SentryReplayView: UIViewRepresentable {
+    func makeUIView(context: Context) -> UIView {
+        let result = UIView()
+        result.sentryReplayRedact()
+        return result
+    }
+
+    func updateUIView(_ uiView: UIView, context: Context) {
+        // This is blank on purpose. UIViewRepresentable requires this function.
+    }
+}
+
+struct SentryReplayModifier: ViewModifier {
+    func body(content: Content) -> some View {
+        content.background(SentryReplayView())
+    }
+}
+
+@available(iOS 13, macOS 10.15, tvOS 13, watchOS 6.0, *)
+public extension View {
+
+    /// Marks the view as containing sensitive information that should be redacted during replays.
+    ///
+    /// When this modifier is applied, any sensitive content within the view will be hidden or masked
+    /// during session replays to ensure user privacy. This is useful for views containing personal
+    /// data or confidential information that shouldn't be visible when the replay is reviewed.
+    ///
+    /// - Returns: A modifier that redacts sensitive information during session replays.
+    ///
+    func replayRedact() -> some View {
+        modifier(SentryReplayModifier())
+    }
+}
+#endif

Sources/Swift/Tools/UIRedactBuilder.swift

@@ -154,7 +154,6 @@ class UIRedactBuilder {
                              redacting: &redactingRegions,
                              rootFrame: view.frame,
                              transform: CGAffineTransform.identity)
-
         return redactingRegions.reversed()
     }
 
@@ -181,7 +180,7 @@ class UIRedactBuilder {
 
     private func mapRedactRegion(fromView view: UIView, redacting: inout [RedactRegion], rootFrame: CGRect, transform: CGAffineTransform, forceRedact: Bool = false) {
         guard !redactClassesIdentifiers.isEmpty && !view.isHidden && view.alpha != 0 else { return }
-        
+
         let layer = view.layer.presentation() ?? view.layer
 
         let newTransform = concatenateTranform(transform, with: layer)