Remove package trait, and cleanup sources; Handle failed HTTP responses

Author: ktoso

Package.swift

@@ -71,10 +71,10 @@ let package = Package(
  .product(name: "NIOHTTPCompression", package: "swift-nio-extras"),
  .product(name: "NIOSOCKS", package: "swift-nio-extras"),
  .product(name: "NIOTransportServices", package: "swift-nio-transport-services"),
- .product(name: "Logging", package: "swift-log"),
  .product(name: "Atomics", package: "swift-atomics"),
  .product(name: "Algorithms", package: "swift-algorithms"),
  // Observability support
+ .product(name: "Logging", package: "swift-log"),
  .product(name: "Tracing", package: "swift-distributed-tracing"),
  .product(name: "InMemoryTracing", package: "swift-distributed-tracing"),
  ],
@@ -93,10 +93,10 @@ let package = Package(
  .product(name: "NIOSSL", package: "swift-nio-ssl"),
  .product(name: "NIOHTTP2", package: "swift-nio-http2"),
  .product(name: "NIOSOCKS", package: "swift-nio-extras"),
- .product(name: "Logging", package: "swift-log"),
  .product(name: "Atomics", package: "swift-atomics"),
  .product(name: "Algorithms", package: "swift-algorithms"),
  // Observability support
+ .product(name: "Logging", package: "swift-log"),
  .product(name: "Tracing", package: "swift-distributed-tracing"),
  .product(name: "InMemoryTracing", package: "swift-distributed-tracing"),
  ],

Package@swift-6.1.swift

@@ -15,13 +15,10 @@
 import Logging
 import NIOCore
 import NIOHTTP1
+import Tracing
 
 import struct Foundation.URL
 
