ref: Use average color for redact masking (#3877)

Use the text color or the average color of the image as the redaction mask.

Co-authored-by: Philipp Hofmann <[email protected]>

Author: brustolin

Samples/iOS-Swift/iOS-Swift/AppDelegate.swift

@@ -25,7 +25,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             options.debug = true
 
             if #available(iOS 16.0, *) {
-                options.experimental.sessionReplay = SentryReplayOptions(sessionSampleRate: 0, errorSampleRate: 1, redactAllText: true, redactAllImages: true)
+                options.experimental.sessionReplay = SentryReplayOptions(sessionSampleRate: 1, errorSampleRate: 1, redactAllText: true, redactAllImages: true)
             }
 
             if #available(iOS 15.0, *) {

Sentry.xcodeproj/project.pbxproj

@@ -35,7 +35,7 @@ @implementation SentrySessionReplay {
     NSDate *_sessionStart;
     NSMutableArray<UIImage *> *imageCollection;
     SentryReplayOptions *_replayOptions;
-    SentryOnDemandReplay *_replayMaker;
+    id<SentryReplayVideoMaker> _replayMaker;
     SentryDisplayLinkWrapper *_displayLink;
     SentryCurrentDateProvider *_dateProvider;
     id<SentryRandom> _sentryRandom;
@@ -48,7 +48,7 @@ @implementation SentrySessionReplay {
 - (instancetype)initWithSettings:(SentryReplayOptions *)replayOptions
                 replayFolderPath:(NSURL *)folderPath
               screenshotProvider:(id<SentryViewScreenshotProvider>)screenshotProvider
-                     replayMaker:(id<SentryReplayMaker>)replayMaker
+                     replayMaker:(id<SentryReplayVideoMaker>)replayMaker
                     dateProvider:(SentryCurrentDateProvider *)dateProvider
                           random:(id<SentryRandom>)random
               displayLinkWrapper:(SentryDisplayLinkWrapper *)displayLinkWrapper;
@@ -242,6 +242,7 @@ - (void)createAndCapture:(NSURL *)videoUrl
                 duration:(NSTimeInterval)duration
                startedAt:(NSDate *)start
 {
+    __weak SentrySessionReplay *weakSelf = self;
     [_replayMaker
         createVideoWithDuration:duration
                       beginning:start
@@ -251,17 +252,22 @@ - (void)createAndCapture:(NSURL *)videoUrl
                          if (error != nil) {
                              SENTRY_LOG_ERROR(@"Could not create replay video - %@", error);
                          } else {
-                             [self captureSegment:self->_currentSegmentId++
-                                            video:videoInfo
-                                         replayId:self->_sessionReplayId
-                                       replayType:kSentryReplayTypeSession];
-
-                             [self->_replayMaker releaseFramesUntil:videoInfo.end];
-                             self->_videoSegmentStart = nil;
+                             [weakSelf newSegmentAvailable:videoInfo];
                          }
                      }];
 }
 
+- (void)newSegmentAvailable:(SentryVideoInfo *)videoInfo
+{
+    [self captureSegment:self->_currentSegmentId++
+                   video:videoInfo
+                replayId:self->_sessionReplayId
+              replayType:kSentryReplayTypeSession];
+
+    [_replayMaker releaseFramesUntil:videoInfo.end];
+    _videoSegmentStart = nil;
+}
+
 - (void)captureSegment:(NSInteger)segment
                  video:(SentryVideoInfo *)videoInfo
               replayId:(SentryId *)replayid
@@ -306,11 +312,16 @@ - (void)takeScreenshot
         _processingScreenshot = YES;
     }
 
-    UIImage *screenshot = [_screenshotProvider imageWithView:_rootView options:_replayOptions];
+    __weak SentrySessionReplay *weakSelf = self;
+    [_screenshotProvider imageWithView:_rootView
+                               options:_replayOptions
+                            onComplete:^(UIImage *screenshot) { [weakSelf newImage:screenshot]; }];
+}
 
