ref: Make SpanProtocol.data non nullable

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased 
 
+This version introduces a dependency on Swift, which only impacts you if you don't use Swift. If your project uses Swift already, this change will not affect you.
+
+### Breaking Changes
+
+- Make SpanProtocol.data non nullable (#2409)
 This version adds a dependency on Swift.
 
 ### Features

Samples/iOS-Swift/iOS-Swift/ViewControllers/TraceTestViewController.swift

@@ -72,7 +72,7 @@ class TraceTestViewController: UIViewController {
                 return
             }
 
-            UIAssert.isEqual(child.data?["url"] as? String, "/sentry-logo-black.png", "Could not read url data value")
+            UIAssert.isEqual(child.data["url"] as? String, "/sentry-logo-black.png", "Could not read url data value")
 
             UIAssert.isEqual(child.tags["http.status_code"], "200", "Could not read status_code tag value")
 

Sources/Sentry/Public/SentrySpanProtocol.h

@@ -27,7 +27,7 @@ NS_SWIFT_NAME(Span)
 /**
  * An arbitrary mapping of additional metadata of the span.
  */
-@property (nullable, readonly) NSDictionary<NSString *, id> *data;
+@property (readonly) NSDictionary<NSString *, id> *data;
 
 /**
  * key-value pairs holding additional data about the span.

Sources/Sentry/SentrySpan.m

@@ -74,7 +74,7 @@ - (void)removeDataForKey:(NSString *)key
     }
 }
 
-- (nullable NSDictionary<NSString *, id> *)data
+- (NSDictionary<NSString *, id> *)data
 {
     @synchronized(_data) {
         return [_data copy];

Sources/Sentry/SentryTracer.m

@@ -325,7 +325,7 @@ - (void)setStartTimestamp:(nullable NSDate *)startTimestamp
 #endif
 }
 
-- (nullable NSDictionary<NSString *, id> *)data
+- (NSDictionary<NSString *, id> *)data
 {
     @synchronized(_data) {
         return [_data copy];

Tests/SentryTests/Integrations/Performance/CoreData/SentryCoreDataTrackerTest.swift

@@ -151,7 +151,7 @@ class SentryCoreDataTrackerTests: XCTestCase {
 
         XCTAssertEqual(transaction.children.count, 1)
 
-        guard let operations = transaction.children[0].data?["operations"] as? [String: Any?] else {
+        guard let operations = transaction.children[0].data["operations"] as? [String: Any?] else {
             XCTFail("Transaction has no `operations` extra")
             return
         }
@@ -230,7 +230,7 @@ class SentryCoreDataTrackerTests: XCTestCase {
         XCTAssertEqual(transaction.children.count, 1)
         XCTAssertEqual(transaction.children[0].context.operation, SENTRY_COREDATA_FETCH_OPERATION)
         XCTAssertEqual(transaction.children[0].context.spanDescription, expectedDescription)
-        XCTAssertEqual(transaction.children[0].data!["read_count"] as? Int, 1)
+        XCTAssertEqual(transaction.children[0].data["read_count"] as? Int, 1)
     }
 
     private func startTransaction() -> SentryTracer {

Tests/SentryTests/Integrations/Performance/IO/SentryNSDataTrackerTests.swift

@@ -224,8 +224,8 @@ class SentryNSDataTrackerTests: XCTestCase {
         XCTAssertNotNil(span)
         XCTAssertEqual(span?.context.operation, operation)
         XCTAssertTrue(span?.isFinished ?? false)
-        XCTAssertEqual(span?.data?["file.size"] as? Int, size)
-        XCTAssertEqual(span?.data?["file.path"] as? String, path)
+        XCTAssertEqual(span?.data["file.size"] as? Int, size)
+        XCTAssertEqual(span?.data["file.path"] as? String, path)
 
         let lastComponent = (path as NSString).lastPathComponent
 

Tests/SentryTests/Integrations/Performance/Network/SentryNetworkTrackerTests.swift

@@ -752,9 +752,9 @@ class SentryNetworkTrackerTests: XCTestCase {
             XCTAssertNil(httpStatusCode)
         }
 
-        let path = span.data!["url"] as? String
-        let method = span.data!["method"] as? String
-        let requestType = span.data!["type"] as? String
+        let path = span.data["url"] as? String
+        let method = span.data["method"] as? String
+        let requestType = span.data["type"] as? String
 
         XCTAssertEqual(path, task.currentRequest!.url!.path)
         XCTAssertEqual(method, task.currentRequest!.httpMethod)

Tests/SentryTests/Transaction/SentrySpanTests.swift

@@ -190,12 +190,12 @@ class SentrySpanTests: XCTestCase {
 
         span.setExtra(value: fixture.extraValue, key: fixture.extraKey)
 
-        XCTAssertEqual(span.data!.count, 1)
-        XCTAssertEqual(span.data![fixture.extraKey] as! String, fixture.extraValue)
+        XCTAssertEqual(span.data.count, 1)
+        XCTAssertEqual(span.data[fixture.extraKey] as! String, fixture.extraValue)
 
         span.removeData(key: fixture.extraKey)
-        XCTAssertEqual(span.data!.count, 0)
-        XCTAssertNil(span.data![fixture.extraKey])
+        XCTAssertEqual(span.data.count, 0)
+        XCTAssertNil(span.data[fixture.extraKey])
     }
 
     func testAddAndRemoveTags() {
@@ -359,7 +359,7 @@ class SentrySpanTests: XCTestCase {
 
         queue.activate()
         group.wait()
-        XCTAssertEqual(span.data!.count, outerLoop * innerLoop)
+        XCTAssertEqual(span.data.count, outerLoop * innerLoop)
     }
 
     func testSpanStatusNames() {