feat(Session Replay): Session Replay Integration

Package.swift

@@ -12,13 +12,13 @@ let package = Package(
     targets: [
         .binaryTarget(
                     name: "Sentry",
-                    url: "https://github.com/getsentry/sentry-cocoa/releases/download/8.22.0-alpha.0/Sentry.xcframework.zip",
-                    checksum: "86156301aee5c8774a8cd5c240286f914f6e7721aaac5a7c9d049ea613a4b730" //Sentry-Static
+                    url: "https://github.com/getsentry/sentry-cocoa/releases/download/8.22.4/Sentry.xcframework.zip",
+                    checksum: "0fb20e85ff8fe2fdfcf6add48bd510bccf113f7db3795931e1d8dc0dbbc6d46d" //Sentry-Static
                 ),
         .binaryTarget(
                     name: "Sentry-Dynamic",
-                    url: "https://github.com/getsentry/sentry-cocoa/releases/download/8.22.0-alpha.0/Sentry-Dynamic.xcframework.zip",
-                    checksum: "86156301aee5c8774a8cd5c240286f914f6e7721aaac5a7c9d049ea613a4b730" //Sentry-Dynamic
+                    url: "https://github.com/getsentry/sentry-cocoa/releases/download/8.22.4/Sentry-Dynamic.xcframework.zip",
+                    checksum: "391cb3b9fe2e967383e9232c53daa547ca60a02b1515ff99da6515dbced165a5" //Sentry-Dynamic
                 ),
         .target ( name: "SentrySwiftUI",
                   dependencies: ["Sentry", "SentryInternal"],

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

@@ -15,13 +15,17 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         let dsn = DSNStorage.shared.getDSN() ?? AppDelegate.defaultDSN
         DSNStorage.shared.saveDSN(dsn: dsn)
 
-        SentrySDK.start { options in
+        SentrySDK.start(configureOptions: { options in
             options.dsn = dsn
             options.beforeSend = { event in
                 return event
             }
             options.debug = true
 
+            if #available(iOS 16.0, *) {
+                options.experimental.sessionReplay = SentryReplayOptions(sessionSampleRate: 1, errorSampleRate: 1, redactAllText: false, redactAllImages: true)
+            }
+
             if #available(iOS 15.0, *) {
                 options.enableMetricKit = true
             }
@@ -58,7 +62,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             options.sessionTrackingIntervalMillis = 5_000
             options.attachScreenshot = true
             options.attachViewHierarchy = true
-            
+
 #if targetEnvironment(simulator)
             options.enableSpotlight = true
             options.environment = "test-app"
@@ -127,7 +131,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
                 }
                 return scope
             }
-        }
+        })
     }
     //swiftlint:enable function_body_length
 

Sentry.podspec

@@ -32,7 +32,8 @@ Pod::Spec.new do |s|
 
   s.subspec 'Core' do |sp|
       sp.source_files = "Sources/Sentry/**/*.{h,hpp,m,mm,c,cpp}",
-        "Sources/SentryCrash/**/*.{h,hpp,m,mm,c,cpp}", "Sources/Swift/**/*.{swift,h,hpp,m,mm,c,cpp}", "Sources/Sentry/include/module.modulemap"
+        "Sources/SentryCrash/**/*.{h,hpp,m,mm,c,cpp}", "Sources/Swift/**/*.{swift,h,hpp,m,mm,c,cpp}"
+      sp.preserve_path = "Sources/Sentry/include/module.modulemap"
       sp.public_header_files =
         "Sources/Sentry/Public/*.h"
       sp.resource_bundles = { "Sentry" => "Sources/Resources/PrivacyInfo.xcprivacy" }
@@ -41,7 +42,8 @@ Pod::Spec.new do |s|
   s.subspec 'HybridSDK' do |sp|
       sp.source_files = "Sources/Sentry/**/*.{h,hpp,m,mm,c,cpp}",
         "Sources/SentryCrash/**/*.{h,hpp,m,mm,c,cpp}", "Sources/Swift/**/*.{swift,h,hpp,m,mm,c,cpp}"
-
+
+      sp.preserve_path = "Sources/Sentry/include/module.modulemap"
       sp.public_header_files =
         "Sources/Sentry/Public/*.h", "Sources/Sentry/include/HybridPublic/*.h"
 

SentryTestUtils/TestCurrentDateProvider.swift

@@ -43,6 +43,10 @@ public class TestCurrentDateProvider: SentryCurrentDateProvider {
         setDate(date: date().addingTimeInterval(TimeInterval(nanoseconds) / 1e9))
         internalSystemTime += nanoseconds
     }
