ref: Changing the redact logic

CHANGELOG.md

@@ -14,8 +14,13 @@
 ### Fixes
 
 - Resumes replay when the app becomes active (#4303)
+- Session replay redact view with transformation (#4308)
+- Don't redact clipped views (#4325)
+- Correct redact UIView with higher zPosition (#4309) 
+- Don't redact clipped views (#4325)
 - Session replay for crash not created because of a race condition (#4314)
 - Double-quoted include, expected angle-bracketed instead (#4298)
+- Stop using `redactAllText` as an indicator tha redact is enabled (#4327)
 
 ## 8.36.0
 

Samples/iOS-Swift/iOS-Swift.xcodeproj/project.pbxproj

@@ -102,6 +102,7 @@
  D8D7BB4A2750067900044146 /* UIAssert.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8D7BB492750067900044146 /* UIAssert.swift */; };
  D8D7BB4C2750095800044146 /* UIViewExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8D7BB4B2750095800044146 /* UIViewExtension.swift */; };
  D8D7BB4E27501B9400044146 /* SpanObserver.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8D7BB4D27501B9400044146 /* SpanObserver.swift */; };
+ D8DA29042C7F2199008BC825 /* SRRedactSampleViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8DA29032C7F2199008BC825 /* SRRedactSampleViewController.swift */; };
  D8DBDA76274D591F00007380 /* TableViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8DBDA75274D591F00007380 /* TableViewController.swift */; };
  D8DBDA78274D5FC400007380 /* SplitViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8DBDA77274D5FC400007380 /* SplitViewController.swift */; };
  D8F01DEA2A1376B5008F4996 /* InfoForBreadcrumbController.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8F01DE92A1376B5008F4996 /* InfoForBreadcrumbController.swift */; };
@@ -361,6 +362,7 @@
  D8D7BB492750067900044146 /* UIAssert.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UIAssert.swift; sourceTree = "<group>"; };
  D8D7BB4B2750095800044146 /* UIViewExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UIViewExtension.swift; sourceTree = "<group>"; };
  D8D7BB4D27501B9400044146 /* SpanObserver.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SpanObserver.swift; sourceTree = "<group>"; };
+ D8DA29032C7F2199008BC825 /* SRRedactSampleViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SRRedactSampleViewController.swift; sourceTree = "<group>"; };
  D8DBDA75274D591F00007380 /* TableViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TableViewController.swift; sourceTree = "<group>"; };
  D8DBDA77274D5FC400007380 /* SplitViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SplitViewController.swift; sourceTree = "<group>"; };
  D8F01DE92A1376B5008F4996 /* InfoForBreadcrumbController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InfoForBreadcrumbController.swift; sourceTree = "<group>"; };
@@ -606,6 +608,7 @@
  D8832B1D2AF52D0500C522B0 /* PageViewController.swift */,
  B70038842BB33E7700065A38 /* ReplaceContentViewController.swift */,
  D8AE48C82C57DC2F0092A2A6 /* WebViewController.swift */,
+ D8DA29032C7F2199008BC825 /* SRRedactSampleViewController.swift */,
  );
  path = ViewControllers;
  sourceTree = "<group>";
@@ -1068,6 +1071,7 @@
  D8444E4C275E38090042F4DE /* UIViewControllerExtension.swift in Sources */,
  637AFDAE243B02760034958B /* TransactionsViewController.swift in Sources */,
  D8832B132AF4F7FE00C522B0 /* TopViewControllerInspector.swift in Sources */,
+ D8DA29042C7F2199008BC825 /* SRRedactSampleViewController.swift in Sources */,
  0AABE2EA28855FF80057ED69 /* PermissionsViewController.swift in Sources */,
  7B5525B32938B5B5006A2932 /* DiskWriteException.swift in Sources */,
  84BA72A72C93698E0045B828 /* GitInjections.swift in Sources */,

Samples/iOS-Swift/iOS-Swift/ViewControllers/SRRedactSampleViewController.swift

@@ -0,0 +1,17 @@
+import Foundation
+
+class SRRedactSampleViewController: UIViewController {
+
+ @IBOutlet var notRedactedView: UIView!
+
+ @IBOutlet var label: UILabel!
+
+ override func viewDidLoad() {
+ super.viewDidLoad()
+
+ notRedactedView.backgroundColor = .green
+ notRedactedView.transform = CGAffineTransform(rotationAngle: 45 * .pi / 180.0)
+
+ SentrySDK.replay.ignoreView(notRedactedView)
+ }
+}

