[Tracing] fix availability issues

Author: ktoso

Sources/AsyncHTTPClient/HTTPClient.swift

@@ -77,7 +77,7 @@ public final class HTTPClient: Sendable {
 
  #if TracingSupport
  @_spi(Tracing)
- @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal ServiceContext
+ @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
  public var tracer: (any Tracer)? {
  configuration.tracing.tracer
  }
@@ -768,16 +768,22 @@ public final class HTTPClient: Sendable {
  return nil
  case .shuttingDown, .shutDown:
  logger.debug("client is shutting down, failing request")
- let error = HTTPClientError.alreadyShutdown
- // #if TracingSupport
- // span?.recordError(error)
- // span?.end()
- // #endif
+ #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: error,
+ error: HTTPClientError.alreadyShutdown,
  logger: logger,
- tracer: tracer,
  makeOrGetFileIOThreadPool: self.makeOrGetFileIOThreadPool
  )
  }
@@ -802,12 +808,29 @@ 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>(
+ eventLoop: taskEL,
+ logger: logger,
+ makeOrGetFileIOThreadPool: self.makeOrGetFileIOThreadPool
+ )
+ }
+ #else
  let task = Task<Delegate.Response>(
  eventLoop: taskEL,
  logger: logger,
- tracer: tracer,
  makeOrGetFileIOThreadPool: self.makeOrGetFileIOThreadPool
  )