+
+    public func advanceBy(interval: TimeInterval) {
+        setDate(date: date().addingTimeInterval(interval))
+    }
 
     public var timezoneOffsetValue = 0
     public override func timezoneOffset() -> Int {

SentryTestUtils/TestTransport.swift

@@ -1,3 +1,4 @@
+import _SentryPrivate
 import Foundation
 
 @objc

Sources/Configuration/SentryNoUI.xcconfig

@@ -0,0 +1,3 @@
+#include "Sentry.xcconfig"
+
+OTHER_SWIFT_FLAGS = -DSENTRY_NO_UIKIT

Sources/Sentry/Public/Sentry.h

@@ -28,7 +28,6 @@ FOUNDATION_EXPORT const unsigned char SentryVersionString[];
 #import "SentryMessage.h"
 #import "SentryNSError.h"
 #import "SentryOptions.h"
-#import "SentryReplayOptions.h"
 #import "SentryRequest.h"
 #import "SentrySDK.h"
 #import "SentrySampleDecision.h"

Sources/Sentry/Public/SentryOptions.h

@@ -5,6 +5,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @class SentryDsn, SentryMeasurementValue, SentryHttpStatusCodeRange, SentryScope,
     SentryReplayOptions;
+@class SentryExperimentalOptions;
 
 NS_SWIFT_NAME(Options)
 @interface SentryOptions : NSObject
@@ -271,14 +272,6 @@ NS_SWIFT_NAME(Options)
  */
 @property (nonatomic, assign) BOOL enablePreWarmedAppStartTracing;
 
-/**
- * @warning This is an experimental feature and may still have bugs.
- * Settings to configure the session replay.
- * @node Default value is @c nil .
- */
-@property (nonatomic, strong)
-    SentryReplayOptions *sessionReplayOptions API_AVAILABLE(ios(16.0), tvos(16.0));
-
 #endif // SENTRY_UIKIT_AVAILABLE
 
 /**
@@ -567,6 +560,12 @@ NS_SWIFT_NAME(Options)
  */
 @property (nonatomic, copy) NSString *spotlightUrl;
 
+/**
+ * This will agreggate options for all experimental features.
+ * Be aware that the options available for experimental can change at any time.
+ */
+@property (nonatomic, readonly) SentryExperimentalOptions *experimental;
+
 @end
 
 NS_ASSUME_NONNULL_END

Sources/Sentry/SentryBaseIntegration.m

@@ -1,7 +1,7 @@
 #import "SentryBaseIntegration.h"
 #import "SentryCrashWrapper.h"
 #import "SentryLog.h"
-#import "SentryReplayOptions.h"
+#import "SentrySwift.h"
 #import <Foundation/Foundation.h>
 #import <SentryDependencyContainer.h>
 #import <SentryOptions+Private.h>
@@ -144,8 +144,8 @@ - (BOOL)shouldBeEnabledWithOptions:(SentryOptions *)options
 
     if (integrationOptions & kIntegrationOptionEnableReplay) {
         if (@available(iOS 16.0, tvOS 16.0, *)) {
-            if (options.sessionReplayOptions.replaysOnErrorSampleRate == 0
-                && options.sessionReplayOptions.replaysSessionSampleRate == 0) {
+            if (options.experimental.sessionReplay.errorSampleRate == 0
+                && options.experimental.sessionReplay.sessionSampleRate == 0) {
                 [self logWithOptionName:@"sessionReplaySettings"];
                 return NO;
             }

Sources/Sentry/SentryClient.m

@@ -504,8 +504,9 @@ - (void)captureReplayEvent:(SentryReplayEvent *)replayEvent
         return;
     }
 
-    SentryEnvelope *envelope = [[SentryEnvelope alloc] initWithHeader:[SentryEnvelopeHeader empty]
-                                                                items:@[ videoEnvelopeItem ]];
+    SentryEnvelope *envelope = [[SentryEnvelope alloc]
+        initWithHeader:[[SentryEnvelopeHeader alloc] initWithId:replayEvent.eventId]
+                 items:@[ videoEnvelopeItem ]];
 
     [self captureEnvelope:envelope];
 }

Sources/Sentry/SentryCoreGraphicsHelper.m

@@ -0,0 +1,18 @@
+#import "SentryCoreGraphicsHelper.h"
+#if SENTRY_HAS_UIKIT
+@implementation SentryCoreGraphicsHelper
++ (CGMutablePathRef)excludeRect:(CGRect)rectangle fromPath:(CGMutablePathRef)path
+{
+#    if (TARGET_OS_IOS || TARGET_OS_TV)
+#        ifdef __IPHONE_16_0
+    if (@available(iOS 16.0, tvOS 16.0, *)) {
+        CGPathRef exclude = CGPathCreateWithRect(rectangle, nil);
+        CGPathRef newPath = CGPathCreateCopyBySubtractingPath(path, exclude, YES);
+        return CGPathCreateMutableCopy(newPath);
+    }
+#        endif // defined(__IPHONE_16_0)
+#    endif // (TARGET_OS_IOS || TARGET_OS_TV)
+    return path;
+}
+@end
+#endif // SENTRY_HAS_UIKIT

Sources/Sentry/SentryDateUtil.m

@@ -40,7 +40,7 @@ + (NSDate *_Nullable)getMaximumDate:(NSDate *_Nullable)first andOther:(NSDate *_
 
 + (long)millisecondsSince1970:(NSDate *)date
 {
-    return (NSInteger)([date timeIntervalSince1970] * 1000);
+    return (long)([date timeIntervalSince1970] * 1000);
 }
 
 @end

Sources/Sentry/SentryEnvelope.m

@@ -227,6 +227,11 @@ - (nullable instancetype)initWithReplayEvent:(SentryReplayEvent *)replayEvent
     }
 
     NSData *envelopeItemContent = [NSData dataWithContentsOfURL:envelopeContentUrl];
+
+    NSError *error;
+    if (![NSFileManager.defaultManager removeItemAtURL:envelopeContentUrl error:&error]) {
+        SENTRY_LOG_ERROR(@"Cound not delete temporary replay content from disk: %@", error);
+    }
     return [self initWithHeader:[[SentryEnvelopeItemHeader alloc]
                                     initWithType:SentryEnvelopeItemTypeReplayVideo
                                           length:envelopeItemContent.length]

Sources/Sentry/SentryOptions.m

@@ -15,15 +15,15 @@
 #import "SentryOptions+Private.h"
 #import "SentrySDK.h"
 #import "SentryScope.h"
+#import "SentrySessionReplayIntegration.h"
+#import "SentrySwift.h"
 #import "SentrySwiftAsyncIntegration.h"
-
 #import <objc/runtime.h>
 
 #if SENTRY_HAS_UIKIT
 #    import "SentryAppStartTrackingIntegration.h"
 #    import "SentryFramesTrackingIntegration.h"
 #    import "SentryPerformanceTrackingIntegration.h"
-#    import "SentryReplayOptions+Private.h"
 #    import "SentryScreenshotIntegration.h"
 #    import "SentryUIEventTrackingIntegration.h"
 #    import "SentryViewHierarchyIntegration.h"
@@ -58,6 +58,9 @@ - (void)setMeasurement:(SentryMeasurementValue *)measurement
             NSStringFromClass([SentryUIEventTrackingIntegration class]),
             NSStringFromClass([SentryViewHierarchyIntegration class]),
             NSStringFromClass([SentryWatchdogTerminationTrackingIntegration class]),
+#    if !TARGET_OS_VISION
+            NSStringFromClass([SentrySessionReplayIntegration class]),
+#    endif
 #endif // SENTRY_HAS_UIKIT
             NSStringFromClass([SentryANRTrackingIntegration class]),
             NSStringFromClass([SentryAutoBreadcrumbTrackingIntegration class]),
@@ -103,7 +106,7 @@ - (instancetype)init
         self.enableTimeToFullDisplayTracing = NO;
 
         self.initialScope = ^SentryScope *(SentryScope *scope) { return scope; };
-
+        _experimental = [[SentryExperimentalOptions alloc] init];
         _enableTracing = NO;
         _enableTracingManual = NO;
 #if SENTRY_HAS_UIKIT
@@ -401,13 +404,6 @@ - (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
     [self setBool:options[@"enablePreWarmedAppStartTracing"]
             block:^(BOOL value) { self->_enablePreWarmedAppStartTracing = value; }];
 
-    if (@available(iOS 16.0, tvOS 16.0, *)) {
-        if ([options[@"sessionReplayOptions"] isKindOfClass:NSDictionary.class]) {
-            self.sessionReplayOptions =
-                [[SentryReplayOptions alloc] initWithDictionary:options[@"sessionReplayOptions"]];
-        }
-    }
-
 #endif // SENTRY_HAS_UIKIT
 
     [self setBool:options[@"enableAppHangTracking"]
@@ -503,6 +499,10 @@ - (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
         self.spotlightUrl = options[@"spotlightUrl"];
     }
 
+    if ([options[@"experimental"] isKindOfClass:NSDictionary.class]) {
+        [self.experimental validateOptions:options[@"experimental"]];
+    }
+
     return YES;
 }
 
@@ -743,4 +743,4 @@ - (NSString *)debugDescription
 }
 #endif // defined(DEBUG) || defined(TEST) || defined(TESTCI)
 
-@end
+@end

Sources/Sentry/SentryReplayEvent.m

@@ -26,12 +26,12 @@ - (NSDictionary *)serialize
     }
 
     result[@"urls"] = self.urls;
-    result[@"replay_start_timestamp"] =
-        @([SentryDateUtil millisecondsSince1970:self.replayStartTimestamp]);
+    result[@"replay_start_timestamp"] = @(self.replayStartTimestamp.timeIntervalSince1970);
     result[@"trace_ids"] = trace_ids;
-    result[@"replay_id"] = self.replayId.sentryIdString;
+    result[@"replay_id"] = self.eventId.sentryIdString;
     result[@"segment_id"] = @(self.segmentId);
     result[@"replay_type"] = nameForSentryReplayType(self.replayType);
+    result[@"error_ids"] = @[];
 
     return result;
 }