Expose span baggage API

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - Replay for crashes (#4171)
 - Redact web view from replay (#4203)
+- Expose span baggage API (#4207)
 
 ## 8.32.0
 

Sources/Sentry/Public/SentrySpanProtocol.h

@@ -1,10 +1,9 @@
 #import "SentryDefines.h"
 #import "SentrySerializable.h"
 #import "SentrySpanContext.h"
-
 NS_ASSUME_NONNULL_BEGIN
 
-@class SentrySpanId, SentryId, SentryTraceHeader, SentryMeasurementUnit;
+@class SentrySpanId, SentryId, SentryTraceHeader, SentryMeasurementUnit, SentryTraceContext;
 
 NS_SWIFT_NAME(Span)
 @protocol SentrySpan <SentrySerializable>
@@ -80,6 +79,11 @@ NS_SWIFT_NAME(Span)
  */
 @property (readonly) BOOL isFinished;
 
+/**
+ * Retrieves a trace context from this tracer.
+ */
+@property (nullable, nonatomic, readonly) SentryTraceContext *traceContext;
+
 /**
  * Starts a child span.
  * @param operation Short code identifying the type of operation the span is measuring.
@@ -167,6 +171,12 @@ NS_SWIFT_NAME(Span)
  */
 - (SentryTraceHeader *)toTraceHeader;
 
+/**
+ * Returns the baggage http header
+ * @return NSString.
+ */
+- (nullable NSString *)baggageHttpHeader;
+
 @end
 
 NS_ASSUME_NONNULL_END

Sources/Sentry/Public/SentryWithoutUIKit.h

@@ -9,6 +9,7 @@ FOUNDATION_EXPORT const unsigned char SentryVersionString[];
 
 #    import <SentryWithoutUIKit/Sentry.h>
 #    import <SentryWithoutUIKit/SentryAttachment.h>
+#    import <SentryWithoutUIKit/SentryBaggage.h>
 #    import <SentryWithoutUIKit/SentryBreadcrumb.h>
 #    import <SentryWithoutUIKit/SentryClient.h>
 #    import <SentryWithoutUIKit/SentryCrashExceptionApplication.h>
@@ -42,6 +43,7 @@ FOUNDATION_EXPORT const unsigned char SentryVersionString[];
 #    import <SentryWithoutUIKit/SentrySpanStatus.h>
 #    import <SentryWithoutUIKit/SentryStacktrace.h>
 #    import <SentryWithoutUIKit/SentryThread.h>
+#    import <SentryWithoutUIKit/SentryTraceContext.h>
 #    import <SentryWithoutUIKit/SentryTraceHeader.h>
 #    import <SentryWithoutUIKit/SentryTransactionContext.h>
 #    import <SentryWithoutUIKit/SentryUser.h>

Sources/Sentry/SentrySpan.m

@@ -1,3 +1,4 @@
+#import "SentryBaggage.h"
 #import "SentryCrashThread.h"
 #import "SentryDependencyContainer.h"
 #import "SentryFrame.h"
@@ -13,6 +14,7 @@
 #import "SentrySwift.h"
 #import "SentryThreadInspector.h"
 #import "SentryTime.h"
+#import "SentryTraceContext.h"
 #import "SentryTraceHeader.h"
 #import "SentryTracer.h"
 
@@ -297,6 +299,23 @@
                                               sampled:self.sampled];
 }
 
+// Getter for the computed property baggage
+- (nullable NSString *)baggageHttpHeader
+{
+    if (nil == self.tracer) {
+        return nil;
+    }
+    return [[self.tracer.traceContext toBaggage] toHTTPHeaderWithOriginalBaggage:nil];
+}
+
+- (nullable SentryTraceContext *)traceContext
+{
+    if (nil == self.tracer) {
+        return nil;
+    }
+    return self.tracer.traceContext;
+}
+
 - (LocalMetricsAggregator *)getLocalMetricsAggregator
 {
     if (localMetricsAggregator == nil) {

Sources/Sentry/SentryTracer.m

@@ -412,14 +412,17 @@ - (void)spanFinished:(id<SentrySpan>)finishedSpan
     [self canBeFinished];
 }
 
-- (SentryTraceContext *)traceContext
+- (nullable SentryTraceContext *)traceContext
 {
     if (_traceContext == nil) {
         @synchronized(self) {
             if (_traceContext == nil) {
-                _traceContext = [[SentryTraceContext alloc] initWithTracer:self
-                                                                     scope:_hub.scope
-                                                                   options:SentrySDK.options];
+                _traceContext = [[SentryTraceContext alloc]
+                    initWithTracer:self
+                             scope:_hub.scope
+                           options:_hub.client.options
+                               ?: SentrySDK.options]; // We should remove static classes and always
+                                                      // inject dependencies.
             }
         }
     }

Sources/Sentry/include/HybridPublic/SentryEnvelope.h

@@ -1,10 +1,9 @@
 #import "PrivatesHeader.h"
 
 #if COCOAPODS
-@class SentrySdkInfo, SentryTraceContext;
+@class SentrySdkInfo;
 #else
 #    import "SentrySdkInfo.h"
-#    import "SentryTraceContext.h"
 
 #endif
 
@@ -14,6 +13,7 @@
 @class SentryUserFeedback;
 @class SentryAttachment;
 @class SentryEnvelopeItemHeader;
+@class SentryTraceContext;
 
 NS_ASSUME_NONNULL_BEGIN
 

Sources/Sentry/include/SentryTracer.h

@@ -43,11 +43,6 @@ static const NSTimeInterval SENTRY_AUTO_TRANSACTION_MAX_DURATION = 500.0;
 
 @property (nullable, nonatomic, copy) BOOL (^shouldIgnoreWaitForChildrenCallback)(id<SentrySpan>);
 
-/**
- * Retrieves a trace context from this tracer.
- */
-@property (nonatomic, readonly) SentryTraceContext *traceContext;
-
 /**
  * All the spans that where created with this tracer but rootSpan.
  */

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

@@ -164,7 +164,7 @@ class SentryNetworkTrackerIntegrationTests: XCTestCase {
             self.assertNetworkError(error)
             let response = String(data: data ?? Data(), encoding: .utf8) ?? ""
 
-            let expectedBaggageHeader = transaction.traceContext.toBaggage().toHTTPHeader(withOriginalBaggage: nil)
+            let expectedBaggageHeader = transaction.traceContext?.toBaggage().toHTTPHeader(withOriginalBaggage: nil)
             XCTAssertEqual(expectedBaggageHeader, response)
 
             expect.fulfill()

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

@@ -665,7 +665,7 @@ class SentryNetworkTrackerTests: XCTestCase {
         let transaction = try XCTUnwrap(startTransaction() as? SentryTracer)
         sut.urlSessionTaskResume(task)
 
-        let expectedBaggageHeader = transaction.traceContext.toBaggage().toHTTPHeader(withOriginalBaggage: nil)
+        let expectedBaggageHeader = transaction.traceContext?.toBaggage().toHTTPHeader(withOriginalBaggage: nil)
         XCTAssertEqual(task.currentRequest?.allHTTPHeaderFields?["baggage"] ?? "", expectedBaggageHeader)
     }
 

Tests/SentryTests/SentrySDKTests.swift

@@ -398,7 +398,7 @@ class SentrySDKTests: XCTestCase {
 
         XCTAssertEqual(operation, transaction.operation)
         let tracer = try XCTUnwrap(transaction as? SentryTracer)
-        XCTAssertEqual(name, tracer.traceContext.transaction)
+        XCTAssertEqual(name, tracer.traceContext?.transaction)
 
         XCTAssertNil(SentrySDK.span)
     }
@@ -410,7 +410,7 @@ class SentrySDKTests: XCTestCase {
 
         XCTAssertEqual(fixture.operation, transaction.operation)
         let tracer = try XCTUnwrap(transaction as? SentryTracer)
-        XCTAssertEqual(fixture.transactionName, tracer.traceContext.transaction)
+        XCTAssertEqual(fixture.transactionName, tracer.traceContext?.transaction)
         XCTAssertEqual(.custom, tracer.transactionContext.nameSource)
 
         let newSpan = SentrySDK.span

Tests/SentryTests/Transaction/SentrySpanTests.swift

@@ -676,6 +676,22 @@ class SentrySpanTests: XCTestCase {
         XCTAssertEqual(nameForSentrySpanStatus(.dataLoss), kSentrySpanStatusNameDataLoss)
     }
 
+    func testTraceContext() {
+        let client = TestClient(options: fixture.options)!
+        let sut = fixture.getSut(client: client) as! SentrySpan
+
+        let expectedTraceContext = sut.tracer?.traceContext
+        XCTAssertEqual(expectedTraceContext, sut.traceContext)
+    }
+
+    func testBaggageHttpHeader() {
+        let client = TestClient(options: fixture.options)!
+        let sut = fixture.getSut(client: client) as! SentrySpan
+
+        let expectedBaggage = sut.tracer?.traceContext?.toBaggage().toHTTPHeader(withOriginalBaggage: nil)
+        XCTAssertEqual(expectedBaggage, sut.baggageHttpHeader())
+    }
+
 #if os(iOS) || os(tvOS) || targetEnvironment(macCatalyst)
     func testAddSlowFrozenFramesToData() {
         let (displayLinkWrapper, framesTracker) = givenFramesTracker()