+ #endif // TracingSupport
 
  do {
  let requestBag = try RequestBag(
@@ -1109,8 +1132,16 @@ public final class HTTPClient: Sendable {
  }
  }
 
+ /// Configuration for tracing attributes set by the HTTPClient.
  public var attributeKeys: AttributeKeys
 
+
+ public init() {
+ self._tracer = nil
+ self.attributeKeys = .init()
+ }
+
+ @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
  public init(
  tracer: (any Tracer)? = InstrumentationSystem.tracer,
  attributeKeys: AttributeKeys = .init()

Sources/AsyncHTTPClient/HTTPHandler.swift

@@ -929,7 +929,15 @@ extension HTTPClient {
  public let logger: Logger // We are okay to store the logger here because a Task is for only one request.
 
  #if TracingSupport
- public let tracer: (any Tracer)? // Ok to store the tracer here because a Task is for only one request.
+ let anyTracer: Optional<any Sendable> // Ok to store the tracer here because a Task is for only one request.
+ 
+ @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
+ public var tracer: (any Tracer)? {
+ get {
+ print("[swift][\(#fileID):\(#line)] _tracer = \(anyTracer)")
+ return anyTracer as! (any Tracer)?
+ }
+ }
  #endif
 
  let promise: EventLoopPromise<Response>
@@ -965,7 +973,7 @@ extension HTTPClient {
  self.eventLoop = eventLoop
  self.promise = eventLoop.makePromise()
  self.logger = logger
- self.tracer = nil
+ self.anyTracer = nil
  self.makeOrGetFileIOThreadPool = makeOrGetFileIOThreadPool
  self.state = NIOLockedValueBox(State(isCancelled: false, taskDelegate: nil))
  }
@@ -986,6 +994,7 @@ extension HTTPClient {
  }
 
  #if TracingSupport
+ @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
  init(
  eventLoop: EventLoop,
  logger: Logger,
@@ -995,11 +1004,13 @@ extension HTTPClient {
  self.eventLoop = eventLoop
  self.promise = eventLoop.makePromise()
  self.logger = logger
- self.tracer = tracer
+ print("[swift] set any tracer on TASK = \(tracer)")
+ self.anyTracer = tracer
  self.makeOrGetFileIOThreadPool = makeOrGetFileIOThreadPool
  self.state = NIOLockedValueBox(State(isCancelled: false, taskDelegate: nil))
  }
 
+ @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
  static func failedTask(
  eventLoop: EventLoop,
  error: Error,

Sources/AsyncHTTPClient/RequestBag.swift

@@ -69,12 +69,16 @@ final class RequestBag<Delegate: HTTPClientResponseDelegate & Sendable>: Sendabl
  self.task.logger
  }
 
- let connectionDeadline: NIODeadline
-
- var tracer: HTTPClientTracingSupportTracerType? {
+ var anyTracer: (any Sendable)? {
+ self.task.anyTracer
+ }
+ @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
+ var tracer: (any Tracer)? {
  self.task.tracer
  }
 
+ let connectionDeadline: NIODeadline
+
  let requestOptions: RequestOptions
 
  let requestHead: HTTPRequestHead
@@ -97,6 +101,8 @@ final class RequestBag<Delegate: HTTPClientResponseDelegate & Sendable>: Sendabl
  self.eventLoopPreference = eventLoopPreference
  self.task = task
 
+ assert(task.anyTracer != nil, "tracer was nil!") 
+
  let loopBoundState = LoopBoundState(
  request: request,
  state: StateMachine(redirectHandler: redirectHandler),
@@ -128,18 +134,19 @@ final class RequestBag<Delegate: HTTPClientResponseDelegate & Sendable>: Sendabl
 
  private func willExecuteRequest0(_ executor: HTTPRequestExecutor) {
  // Immediately start a span for the "whole" request
- self.loopBoundState.value.startRequestSpan(tracer: self.tracer)
+ print("[swift] WILL EXECUTE \(self.anyTracer)")
+ self.loopBoundState.value.startRequestSpan(tracer: self.anyTracer)
 
  let action = self.loopBoundState.value.state.willExecuteRequest(executor)
  switch action {
  case .cancelExecuter(let executor):
  executor.cancelRequest(self)
- self.loopBoundState.value.failRequestSpan(error: CancellationError())
+ self.loopBoundState.value.failRequestSpanAsCancelled()
  case .failTaskAndCancelExecutor(let error, let executor):
  self.delegate.didReceiveError(task: self.task, error)
  self.task.failInternal(with: error)
  executor.cancelRequest(self)
- self.loopBoundState.value.failRequestSpan(error: CancellationError())
+ self.loopBoundState.value.failRequestSpan(error: error)
  case .none:
  break
  }

Sources/AsyncHTTPClient/TracingSupport.swift

@@ -34,22 +34,24 @@ struct HTTPHeadersInjector: Injector, @unchecked Sendable {
 }
 #endif // TracingSupport
 
-#if TracingSupport
-typealias HTTPClientTracingSupportTracerType = any Tracer
-#else
-enum TracingSupportDisabledTracer {}
-typealias HTTPClientTracingSupportTracerType = TracingSupportDisabledTracer
-#endif
+// #if TracingSupport
+// @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
+// typealias HTTPClientTracingSupportTracerType = any Tracer
+// #else
+// enum TracingSupportDisabledTracer {}
+// typealias HTTPClientTracingSupportTracerType = TracingSupportDisabledTracer
+// #endif
 
 protocol _TracingSupportOperations {
- associatedtype TracerType
+ // associatedtype TracerType
 
  /// Starts the "overall" Span that encompases the beginning of a request until receipt of the head part of the response.
- mutating func startRequestSpan(tracer: TracerType?)
+ mutating func startRequestSpan(tracer: Any?)
 
  /// Fails the active overall span given some internal error, e.g. timeout, pool shutdown etc.
  /// This is not to be used for failing a span given a failure status coded HTTPResponse.
  mutating func failRequestSpan(error: any Error)
+ mutating func failRequestSpanAsCancelled() // because CancellationHandler availability...
 
  /// Ends the active overall span upon receipt of the response head.
  ///
@@ -65,7 +67,7 @@ extension RequestBag.LoopBoundState {
  typealias TracerType = HTTPClientTracingSupportTracerType
 
  @inlinable
- mutating func startRequestSpan(tracer: TracerType?) {}
+ mutating func startRequestSpan(tracer: Any?) {}
 
  @inlinable
  mutating func failRequestSpan(error: any Error) {}
@@ -77,10 +79,14 @@ extension RequestBag.LoopBoundState {
 #else // TracingSupport
 
 extension RequestBag.LoopBoundState {
- typealias TracerType = Tracer
-
- mutating func startRequestSpan(tracer: (any Tracer)?) {
- guard let tracer else {
+ // typealias TracerType = Tracer
+
+ mutating func startRequestSpan(tracer: Any?) {
+ guard #available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *), 
+ let tracer = tracer as? (any Tracer)?,
+ let tracer else {
+ // print("[swift][\(#fileID):\(#line)] MISSING TRACER: \(tracer)")
+ fatalError("[swift][\(#fileID):\(#line)] MISSING TRACER: \(tracer)")
  return
  }
 
@@ -92,13 +98,23 @@ extension RequestBag.LoopBoundState {
  self.activeSpan?.attributes["loc"] = "\(#fileID):\(#line)"
  }
 
- // TODO: should be able to record the reason for the failure, e.g. timeout, cancellation etc.
+ mutating func failRequestSpanAsCancelled() {
+ if #available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) {
+ let error = CancellationError()
+ failRequestSpan(error: error)
+ } else {
+ fatalError("Unexpected configuration; expected availability of CancellationError")
+ }
+ }
+
  mutating func failRequestSpan(error: any Error) {
  guard let span = activeSpan else {
  return
  }
 
  span.recordError(error)
+ span.end()
+
  self.activeSpan = nil
  }
 

Tests/AsyncHTTPClientTests/HTTPClientBase.swift

@@ -61,7 +61,7 @@ class XCTestCaseHTTPClientTestsBaseClass: XCTestCase {
  }
  )
  backgroundLogger.logLevel = .trace
- var configuration = HTTPClient.Configuration().enableFastFailureModeForTesting()
+ let configuration = HTTPClient.Configuration().enableFastFailureModeForTesting()
 
  self.defaultClient = HTTPClient(
  eventLoopGroupProvider: .shared(self.clientGroup),

Tests/AsyncHTTPClientTests/HTTPClientTracingTests.swift

@@ -85,6 +85,10 @@ final class HTTPClientTracingTests: XCTestCaseHTTPClientTestsBaseClass {
  let url = self.defaultHTTPBinURLPrefix + "echo-method"
  let _ = try client.post(url: url).wait()
 
+ guard tracer.activeSpans.isEmpty else {
+ XCTFail("Still active spans which were not finished (\(tracer.activeSpans.count))! \(tracer.activeSpans)")
+ return
+ }
  guard let span = tracer.finishedSpans.first else {
  XCTFail("No span was recorded!")
  return
@@ -98,6 +102,10 @@ final class HTTPClientTracingTests: XCTestCaseHTTPClientTestsBaseClass {
  let request = HTTPClientRequest(url: url)
  let _ = try await client.execute(request, deadline: .distantFuture)
 
+ guard tracer.activeSpans.isEmpty else {
+ XCTFail("Still active spans which were not finished (\(tracer.activeSpans.count))! \(tracer.activeSpans)")
+ return
+ }
  guard let span = tracer.finishedSpans.first else {
  XCTFail("No span was recorded!")
  return