Sentry.xcodeproj/project.pbxproj

@@ -808,6 +808,7 @@
  D820CDB82BB1895F00BA339D /* SentrySessionReplayIntegration.h in Headers */ = {isa = PBXBuildFile; fileRef = D820CDB52BB1895F00BA339D /* SentrySessionReplayIntegration.h */; };
  D82859432C3E753C009A28AA /* SentrySessionReplaySyncC.c in Sources */ = {isa = PBXBuildFile; fileRef = D82859422C3E753C009A28AA /* SentrySessionReplaySyncC.c */; };
  D82859442C3E753C009A28AA /* SentrySessionReplaySyncC.h in Headers */ = {isa = PBXBuildFile; fileRef = D82859412C3E753C009A28AA /* SentrySessionReplaySyncC.h */; };
+ D82915632C85EF0C00A6CDD4 /* SentryViewPhotographerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D82915622C85EF0C00A6CDD4 /* SentryViewPhotographerTests.swift */; };
  D8292D7D2A39A027009872F7 /* UrlSanitizedTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8292D7C2A39A027009872F7 /* UrlSanitizedTests.swift */; };
  D82DD1CD2BEEB1A0001AB556 /* SentrySRDefaultBreadcrumbConverterTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D82DD1CC2BEEB1A0001AB556 /* SentrySRDefaultBreadcrumbConverterTests.swift */; };
  D8370B6A273DF1E900F66E2D /* SentryNSURLSessionTaskSearch.m in Sources */ = {isa = PBXBuildFile; fileRef = D8370B68273DF1E900F66E2D /* SentryNSURLSessionTaskSearch.m */; };
@@ -885,7 +886,6 @@
  D8AFC01A2BD7A20B00118BE1 /* SentryViewScreenshotProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8AFC0192BD7A20B00118BE1 /* SentryViewScreenshotProvider.swift */; };
  D8AFC03D2BDA79BF00118BE1 /* SentryReplayVideoMaker.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8AFC03C2BDA79BF00118BE1 /* SentryReplayVideoMaker.swift */; };
  D8AFC0572BDA895400118BE1 /* UIRedactBuilder.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8AFC0562BDA895400118BE1 /* UIRedactBuilder.swift */; };
- D8AFC05A2BDA89C100118BE1 /* RedactRegionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8AFC0582BDA899A00118BE1 /* RedactRegionTests.swift */; };
  D8B0542E2A7D2C720056BAF6 /* PrivacyInfo.xcprivacy in Resources */ = {isa = PBXBuildFile; fileRef = D8B0542D2A7D2C720056BAF6 /* PrivacyInfo.xcprivacy */; };
  D8B088B629C9E3FF00213258 /* SentryTracerConfiguration.h in Headers */ = {isa = PBXBuildFile; fileRef = D8B088B429C9E3FF00213258 /* SentryTracerConfiguration.h */; };
  D8B088B729C9E3FF00213258 /* SentryTracerConfiguration.m in Sources */ = {isa = PBXBuildFile; fileRef = D8B088B529C9E3FF00213258 /* SentryTracerConfiguration.m */; };
@@ -1873,6 +1873,7 @@
  D820CDB62BB1895F00BA339D /* SentrySessionReplayIntegration.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentrySessionReplayIntegration.m; sourceTree = "<group>"; };
  D82859412C3E753C009A28AA /* SentrySessionReplaySyncC.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentrySessionReplaySyncC.h; path = include/SentrySessionReplaySyncC.h; sourceTree = "<group>"; };
  D82859422C3E753C009A28AA /* SentrySessionReplaySyncC.c */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.c; path = SentrySessionReplaySyncC.c; sourceTree = "<group>"; };
