Update tracing test

Author: ptoffy

Package.swift

@@ -69,6 +69,7 @@ let package = Package(
                 .target(name: "FluentBenchmark"),
                 .target(name: "FluentSQL"),
                 .target(name: "XCTFluent"),
+                .product(name: "InMemoryTracing", package: "swift-distributed-tracing")
             ],
             swiftSettings: swiftSettings
         ),

Sources/FluentKit/Query/Database/DatabaseQuery.swift

@@ -35,32 +35,26 @@ public struct DatabaseQuery: Sendable {
 
     func withTracing<T>(_ closure: () async throws -> T) async rethrows -> T {
         if shouldTrace {
-            try await withSpan(
-                "db.query",
-                context: self.serviceContext,
-                ofKind: .server
-            ) { span in
-                self.setSpanAttributes(span)
+            try await withSpan("db.query", context: self.serviceContext, ofKind: .server) { span in
+                // https://opentelemetry.io/docs/specs/semconv/database/database-spans/#span-definition
+                // We add what we can. The rest is up to the underlying driver packages
+                span.updateAttributes { attributes in
+                    // db.system.name
+                    attributes["db.collection.name"] = self.schema
+                    attributes["db.namespace"] = self.space
+                    attributes["db.operation.name"] = "\(self.action)"
+                    // db.response.status_code
+                    // error.type
+                    // server.port
+                    attributes["db.query.summary"] = "\(self.action) \(self.space.map { "\($0)." } ?? "")\(self.schema)"
+                }
                 return try await closure()
             }
         } else {
             try await closure()
         }
     }
 
-    // https://opentelemetry.io/docs/specs/semconv/database/database-spans/#span-definition
-    fileprivate func setSpanAttributes(_ span: any Span) {
-        span.updateAttributes { attributes in
-            // db.system.name
-            attributes["db.collection.name"] = self.schema
-            attributes["db.namespace"] = self.space
-            attributes["db.operation.name"] = "\(self.action)"
-            // db.response.status_code
-            // error.type
-            // server.port
-            attributes["db.query.summary"] = "\(self.action) \(self.space.map { "\($0)." } ?? "")\(self.schema)"
-        }
-    }
 }
 
 extension DatabaseQuery: CustomStringConvertible {

Tests/FluentKitTests/TracingTests.swift

@@ -1,90 +1,20 @@
 import FluentBenchmark
 import FluentKit
 import Tracing
+import InMemoryTracing
 import XCTest
 
 final class TracingTests: XCTestCase {
     func testTracing() async throws {
         let db = DummyDatabaseForTestSQLSerializer()
-        let tracer = TestTracer()
+        let tracer = InMemoryTracer()
         InstrumentationSystem.bootstrap(tracer)
 
         _ = try await Planet.query(on: db).sort(\.$name, .descending).all()
-        let span = try XCTUnwrap(tracer.spans.first)
+        let span = try XCTUnwrap(tracer.finishedSpans.first)
 
-        XCTAssertEqual(span.attributes["db.action"]?.toSpanAttribute(), "read")
-    }
-}
-
-final class TestTracer: Tracer, @unchecked Sendable {
-    typealias Span = TestSpan
-
-    var spans: [TestSpan] = []
-
-    func startSpan(
-        _ operationName: String,
-        context: @autoclosure () -> ServiceContext,
-        ofKind kind: SpanKind,
-        at instant: @autoclosure () -> some TracerInstant,
-        function: String,
-        file fileID: String,
-        line: UInt
-    ) -> TestSpan {
-        let span = TestSpan(
-            operationName,
-            context: context()
-        )
-        self.spans.append(span)
-        return span
-    }
-
-    func forceFlush() {
-        return
-    }
-
-    func extract<Carrier, Extract>(_ carrier: Carrier, into context: inout ServiceContextModule.ServiceContext, using extractor: Extract)
-    where Carrier == Extract.Carrier, Extract: Instrumentation.Extractor {
-        return
-    }
-
-    func inject<Carrier, Inject>(_ context: ServiceContextModule.ServiceContext, into carrier: inout Carrier, using injector: Inject)
-    where Carrier == Inject.Carrier, Inject: Instrumentation.Injector {
-        return
-    }
-}
-
-final class TestSpan: Span, @unchecked Sendable {
-    let context: ServiceContext
-    var operationName: String
-    var attributes: Tracing.SpanAttributes = .init()
-    var isRecording: Bool = true
-
-    private var status: SpanStatus?
-    private var events: [SpanEvent] = []
-
-    init(_ operationName: String, context: ServiceContext) {
-        self.operationName = operationName
-        self.context = context
-    }
-
-    func setStatus(_ status: SpanStatus) {
-        self.status = status
-    }
-
-    func addEvent(_ event: SpanEvent) {
-        events.append(event)
-    }
-
-    func recordError<Instant>(_ error: any Error, attributes: Tracing.SpanAttributes, at instant: @autoclosure () -> Instant)
-    where Instant: Tracing.TracerInstant {
-        return
-    }
-
-    func addLink(_ link: Tracing.SpanLink) {
-        return
-    }
-
-    func end<Instant>(at instant: @autoclosure () -> Instant) where Instant: Tracing.TracerInstant {
-        isRecording = false
+        XCTAssertEqual(span.attributes["db.operation.name"]?.toSpanAttribute(), "read")
+        XCTAssertEqual(span.attributes["db.query.summary"]?.toSpanAttribute(), "read planets")
+        XCTAssertEqual(span.attributes["db.collection.name"]?.toSpanAttribute(), "\(Planet.schema)")
     }
 }