Feat: Add native SDK information in the replay option event

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Improvements
+
+- Add native SDK information in the replay option event (#4663)
+
 ## 8.43.0-beta.1
 
 ### Improvements

Sources/Sentry/SentryMeta.m

@@ -2,11 +2,20 @@
 
 @implementation SentryMeta
 
+const NSString *const sentryVersionString = @"8.43.0-beta.1";
+const NSString *const sentrySdkName = @"sentry.cocoa";
+
 // Don't remove the static keyword. If you do the compiler adds the constant name to the global
 // symbol table and it might clash with other constants. When keeping the static keyword the
 // compiler replaces all occurrences with the value.
-static NSString *versionString = @"8.43.0-beta.1";
-static NSString *sdkName = @"sentry.cocoa";
+static NSString *versionString;
+static NSString *sdkName;
+
++ (void)initialize
+{
+    versionString = sentryVersionString.copy;
+    sdkName = sentrySdkName.copy;
+}
 
 + (NSString *)versionString
 {
@@ -28,4 +37,14 @@ + (void)setSdkName:(NSString *)value
     sdkName = value;
 }
 
++ (NSString *)nativeSdkName
+{
+    return sentrySdkName.copy;
+}
+
++ (NSString *)nativeVersionString
+{
+    return sentryVersionString.copy;
+}
+
 @end

Sources/Sentry/SentrySessionReplayIntegration.m

@@ -18,6 +18,7 @@
 #    import "SentryReachability.h"
 #    import "SentrySDK+Private.h"
 #    import "SentryScope+Private.h"
+#    import "SentrySdkInfo.h"
 #    import "SentrySerialization.h"
 #    import "SentrySessionReplaySyncC.h"
 #    import "SentrySwift.h"
@@ -50,6 +51,7 @@ @implementation SentrySessionReplayIntegration {
     id<SentryRateLimits> _rateLimits;
     id<SentryViewScreenshotProvider> _currentScreenshotProvider;
     id<SentryReplayBreadcrumbConverter> _currentBreadcrumbConverter;
+    NSDictionary<NSString *, id> *_sdkInfo;
     // We need to use this variable to identify whether rate limiting was ever activated for session
     // replay in this session, instead of always looking for the rate status in `SentryRateLimits`
     // This is the easiest way to ensure segment 0 will always reach the server, because session
@@ -88,6 +90,7 @@ - (void)setupWith:(SentryReplayOptions *)replayOptions enableTouchTracker:(BOOL)
     _replayOptions = replayOptions;
     _viewPhotographer = [[SentryViewPhotographer alloc] initWithRedactOptions:replayOptions];
     _rateLimits = SentryDependencyContainer.sharedInstance.rateLimits;
+    _sdkInfo = replayOptions.sdkInfo;
 
     if (touchTracker) {
         _touchTracker = [[SentryTouchTracker alloc]
@@ -582,6 +585,8 @@ - (void)sessionReplayNewSegmentWithReplayEvent:(SentryReplayEvent *)replayEvent
         return;
     }
 
+    replayEvent.sdk = _sdkInfo;
+
     [SentrySDK.currentHub captureReplayEvent:replayEvent
                              replayRecording:replayRecording
                                        video:videoUrl];

Sources/Sentry/include/SentryMeta.h

@@ -14,6 +14,21 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, class, copy) NSString *sdkName;
 
+/**
+ * Return a version string e.g: 1.2.3 (3)
+ * This always report the version of Sentry.cocoa,
+ * `versionString` can be changed by hybrid SDKs.
+ * We can use this property to get which version of Sentry cocoa
+ * the hybrid SDK is using.
+ */
+@property (nonatomic, class, readonly) NSString *nativeVersionString;
+
+/**
+ * Returns "sentry.cocoa"
+ * `sdkName` can be changed by hybrid SDKs.
+ */
+@property (nonatomic, class, readonly) NSString *nativeSdkName;
+
 @end
 
 NS_ASSUME_NONNULL_END

Sources/Sentry/include/SentryPrivate.h

@@ -13,6 +13,7 @@
 #import "SentryDisplayLinkWrapper.h"
 #import "SentryLevelHelper.h"
 #import "SentryLogC.h"
+#import "SentryMeta.h"
 #import "SentryRandom.h"
 #import "SentrySdkInfo.h"
 #import "SentrySession.h"

Sources/Sentry/include/SentrySessionReplayIntegration+Private.h

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

Sources/Swift/Integrations/SessionReplay/RRWeb/SentryRRWebOptionsEvent.swift

@@ -12,7 +12,9 @@ import Foundation
                         "maskAllImages": options.maskAllImages,
                         "quality": String(describing: options.quality),
                         "maskedViewClasses": options.maskedViewClasses.map(String.init(describing: )).joined(separator: ", "),
-                        "unmaskedViewClasses": options.unmaskedViewClasses.map(String.init(describing: )).joined(separator: ", ")
+                        "unmaskedViewClasses": options.unmaskedViewClasses.map(String.init(describing: )).joined(separator: ", "),
+                        "nativeSdkName": SentryMeta.nativeSdkName,
+                        "nativeSdkVersion": SentryMeta.nativeVersionString
                     ]
         )
     }

Sources/Swift/Integrations/SessionReplay/SentryReplayOptions.swift

@@ -1,3 +1,4 @@
+@_implementationOnly import _SentryPrivate
 import Foundation
 
 @objcMembers
@@ -146,6 +147,10 @@ public class SentryReplayOptions: NSObject, SentryRedactOptions {
      */
     let maximumDuration = TimeInterval(3_600)
 
+    /**
+     * Used by hybrid SDKs to be able to configure SDK info for Session Replay
+     */
+    var sdkInfo: [String: Any]?
     /**
      * Inittialize session replay options disabled
      */
@@ -183,5 +188,6 @@ public class SentryReplayOptions: NSObject, SentryRedactOptions {
         if let quality = SentryReplayQuality(rawValue: dictionary["quality"] as? Int ?? -1) {
             self.quality = quality
         }
+        sdkInfo = dictionary["sdkInfo"] as? [String: Any]
     }
 }

Tests/SentryTests/Integrations/SessionReplay/SentrySessionReplayTests.swift

@@ -428,6 +428,8 @@ class SentrySessionReplayTests: XCTestCase {
         XCTAssertEqual(options["maskedViewClasses"] as? String, "")
         XCTAssertEqual(options["unmaskedViewClasses"] as? String, "")
         XCTAssertEqual(options["quality"] as? String, "medium")
+        XCTAssertEqual(options["nativeSdkName"] as? String, SentryMeta.nativeSdkName)
+        XCTAssertEqual(options["nativeSdkVersion"] as? String, SentryMeta.nativeVersionString)
     }
 
     func testOptionsInTheEventAllChanged() throws {