fix: Type check SentrySpan

noahsmartin · noahsmartin · commit b54498bf6176 · 2025-08-15T20:11:25.000-07:00
diff --git a/Sources/Sentry/Public/SentrySpanProtocol.h b/Sources/Sentry/Public/SentrySpanProtocol.h
@@ -5,7 +5,9 @@
 #else
 #    import <SentryDefines.h>
 #endif
-#import SENTRY_HEADER(SentrySerializable)
+#if SDK_V9
+#    import SENTRY_HEADER(SentrySerializable)
+#endif // SDK_V9
 #import SENTRY_HEADER(SentrySpanContext)
 
 NS_ASSUME_NONNULL_BEGIN
@@ -17,7 +19,11 @@ NS_ASSUME_NONNULL_BEGIN
 @class SentryTraceHeader;
 
 NS_SWIFT_NAME(Span)
+#if SDK_V9
+@protocol SentrySpan <NSObject>
+#else
 @protocol SentrySpan <SentrySerializable>
+#endif
 
 /**
  * Determines which trace the Span belongs to.
@@ -190,6 +196,8 @@ NS_SWIFT_NAME(Span)
  */
 - (nullable NSString *)baggageHttpHeader;
 
+- (NSDictionary<NSString *, id> *)serialize;
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/Sources/Sentry/SentryBuildAppStartSpans.m b/Sources/Sentry/SentryBuildAppStartSpans.m
@@ -55,40 +55,41 @@
     NSDate *appStartEndTimestamp = [appStartMeasurement.appStartTimestamp
         dateByAddingTimeInterval:appStartMeasurement.duration];
 
