fix: Set default trace context status to ok (#6611)

Set the default context status to ok instead of not sending it at all
to avoid user confusion.

Fixes GH-6230

Author: philipphofmann

CHANGELOG.md

@@ -24,6 +24,7 @@
 - Remove `uuid` and `name` of `SentryDebugMeta` (#6512) Use `debugID` instead of `uuid` and `codeFile` instead of `name`.
 - Enable enablePreWarmedAppStartTracing by default (#6508). With this option enabled, the SDK collects [prewarmed app starts](https://docs.sentry.io/platforms/apple/tracing/instrumentation/automatic-instrumentation/#prewarmed-app-start-tracing).
 - Change `value` and `type` of `SentryException` to be nullable (#6563)
+- Change the default trace context status to "ok" instead of "undefined" (#6611)
 
 ### Features
 

Sources/Sentry/SentryScope.m

@@ -9,7 +9,7 @@
 #import "SentryPropagationContext.h"
 #import "SentryScope+Private.h"
 #import "SentryScope+PrivateSwift.h"
-#import "SentrySpan.h"
+#import "SentrySpan+Private.h"
 #import "SentrySwift.h"
 #import "SentryTracer.h"
 #import "SentryTransactionContext.h"
@@ -630,7 +630,21 @@ - (void)addObserver:(id<SentryScopeObserver>)observer
 - (NSDictionary *)buildTraceContext:(nullable id<SentrySpan>)span
 {
     if (span != nil) {
-        return [SENTRY_UNWRAP_NULLABLE_VALUE(id<SentrySpan>, span) serialize];
+        NSDictionary *dict = [SENTRY_UNWRAP_NULLABLE_VALUE(id<SentrySpan>, span) serialize];
+        if (dict[kSentrySpanStatusSerializationKey] != nil) {
+            return dict;
+        }
+
+        // We set the trace context status to OK by default here if it's not set, because spans on
+        // the scope are usually unfinished and don't have a status set. So the default trace
+        // context status would be undefined otherwise, which would confuse users. We don't want to
+        // set the default status for spans to OK, because when a span finishes, it sets the status
+        // to any state other than undefined. Spans first have a default status of OK, but we don't
+        // want to change this for the trace context status.
+        NSMutableDictionary *mutableDict = [dict mutableCopy];
+        mutableDict[kSentrySpanStatusSerializationKey] = kSentrySpanStatusNameOk;
+        return mutableDict;
+
     } else {
         return [self.propagationContext traceContextForEvent];
     }

Sources/Sentry/SentrySpan.m

@@ -351,7 +351,8 @@ - (NSDictionary *)serialize
     }
 
     if (self.status != kSentrySpanStatusUndefined) {
-        [mutableDictionary setValue:nameForSentrySpanStatus(self.status) forKey:@"status"];
+        [mutableDictionary setValue:nameForSentrySpanStatus(self.status)
+                             forKey:kSentrySpanStatusSerializationKey];
     }
 
     [mutableDictionary setValue:@(self.timestamp.timeIntervalSince1970) forKey:@"timestamp"];

Sources/Sentry/include/SentrySpan+Private.h

@@ -2,6 +2,8 @@
 
 #import "SentryProfilingConditionals.h"
 
+static NSString *_Nonnull const kSentrySpanStatusSerializationKey = @"status";
+
 @interface SentrySpan ()
 
 #if SENTRY_TARGET_PROFILING_SUPPORTED

Tests/SentryTests/SentryScopeSwiftTests.swift

@@ -218,17 +218,18 @@ class SentryScopeSwiftTests: XCTestCase {
         XCTAssertEqual(event.dist, actual?.dist)
     }
 
-    func testApplyToEvent_ScopeWithSpan() {
+    func testApplyToEvent_ScopeWithSpan() throws {
         let scope = fixture.scope
         scope.span = fixture.transaction
 
         let actual = scope.applyTo(event: fixture.event, maxBreadcrumbs: 10)
-        let trace = fixture.event.context?["trace"]
-              
+        let trace = try XCTUnwrap(fixture.event.context?["trace"])
+
         XCTAssertEqual(actual?.transaction, fixture.transactionName)
-        XCTAssertEqual(trace?["op"] as? String, fixture.transactionOperation)
-        XCTAssertEqual(trace?["trace_id"] as? String, fixture.transaction.traceId.sentryIdString)
-        XCTAssertEqual(trace?["span_id"] as? String, fixture.transaction.spanId.sentrySpanIdString)
+        XCTAssertEqual(trace["op"] as? String, fixture.transactionOperation)
+        XCTAssertEqual(trace["trace_id"] as? String, fixture.transaction.traceId.sentryIdString)
+        XCTAssertEqual(trace["span_id"] as? String, fixture.transaction.spanId.sentrySpanIdString)
+        XCTAssertEqual(trace["status"] as? String, "ok")
     }
 
     func testApplyToEvent_EventWithDist() {
@@ -603,15 +604,20 @@ class SentryScopeSwiftTests: XCTestCase {
         let traceContext = try XCTUnwrap(observer.traceContext)
         let serializedTransaction = transaction.serialize()
 
-        XCTAssertEqual(Set(serializedTransaction.keys), Set(traceContext.keys))
-        
+        var expectedKeys = Set(serializedTransaction.keys)
+        // The transaction doesn't serialize the status when it's undefined, but the trace context sets it to OK.
+        expectedKeys.insert("status")
+
+        XCTAssertEqual(Set(traceContext.keys), expectedKeys)
+
         XCTAssertEqual(serializedTransaction["trace_id"] as? String, traceContext["trace_id"] as? String)
         XCTAssertEqual(serializedTransaction["span_id"] as? String, traceContext["span_id"] as? String)
         XCTAssertEqual(serializedTransaction["op"] as? String, traceContext["op"] as? String)
         XCTAssertEqual(serializedTransaction["origin"] as? String, traceContext["origin"] as? String)
         XCTAssertEqual(serializedTransaction["type"] as? String, traceContext["type"] as? String)
         XCTAssertEqual(serializedTransaction["start_timestamp"] as? Double, traceContext["start_timestamp"] as? Double)
         XCTAssertEqual(serializedTransaction["timestamp"] as? Double, traceContext["timestamp"] as? Double)
+        XCTAssertEqual(traceContext["status"] as? String, "ok")
     }
 
     func testScopeObserver_setSpanToNil_SetsTraceContextToPropagationContext() throws {