Update to BaggageContext 0.2.0

Author: slashmo

Package.swift

@@ -26,7 +26,8 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-nio-extras.git", from: "1.3.0"),
         .package(url: "https://github.com/apple/swift-nio-transport-services.git", from: "1.5.1"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.4.0"),
-        .package(url: "https://github.com/slashmo/gsoc-swift-tracing.git", .branch("main"))
+        .package(url: "https://github.com/slashmo/gsoc-swift-tracing.git", .branch("main")),
+        .package(url: "https://github.com/slashmo/gsoc-swift-baggage-context.git", from: "0.2.0"),
     ],
     targets: [
         .target(
@@ -35,7 +36,8 @@ let package = Package(
                            "NIOFoundationCompat", "NIOTransportServices", "Logging",
                            .product(name: "TracingInstrumentation", package: "gsoc-swift-tracing"),
                            .product(name: "OpenTelemetryInstrumentationSupport", package: "gsoc-swift-tracing"),
-                           .product(name: "NIOInstrumentation", package: "gsoc-swift-tracing")]
+                           .product(name: "NIOInstrumentation", package: "gsoc-swift-tracing"),
+                           .product(name: "BaggageLogging", package: "swift-baggage-context")]
         ),
         .testTarget(
             name: "AsyncHTTPClientTests",

Sources/AsyncHTTPClient/HTTPClient.swift

@@ -13,6 +13,7 @@
 //===----------------------------------------------------------------------===//
 
 import Baggage
+import BaggageLogging
 import Foundation
 import Instrumentation
 import TracingInstrumentation
@@ -232,7 +233,7 @@ public class HTTPClient {
     ///     - url: Remote URL.
     ///     - context: Baggage context associated with this request
     ///     - deadline: Point in time by which the request must complete.
-    public func get(url: String, context: BaggageContext, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func get(url: String, context: LoggingBaggageContextCarrier, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         return self.execute(.GET, url: url, context: context, deadline: deadline)
     }
 
@@ -243,7 +244,7 @@ public class HTTPClient {
     ///     - context: Baggage context associated with this request
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
-    public func post(url: String, context: BaggageContext, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func post(url: String, context: LoggingBaggageContextCarrier, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         return self.execute(.POST, url: url, context: context, body: body, deadline: deadline)
     }
 
@@ -254,7 +255,7 @@ public class HTTPClient {
     ///     - context: Baggage context associated with this request
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
-    public func patch(url: String, context: BaggageContext, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func patch(url: String, context: LoggingBaggageContextCarrier, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         return self.execute(.PATCH, url: url, context: context, body: body, deadline: deadline)
     }
 
@@ -265,7 +266,7 @@ public class HTTPClient {
     ///     - context: Baggage context associated with this request
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
-    public func put(url: String, context: BaggageContext, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func put(url: String, context: LoggingBaggageContextCarrier, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         return self.execute(.PUT, url: url, context: context, body: body, deadline: deadline)
     }
 
@@ -275,7 +276,7 @@ public class HTTPClient {
     ///     - url: Remote URL.
     ///     - context: Baggage context associated with this request
     ///     - deadline: The time when the request must have been completed by.
-    public func delete(url: String, context: BaggageContext, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func delete(url: String, context: LoggingBaggageContextCarrier, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         return self.execute(.DELETE, url: url, context: context, deadline: deadline)
     }
 
@@ -287,7 +288,7 @@ public class HTTPClient {
     ///     - context: Baggage context associated with this request
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
-    public func execute(_ method: HTTPMethod = .GET, url: String, context: BaggageContext, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func execute(_ method: HTTPMethod = .GET, url: String, context: LoggingBaggageContextCarrier, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         do {
             let request = try Request(url: url, method: method, body: body)
             return self.execute(request: request, context: context, deadline: deadline)
@@ -305,7 +306,7 @@ public class HTTPClient {
     ///     - context: Baggage context associated with this request
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
-    public func execute(_ method: HTTPMethod = .GET, socketPath: String, urlPath: String, context: BaggageContext, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func execute(_ method: HTTPMethod = .GET, socketPath: String, urlPath: String, context: LoggingBaggageContextCarrier, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         do {
             guard let url = URL(httpURLWithSocketPath: socketPath, uri: urlPath) else {
                 throw HTTPClientError.invalidURL
@@ -327,7 +328,7 @@ public class HTTPClient {
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
     ///     - logger: The logger to use for this request.
-    public func execute(_ method: HTTPMethod = .GET, secureSocketPath: String, urlPath: String, context: BaggageContext, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func execute(_ method: HTTPMethod = .GET, secureSocketPath: String, urlPath: String, context: LoggingBaggageContextCarrier, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         do {
             guard let url = URL(httpsURLWithSocketPath: secureSocketPath, uri: urlPath) else {
                 throw HTTPClientError.invalidURL
@@ -345,7 +346,7 @@ public class HTTPClient {
     ///     - request: HTTP request to execute.
     ///     - context: Baggage context associated with this request
     ///     - deadline: Point in time by which the request must complete.
-    public func execute(request: Request, context: BaggageContext, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func execute(request: Request, context: LoggingBaggageContextCarrier, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         let accumulator = ResponseAccumulator(request: request)
         return self.execute(request: request, delegate: accumulator, context: context, deadline: deadline).futureResult
     }
@@ -357,7 +358,7 @@ public class HTTPClient {
     ///     - eventLoop: NIO Event Loop preference.
     ///     - context: Baggage context associated with this request
     ///     - deadline: Point in time by which the request must complete.
-    public func execute(request: Request, eventLoop: EventLoopPreference, context: BaggageContext, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func execute(request: Request, eventLoop: EventLoopPreference, context: LoggingBaggageContextCarrier, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         let accumulator = ResponseAccumulator(request: request)
         return self.execute(request: request, delegate: accumulator, eventLoop: eventLoop, context: context, deadline: deadline).futureResult
     }
@@ -371,7 +372,7 @@ public class HTTPClient {
     ///     - deadline: Point in time by which the request must complete.
     public func execute<Delegate: HTTPClientResponseDelegate>(request: Request,
                                                               delegate: Delegate,
-                                                              context: BaggageContext,
+                                                              context: LoggingBaggageContextCarrier,
                                                               deadline: NIODeadline? = nil) -> Task<Delegate.Response> {
         return self.execute(request: request, delegate: delegate, eventLoop: .indifferent, context: context, deadline: deadline)
     }
@@ -387,7 +388,7 @@ public class HTTPClient {
     public func execute<Delegate: HTTPClientResponseDelegate>(request: Request,
                                                               delegate: Delegate,
                                                               eventLoop eventLoopPreference: EventLoopPreference,
-                                                              context: BaggageContext,
+                                                              context: LoggingBaggageContextCarrier,
                                                               deadline: NIODeadline? = nil) -> Task<Delegate.Response> {
         var span = InstrumentationSystem.tracingInstrument.startSpan(named: request.method.rawValue, context: context, ofKind: .client, at: nil)
         span.attributes.http.method = request.method.rawValue
@@ -401,10 +402,10 @@ public class HTTPClient {
         // TODO: net.peer.ip / Not required, but recommended
 
         var request = request
-        InstrumentationSystem.instrument.inject(context, into: &request.headers, using: HTTPHeadersInjector())
+        InstrumentationSystem.instrument.inject(context.baggage, into: &request.headers, using: HTTPHeadersInjector())
+
+        let logger = context.logger.attachingRequestInformation(request, requestID: globalRequestID.add(1))
 
-//        let logger = (originalLogger ?? HTTPClient.loggingDisabled).attachingRequestInformation(request, requestID: globalRequestID.add(1))
-        let logger = HTTPClient.loggingDisabled
         let taskEL: EventLoop
         switch eventLoopPreference.preference {
         case .indifferent:
@@ -418,16 +419,16 @@ public class HTTPClient {
         case .testOnly_exact(_, delegateOn: let delegateEL):
             taskEL = delegateEL
         }
-//        logger.trace("selected EventLoop for task given the preference",
-//                     metadata: ["ahc-eventloop": "\(taskEL)",
-//                                "ahc-el-preference": "\(eventLoopPreference)"])
+        logger.trace("selected EventLoop for task given the preference",
+                     metadata: ["ahc-eventloop": "\(taskEL)",
+                                "ahc-el-preference": "\(eventLoopPreference)"])
 
         let failedTask: Task<Delegate.Response>? = self.stateLock.withLock {
             switch state {
             case .upAndRunning:
                 return nil
             case .shuttingDown, .shutDown:
-//                logger.debug("client is shutting down, failing request")
+                logger.debug("client is shutting down, failing request")
                 return Task<Delegate.Response>.failedTask(eventLoop: taskEL,
                                                           error: HTTPClientError.alreadyShutdown,
                                                           logger: logger)