+- (void)newImage:(UIImage *)image
+{
     _processingScreenshot = NO;
-
-    [self->_replayMaker addFrameAsyncWithImage:screenshot];
+    [_replayMaker addFrameAsyncWithImage:image];
 }
 
 @end

Sources/Sentry/SentryCoreGraphicsHelper.m

@@ -28,17 +28,6 @@
 - (void)newSceneActivate;
 @end
 
-API_AVAILABLE(ios(16.0), tvos(16.0))
-@interface
-SentryViewPhotographer (SentryViewScreenshotProvider) <SentryViewScreenshotProvider>
-@end
-
-API_AVAILABLE(ios(16.0), tvos(16.0))
-@interface
-SentryOnDemandReplay (SentryReplayMaker) <SentryReplayMaker>
-
-@end
-
 @implementation SentrySessionReplayIntegration {
     BOOL _startedAsFullSession;
     SentryReplayOptions *_replayOptions;

Sources/Sentry/SentrySessionReplay.m

@@ -11,4 +11,3 @@
 
 // Headers that also import SentryDefines should be at the end of this list
 // otherwise it wont compile
-#import "SentryCoreGraphicsHelper.h"

Sources/Sentry/SentrySessionReplayIntegration.m

@@ -13,35 +13,19 @@
 
 @protocol SentryRandom;
 @protocol SentryRedactOptions;
+@protocol SentryViewScreenshotProvider;
+@protocol SentryReplayVideoMaker;
 
 NS_ASSUME_NONNULL_BEGIN
 
-@protocol SentryReplayMaker <NSObject>
-
-- (void)addFrameAsyncWithImage:(UIImage *)image;
-- (void)releaseFramesUntil:(NSDate *)date;
-- (BOOL)createVideoWithDuration:(NSTimeInterval)duration
-                      beginning:(NSDate *)beginning
-                  outputFileURL:(NSURL *)outputFileURL
-                          error:(NSError *_Nullable *_Nullable)error
-                     completion:
-                         (void (^)(SentryVideoInfo *_Nullable, NSError *_Nullable))completion;
-
-@end
-
-@protocol SentryViewScreenshotProvider <NSObject>
-- (UIImage *)imageWithView:(UIView *)view options:(id<SentryRedactOptions>)options;
-@end
-
-API_AVAILABLE(ios(16.0), tvos(16.0))
 @interface SentrySessionReplay : NSObject
 
 @property (nonatomic, strong, readonly) SentryId *sessionReplayId;
 
 - (instancetype)initWithSettings:(SentryReplayOptions *)replayOptions
                 replayFolderPath:(NSURL *)folderPath
               screenshotProvider:(id<SentryViewScreenshotProvider>)photographer
-                     replayMaker:(id<SentryReplayMaker>)replayMaker
+                     replayMaker:(id<SentryReplayVideoMaker>)replayMaker
                     dateProvider:(SentryCurrentDateProvider *)dateProvider
                           random:(id<SentryRandom>)random
               displayLinkWrapper:(SentryDisplayLinkWrapper *)displayLinkWrapper;

Sources/Sentry/include/SentryCoreGraphicsHelper.h

@@ -22,7 +22,7 @@ enum SentryOnDemandReplayError: Error {
 }
 
 @objcMembers
-class SentryOnDemandReplay: NSObject {
+class SentryOnDemandReplay: NSObject, SentryReplayVideoMaker {
     private let _outputPath: String
     private var _currentPixelBuffer: SentryPixelBuffer?
     private var _totalFrames = 0

Sources/Sentry/include/SentryPrivate.h

@@ -0,0 +1,11 @@
+#if canImport(UIKit)
+import Foundation
+import UIKit
+
+@objc
+protocol SentryReplayVideoMaker: NSObjectProtocol {
+    func addFrameAsync(image: UIImage)
+    func releaseFramesUntil(_ date: Date)
+    func createVideoWith(duration: TimeInterval, beginning: Date, outputFileURL: URL, completion: @escaping (SentryVideoInfo?, Error?) -> Void) throws
+}
+#endif