rename tracer types -> InMemory...

<!-- After your change, what will change. -->

Author: ktoso

Package.swift

@@ -6,7 +6,7 @@ let package = Package(
     products: [
         .library(name: "Instrumentation", targets: ["Instrumentation"]),
         .library(name: "Tracing", targets: ["Tracing"]),
-        .library(name: "TracingTestKit", targets: ["TracingTestKit"]),
+        .library(name: "InMemoryTracing", targets: ["InMemoryTracing"]),
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-service-context.git", from: "1.1.0")
@@ -46,15 +46,15 @@ let package = Package(
             ]
         ),
         .target(
-            name: "TracingTestKit",
+            name: "InMemoryTracing",
             dependencies: [
                 .target(name: "Tracing")
             ]
         ),
         .testTarget(
-            name: "TracingTestKitTests",
+            name: "InMemoryTracingTests",
             dependencies: [
-                .target(name: "TracingTestKit")
+                .target(name: "InMemoryTracing")
             ]
         ),
 

Sources/TracingTestKit/TestSpan.swift renamed to Sources/InMemoryTracing/InMemorySpan.swift

@@ -15,19 +15,30 @@
 @_spi(Locking) import Instrumentation
 import Tracing
 
-public struct TestSpan: Span {
+/// A ``Span`` created by the ``InMemoryTracer`` that will be retained in memory when ended.
+/// See ``InMemoryTracer/
+public struct InMemorySpan: Span {
     public let context: ServiceContext
-    public let spanContext: TestSpanContext
+    public let spanContext: InMemorySpanContext
     public let kind: SpanKind
     public let startInstant: any TracerInstant
 
-    init(
+    private let _operationName: LockedValueBox<String>
+    private let _attributes = LockedValueBox<SpanAttributes>([:])
+    private let _events = LockedValueBox<[SpanEvent]>([])
+    private let _links = LockedValueBox<[SpanLink]>([])
+    private let _errors = LockedValueBox<[RecordedError]>([])
+    private let _status = LockedValueBox<SpanStatus?>(nil)
+    private let _isRecording = LockedValueBox<Bool>(true)
+    private let onEnd: @Sendable (FinishedInMemorySpan) -> Void
+
+    public init(
         operationName: String,
         context: ServiceContext,
-        spanContext: TestSpanContext,
+        spanContext: InMemorySpanContext,
         kind: SpanKind,
         startInstant: any TracerInstant,
-        onEnd: @escaping @Sendable (FinishedTestSpan) -> Void
+        onEnd: @escaping @Sendable (FinishedInMemorySpan) -> Void
     ) {
         self._operationName = LockedValueBox(operationName)
         self.context = context
@@ -105,7 +116,7 @@ public struct TestSpan: Span {
 
     public func end(at instant: @autoclosure () -> some TracerInstant) {
         assertIsRecording()
-        let finishedSpan = FinishedTestSpan(
+        let finishedSpan = FinishedInMemorySpan(
             operationName: operationName,
             context: context,
             kind: kind,
@@ -128,15 +139,6 @@ public struct TestSpan: Span {
         public let instant: any TracerInstant
     }
 
-    private let _operationName: LockedValueBox<String>
-    private let _attributes = LockedValueBox<SpanAttributes>([:])
-    private let _events = LockedValueBox<[SpanEvent]>([])
-    private let _links = LockedValueBox<[SpanLink]>([])
-    private let _errors = LockedValueBox<[RecordedError]>([])
-    private let _status = LockedValueBox<SpanStatus?>(nil)
-    private let _isRecording = LockedValueBox<Bool>(true)
-    private let onEnd: @Sendable (FinishedTestSpan) -> Void
-
     private func assertIsRecording(
         file: StaticString = #file,
         line: UInt = #line
@@ -150,16 +152,18 @@ public struct TestSpan: Span {
     }
 }
 
-public struct FinishedTestSpan: Sendable {
-    public let operationName: String
-    public let context: ServiceContext
-    public let kind: SpanKind
-    public let spanContext: TestSpanContext
-    public let startInstant: any TracerInstant
-    public let endInstant: any TracerInstant
-    public let attributes: SpanAttributes
-    public let events: [SpanEvent]
-    public let links: [SpanLink]
-    public let errors: [TestSpan.RecordedError]
-    public let status: SpanStatus?
+/// Represents a finished span (a ``Span`` that `end()` was called on)
+/// that was recorded by the ``InMemoryTracer``.
+public struct FinishedInMemorySpan: Sendable {
+    public var operationName: String
+    public var context: ServiceContext
+    public var kind: SpanKind
+    public var spanContext: InMemorySpanContext
+    public var startInstant: any TracerInstant
+    public var endInstant: any TracerInstant
+    public var attributes: SpanAttributes
+    public var events: [SpanEvent]
+    public var links: [SpanLink]
+    public var errors: [InMemorySpan.RecordedError]
+    public var status: SpanStatus?
 }

Sources/TracingTestKit/TestSpanContext.swift renamed to Sources/InMemoryTracing/InMemorySpanContext.swift

@@ -14,7 +14,7 @@
 
 import ServiceContextModule
 
-public struct TestSpanContext: Sendable, Hashable {
+public struct InMemorySpanContext: Sendable, Hashable {
     public let traceID: String
     public let spanID: String
     public let parentSpanID: String?
@@ -27,16 +27,16 @@ public struct TestSpanContext: Sendable, Hashable {
 }
 
 extension ServiceContext {
-    var testSpanContext: TestSpanContext? {
+    var inMemorySpanContext: InMemorySpanContext? {
         get {
-            self[TestSpanContextKey.self]
+            self[InMemorySpanContextKey.self]
         }
         set {
-            self[TestSpanContextKey.self] = newValue
+            self[InMemorySpanContextKey.self] = newValue
         }
     }
 }
 
-private struct TestSpanContextKey: ServiceContextKey {
-    typealias Value = TestSpanContext
+struct InMemorySpanContextKey: ServiceContextKey {
+    typealias Value = InMemorySpanContext
 }

Sources/TracingTestKit/TestTracer.swift renamed to Sources/InMemoryTracing/InMemoryTracer.swift

@@ -15,9 +15,17 @@
 @_spi(Locking) import Instrumentation
 import Tracing
 
-public struct TestTracer: Tracer {
+public struct InMemoryTracer: Tracer {
+
+    public static let traceIDKey = "test-trace-id"
+    public static let spanIDKey = "test-span-id"
+
     public let idGenerator: IDGenerator
 
+    private let _activeSpans = LockedValueBox<[InMemorySpanContext: InMemorySpan]>([:])
+    private let _finishedSpans = LockedValueBox<[FinishedInMemorySpan]>([])
+    private let _numberOfForceFlushes = LockedValueBox<Int>(0)
+
     public init(idGenerator: IDGenerator = .incrementing) {
         self.idGenerator = idGenerator
     }
@@ -32,30 +40,30 @@ public struct TestTracer: Tracer {
         function: String,
         file fileID: String,
         line: UInt
-    ) -> TestSpan where Instant: TracerInstant {
+    ) -> InMemorySpan where Instant: TracerInstant {
         let parentContext = context()
-        let spanContext: TestSpanContext
+        let spanContext: InMemorySpanContext
 
-        if let parentSpanContext = parentContext.testSpanContext {
+        if let parentSpanContext = parentContext.inMemorySpanContext {
             // child span
-            spanContext = TestSpanContext(
+            spanContext = InMemorySpanContext(
                 traceID: parentSpanContext.traceID,
                 spanID: idGenerator.nextSpanID(),
                 parentSpanID: parentSpanContext.spanID
             )
         } else {
             // root span
-            spanContext = TestSpanContext(
+            spanContext = InMemorySpanContext(
                 traceID: idGenerator.nextTraceID(),
                 spanID: idGenerator.nextSpanID(),
                 parentSpanID: nil
             )
         }
 
         var context = parentContext
-        context.testSpanContext = spanContext
+        context.inMemorySpanContext = spanContext
 
-        let span = TestSpan(
+        let span = InMemorySpan(
             operationName: operationName,
             context: context,
             spanContext: spanContext,
@@ -69,8 +77,8 @@ public struct TestTracer: Tracer {
         return span
     }
 
-    public func activeSpan(identifiedBy context: ServiceContext) -> TestSpan? {
-        guard let spanContext = context.testSpanContext else { return nil }
+    public func activeSpan(identifiedBy context: ServiceContext) -> InMemorySpan? {
+        guard let spanContext = context.inMemorySpanContext else { return nil }
         return _activeSpans.withValue { $0[spanContext] }
     }
 
@@ -82,27 +90,20 @@ public struct TestTracer: Tracer {
         _numberOfForceFlushes.withValue { $0 }
     }
 
-    public var finishedSpans: [FinishedTestSpan] {
+    public var finishedSpans: [FinishedInMemorySpan] {
         _finishedSpans.withValue { $0 }
     }
 
-    private let _activeSpans = LockedValueBox<[TestSpanContext: TestSpan]>([:])
-    private let _finishedSpans = LockedValueBox<[FinishedTestSpan]>([])
-    private let _numberOfForceFlushes = LockedValueBox<Int>(0)
-
     // MARK: - Instrument
 
-    public static let traceIDKey = "test-trace-id"
-    public static let spanIDKey = "test-span-id"
-
     public func inject<Carrier, Inject: Injector>(
         _ context: ServiceContext,
         into carrier: inout Carrier,
         using injector: Inject
     ) where Carrier == Inject.Carrier {
         var values = [String: String]()
 
-        if let spanContext = context.testSpanContext {
+        if let spanContext = context.inMemorySpanContext {
             injector.inject(spanContext.traceID, forKey: Self.traceIDKey, into: &carrier)
             values[Self.traceIDKey] = spanContext.traceID
             injector.inject(spanContext.spanID, forKey: Self.spanIDKey, into: &carrier)
@@ -133,7 +134,7 @@ public struct TestTracer: Tracer {
             return
         }
 
-        context.testSpanContext = TestSpanContext(traceID: traceID, spanID: spanID, parentSpanID: nil)
+        context.inMemorySpanContext = InMemorySpanContext(traceID: traceID, spanID: spanID, parentSpanID: nil)
     }
 
     public var extractions: [Extraction] {
@@ -156,7 +157,7 @@ public struct TestTracer: Tracer {
 
 // MARK: - ID Generator
 
-extension TestTracer {
+extension InMemoryTracer {
     public struct IDGenerator: Sendable {
         public let nextTraceID: @Sendable () -> String
         public let nextSpanID: @Sendable () -> String