+ D82915622C85EF0C00A6CDD4 /* SentryViewPhotographerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryViewPhotographerTests.swift; sourceTree = "<group>"; };
  D8292D7A2A38AF04009872F7 /* HTTPHeaderSanitizer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HTTPHeaderSanitizer.swift; sourceTree = "<group>"; };
  D8292D7C2A39A027009872F7 /* UrlSanitizedTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UrlSanitizedTests.swift; sourceTree = "<group>"; };
  D82DD1CC2BEEB1A0001AB556 /* SentrySRDefaultBreadcrumbConverterTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentrySRDefaultBreadcrumbConverterTests.swift; sourceTree = "<group>"; };
@@ -1957,7 +1958,6 @@
  D8AFC0192BD7A20B00118BE1 /* SentryViewScreenshotProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryViewScreenshotProvider.swift; sourceTree = "<group>"; };
  D8AFC03C2BDA79BF00118BE1 /* SentryReplayVideoMaker.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryReplayVideoMaker.swift; sourceTree = "<group>"; };
  D8AFC0562BDA895400118BE1 /* UIRedactBuilder.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UIRedactBuilder.swift; sourceTree = "<group>"; };
- D8AFC0582BDA899A00118BE1 /* RedactRegionTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RedactRegionTests.swift; sourceTree = "<group>"; };
  D8AFC0612BDBEDF100118BE1 /* SentrySessionReplayIntegration+Private.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "SentrySessionReplayIntegration+Private.h"; path = "include/SentrySessionReplayIntegration+Private.h"; sourceTree = "<group>"; };
  D8B0542D2A7D2C720056BAF6 /* PrivacyInfo.xcprivacy */ = {isa = PBXFileReference; lastKnownFileType = text.xml; path = PrivacyInfo.xcprivacy; sourceTree = "<group>"; };
  D8B088B429C9E3FF00213258 /* SentryTracerConfiguration.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryTracerConfiguration.h; path = include/SentryTracerConfiguration.h; sourceTree = "<group>"; };
@@ -3702,10 +3702,10 @@
  D84541192A2DC55100E2B11C /* SentryBinaryImageCache+Private.h */,
  D8292D7C2A39A027009872F7 /* UrlSanitizedTests.swift */,
  D8F8F5562B835BC600AC5465 /* SentryMsgPackSerializerTests.m */,
- D8AFC0582BDA899A00118BE1 /* RedactRegionTests.swift */,
  D8F67AEF2BE0D31A00C9197B /* UIImageHelperTests.swift */,
  D8F67AF22BE10F7600C9197B /* UIRedactBuilderTests.swift */,
  51B15F7F2BE88D510026A2F2 /* URLSessionTaskHelperTests.swift */,
+ D82915622C85EF0C00A6CDD4 /* SentryViewPhotographerTests.swift */,
  );
  name = Tools;
  sourceTree = "<group>";
@@ -4830,6 +4830,7 @@
  63FE722420DA66EC00CDBAE8 /* SentryCrashMonitor_NSException_Tests.m in Sources */,
  7B5AB65D27E48E5200F1D1BA /* TestThreadInspector.swift in Sources */,
  7BF9EF742722A85B00B5BBEF /* SentryClassRegistrator.m in Sources */,
+ D82915632C85EF0C00A6CDD4 /* SentryViewPhotographerTests.swift in Sources */,
  D8DBE0CA2C0E093000FAB1FD /* SentryTouchTrackerTests.swift in Sources */,
  D8F67AF42BE10F9600C9197B /* UIRedactBuilderTests.swift in Sources */,
  63B819141EC352A7002FDF4C /* SentryInterfacesTests.m in Sources */,
@@ -4958,7 +4959,6 @@
  62BAD74E2BA1C58D00EBAAFC /* EncodeMetricTests.swift in Sources */,
  7BE0DC29272A9E1C004FA8B7 /* SentryBreadcrumbTrackerTests.swift in Sources */,
  63FE722520DA66EC00CDBAE8 /* SentryCrashFileUtils_Tests.m in Sources */,
- D8AFC05A2BDA89C100118BE1 /* RedactRegionTests.swift in Sources */,
  D86130122BB563FD004C0F5E /* SentrySessionReplayIntegrationTests.swift in Sources */,
  7BFC16BA2524D4AF00FF6266 /* SentryMessage+Equality.m in Sources */,
  7B4260342630315C00B36EDD /* SampleError.swift in Sources */,

Sources/Sentry/PrivateSentrySDKOnly.mm

@@ -11,7 +11,7 @@
 #import "SentryOptions.h"
 #import "SentrySDK+Private.h"
 #import "SentrySerialization.h"
-#import "SentrySessionReplayIntegration.h"
+#import "SentrySessionReplayIntegration+Private.h"
 #import "SentrySwift.h"
 #import "SentryThreadHandle.hpp"
 #import "SentryUser+Private.h"
