Make SentrySDKSettings only visible to Swift (#6927)

Author: noahsmartin

Sentry.xcodeproj/project.pbxproj

@@ -529,14 +529,8 @@ - (void)captureReplayEvent:(SentryReplayEvent *)replayEvent
 
     // Hybrid SDKs may override the sdk info for a replay Event,
     // the same SDK should be used for the envelope header.
-    SentrySdkInfo *sdkInfo = replayEvent.sdk
-        ? [[SentrySdkInfo alloc]
-              initWithDict:SENTRY_UNWRAP_NULLABLE_DICT(NSString *, id, replayEvent.sdk)]
-        : [SentrySdkInfo global];
     SentryEnvelopeHeader *envelopeHeader =
-        [[SentryEnvelopeHeader alloc] initWithId:replayEvent.eventId
-                                         sdkInfo:sdkInfo
-                                    traceContext:nil];
+        [[SentryEnvelopeHeader alloc] initWithId:replayEvent.eventId sdkInfo:replayEvent.sdk];
 
     SentryEnvelope *envelope = [[SentryEnvelope alloc] initWithHeader:envelopeHeader
                                                                 items:@[ videoEnvelopeItem ]];
@@ -907,7 +901,7 @@ - (void)setSdk:(SentryEvent *)event
         return;
     }
 
-    event.sdk = [[[SentrySdkInfo alloc] initWithOptions:self.options] serialize];
+    event.sdk = [SentrySdkInfoObjC optionsToDict:self.options];
 }
 
 - (void)setUserInfo:(NSDictionary *_Nullable)userInfo withEvent:(SentryEvent *_Nullable)event

Sources/Sentry/SentryClient.m

@@ -6,9 +6,9 @@ import Foundation
  * @note Both name and version are required.
  * @see https://develop.sentry.dev/sdk/event-payloads/sdk/
  */
