Merge pull request #148 from slashmo/update/swift-context

Adopt Baggage API updates (0.5.0)

Author: slashmo

.gitignore

@@ -4,5 +4,4 @@
 /*.xcodeproj
 xcuserdata/
 .swiftpm
-
-UseCases/Sources/InstrumentsAppTracingInstrpkg/SpansExampleInstrument/SpansExampleInstrument.xcodeproj/project.xcworkspace/
+/Package.resolved

Package.resolved

@@ -12,7 +12,7 @@ let package = Package(
     dependencies: [
         .package(
             url: "https://github.com/slashmo/gsoc-swift-baggage-context.git",
-            from: "0.3.0"
+            from: "0.5.0"
         ),
         .package(url: "https://github.com/apple/swift-nio.git", from: "2.17.0"),
     ],
@@ -24,18 +24,21 @@ let package = Package(
             name: "Instrumentation",
             dependencies: [
                 "Baggage",
+                "BaggageContext",
             ]
         ),
         .testTarget(
             name: "InstrumentationTests",
             dependencies: [
+                "BaggageContext",
                 "Instrumentation",
             ]
         ),
 
         .target(
             name: "Tracing",
             dependencies: [
+                "BaggageContext",
                 "Instrumentation",
             ]
         ),
@@ -44,7 +47,7 @@ let package = Package(
             dependencies: [
                 "Instrumentation",
                 "Tracing",
-                "BaggageLogging",
+                "BaggageContext",
             ]
         ),
 

Package.swift

@@ -48,11 +48,11 @@ public protocol Instrument {
     ///
     /// - Parameters:
     ///   - carrier: The `Carrier` that was used to propagate values across boundaries.
-    ///   - context: The `BaggageContext` into which these values should be injected.
+    ///   - baggage: The `Baggage` into which these values should be injected.
     ///   - extractor: The `Extractor` that extracts values from the given `Carrier`.
     func extract<Carrier, Extractor>(
         _ carrier: Carrier,
-        into context: inout BaggageContext,
+        into baggage: inout Baggage,
         using extractor: Extractor
     )
         where
@@ -62,11 +62,11 @@ public protocol Instrument {
     /// Inject values from a `BaggageContext` and inject them into the given `Carrier` using the given `Injector`.
     ///
     /// - Parameters:
-    ///   - context: The `BaggageContext` from which relevant information will be extracted.
+    ///   - baggage: The `Baggage` from which relevant information will be extracted.
     ///   - carrier: The `Carrier` into which this information will be injected.
     ///   - injector: The `Injector` used to inject extracted `BaggageContext` into the given `Carrier`.
     func inject<Carrier, Injector>(
-        _ context: BaggageContext,
+        _ baggage: Baggage,
         into carrier: inout Carrier,
         using injector: Injector
     )

Sources/Instrumentation/Instrument.swift

@@ -35,22 +35,22 @@ extension MultiplexInstrument {
 
 extension MultiplexInstrument: Instrument {
     public func inject<Carrier, Injector>(
-        _ context: BaggageContext, into carrier: inout Carrier, using injector: Injector
+        _ baggage: Baggage, into carrier: inout Carrier, using injector: Injector
     )
         where
         Injector: InjectorProtocol,
         Carrier == Injector.Carrier
     {
-        self.instruments.forEach { $0.inject(context, into: &carrier, using: injector) }
+        self.instruments.forEach { $0.inject(baggage, into: &carrier, using: injector) }
     }
 
     public func extract<Carrier, Extractor>(
-        _ carrier: Carrier, into context: inout BaggageContext, using extractor: Extractor
+        _ carrier: Carrier, into baggage: inout Baggage, using extractor: Extractor
     )
         where
         Carrier == Extractor.Carrier,
         Extractor: ExtractorProtocol
     {
-        self.instruments.forEach { $0.extract(carrier, into: &context, using: extractor) }
+        self.instruments.forEach { $0.extract(carrier, into: &baggage, using: extractor) }
     }
 }

Sources/Instrumentation/MultiplexInstrument.swift

@@ -18,7 +18,7 @@ public struct NoOpInstrument: Instrument {
     public init() {}
 
     public func inject<Carrier, Injector>(
-        _ context: BaggageContext,
+        _ baggage: Baggage,
         into carrier: inout Carrier,
         using injector: Injector
     )
@@ -28,7 +28,7 @@ public struct NoOpInstrument: Instrument {
 
     public func extract<Carrier, Extractor>(
         _ carrier: Carrier,
-        into context: inout BaggageContext,
+        into baggage: inout Baggage,
         using extractor: Extractor
     )
         where

Sources/Instrumentation/NoOpInstrument.swift

@@ -21,16 +21,16 @@ public final class BaggageContextInboundHTTPHandler: ChannelInboundHandler {
     public typealias InboundOut = HTTPServerRequestPart
 
     private let instrument: Instrument
-    private var onBaggageExtracted: (BaggageContext) -> Void
+    private var onBaggageExtracted: (Baggage) -> Void
 
-    public init(instrument: Instrument, onBaggage: @escaping (BaggageContext) -> Void) {
+    public init(instrument: Instrument, onBaggage: @escaping (Baggage) -> Void) {
         self.instrument = instrument
         self.onBaggageExtracted = onBaggage
     }
 
     public func channelRead(context: ChannelHandlerContext, data: NIOAny) {
         guard case .head(let head) = unwrapInboundIn(data) else { return }
-        var baggage = BaggageContext()
+        var baggage = Baggage.topLevel
         self.instrument.extract(head.headers, into: &baggage, using: HTTPHeadersExtractor())
         self.onBaggageExtracted(baggage)
     }

Sources/NIOInstrumentation/BaggageContextInboundHTTPHandler.swift

@@ -29,7 +29,7 @@ public final class BaggageContextOutboundHTTPHandler: ChannelOutboundHandler {
     public func write(context: ChannelHandlerContext, data: NIOAny, promise: EventLoopPromise<Void>?) {
         let requestPartWithBaggage = unwrapOutboundIn(data)
         guard case .head(var head) = requestPartWithBaggage.requestPart else { return }
-        self.instrument.inject(requestPartWithBaggage.context, into: &head.headers, using: HTTPHeadersInjector())
+        self.instrument.inject(requestPartWithBaggage.baggage, into: &head.headers, using: HTTPHeadersInjector())
         // TODO: context.baggage = baggage
         // consider how we'll offer this capability in NIO
         context.write(self.wrapOutboundOut(.head(head)), promise: promise)
@@ -38,10 +38,10 @@ public final class BaggageContextOutboundHTTPHandler: ChannelOutboundHandler {
 
 public struct HTTPClientRequestPartWithBaggage {
     public let requestPart: HTTPClientRequestPart
-    public let context: BaggageContext
+    public let baggage: Baggage
 
-    public init(requestPart: HTTPClientRequestPart, context: BaggageContext) {
+    public init(requestPart: HTTPClientRequestPart, baggage: Baggage) {
         self.requestPart = requestPart
-        self.context = context
+        self.baggage = baggage
     }
 }

Sources/NIOInstrumentation/BaggageContextOutboundHTTPHandler.swift

@@ -11,7 +11,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Baggage
 import Instrumentation
 
 extension InstrumentationSystem {

Sources/Tracing/InstrumentationSystem+Tracing.swift

@@ -18,17 +18,17 @@ import Instrumentation
 public struct NoOpTracer: Tracer {
     public func startSpan(
         named operationName: String,
-        context: BaggageContextCarrier,
+        baggage: Baggage,
         ofKind kind: SpanKind,
         at timestamp: Timestamp
     ) -> Span {
-        return NoOpSpan(context: context.baggage)
+        return NoOpSpan(baggage: baggage)
     }
 
     public func forceFlush() {}
 
     public func inject<Carrier, Injector>(
-        _ context: BaggageContext,
+        _ baggage: Baggage,
         into carrier: inout Carrier,
         using injector: Injector
     )
@@ -38,19 +38,19 @@ public struct NoOpTracer: Tracer {
 
     public func extract<Carrier, Extractor>(
         _ carrier: Carrier,
-        into context: inout BaggageContext,
+        into baggage: inout Baggage,
         using extractor: Extractor
     )
         where
         Extractor: ExtractorProtocol,
         Carrier == Extractor.Carrier {}
 
     public final class NoOpSpan: Span {
-        public let context: BaggageContext
+        public let baggage: Baggage
         public let isRecording = false
 
-        public init(context: BaggageContext) {
-            self.context = context
+        public init(baggage: Baggage) {
+            self.baggage = baggage
         }
 
         public func setStatus(_ status: SpanStatus) {}