@@ -21,7 +21,6 @@
 #import <SentryFramesTracker.h>
 #import <SentryScope+Private.h>
 #import <SentryScreenshot.h>
-#import <SentrySessionReplayIntegration.h>
 #import <SentryUser.h>
 
 #if SENTRY_TARGET_PROFILING_SUPPORTED
@@ -351,12 +350,12 @@ + (NSString *__nullable)getReplayId
 
 + (void)addReplayIgnoreClasses:(NSArray<Class> *_Nonnull)classes
 {
- [SentryViewPhotographer.shared addIgnoreClasses:classes];
+ [[PrivateSentrySDKOnly getReplayIntegration].viewPhotographer addIgnoreClasses:classes];
 }
 
 + (void)addReplayRedactClasses:(NSArray<Class> *_Nonnull)classes
 {
- [SentryViewPhotographer.shared addRedactClasses:classes];
+ [[PrivateSentrySDKOnly getReplayIntegration].viewPhotographer addRedactClasses:classes];
 }
 #endif
 

Sources/Sentry/SentrySessionReplayIntegration.m

@@ -63,6 +63,8 @@ - (BOOL)installWithOptions:(nonnull SentryOptions *)options
  }
 
  _replayOptions = options.experimental.sessionReplay;
+ _viewPhotographer =
+ [[SentryViewPhotographer alloc] initWithRedactOptions:options.experimental.sessionReplay];
 
  if (options.enableSwizzling) {
  _touchTracker = [[SentryTouchTracker alloc]
@@ -86,8 +88,6 @@ - (BOOL)installWithOptions:(nonnull SentryOptions *)options
  }];
 
  [SentryDependencyContainer.sharedInstance.reachability addObserver:self];
- [SentryViewPhotographer.shared addIgnoreClasses:_replayOptions.ignoreRedactViewTypes];
- [SentryViewPhotographer.shared addRedactClasses:_replayOptions.redactViewTypes];
 
  _installedInstance = self;
  return YES;
@@ -236,7 +236,7 @@ - (void)startWithOptions:(SentryReplayOptions *)replayOptions
  fullSession:(BOOL)shouldReplayFullSession
 {
  [self startWithOptions:replayOptions
- screenshotProvider:SentryViewPhotographer.shared
+ screenshotProvider:_viewPhotographer
  breadcrumbConverter:[[SentrySRDefaultBreadcrumbConverter alloc] init]
  fullSession:shouldReplayFullSession];
 }

Sources/Sentry/include/SentrySessionReplayIntegration+Private.h

@@ -5,13 +5,16 @@
 #if SENTRY_TARGET_REPLAY_SUPPORTED
 
 @class SentrySessionReplay;
+@class SentryViewPhotographer;
 
 @interface
 SentrySessionReplayIntegration () <SentryIntegrationProtocol, SentrySessionListener,
  SentrySessionReplayDelegate>
 
 @property (nonatomic, strong) SentrySessionReplay *sessionReplay;
 
+@property (nonatomic, strong) SentryViewPhotographer *viewPhotographer;
+
 @end
 
 #endif

Sources/Swift/Extensions/UIViewExtensions.swift