-@_spi(Private) @objc public final class SentrySdkInfo: NSObject, SentrySerializable {
+final class SentrySdkInfo {
 
-    @objc public static func global() -> Self {
+    static func global() -> Self {
         if let options = SentrySDKInternal.currentHub().getClient()?.getOptions() {
             let enabledFeatures = SentryDependencyContainerSwiftHelper.enabledFeatures(options)
             return Self(withEnabledFeatures: enabledFeatures, sendDefaultPii: SentryDependencyContainerSwiftHelper.sendDefaultPii(options))
@@ -19,49 +19,49 @@ import Foundation
     /**
      * The name of the SDK. Examples: sentry.cocoa, sentry.cocoa.vapor, ...
      */
-    @objc public let name: String
+    let name: String
 
     /**
      * The version of the SDK. It should have the Semantic Versioning format MAJOR.MINOR.PATCH, without
      * any prefix (no v or anything else in front of the major version number). Examples:
      * 0.1.0, 1.0.0, 2.0.0-beta0
      */
-    @objc public let version: String
+    let version: String
 
     /**
      * A list of names identifying enabled integrations. The list should
      * have all enabled integrations, including default integrations. Default
      * integrations are included because different SDK releases may contain different
      * default integrations.
      */
-    @objc public let integrations: [String]
+    let integrations: [String]
 
     /**
      * A list of feature names identifying enabled SDK features. This list
      * should contain all enabled SDK features. On some SDKs, enabling a feature in the
      * options also adds an integration. We encourage tracking such features with either
      * integrations or features but not both to reduce the payload size.
      */
-    @objc public let features: [String]
+    let features: [String]
 
     /**
      * A list of packages that were installed as part of this SDK or the
      * activated integrations. Each package consists of a name in the format
      * source:identifier and version.
      */
-    @objc public let packages: [[String: String]]
+    let packages: [[String: String]]
 
     /**
      * A set of settings as part of this SDK.
      */
-    @objc public let settings: SentrySDKSettings
+    let settings: SentrySDKSettings
 
-    @objc public convenience init(withOptions options: Options?) {
+    convenience init(withOptions options: Options?) {
         let features = SentryEnabledFeaturesBuilder.getEnabledFeatures(options: options)
         self.init(withEnabledFeatures: features, sendDefaultPii: options?.sendDefaultPii ?? false)
     }
 
-    @objc public convenience init(withEnabledFeatures features: [String], sendDefaultPii: Bool) {
+    convenience init(withEnabledFeatures features: [String], sendDefaultPii: Bool) {
         let integrations = SentrySDKInternal.currentHub().trimmedInstalledIntegrationNames()
         var packages = SentryExtraPackages.getPackages()
         let sdkPackage = SentrySdkPackage.global()
@@ -77,7 +77,7 @@ import Foundation
             settings: SentrySDKSettings(sendDefaultPii: sendDefaultPii))
     }
 
-    @objc public init(name: String?, version: String?, integrations: [String]?, features: [String]?, packages: [[String: String]]?, settings: SentrySDKSettings) {
+    init(name: String?, version: String?, integrations: [String]?, features: [String]?, packages: [[String: String]]?, settings: SentrySDKSettings) {
         self.name = name ?? ""
         self.version = version ?? ""
         self.integrations = integrations ?? []
@@ -87,40 +87,39 @@ import Foundation
     }
 
     // swiftlint:disable cyclomatic_complexity
-    @objc
-    public convenience init(dict: [AnyHashable: Any]) {
+    convenience init(dict: [AnyHashable: Any]?) {
         var name = ""
         var version = ""
         var integrations = Set<String>()
         var features = Set<String>()
         var packages = Set<[String: String]>()
         var settings = SentrySDKSettings(dict: [:])
 
-        if let nameValue = dict["name"] as? String {
+        if let nameValue = dict?["name"] as? String {
             name = nameValue
         }
 
-        if let versionValue = dict["version"] as? String {
+        if let versionValue = dict?["version"] as? String {
             version = versionValue
         }
 
-        if let integrationArray = dict["integrations"] as? [Any] {
+        if let integrationArray = dict?["integrations"] as? [Any] {
             for item in integrationArray {
                 if let integration = item as? String {
                     integrations.insert(integration)
                 }
             }
         }
 
-        if let featureArray = dict["features"] as? [Any] {
+        if let featureArray = dict?["features"] as? [Any] {
             for item in featureArray {
                 if let feature = item as? String {
                     features.insert(feature)
                 }
             }
         }
 
-        if let packageArray = dict["packages"] as? [Any] {
+        if let packageArray = dict?["packages"] as? [Any] {
             for item in packageArray {
                 if let package = item as? [String: Any],
                    let name = package["name"] as? String,
@@ -130,7 +129,7 @@ import Foundation
             }
         }
 
-        if let settingsDict = dict["settings"] as? NSDictionary {
+        if let settingsDict = dict?["settings"] as? NSDictionary {
             settings = SentrySDKSettings(dict: settingsDict)
         }
 
@@ -145,7 +144,7 @@ import Foundation
     }
     // swiftlint:enable cyclomatic_complexity
 
-    @objc public func serialize() -> [String: Any] {
+    func serialize() -> [String: Any] {
         [
             "name": self.name,
             "version": self.version,
@@ -156,3 +155,11 @@ import Foundation
         ]
     }
 }
+
+@_spi(Private) @objc public final class SentrySdkInfoObjC: NSObject {
+    
+    @objc public static func optionsToDict(_ options: Options) -> [String: Any] {
+        SentrySdkInfo(withOptions: options).serialize()
+    }
+    
+}

Sources/Swift/Helper/SentrySdkInfo.swift

@@ -2,31 +2,31 @@
  * Describes the settings for the Sentry SDK
  * @see https://develop.sentry.dev/sdk/event-payloads/sdk/
  */
-@_spi(Private) @objc public final class SentrySDKSettings: NSObject {
+final class SentrySDKSettings {
 
-    @objc public override init() {
+    init() {
         autoInferIP = false
     }
 
-    @objc public convenience init(options: Options?) {
+    convenience init(options: Options?) {
         self.init(sendDefaultPii: options?.sendDefaultPii ?? false)
     }
 
-    @objc public init(sendDefaultPii: Bool) {
+    init(sendDefaultPii: Bool) {
         autoInferIP = sendDefaultPii
     }
 
-    @objc public init(dict: NSDictionary) {
+    init(dict: NSDictionary) {
         if let inferIp = dict["infer_ip"] as? String {
             autoInferIP = inferIp == "auto"
         } else {
             autoInferIP = false
         }
     }
 
-    @objc public var autoInferIP: Bool
+    var autoInferIP: Bool
 
-    @objc public func serialize() -> NSDictionary {
+    func serialize() -> NSDictionary {
         [
             "infer_ip": autoInferIP ? "auto" : "never"
         ]

Sources/Swift/Protocol/SentrySDKSettings.swift

@@ -7,7 +7,7 @@
      * @param eventId The identifier of the event. Can be nil if no event in the envelope or attachment
      * related to event.
      */
-    @objc public convenience init(id eventId: SentryId?) {
+    convenience init(id eventId: SentryId?) {
         self.init(id: eventId, traceContext: nil)
     }
 
@@ -31,13 +31,17 @@
      * instances should always provide a version.
      * @param traceContext Current trace state.
      */
-    @objc public
     init(id eventId: SentryId?, sdkInfo: SentrySdkInfo?, traceContext: TraceContext?) {
         self.eventId = eventId
         self.sdkInfo = sdkInfo
         self.traceContext = traceContext
     }
-    
+
+    @objc public convenience init(id eventId: SentryId?, sdkInfo: [AnyHashable: Any]?) {
+        let info = sdkInfo.map { SentrySdkInfo(dict: $0) } ?? SentrySdkInfo.global()
+        self.init(id: eventId, sdkInfo: info, traceContext: nil)
+    }
+
     @objc public static func empty() -> Self {
         Self(id: nil, traceContext: nil)
     }
@@ -48,7 +52,7 @@
      * Attachments
      */
     @objc public var eventId: SentryId?
-    @objc public var sdkInfo: SentrySdkInfo?
+    var sdkInfo: SentrySdkInfo?
     @objc public var traceContext: TraceContext?
 
     /**

Sources/Swift/Tools/SentryEnvelopeHeader.swift

@@ -0,0 +1,18 @@
+@testable import Sentry
+
+extension SentrySdkInfo {
+    public static func == (lhs: Sentry.SentrySdkInfo, rhs: Sentry.SentrySdkInfo) -> Bool {
+        return lhs.name == rhs.name &&
+        lhs.version == rhs.version &&
+        Set(lhs.integrations) == Set(rhs.integrations) &&
+        Set(lhs.features) == Set(rhs.features) &&
+        Set(lhs.packages) == Set(rhs.packages) &&
+        lhs.settings == rhs.settings
+    }
+}
+
+#if compiler(>=6.0)
+extension SentrySdkInfo: @retroactive Equatable { }
+#else
+extension SentrySdkInfo: Equatable { }
+#endif

Tests/SentryTests/Protocol/SentrySDKInfo+Equality.swift

@@ -0,0 +1,13 @@
+@testable import Sentry
+
+extension SentrySDKSettings {
+    public static func == (lhs: Sentry.SentrySDKSettings, rhs: Sentry.SentrySDKSettings) -> Bool {
+        lhs.autoInferIP == rhs.autoInferIP
+    }
+}
+
+#if compiler(>=6.0)
+extension SentrySDKSettings: @retroactive Equatable { }
+#else
+extension SentrySDKSettings: Equatable { }
+#endif