Merge pull request #113 from slashmo/dep/baggage-context

Adopt BaggageContext 0.2.0 📦

Author: slashmo

Package.resolved

@@ -4,7 +4,6 @@ import PackageDescription
 let package = Package(
     name: "gsoc-swift-tracing",
     products: [
-        .library(name: "BaggageLogging", targets: ["BaggageLogging"]),
         .library(name: "Instrumentation", targets: ["Instrumentation"]),
         .library(name: "TracingInstrumentation", targets: ["TracingInstrumentation"]),
         .library(name: "NIOInstrumentation", targets: ["NIOInstrumentation"]),
@@ -13,30 +12,12 @@ let package = Package(
     dependencies: [
         .package(
             name: "swift-baggage-context",
-            url: "https://github.com/slashmo/gsoc-swift-baggage-context",
-            from: "0.1.0"
+            url: "https://github.com/slashmo/gsoc-swift-baggage-context.git",
+            from: "0.2.0"
         ),
-        .package(url: "https://github.com/apple/swift-nio.git", from: "2.17.0"),
-        .package(url: "https://github.com/apple/swift-log.git", from: "1.2.0")
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.17.0")
     ],
     targets: [
-        // ==== --------------------------------------------------------------------------------------------------------
-        // MARK: Baggage + Logging
-
-        .target(
-            name: "BaggageLogging",
-            dependencies: [
-                .product(name: "Baggage", package: "swift-baggage-context"),
-                .product(name: "Logging", package: "swift-log"),
-            ]
-        ),
-        .testTarget(
-            name: "BaggageLoggingTests",
-            dependencies: [
-                "BaggageLogging",
-            ]
-        ),
-
         // ==== --------------------------------------------------------------------------------------------------------
         // MARK: Instrumentation
 
@@ -50,7 +31,6 @@ let package = Package(
             name: "InstrumentationTests",
             dependencies: [
                 "Instrumentation",
-                "BaggageLogging"
             ]
         ),
 
@@ -65,7 +45,7 @@ let package = Package(
             dependencies: [
                 "Instrumentation",
                 "TracingInstrumentation",
-                "BaggageLogging"
+                .product(name: "BaggageLogging", package: "swift-baggage-context"),
             ]
         ),
 

Package.swift

@@ -50,7 +50,11 @@ public protocol Instrument {
     ///   - carrier: The `Carrier` that was used to propagate values across boundaries.
     ///   - context: The `BaggageContext` 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, using extractor: Extractor)
+    func extract<Carrier, Extractor>(
+        _ carrier: Carrier,
+        into context: inout BaggageContext,
+        using extractor: Extractor
+    )
         where
         Extractor: ExtractorProtocol,
         Extractor.Carrier == Carrier
@@ -61,7 +65,11 @@ public protocol Instrument {
     ///   - context: The `BaggageContext` 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, into carrier: inout Carrier, using injector: Injector)
+    func inject<Carrier, Injector>(
+        _ context: BaggageContext,
+        into carrier: inout Carrier,
+        using injector: Injector
+    )
         where
         Injector: InjectorProtocol,
         Injector.Carrier == Carrier

Sources/BaggageLogging/Baggage+Logger.swift

@@ -17,12 +17,20 @@ import Baggage
 public struct NoOpInstrument: Instrument {
     public init() {}
 
-    public func inject<Carrier, Injector>(_ context: BaggageContext, into carrier: inout Carrier, using injector: Injector)
+    public func inject<Carrier, Injector>(
+        _ context: BaggageContext,
+        into carrier: inout Carrier,
+        using injector: Injector
+    )
         where
         Injector: InjectorProtocol,
         Carrier == Injector.Carrier {}
 
-    public func extract<Carrier, Extractor>(_ carrier: Carrier, into context: inout BaggageContext, using extractor: Extractor)
+    public func extract<Carrier, Extractor>(
+        _ carrier: Carrier,
+        into context: inout BaggageContext,
+        using extractor: Extractor
+    )
         where
         Extractor: ExtractorProtocol,
         Carrier == Extractor.Carrier {}

Sources/Instrumentation/Instrument.swift

@@ -18,19 +18,27 @@ import Instrumentation
 public struct NoOpTracingInstrument: TracingInstrument {
     public func startSpan(
         named operationName: String,
-        context: BaggageContext,
+        context: BaggageContextCarrier,
         ofKind kind: SpanKind,
         at timestamp: Timestamp?
     ) -> Span {
         NoOpSpan()
     }
 
-    public func inject<Carrier, Injector>(_ context: BaggageContext, into carrier: inout Carrier, using injector: Injector)
+    public func inject<Carrier, Injector>(
+        _ context: BaggageContext,
+        into carrier: inout Carrier,
+        using injector: Injector
+    )
         where
         Injector: InjectorProtocol,
         Carrier == Injector.Carrier {}
 
-    public func extract<Carrier, Extractor>(_ carrier: Carrier, into context: inout BaggageContext, using extractor: Extractor)
+    public func extract<Carrier, Extractor>(
+        _ carrier: Carrier,
+        into context: inout BaggageContext,
+        using extractor: Extractor
+    )
         where
         Extractor: ExtractorProtocol,
         Carrier == Extractor.Carrier {}

Sources/Instrumentation/NoOpInstrument.swift

@@ -469,10 +469,10 @@ public struct SpanLink {
 
     /// Create a new `SpanLink`.
     /// - Parameters:
-    ///   - context: The `BaggageContext` identifying the targeted `Span`.
+    ///   - context: The carrier of a `BaggageContext` identifying the targeted `Span`.
     ///   - attributes: `SpanAttributes` that further describe the link. Defaults to no attributes.
-    public init(context: BaggageContext, attributes: SpanAttributes = [:]) {
-        self.context = context
+    public init(context: BaggageContextCarrier, attributes: SpanAttributes = [:]) {
+        self.context = context.baggage
         self.attributes = attributes
     }
 }

Sources/TracingInstrumentation/NoOpTracingInstrument.swift

@@ -20,12 +20,12 @@ public protocol TracingInstrument: Instrument {
     /// Start a new `Span` within the given `BaggageContext` at a given timestamp.
     /// - Parameters:
     ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
-    ///   - context: The `BaggageContext` within to start the new `Span`.
+    ///   - context: The carrier of a `BaggageContext` within to start the new `Span`.
     ///   - kind: The `SpanKind` of the new `Span`.
     ///   - timestamp: The `DispatchTime` at which to start the new `Span`. Passing `nil` leaves the timestamp capture to the underlying tracing instrument.
     func startSpan(
         named operationName: String,
-        context: BaggageContext,
+        context: BaggageContextCarrier,
         ofKind kind: SpanKind,
         at timestamp: Timestamp?
     ) -> Span
@@ -36,12 +36,12 @@ extension TracingInstrument {
     /// usually means it should default to the current timestamp.
     /// - Parameters:
     ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
-    ///   - context: The `BaggageContext` within to start the new `Span`.
+    ///   - context: The carrier of a `BaggageContext` within to start the new `Span`.
     ///   - kind: The `SpanKind` of the `Span` to be created. Defaults to `.internal`.
     ///   - timestamp: The `DispatchTime` at which to start the new `Span`. Defaults to `nil`, meaning the timestamp capture is left up to the underlying tracing instrument.
     public func startSpan(
         named operationName: String,
-        context: BaggageContext,
+        context: BaggageContextCarrier,
         at timestamp: Timestamp? = nil
     ) -> Span {
         self.startSpan(named: operationName, context: context, ofKind: .internal, at: nil)

Sources/TracingInstrumentation/Span.swift

@@ -37,24 +37,40 @@ final class InstrumentationSystemTests: XCTestCase {
 }
 
 private final class FakeTracer: Instrument {
-    func inject<Carrier, Injector>(_ context: BaggageContext, into carrier: inout Carrier, using injector: Injector)
+    func inject<Carrier, Injector>(
+        _ context: BaggageContext,
+        into carrier: inout Carrier,
+        using injector: Injector
+    )
         where
         Injector: InjectorProtocol,
         Carrier == Injector.Carrier {}
 
-    func extract<Carrier, Extractor>(_ carrier: Carrier, into context: inout BaggageContext, using extractor: Extractor)
+    func extract<Carrier, Extractor>(
+        _ carrier: Carrier,
+        into context: inout BaggageContext,
+        using extractor: Extractor
+    )
         where
         Extractor: ExtractorProtocol,
         Carrier == Extractor.Carrier {}
 }
 
 private final class FakeInstrument: Instrument {
-    func inject<Carrier, Injector>(_ context: BaggageContext, into carrier: inout Carrier, using injector: Injector)
+    func inject<Carrier, Injector>(
+        _ context: BaggageContext,
+        into carrier: inout Carrier,
+        using injector: Injector
+    )
         where
         Injector: InjectorProtocol,
         Carrier == Injector.Carrier {}
 
-    func extract<Carrier, Extractor>(_ carrier: Carrier, into context: inout BaggageContext, using extractor: Extractor)
+    func extract<Carrier, Extractor>(
+        _ carrier: Carrier,
+        into context: inout BaggageContext,
+        using extractor: Extractor
+    )
         where
         Extractor: ExtractorProtocol,
         Carrier == Extractor.Carrier {}