@@ -7,7 +7,7 @@ public extension UIView {
 
  /**
  * Marks this view to be redacted during replays.
- * - warning: This is an experimental feature and may still have bugs.
+ * - experiment: This is an experimental feature and may still have bugs.
  */
  func sentryReplayRedact() {
  SentryRedactViewHelper.redactView(self)
@@ -16,7 +16,7 @@ public extension UIView {
  /**
  * Marks this view to be ignored during redact step
  * of session replay. All its content will be visible in the replay.
- * - warning: This is an experimental feature and may still have bugs.
+ * - experiment: This is an experimental feature and may still have bugs.
  */
  func sentryReplayIgnore() {
  SentryRedactViewHelper.ignoreView(self)

Sources/Swift/Integrations/SessionReplay/SentryReplayOptions.swift

@@ -70,16 +70,18 @@ public class SentryReplayOptions: NSObject, SentryRedactOptions {
  /**
  * A list of custom UIView subclasses that need 
  * to be masked during session replay.
- * By default Sentry already mask text elements from UIKit
+ * By default Sentry already mask text and image elements from UIKit
+ * Every child of a view that is redacted will also be redacted.
  */
- public var redactViewTypes = [AnyClass]()
+ public var redactViewClasses = [AnyClass]()
 
  /**
  * A list of custom UIView subclasses to be ignored
  * during masking step of the session replay.
- * The view itself and any child will be ignored and not masked.
+ * The views of given classes will not be redacted but their children may be.
+ * This property has precedence over `redactViewTypes`.
  */
- public var ignoreRedactViewTypes = [AnyClass]()
+ public var ignoreViewClasses = [AnyClass]()
 
  /**
  * Defines the quality of the session replay.

Sources/Swift/Protocol/SentryRedactOptions.swift

@@ -4,4 +4,6 @@ import Foundation
 protocol SentryRedactOptions {
  var redactAllText: Bool { get }
  var redactAllImages: Bool { get }
+ var redactViewClasses: [AnyClass] { get }
+ var ignoreViewClasses: [AnyClass] { get }
 }

Sources/Swift/Tools/SentryViewPhotographer.swift

@@ -1,32 +1,79 @@
 #if canImport(UIKit) && !SENTRY_NO_UIKIT
 #if os(iOS) || os(tvOS)
 
+@_implementationOnly import _SentryPrivate
 import CoreGraphics
 import Foundation
 import UIKit
 
+protocol ViewRenderer {
+ func render(view: UIView) -> UIImage
+}
+
+class DefaultViewRenderer: ViewRenderer {
+ func render(view: UIView) -> UIImage {
+ let image = UIGraphicsImageRenderer(size: view.bounds.size).image { _ in
+ view.drawHierarchy(in: view.bounds, afterScreenUpdates: false)
+ }
+ return image
+ }
+}
+
 @objcMembers
 class SentryViewPhotographer: NSObject, SentryViewScreenshotProvider {
+ private let redactBuilder: UIRedactBuilder
+ private let dispatchQueue = SentryDispatchQueueWrapper()
+
+ var renderer: ViewRenderer
+
+ init(renderer: ViewRenderer, redactOptions: SentryRedactOptions) {
+ self.renderer = renderer
+ redactBuilder = UIRedactBuilder(options: redactOptions)
+ super.init()
+ }
 
- static let shared = SentryViewPhotographer()
-
- private let redactBuilder = UIRedactBuilder()
+ init(redactOptions: SentryRedactOptions) {
+ self.renderer = DefaultViewRenderer()
+ self.redactBuilder = UIRedactBuilder(options: redactOptions)
+ }
 
  func image(view: UIView, options: SentryRedactOptions, onComplete: @escaping ScreenshotCallback ) {
- let image = UIGraphicsImageRenderer(size: view.bounds.size).image { _ in
- view.drawHierarchy(in: view.bounds, afterScreenUpdates: false)
- }
+ let image = renderer.render(view: view)
 
- let redact = redactBuilder.redactRegionsFor(view: view, options: options)
+ let redact = redactBuilder.redactRegionsFor(view: view)
  let imageSize = view.bounds.size
- DispatchQueue.global().async {
+ dispatchQueue.dispatchAsync {
  let screenshot = UIGraphicsImageRenderer(size: imageSize, format: .init(for: .init(displayScale: 1))).image { context in
+
+ context.cgContext.addRect(CGRect(origin: CGPoint.zero, size: imageSize))
+ context.cgContext.clip(using: .evenOdd)
+ UIColor.blue.setStroke()
+
  context.cgContext.interpolationQuality = .none
  image.draw(at: .zero)
 
  for region in redact {
- (region.color ?? UIImageHelper.averageColor(of: context.currentImage, at: region.rect)).setFill()
- context.fill(region.rect)
+ let rect = CGRect(origin: CGPoint.zero, size: region.size)
+ var transform = region.transform
+ let path = CGPath(rect: rect, transform: &transform)
+
+ switch region.type {
+ case .redact:
+ (region.color ?? UIImageHelper.averageColor(of: context.currentImage, at: rect.applying(region.transform))).setFill()
+ context.cgContext.addPath(path)
+ context.cgContext.fillPath()
+ case .clipOut:
+ context.cgContext.addRect(context.cgContext.boundingBoxOfClipPath)
+ context.cgContext.addPath(path)
+ context.cgContext.clip(using: .evenOdd)
+ case .clipBegin:
+ context.cgContext.saveGState()
+ context.cgContext.resetClip()
+ context.cgContext.addPath(path)
+ context.cgContext.clip()
+ case .clipEnd:
+ context.cgContext.restoreGState()
+ }
  }
  }
  onComplete(screenshot)