feat(session-replay): refactor session replay types and added logging (#5082)

Author: philprime

Samples/iOS-Swift/iOS-Swift/SentrySDKWrapper.swift

@@ -19,7 +19,12 @@ struct SentrySDKWrapper {
         options.debug = true
 
         if #available(iOS 16.0, *), enableSessionReplay {
-            options.sessionReplay = SentryReplayOptions(sessionSampleRate: 0, onErrorSampleRate: 1, maskAllText: true, maskAllImages: true)
+            options.sessionReplay = SentryReplayOptions(
+                sessionSampleRate: 0,
+                onErrorSampleRate: 1,
+                maskAllText: true,
+                maskAllImages: true
+            )
             options.sessionReplay.quality = .high
         }
 

Sentry.xcodeproj/project.pbxproj

@@ -821,6 +821,8 @@
 		D43B26D62D70964C007747FD /* SentrySpanOperation.m in Sources */ = {isa = PBXBuildFile; fileRef = D43B26D52D709648007747FD /* SentrySpanOperation.m */; };
 		D43B26D82D70A550007747FD /* SentryTraceOrigin.m in Sources */ = {isa = PBXBuildFile; fileRef = D43B26D72D70A54A007747FD /* SentryTraceOrigin.m */; };
 		D43B26DA2D70A612007747FD /* SentrySpanDataKey.m in Sources */ = {isa = PBXBuildFile; fileRef = D43B26D92D70A60E007747FD /* SentrySpanDataKey.m */; };
+		D451ED5D2D92ECD200C9BEA8 /* SentryOnDemandReplayError.swift in Sources */ = {isa = PBXBuildFile; fileRef = D451ED5C2D92ECD200C9BEA8 /* SentryOnDemandReplayError.swift */; };
+		D451ED5F2D92ECDE00C9BEA8 /* SentryReplayFrame.swift in Sources */ = {isa = PBXBuildFile; fileRef = D451ED5E2D92ECDE00C9BEA8 /* SentryReplayFrame.swift */; };
 		D456B4322D706BDF007068CB /* SentrySpanOperation.h in Headers */ = {isa = PBXBuildFile; fileRef = D456B4312D706BDD007068CB /* SentrySpanOperation.h */; };
 		D456B4362D706BF2007068CB /* SentryTraceOrigin.h in Headers */ = {isa = PBXBuildFile; fileRef = D456B4352D706BEE007068CB /* SentryTraceOrigin.h */; };
 		D456B4382D706BFE007068CB /* SentrySpanDataKey.h in Headers */ = {isa = PBXBuildFile; fileRef = D456B4372D706BFB007068CB /* SentrySpanDataKey.h */; };
@@ -1981,6 +1983,8 @@
 		D43B26D52D709648007747FD /* SentrySpanOperation.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentrySpanOperation.m; sourceTree = "<group>"; };
 		D43B26D72D70A54A007747FD /* SentryTraceOrigin.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryTraceOrigin.m; sourceTree = "<group>"; };
 		D43B26D92D70A60E007747FD /* SentrySpanDataKey.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentrySpanDataKey.m; sourceTree = "<group>"; };
+		D451ED5C2D92ECD200C9BEA8 /* SentryOnDemandReplayError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryOnDemandReplayError.swift; sourceTree = "<group>"; };
+		D451ED5E2D92ECDE00C9BEA8 /* SentryReplayFrame.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryReplayFrame.swift; sourceTree = "<group>"; };
 		D456B4312D706BDD007068CB /* SentrySpanOperation.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentrySpanOperation.h; path = include/SentrySpanOperation.h; sourceTree = "<group>"; };
 		D456B4352D706BEE007068CB /* SentryTraceOrigin.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryTraceOrigin.h; path = include/SentryTraceOrigin.h; sourceTree = "<group>"; };
 		D456B4372D706BFB007068CB /* SentrySpanDataKey.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentrySpanDataKey.h; path = include/SentrySpanDataKey.h; sourceTree = "<group>"; };
@@ -4265,6 +4269,8 @@
 				D8CAC02A2BA0663E00E38F34 /* SentryReplayOptions.swift */,
 				D8CAC02B2BA0663E00E38F34 /* SentryVideoInfo.swift */,
 				D802994D2BA836EF000F0081 /* SentryOnDemandReplay.swift */,
+				D451ED5E2D92ECDE00C9BEA8 /* SentryReplayFrame.swift */,
+				D451ED5C2D92ECD200C9BEA8 /* SentryOnDemandReplayError.swift */,
 				D802994F2BA83A88000F0081 /* SentryPixelBuffer.swift */,
 				D8AFC03C2BDA79BF00118BE1 /* SentryReplayVideoMaker.swift */,
 				D8F67B1A2BE9728600C9197B /* SentrySRDefaultBreadcrumbConverter.swift */,
@@ -5032,6 +5038,7 @@
 				7B30B67E26527894006B2752 /* SentryDisplayLinkWrapper.m in Sources */,
 				63FE711D20DA4C1000CDBAE8 /* SentryCrashCPU_arm64.c in Sources */,
 				844EDC77294144DB00C86F34 /* SentrySystemWrapper.mm in Sources */,
+				D451ED5F2D92ECDE00C9BEA8 /* SentryReplayFrame.swift in Sources */,
 				D8739CF92BECFFB5007D2F66 /* SentryTransactionNameSource.swift in Sources */,
 				630435FF1EBCA9D900C4D3FA /* SentryNSURLRequest.m in Sources */,
 				6281C5722D3E4F12009D0978 /* DecodeArbitraryData.swift in Sources */,
@@ -5124,6 +5131,7 @@
 				D83D079C2B7F9D1C00CC9674 /* SentryMsgPackSerializer.m in Sources */,
 				7B6D1261265F784000C9BE4B /* PrivateSentrySDKOnly.mm in Sources */,
 				63BE85711ECEC6DE00DC44F5 /* SentryDateUtils.m in Sources */,
+				D451ED5D2D92ECD200C9BEA8 /* SentryOnDemandReplayError.swift in Sources */,
 				D4E829D82D75E57900D375AD /* SentryMaskRenderer.swift in Sources */,
 				7BD4BD4927EB2A5D0071F4FF /* SentryDiscardedEvent.m in Sources */,
 				628308612D50ADAC00EAEF77 /* SentryRequestCodable.swift in Sources */,

Sources/Sentry/SentrySessionReplayIntegration.m

@@ -57,6 +57,7 @@ @implementation SentrySessionReplayIntegration {
     // This is the easiest way to ensure segment 0 will always reach the server, because session
     // replay absolutely needs segment 0 to make replay work.
     BOOL _rateLimited;
+    id<SentryCurrentDateProvider> _dateProvider;
 }
 
 - (instancetype)init
@@ -97,6 +98,8 @@ - (void)setupWith:(SentryReplayOptions *)replayOptions
 {
     _replayOptions = replayOptions;
     _rateLimits = SentryDependencyContainer.sharedInstance.rateLimits;
+    _dateProvider = SentryDependencyContainer.sharedInstance.dateProvider;
+
     id<SentryViewRenderer> viewRenderer;
     if (enableExperimentalRenderer) {
         viewRenderer = [[SentryExperimentalViewRenderer alloc]
@@ -113,14 +116,15 @@ - (void)setupWith:(SentryReplayOptions *)replayOptions
                           enableExperimentalMaskRenderer:enableExperimentalRenderer];
 
     if (touchTracker) {
-        _touchTracker = [[SentryTouchTracker alloc]
-            initWithDateProvider:SentryDependencyContainer.sharedInstance.dateProvider
-                           scale:replayOptions.sizeScale];
+        _touchTracker = [[SentryTouchTracker alloc] initWithDateProvider:_dateProvider
+                                                                   scale:replayOptions.sizeScale];
         [self swizzleApplicationTouch];
     }
 
     _notificationCenter = SentryDependencyContainer.sharedInstance.notificationCenterWrapper;
 
+    // The asset worker queue is used to work on video and frames data.
+
     [self moveCurrentReplay];
     [self cleanUp];
 
@@ -196,23 +200,23 @@ - (void)resumePreviousSessionReplay:(SentryEvent *)event
     NSDate *beginning = hasCrashInfo
         ? [NSDate dateWithTimeIntervalSinceReferenceDate:crashInfo.lastSegmentEnd]
         : [resumeReplayMaker oldestFrameDate];
-
     if (beginning == nil) {
         return; // no frames to send
     }
-
-    SentryReplayType _type = type;
-    int _segmentId = segmentId;
+    NSDate *end = [beginning dateByAddingTimeInterval:duration];
 
     NSError *error;
-    NSArray<SentryVideoInfo *> *videos =
-        [resumeReplayMaker createVideoWithBeginning:beginning
-                                                end:[beginning dateByAddingTimeInterval:duration]
-                                              error:&error];
+    NSArray<SentryVideoInfo *> *videos = [resumeReplayMaker createVideoWithBeginning:beginning
+                                                                                 end:end
+                                                                               error:&error];
     if (videos == nil) {
-        SENTRY_LOG_ERROR(@"Could not create replay video: %@", error);
+        SENTRY_LOG_ERROR(@"Could not create replay video, reason: %@", error);
         return;
     }
+
+    // For each segment we need to create a new event with the video.
+    int _segmentId = segmentId;
+    SentryReplayType _type = type;
     for (SentryVideoInfo *video in videos) {
         [self captureVideo:video replayId:replayId segmentId:_segmentId++ type:_type];
         // type buffer is only for the first segment
@@ -224,8 +228,11 @@ - (void)resumePreviousSessionReplay:(SentryEvent *)event
         [NSDictionary dictionaryWithObjectsAndKeys:replayId.sentryIdString, @"replay_id", nil];
     event.context = eventContext;
 
-    if ([NSFileManager.defaultManager removeItemAtURL:lastReplayURL error:&error] == NO) {
-        SENTRY_LOG_ERROR(@"Can`t delete '%@': %@", SENTRY_LAST_REPLAY, error);
+    NSError *_Nullable removeError;
+    BOOL result = [NSFileManager.defaultManager removeItemAtURL:lastReplayURL error:&removeError];
+    if (result == NO) {
+        SENTRY_LOG_ERROR(@"Can't delete '%@' with file item at url: '%@', reason: %@",
+            SENTRY_LAST_REPLAY, lastReplayURL, removeError);
     }
 }
 

Sources/Swift/Integrations/SessionReplay/SentryOnDemandReplay.swift

@@ -7,18 +7,6 @@ import CoreGraphics
 import Foundation
 import UIKit
 
-struct SentryReplayFrame {
-    let imagePath: String
-    let time: Date
-    let screenName: String?
-}
-
-enum SentryOnDemandReplayError: Error {
-    case cantReadVideoSize
-    case cantCreatePixelBuffer
-    case errorRenderingVideo
-}
-
 @objcMembers
 class SentryOnDemandReplay: NSObject, SentryReplayVideoMaker {
 
@@ -27,7 +15,7 @@ class SentryOnDemandReplay: NSObject, SentryReplayVideoMaker {
     private let dateProvider: SentryCurrentDateProvider
     private let workingQueue: SentryDispatchQueueWrapper
     private var _frames = [SentryReplayFrame]()
-    
+
     #if SENTRY_TEST || SENTRY_TEST_CI || DEBUG
     //This is exposed only for tests, no need to make it thread safe.
     var frames: [SentryReplayFrame] {
@@ -48,20 +36,28 @@ class SentryOnDemandReplay: NSObject, SentryReplayVideoMaker {
 
     convenience init(withContentFrom outputPath: String, workingQueue: SentryDispatchQueueWrapper, dateProvider: SentryCurrentDateProvider) {
         self.init(outputPath: outputPath, workingQueue: workingQueue, dateProvider: dateProvider)
-        
+        loadFrames(fromPath: outputPath)
+    }
+
+    /// Loads the frames from the given path.
+    ///
+    /// - Parameter path: The path to the directory containing the frames.
+    private func loadFrames(fromPath path: String) {
+        SentryLog.debug("[Session Replay] Loading frames from path: \(path)")
         do {
-            let content = try FileManager.default.contentsOfDirectory(atPath: outputPath)
-            _frames = content.compactMap {
-                guard $0.hasSuffix(".png") else { return SentryReplayFrame?.none }
-                guard let time = Double($0.dropLast(4)) else { return nil }
-                return SentryReplayFrame(imagePath: "\(outputPath)/\($0)", time: Date(timeIntervalSinceReferenceDate: time), screenName: nil)
+            let content = try FileManager.default.contentsOfDirectory(atPath: path)
+            _frames = content.compactMap { frameFilePath -> SentryReplayFrame? in
+                guard frameFilePath.hasSuffix(".png") else { return nil }
+                guard let time = Double(frameFilePath.dropLast(4)) else { return nil }
+                let timestamp = Date(timeIntervalSinceReferenceDate: time)
+                return SentryReplayFrame(imagePath: "\(path)/\(frameFilePath)", time: timestamp, screenName: nil)
             }.sorted { $0.time < $1.time }
+            SentryLog.debug("[Session Replay] Loaded \(content.count) files into \(_frames.count) frames from path: \(path)")
         } catch {
-            SentryLog.debug("Could not list frames from replay: \(error.localizedDescription)")
-            return
+            SentryLog.error("[Session Replay] Could not list frames from replay: \(error.localizedDescription)")
         }
     }
-    
+
     convenience init(outputPath: String) {
         self.init(outputPath: outputPath,
                   workingQueue: SentryDispatchQueueWrapper(name: "io.sentry.onDemandReplay", attributes: nil),
@@ -73,7 +69,7 @@ class SentryOnDemandReplay: NSObject, SentryReplayVideoMaker {
                   workingQueue: SentryDispatchQueueWrapper(name: "io.sentry.onDemandReplay", attributes: nil),
                   dateProvider: SentryDefaultCurrentDateProvider())
     }
-    
+
     func addFrameAsync(image: UIImage, forScreen: String?) {
         workingQueue.dispatchAsync({
             self.addFrame(image: image, forScreen: forScreen)
@@ -88,11 +84,12 @@ class SentryOnDemandReplay: NSObject, SentryReplayVideoMaker {
         do {
             try data.write(to: URL(fileURLWithPath: imagePath))
         } catch {
-            SentryLog.debug("Could not save replay frame. Error: \(error)")
+            SentryLog.error("[Session Replay] Could not save replay frame. Error: \(error)")
             return
         }
         _frames.append(SentryReplayFrame(imagePath: imagePath, time: date, screenName: forScreen))
-        
+
+        // Remove the oldest frames if the cache size exceeds the maximum size.
         while _frames.count > cacheMaxSize {
             let first = _frames.removeFirst()
             try? FileManager.default.removeItem(at: URL(fileURLWithPath: first.imagePath))
@@ -111,10 +108,17 @@ class SentryOnDemandReplay: NSObject, SentryReplayVideoMaker {
     }
 
     func releaseFramesUntil(_ date: Date) {
+        SentryLog.debug("[Session Replay] Releasing frames until date: \(date)")
         workingQueue.dispatchAsync ({
             while let first = self._frames.first, first.time < date {
                 self._frames.removeFirst()
-                try? FileManager.default.removeItem(at: URL(fileURLWithPath: first.imagePath))
+                let fileUrl = URL(fileURLWithPath: first.imagePath)
+                do {
+                    try FileManager.default.removeItem(at: fileUrl)
+                    SentryLog.debug("[Session Replay] Removed frame at url: \(fileUrl.path)")
+                } catch {
+                    SentryLog.error("[Session Replay] Failed to remove frame at: \(fileUrl.path), reason: \(error.localizedDescription), ignoring error")
+                }
             }
         })
     }
@@ -239,7 +243,7 @@ class SentryOnDemandReplay: NSObject, SentryReplayVideoMaker {
         })
         return frames
     }
-    
+
     private func createVideoSettings(width: CGFloat, height: CGFloat) -> [String: Any] {
         return [
             AVVideoCodecKey: AVVideoCodecType.h264,

Sources/Swift/Integrations/SessionReplay/SentryOnDemandReplayError.swift

@@ -0,0 +1,6 @@
+enum SentryOnDemandReplayError: Error {
+    case cantReadVideoSize
+    case cantCreatePixelBuffer
+    case errorRenderingVideo
+    case cantReadVideoStartTime
+}

Sources/Swift/Integrations/SessionReplay/SentryReplayFrame.swift

@@ -0,0 +1,7 @@
+import Foundation
+
+struct SentryReplayFrame {
+    let imagePath: String
+    let time: Date
+    let screenName: String?
+}

Sources/Swift/Integrations/SessionReplay/SentrySessionReplay.swift

@@ -131,7 +131,7 @@ class SentrySessionReplay: NSObject {
         videoSegmentStart = nil
         displayLink.link(withTarget: self, selector: #selector(newFrame(_:)))
     }
-  
+
     func captureReplayFor(event: Event) {
         guard isRunning else { return }
 
@@ -140,8 +140,9 @@ class SentrySessionReplay: NSObject {
             return
         }
 
-        guard (event.error != nil || event.exceptions?.isEmpty == false)
-        && captureReplay() else { return }
+        guard (event.error != nil || event.exceptions?.isEmpty == false) && captureReplay() else { 
+            return
+        }
 
         setEventContext(event: event)
     }
@@ -223,6 +224,7 @@ class SentrySessionReplay: NSObject {
     }
 
     private func createAndCapture(startedAt: Date, replayType: SentryReplayType) {
+        SentryLog.debug("[Session Replay] Creating replay video started at date: \(startedAt), replayType: \(replayType)")
         //Creating a video is heavy and blocks the thread
         //Since this function is always called in the main thread
         //we dispatch it to a background thread.
@@ -232,13 +234,15 @@ class SentrySessionReplay: NSObject {
                 for video in videos {
                     self.newSegmentAvailable(videoInfo: video, replayType: replayType)
                 }
+                SentryLog.debug("[Session Replay] Finished replay video creation with \(videos.count) segments")
             } catch {
                 SentryLog.debug("Could not create replay video - \(error.localizedDescription)")
             }
         }
     }
 
     private func newSegmentAvailable(videoInfo: SentryVideoInfo, replayType: SentryReplayType) {
+        SentryLog.debug("[Session Replay] New segment available for replayType: \(replayType), videoInfo: \(videoInfo)")
         guard let sessionReplayId = sessionReplayId else { return }
         captureSegment(segment: currentSegmentId, video: videoInfo, replayId: sessionReplayId, replayType: replayType)
         replayMaker.releaseFramesUntil(videoInfo.end)
@@ -270,7 +274,7 @@ class SentrySessionReplay: NSObject {
         }
 
         let recording = SentryReplayRecording(segmentId: segment, video: video, extraEvents: events)
-                
+
         delegate?.sessionReplayNewSegment(replayEvent: replayEvent, replayRecording: recording, videoUrl: video.path)
 
         do {
@@ -302,15 +306,15 @@ class SentrySessionReplay: NSObject {
 
     private func takeScreenshot() {
         guard let rootView = rootView, !processingScreenshot else { return }
- 
+
         lock.lock()
         guard !processingScreenshot else {
             lock.unlock()
             return
         }
         processingScreenshot = true
         lock.unlock()
-
+        
         let screenName = delegate?.currentScreenNameForSessionReplay()
 
         screenshotProvider.image(view: rootView) { [weak self] screenshot in