-    SentrySpan *appStartSpan = sentryBuildAppStartSpan(tracer, tracer.spanId, operation, type);
+    SentrySpan *appStartSpan
+        = (SentrySpan *)sentryBuildAppStartSpan(tracer, tracer.spanId, operation, type);
     [appStartSpan setStartTimestamp:appStartMeasurement.appStartTimestamp];
     [appStartSpan setTimestamp:appStartEndTimestamp];
 
     [appStartSpans addObject:appStartSpan];
 
     if (!appStartMeasurement.isPreWarmed) {
-        SentrySpan *premainSpan
-            = sentryBuildAppStartSpan(tracer, appStartSpan.spanId, operation, @"Pre Runtime Init");
+        SentrySpan *premainSpan = (SentrySpan *)sentryBuildAppStartSpan(
+            tracer, appStartSpan.spanId, operation, @"Pre Runtime Init");
         [premainSpan setStartTimestamp:appStartMeasurement.appStartTimestamp];
         [premainSpan setTimestamp:appStartMeasurement.runtimeInitTimestamp];
         [appStartSpans addObject:premainSpan];
 
-        SentrySpan *runtimeInitSpan = sentryBuildAppStartSpan(
+        SentrySpan *runtimeInitSpan = (SentrySpan *)sentryBuildAppStartSpan(
             tracer, appStartSpan.spanId, operation, @"Runtime Init to Pre Main Initializers");
         [runtimeInitSpan setStartTimestamp:appStartMeasurement.runtimeInitTimestamp];
         [runtimeInitSpan setTimestamp:appStartMeasurement.moduleInitializationTimestamp];
         [appStartSpans addObject:runtimeInitSpan];
     }
 
-    SentrySpan *appInitSpan
-        = sentryBuildAppStartSpan(tracer, appStartSpan.spanId, operation, @"UIKit Init");
+    SentrySpan *appInitSpan = (SentrySpan *)sentryBuildAppStartSpan(
+        tracer, appStartSpan.spanId, operation, @"UIKit Init");
     [appInitSpan setStartTimestamp:appStartMeasurement.moduleInitializationTimestamp];
     [appInitSpan setTimestamp:appStartMeasurement.sdkStartTimestamp];
     [appStartSpans addObject:appInitSpan];
 
-    SentrySpan *didFinishLaunching
-        = sentryBuildAppStartSpan(tracer, appStartSpan.spanId, operation, @"Application Init");
+    SentrySpan *didFinishLaunching = (SentrySpan *)sentryBuildAppStartSpan(
+        tracer, appStartSpan.spanId, operation, @"Application Init");
     [didFinishLaunching setStartTimestamp:appStartMeasurement.sdkStartTimestamp];
     [didFinishLaunching setTimestamp:appStartMeasurement.didFinishLaunchingTimestamp];
     [appStartSpans addObject:didFinishLaunching];
 
-    SentrySpan *frameRenderSpan
-        = sentryBuildAppStartSpan(tracer, appStartSpan.spanId, operation, @"Initial Frame Render");
+    SentrySpan *frameRenderSpan = (SentrySpan *)sentryBuildAppStartSpan(
+        tracer, appStartSpan.spanId, operation, @"Initial Frame Render");
     [frameRenderSpan setStartTimestamp:appStartMeasurement.didFinishLaunchingTimestamp];
     [frameRenderSpan setTimestamp:appStartEndTimestamp];
     [appStartSpans addObject:frameRenderSpan];
diff --git a/Sources/Sentry/SentryCoreDataTracker.m b/Sources/Sentry/SentryCoreDataTracker.m
@@ -57,7 +57,7 @@ - (NSArray *)managedObjectContext:(NSManagedObjectContext *)context
     NSArray *result = original(request, error);
 
     if (fetchSpan) {
-        [self addExtraInfoToSpan:fetchSpan withContext:context];
+        [self addExtraInfoToSpan:(SentrySpan *)fetchSpan withContext:context];
 
         [fetchSpan setDataValue:[NSNumber numberWithInteger:result.count] forKey:@"read_count"];
         [fetchSpan
@@ -104,7 +104,7 @@ - (BOOL)managedObjectContext:(NSManagedObjectContext *)context
     BOOL result = original(error);
 
     if (saveSpan) {
-        [self addExtraInfoToSpan:saveSpan withContext:context];
+        [self addExtraInfoToSpan:(SentrySpan *)saveSpan withContext:context];
         [saveSpan finishWithStatus:result ? kSentrySpanStatusOk : kSentrySpanStatusInternalError];
 
         SENTRY_LOG_DEBUG(@"SentryCoreDataTracker automatically finished span with status: %@",
diff --git a/Sources/Sentry/SentryCrashIntegration.m b/Sources/Sentry/SentryCrashIntegration.m
@@ -41,7 +41,7 @@
 void
 sentry_finishAndSaveTransaction(void)
 {
-    SentrySpan *span = SentrySDKInternal.currentHub.scope.span;
+    SentrySpan *span = (SentrySpan *)SentrySDKInternal.currentHub.scope.span;
 
     if (span != nil) {
         SentryTracer *tracer = [span tracer];
diff --git a/Sources/Sentry/SentryTimeToDisplayTracker.m b/Sources/Sentry/SentryTimeToDisplayTracker.m
@@ -62,16 +62,16 @@ - (BOOL)startForTracer:(SentryTracer *)tracer
     }
 
     SENTRY_LOG_DEBUG(@"Starting initial display span");
-    self.initialDisplaySpan =
-        [tracer startChildWithOperation:SentrySpanOperationUiLoadInitialDisplay
-                            description:[NSString stringWithFormat:@"%@ initial display", _name]];
+    self.initialDisplaySpan = (SentrySpan *)[tracer
+        startChildWithOperation:SentrySpanOperationUiLoadInitialDisplay
+                    description:[NSString stringWithFormat:@"%@ initial display", _name]];
     self.initialDisplaySpan.origin = SentryTraceOriginAutoUITimeToDisplay;
 
     if (self.waitForFullDisplay) {
         SENTRY_LOG_DEBUG(@"Starting full display span");
-        self.fullDisplaySpan =
-            [tracer startChildWithOperation:SentrySpanOperationUiLoadFullDisplay
-                                description:[NSString stringWithFormat:@"%@ full display", _name]];
+        self.fullDisplaySpan = (SentrySpan *)[tracer
+            startChildWithOperation:SentrySpanOperationUiLoadFullDisplay
+                        description:[NSString stringWithFormat:@"%@ full display", _name]];
         self.fullDisplaySpan.origin = SentryTraceOriginManualUITimeToDisplay;
 
         // By concept TTID and TTFD spans should have the same beginning,
diff --git a/Sources/Sentry/SentryTracer.m b/Sources/Sentry/SentryTracer.m
@@ -926,7 +926,7 @@ + (nullable SentryTracer *)getTracer:(id<SentrySpan> _Nullable)span
     }
 
     if ([span isKindOfClass:[SentryTracer class]]) {
-        return span;
+        return (SentryTracer *)span;
     } else if ([span isKindOfClass:[SentrySpan class]]) {
         return [(SentrySpan *)span tracer];
     }
diff --git a/Sources/Sentry/SentryUIViewControllerPerformanceTracker.m b/Sources/Sentry/SentryUIViewControllerPerformanceTracker.m
@@ -179,8 +179,8 @@ - (void)startRootSpanFor:(UIViewController *)controller
     }
 
     spanId = [self getSpanIdForViewController:controller];
-    SentrySpan *_Nullable vcSpan =
-        [self.tracker getSpan:SENTRY_UNWRAP_NULLABLE(SentrySpanId, spanId)];
+    SentrySpan *_Nullable vcSpan
+        = (SentrySpan *)[self.tracker getSpan:SENTRY_UNWRAP_NULLABLE(SentrySpanId, spanId)];
 
     if (![vcSpan isKindOfClass:[SentryTracer self]]) {
         // Since TTID and TTFD are meant to the whole screen
diff --git a/Tests/SentryTests/Integrations/Performance/IO/SentryFileIOTrackingIntegrationObjCTests.m b/Tests/SentryTests/Integrations/Performance/IO/SentryFileIOTrackingIntegrationObjCTests.m
@@ -204,13 +204,14 @@ - (void)assertDataWritten
 
 - (void)assertTransactionForOperation:(NSString *)operation block:(void (^)(void))block
 {
-    SentryTracer *parentTransaction = [SentrySDK startTransactionWithName:@"Transaction"
-                                                                operation:@"Test"
-                                                              bindToScope:YES];
+    SentryTracer *parentTransaction
+        = (SentryTracer *)[SentrySDK startTransactionWithName:@"Transaction"
+                                                    operation:@"Test"
+                                                  bindToScope:YES];
 
     block();
 
-    SentrySpan *ioSpan = parentTransaction.children.firstObject;
+    SentrySpan *ioSpan = (SentrySpan *)parentTransaction.children.firstObject;
 
     XCTAssertEqual(parentTransaction.children.count, 1);
     XCTAssertEqual([ioSpan.data[@"file.size"] unsignedIntValue], someData.length);
diff --git a/Tests/SentryTests/Integrations/Performance/IO/SentryNSFileManagerSwizzlingTests.m b/Tests/SentryTests/Integrations/Performance/IO/SentryNSFileManagerSwizzlingTests.m
@@ -162,15 +162,16 @@ - (void)assertTransactionForOperation:(NSString *)operation
                             spanCount:(NSUInteger)spanCount
                                 block:(void (^)(void))block
 {
-    SentryTracer *parentTransaction = [SentrySDK startTransactionWithName:@"Transaction"
-                                                                operation:@"Test"
-                                                              bindToScope:YES];
+    SentryTracer *parentTransaction
+        = (SentryTracer *)[SentrySDK startTransactionWithName:@"Transaction"
+                                                    operation:@"Test"
+                                                  bindToScope:YES];
 
     block();
 
     XCTAssertEqual(parentTransaction.children.count, spanCount);
 
-    SentrySpan *ioSpan = parentTransaction.children.firstObject;
+    SentrySpan *ioSpan = (SentrySpan *)parentTransaction.children.firstObject;
     if (spanCount > 0) {
         XCTAssertEqual([ioSpan.data[@"file.size"] unsignedIntValue], someData.length);
         XCTAssertEqualObjects(ioSpan.data[@"file.path"], filePath);
diff --git a/sdk_api.json b/sdk_api.json
@@ -37022,6 +37022,45 @@
             ],
             "reqNewWitnessTableEntry": true,
             "funcSelfKind": "NonMutating"
+          },
+          {
+            "kind": "Function",
+            "name": "serialize",
+            "printedName": "serialize()",
+            "children": [
+              {
+                "kind": "TypeNominal",
+                "name": "Dictionary",
+                "printedName": "[Swift.String : Any]",
+                "children": [
+                  {
+                    "kind": "TypeNominal",
+                    "name": "String",
+                    "printedName": "Swift.String",
+                    "usr": "s:SS"
+                  },
+                  {
+                    "kind": "TypeNominal",
+                    "name": "ProtocolComposition",
+                    "printedName": "Any"
+                  }
+                ],
+                "usr": "s:SD"
+              }
+            ],
+            "declKind": "Func",
+            "usr": "c:objc(pl)SentrySpan(im)serialize",
+            "moduleName": "Sentry",
+            "genericSig": "<Self where Self : Sentry.Span>",
+            "protocolReq": true,
+            "objc_name": "serialize",
+            "declAttributes": [
+              "DiscardableResult",
+              "ObjC",
+              "Dynamic"
+            ],
+            "reqNewWitnessTableEntry": true,
+            "funcSelfKind": "NonMutating"
           }
         ],
         "declKind": "Protocol",
diff --git a/sdk_api_V9.json b/sdk_api_V9.json
@@ -34479,12 +34479,51 @@
             ],
             "reqNewWitnessTableEntry": true,
             "funcSelfKind": "NonMutating"
+          },
+          {
+            "kind": "Function",
+            "name": "serialize",
+            "printedName": "serialize()",
+            "children": [
+              {
+                "kind": "TypeNominal",
+                "name": "Dictionary",
+                "printedName": "[Swift.String : Any]",
+                "children": [
+                  {
+                    "kind": "TypeNominal",
+                    "name": "String",
+                    "printedName": "Swift.String",
+                    "usr": "s:SS"
+                  },
+                  {
+                    "kind": "TypeNominal",
+                    "name": "ProtocolComposition",
+                    "printedName": "Any"
+                  }
+                ],
+                "usr": "s:SD"
+              }
+            ],
+            "declKind": "Func",
+            "usr": "c:objc(pl)SentrySpan(im)serialize",
+            "moduleName": "Sentry",
+            "genericSig": "<Self where Self : Sentry.Span>",
+            "protocolReq": true,
+            "objc_name": "serialize",
+            "declAttributes": [
+              "DiscardableResult",
+              "ObjC",
+              "Dynamic"
+            ],
+            "reqNewWitnessTableEntry": true,
+            "funcSelfKind": "NonMutating"
           }
         ],
         "declKind": "Protocol",
         "usr": "c:objc(pl)SentrySpan",
         "moduleName": "Sentry",
-        "genericSig": "<Self : Sentry.SentrySerializable>",
+        "genericSig": "<Self : ObjectiveC.NSObjectProtocol>",
         "objc_name": "SentrySpan",
         "declAttributes": [
           "ObjC",
@@ -34505,12 +34544,6 @@
             "usr": "s:s8CopyableP",
             "mangledName": "$ss8CopyableP"
           },
-          {
-            "kind": "Conformance",
-            "name": "SentrySerializable",
-            "printedName": "SentrySerializable",
-            "usr": "c:objc(pl)SentrySerializable"
-          },
           {
             "kind": "Conformance",
             "name": "NSObjectProtocol",

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`void`
`42`	`42`	`sentry_finishAndSaveTransaction(void)`
`43`	`43`	`{`
`44`		`- SentrySpan *span = SentrySDKInternal.currentHub.scope.span;`
	`44`	`+ SentrySpan span = (SentrySpan )SentrySDKInternal.currentHub.scope.span;`
`45`	`45`
`46`	`46`	`if (span != nil) {`
`47`	`47`	`SentryTracer *tracer = [span tracer];`
Original file line number	Diff line number	Diff line change
`@@ -926,7 +926,7 @@ + (nullable SentryTracer *)getTracer:(id<SentrySpan> _Nullable)span`
`926`	`926`	`}`
`927`	`927`
`928`	`928`	`if ([span isKindOfClass:[SentryTracer class]]) {`
`929`		`- return span;`
	`929`	`+ return (SentryTracer *)span;`
`930`	`930`	`} else if ([span isKindOfClass:[SentrySpan class]]) {`
`931`	`931`	`return [(SentrySpan *)span tracer];`
`932`	`932`	`}`
Original file line number	Diff line number	Diff line change
`@@ -179,8 +179,8 @@ - (void)startRootSpanFor:(UIViewController *)controller`
`179`	`179`	`}`
`180`	`180`
`181`	`181`	`spanId = [self getSpanIdForViewController:controller];`
`182`		`- SentrySpan *_Nullable vcSpan =`
`183`		`- [self.tracker getSpan:SENTRY_UNWRAP_NULLABLE(SentrySpanId, spanId)];`
	`182`	`+ SentrySpan *_Nullable vcSpan`
	`183`	`+ = (SentrySpan *)[self.tracker getSpan:SENTRY_UNWRAP_NULLABLE(SentrySpanId, spanId)];`
`184`	`184`
`185`	`185`	`if (![vcSpan isKindOfClass:[SentryTracer self]]) {`
`186`	`186`	`// Since TTID and TTFD are meant to the whole screen`