-#if TracingSupport
-import Tracing
-#endif
-
 @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
 extension HTTPClient {
  /// Execute arbitrary HTTP requests.

Sources/AsyncHTTPClient/AsyncAwait/HTTPClient+execute.swift

@@ -0,0 +1,45 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the AsyncHTTPClient open source project
+//
+// Copyright (c) 2021 Apple Inc. and the AsyncHTTPClient project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of AsyncHTTPClient project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import Logging
+import NIOCore
+import NIOHTTP1
+import Tracing
+
+import struct Foundation.URL
+
+@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
+extension HTTPClient {
+ @inlinable
+ func withRequestSpan(
+ _ request: HTTPClientRequest,
+ _ body: () async throws -> HTTPClientResponse
+ ) async rethrows -> HTTPClientResponse {
+ guard let tracer = self.tracer else {
+ return try await body()
+ }
+
+ return try await tracer.withSpan(request.method.rawValue, ofKind: .client) { span in
+ let keys = self.configuration.tracing.attributeKeys
+ span.attributes[keys.requestMethod] = request.method.rawValue
+ // TODO: set more attributes on the span
+ let response = try await body()
+
+ // set response span attributes
+ TracingSupport.handleResponseStatusCode(span, response.status, keys: tracing.attributeKeys)
+
+ return response
+ }
+ }
+}

Sources/AsyncHTTPClient/AsyncAwait/HTTPClient+tracing.swift

@@ -17,10 +17,7 @@ import NIOConcurrencyHelpers
 import NIOCore
 import NIOHTTP1
 import NIOSSL
-
-#if TracingSupport
 import Tracing
-#endif // TracingSupport
 
 @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
 @usableFromInline
@@ -38,7 +35,6 @@ final class Transaction:
 
  private let state: NIOLockedValueBox<StateMachine>
 
- #if TracingSupport
  init(
  request: HTTPClientRequest.Prepared,
  requestOptions: RequestOptions,
@@ -55,7 +51,6 @@ final class Transaction:
  self.preferredEventLoop = preferredEventLoop
  self.state = NIOLockedValueBox(StateMachine(responseContinuation))
  }
- #endif // TracingSupport
 
  init(
  request: HTTPClientRequest.Prepared,

Sources/AsyncHTTPClient/AsyncAwait/Transaction.swift

@@ -23,10 +23,7 @@ import NIOPosix
 import NIOSSL
 import NIOTLS
 import NIOTransportServices
-
-#if TracingSupport
 import Tracing
-#endif
 
 extension Logger {
  private func requestInfo(_ request: HTTPClient.Request) -> Logger.Metadata.Value {
@@ -77,12 +74,17 @@ public final class HTTPClient: Sendable {
  private let state: NIOLockedValueBox<State>
  private let canBeShutDown: Bool
 
- #if TracingSupport
+ /// Tracer configured for this HTTPClient at configuration time.
  @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
  public var tracer: (any Tracer)? {
  configuration.tracing.tracer
  }
- #endif // TracingSupport
+
+ /// Access to tracing configuration in order to get configured attribute keys etc.
+ @usableFromInline
+ package var tracing: TracingConfiguration {
+ self.configuration.tracing
+ }
 
  static let loggingDisabled = Logger(label: "AHC-do-not-log", factory: { _ in SwiftLogNoOpLogHandler() })
 
@@ -748,28 +750,17 @@ public final class HTTPClient: Sendable {
  ]
  )
 
- let failedTask: Task<Delegate.Response>? = self.state.withLockedValue { state in
+ let failedTask: Task<Delegate.Response>? = self.state.withLockedValue { state -> (Task<Delegate.Response>?) in
  switch state {
  case .upAndRunning:
  return nil
  case .shuttingDown, .shutDown:
  logger.debug("client is shutting down, failing request")
- #if TracingSupport
- if #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) {
- return Task<Delegate.Response>.failedTask(
- eventLoop: taskEL,
- error: HTTPClientError.alreadyShutdown,
- logger: logger,
- tracer: tracer,
- makeOrGetFileIOThreadPool: self.makeOrGetFileIOThreadPool
- )
- }
- #endif // TracingSupport
-
  return Task<Delegate.Response>.failedTask(
  eventLoop: taskEL,
  error: HTTPClientError.alreadyShutdown,
  logger: logger,
+ tracing: tracing,
  makeOrGetFileIOThreadPool: self.makeOrGetFileIOThreadPool
  )
  }
@@ -794,29 +785,13 @@ public final class HTTPClient: Sendable {
  }
  }()
 
- let task: HTTPClient.Task<Delegate.Response>
- #if TracingSupport
- if #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) {
- task = Task<Delegate.Response>(
- eventLoop: taskEL,
- logger: logger,
- tracer: tracer,
- makeOrGetFileIOThreadPool: self.makeOrGetFileIOThreadPool
- )
- } else {
- task = Task<Delegate.Response>(
+ let task: HTTPClient.Task<Delegate.Response> =
+ Task<Delegate.Response>(
  eventLoop: taskEL,
  logger: logger,
+ tracing: self.tracing,
  makeOrGetFileIOThreadPool: self.makeOrGetFileIOThreadPool
  )
- }
- #else
- task = Task<Delegate.Response>(
- eventLoop: taskEL,
- logger: logger,
- makeOrGetFileIOThreadPool: self.makeOrGetFileIOThreadPool
- )
- #endif // TracingSupport
 
  do {
  let requestBag = try RequestBag(
@@ -929,9 +904,8 @@ public final class HTTPClient: Sendable {
  /// A method with access to the HTTP/2 stream channel that is called when creating the stream.
  public var http2StreamChannelDebugInitializer: (@Sendable (Channel) -> EventLoopFuture<Void>)?
 
- #if TracingSupport
+ /// Configuration how distributed traces are created and handled.
  public var tracing: TracingConfiguration = .init()
- #endif
 
  public init(
  tlsConfiguration: TLSConfiguration? = nil,
@@ -1062,7 +1036,6 @@ public final class HTTPClient: Sendable {
  self.http2StreamChannelDebugInitializer = http2StreamChannelDebugInitializer
  }
 
- #if TracingSupport
  public init(
  tlsConfiguration: TLSConfiguration? = nil,
  redirectConfiguration: RedirectConfiguration? = nil,
@@ -1090,10 +1063,8 @@ public final class HTTPClient: Sendable {
  self.http2StreamChannelDebugInitializer = http2StreamChannelDebugInitializer
  self.tracing = tracing
  }
- #endif
  }
 
- #if TracingSupport
  public struct TracingConfiguration: Sendable {
 
  @usableFromInline
@@ -1149,7 +1120,6 @@ public final class HTTPClient: Sendable {
  public init() {}
  }
  }
- #endif
 
  /// Specifies how `EventLoopGroup` will be created and establishes lifecycle ownership.
  public enum EventLoopGroupProvider {