fix: setting SDK name through options[sdk][name] shouldn't clear vers…

…ion (#2139) * fix: setting SDK name through options[sdk][name] shouldn't clear version * chore: update changelog
getsentry · Sep 9, 2022 · 7cd89d4 · 7cd89d4
1 parent 193647c
commit 7cd89d4
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@
 
 - Can't find app image when swizzling (#2124)
 - Crash with screenshot is reported twice (#2134)
+- Setting SDK name through `options[sdk][name]` shouldn't clear version (#2139)
 
 ## 7.24.1
 

diff --git a/Sources/Sentry/SentryOptions.m b/Sources/Sentry/SentryOptions.m
@@ -333,7 +333,9 @@ - (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
     // Note: we should remove this code once the hybrid SDKs move over to the new
     // PrivateSentrySDKOnly setter functions.
     if ([options[@"sdk"] isKindOfClass:[NSDictionary class]]) {
-        SentrySdkInfo *sdkInfo = [[SentrySdkInfo alloc] initWithDict:options];
+        SentrySdkInfo *defaults = [[SentrySdkInfo alloc] initWithName:SentryMeta.sdkName
+                                                           andVersion:SentryMeta.versionString];
+        SentrySdkInfo *sdkInfo = [[SentrySdkInfo alloc] initWithDict:options orDefaults:defaults];
         SentryMeta.versionString = sdkInfo.version;
         SentryMeta.sdkName = sdkInfo.name;
     }

diff --git a/Tests/SentryTests/PrivateSentrySDKOnlyTests.swift b/Tests/SentryTests/PrivateSentrySDKOnlyTests.swift
@@ -32,12 +32,20 @@ class PrivateSentrySDKOnlyTests: XCTestCase {
     func testSetSdkName() {
         let originalName = PrivateSentrySDKOnly.getSdkName()
         let name = "Some SDK name"
+        let originalVersion = SentryMeta.versionString
+        XCTAssertNotEqual(originalVersion, "")
+
         PrivateSentrySDKOnly.setSdkName(name)
         XCTAssertEqual(SentryMeta.sdkName, name)
+        XCTAssertEqual(SentryMeta.versionString, originalVersion)
         XCTAssertEqual(PrivateSentrySDKOnly.getSdkName(), name)
+        XCTAssertEqual(PrivateSentrySDKOnly.getSdkVersionString(), originalVersion)
+
         PrivateSentrySDKOnly.setSdkName(originalName)
         XCTAssertEqual(SentryMeta.sdkName, originalName)
+        XCTAssertEqual(SentryMeta.versionString, originalVersion)
         XCTAssertEqual(PrivateSentrySDKOnly.getSdkName(), originalName)
+        XCTAssertEqual(PrivateSentrySDKOnly.getSdkVersionString(), originalVersion)
     }
 
     func testSetSdkNameAndVersion() {

diff --git a/Tests/SentryTests/SentryOptionsTest.m b/Tests/SentryTests/SentryOptionsTest.m
@@ -603,6 +603,7 @@ - (void)testSetCustomSdkInfo
 - (void)testSetCustomSdkName
 {
     NSDictionary *dict = @{ @"name" : @"custom.sdk" };
+    NSString *originalVersion = SentryMeta.versionString;
 
     NSError *error = nil;
     SentryOptions *options =
@@ -614,13 +615,16 @@ - (void)testSetCustomSdkName
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
     XCTAssertEqual(dict[@"name"], options.sdkInfo.name);
-    XCTAssertEqual(SentryMeta.versionString, options.sdkInfo.version); // default version
+    // version stays unchanged
+    XCTAssertEqual(SentryMeta.versionString, options.sdkInfo.version);
+    XCTAssertEqual(SentryMeta.versionString, originalVersion);
 #pragma clang diagnostic pop
 }
 
 - (void)testSetCustomSdkVersion
 {
     NSDictionary *dict = @{ @"version" : @"1.2.3-alpha.0" };
+    NSString *originalName = SentryMeta.sdkName;
 
     NSError *error = nil;
     SentryOptions *options =
@@ -631,8 +635,10 @@ - (void)testSetCustomSdkVersion
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
-    XCTAssertEqual(SentryMeta.sdkName, options.sdkInfo.name); // default name
     XCTAssertEqual(dict[@"version"], options.sdkInfo.version);
+    // name stays unchanged
+    XCTAssertEqual(SentryMeta.sdkName, options.sdkInfo.name);
+    XCTAssertEqual(SentryMeta.sdkName, originalName);
 #pragma clang diagnostic pop
 
     NSDictionary *info = [[NSBundle bundleForClass:[SentryClient class]] infoDictionary];