Skip to content

Commit 3d152af

Browse files
ktosoktoso
authored
consider TracerSpan assoc type -> Span (#111)
1 parent 83a37b4 commit 3d152af

9 files changed

+37
-37
lines changed

‎Sources/Tracing/NoOpTracer.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import Dispatch
1919
/// Tracer that ignores all operations, used when no tracing is required.
2020
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal Baggage
2121
public struct NoOpTracer: LegacyTracer {
22-
public typealias TracerSpan = NoOpSpan
22+
public typealias Span = NoOpSpan
2323

2424
public init() {}
2525

@@ -29,7 +29,7 @@ public struct NoOpTracer: LegacyTracer {
2929
at instant: @autoclosure () -> Instant,
3030
function: String,
3131
file fileID: String,
32-
line: UInt) -> any Span
32+
line: UInt) -> any Tracing.Span
3333
{
3434
NoOpSpan(baggage: baggage())
3535
}
@@ -48,7 +48,7 @@ public struct NoOpTracer: LegacyTracer {
4848
// no-op
4949
}
5050

51-
public struct NoOpSpan: Span {
51+
public struct NoOpSpan: Tracing.Span {
5252
public let baggage: Baggage
5353
public var isRecording: Bool {
5454
false

‎Sources/Tracing/TracerProtocol+Legacy.swift

+9-9
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public protocol LegacyTracer: Instrument {
5454
function: String,
5555
file fileID: String,
5656
line: UInt
57-
) -> any Span
57+
) -> any Tracing.Span
5858

5959
/// Export all ended spans to the configured backend that have not yet been exported.
6060
///
@@ -108,7 +108,7 @@ extension LegacyTracer {
108108
function: String = #function,
109109
file fileID: String = #fileID,
110110
line: UInt = #line
111-
) -> any Span {
111+
) -> any Tracing.Span {
112112
self.startAnySpan(
113113
operationName,
114114
baggage: baggage(),
@@ -155,7 +155,7 @@ extension LegacyTracer {
155155
function: String = #function,
156156
file fileID: String = #fileID,
157157
line: UInt = #line
158-
) -> any Span {
158+
) -> any Tracing.Span {
159159
self.startAnySpan(
160160
operationName,
161161
baggage: baggage(),
@@ -200,7 +200,7 @@ extension LegacyTracer {
200200
function: String = #function,
201201
file fileID: String = #fileID,
202202
line: UInt = #line,
203-
_ operation: (any Span) throws -> T
203+
_ operation: (any Tracing.Span) throws -> T
204204
) rethrows -> T {
205205
let span = self.startAnySpan(
206206
operationName,
@@ -253,7 +253,7 @@ extension LegacyTracer {
253253
function: String = #function,
254254
file fileID: String = #fileID,
255255
line: UInt = #line,
256-
_ operation: (any Span) throws -> T
256+
_ operation: (any Tracing.Span) throws -> T
257257
) rethrows -> T {
258258
try self.withAnySpan(
259259
operationName,
@@ -301,7 +301,7 @@ extension LegacyTracer {
301301
function: String = #function,
302302
file fileID: String = #fileID,
303303
line: UInt = #line,
304-
_ operation: (any Span) async throws -> T
304+
_ operation: (any Tracing.Span) async throws -> T
305305
) async rethrows -> T {
306306
let span = self.startAnySpan(
307307
operationName,
@@ -354,7 +354,7 @@ extension LegacyTracer {
354354
function: String = #function,
355355
file fileID: String = #fileID,
356356
line: UInt = #line,
357-
_ operation: (any Span) async throws -> T
357+
_ operation: (any Tracing.Span) async throws -> T
358358
) async rethrows -> T {
359359
let span = self.startAnySpan(
360360
operationName,
@@ -469,7 +469,7 @@ extension Tracer {
469469
function: String = #function,
470470
file fileID: String = #fileID,
471471
line: UInt = #line,
472-
_ operation: (any Span) throws -> T
472+
_ operation: (any Tracing.Span) throws -> T
473473
) rethrows -> T {
474474
try self.withSpan(
475475
operationName,
@@ -524,7 +524,7 @@ extension Tracer {
524524
function: String = #function,
525525
file fileID: String = #fileID,
526526
line: UInt = #line,
527-
@_inheritActorContext @_implicitSelfCapture _ operation: (any Span) async throws -> T
527+
@_inheritActorContext @_implicitSelfCapture _ operation: (any Tracing.Span) async throws -> T
528528
) async rethrows -> T {
529529
try await self.withSpan(
530530
operationName,

‎Sources/Tracing/TracerProtocol.swift

+7-7
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal Baggage
2727
public protocol Tracer: LegacyTracer {
2828
/// The concrete type of span this tracer will be producing/
29-
associatedtype TracerSpan: Span
29+
associatedtype Span: Tracing.Span
3030

3131
/// Start a new ``Span`` with the given `Baggage`.
3232
///
@@ -60,7 +60,7 @@ public protocol Tracer: LegacyTracer {
6060
function: String,
6161
file fileID: String,
6262
line: UInt
63-
) -> TracerSpan
63+
) -> Self.Span
6464
}
6565

6666
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal Baggage
@@ -97,7 +97,7 @@ extension Tracer {
9797
function: String = #function,
9898
file fileID: String = #fileID,
9999
line: UInt = #line
100-
) -> TracerSpan {
100+
) -> Self.Span {
101101
self.startSpan(
102102
operationName,
103103
baggage: baggage(),
@@ -145,7 +145,7 @@ extension Tracer {
145145
function: String = #function,
146146
file fileID: String = #fileID,
147147
line: UInt = #line,
148-
_ operation: (TracerSpan) throws -> T
148+
_ operation: (Self.Span) throws -> T
149149
) rethrows -> T {
150150
let span = self.startSpan(
151151
operationName,
@@ -197,7 +197,7 @@ extension Tracer {
197197
function: String = #function,
198198
file fileID: String = #fileID,
199199
line: UInt = #line,
200-
_ operation: (TracerSpan) throws -> T
200+
_ operation: (Self.Span) throws -> T
201201
) rethrows -> T {
202202
let span = self.startSpan(
203203
operationName,
@@ -249,7 +249,7 @@ extension Tracer {
249249
function: String = #function,
250250
file fileID: String = #fileID,
251251
line: UInt = #line,
252-
@_inheritActorContext @_implicitSelfCapture _ operation: (TracerSpan) async throws -> T
252+
@_inheritActorContext @_implicitSelfCapture _ operation: (Self.Span) async throws -> T
253253
) async rethrows -> T {
254254
let span = self.startSpan(
255255
operationName,
@@ -302,7 +302,7 @@ extension Tracer {
302302
function: String = #function,
303303
file fileID: String = #fileID,
304304
line: UInt = #line,
305-
@_inheritActorContext @_implicitSelfCapture _ operation: (TracerSpan) async throws -> T
305+
@_inheritActorContext @_implicitSelfCapture _ operation: (Self.Span) async throws -> T
306306
) async rethrows -> T {
307307
let span = self.startSpan(
308308
operationName,

‎Sources/_TracingBenchmarks/SpanAttributesDSLBenchmark.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public let SpanAttributesDSLBenchmarks: [BenchmarkInfo] = [
6969
),
7070
]
7171

72-
private var span: (any Span)!
72+
private var span: (any Tracing.Span)!
7373

7474
private func setUp() {
7575
span = InstrumentationSystem.legacyTracer.startAnySpan("something", baggage: .topLevel)

‎Tests/TracingTests/DynamicTracepointTracerTests.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ final class DynamicTracepointTestTracer: LegacyTracer {
162162
}
163163

164164
private(set) var spans: [TracepointSpan] = []
165-
var onEndSpan: (any Span) -> Void = { _ in
165+
var onEndSpan: (any Tracing.Span) -> Void = { _ in
166166
}
167167

168168
func startAnySpan<Instant: TracerInstant>(
@@ -173,7 +173,7 @@ final class DynamicTracepointTestTracer: LegacyTracer {
173173
function: String,
174174
file fileID: String,
175175
line: UInt
176-
) -> any Span {
176+
) -> any Tracing.Span {
177177
let tracepoint = TracepointID(function: function, fileID: fileID, line: line)
178178
guard self.shouldRecord(tracepoint: tracepoint) else {
179179
return TracepointSpan.notRecording(file: fileID, line: line)
@@ -331,7 +331,7 @@ extension DynamicTracepointTestTracer {
331331

332332
#if compiler(>=5.7.0)
333333
extension DynamicTracepointTestTracer: Tracer {
334-
typealias TracerSpan = TracepointSpan
334+
typealias Span = TracepointSpan
335335

336336
func startSpan<Instant: TracerInstant>(_ operationName: String,
337337
baggage: @autoclosure () -> Baggage,

‎Tests/TracingTests/TestTracer.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ final class TestTracer: LegacyTracer {
3131
function: String,
3232
file fileID: String,
3333
line: UInt
34-
) -> any Span {
34+
) -> any Tracing.Span {
3535
let span = TestSpan(
3636
operationName: operationName,
3737
startTime: instant(),

‎Tests/TracingTests/TracedLock.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ final class TracedLock {
2121
let name: String
2222
let underlyingLock: NSLock
2323

24-
var activeSpan: (any Span)?
24+
var activeSpan: (any Tracing.Span)?
2525

2626
init(name: String) {
2727
self.name = name

‎Tests/TracingTests/TracedLockTests.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ private final class TracedLockPrintlnTracer: LegacyTracer {
6868
function: String,
6969
file fileID: String,
7070
line: UInt
71-
) -> any Span {
71+
) -> any Tracing.Span {
7272
TracedLockPrintlnSpan(
7373
operationName: operationName,
7474
startTime: instant(),
@@ -97,7 +97,7 @@ private final class TracedLockPrintlnTracer: LegacyTracer {
9797
Extract: Extractor,
9898
Carrier == Extract.Carrier {}
9999

100-
final class TracedLockPrintlnSpan: Span {
100+
final class TracedLockPrintlnSpan: Tracing.Span {
101101
private let kind: SpanKind
102102

103103
private var status: SpanStatus?

‎Tests/TracingTests/TracerTests.swift

+10-10
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,11 @@ final class TracerTests: XCTestCase {
123123
var spanEnded = false
124124
tracer.onEndSpan = { _ in spanEnded = true }
125125

126-
func operation(span: any Span) -> String {
126+
func operation(span: any Tracing.Span) -> String {
127127
"world"
128128
}
129129

130-
let value = tracer.withAnySpan("hello") { (span: any Span) -> String in
130+
let value = tracer.withAnySpan("hello") { (span: any Tracing.Span) -> String in
131131
XCTAssertEqual(span.baggage.traceID, Baggage.current?.traceID)
132132
return operation(span: span)
133133
}
@@ -152,7 +152,7 @@ final class TracerTests: XCTestCase {
152152
var spanEnded = false
153153
tracer.onEndSpan = { _ in spanEnded = true }
154154

155-
func operation(span: any Span) throws -> String {
155+
func operation(span: any Tracing.Span) throws -> String {
156156
throw ExampleSpanError()
157157
}
158158

@@ -182,12 +182,12 @@ final class TracerTests: XCTestCase {
182182
var spanEnded = false
183183
tracer.onEndSpan = { _ in spanEnded = true }
184184

185-
func operation(span: any Span) async throws -> String {
185+
func operation(span: any Tracing.Span) async throws -> String {
186186
"world"
187187
}
188188

189189
try self.testAsync {
190-
let value = try await tracer.withAnySpan("hello") { (span: any Span) -> String in
190+
let value = try await tracer.withAnySpan("hello") { (span: any Tracing.Span) -> String in
191191
XCTAssertEqual(span.baggage.traceID, Baggage.current?.traceID)
192192
return try await operation(span: span)
193193
}
@@ -212,14 +212,14 @@ final class TracerTests: XCTestCase {
212212
var spanEnded = false
213213
tracer.onEndSpan = { _ in spanEnded = true }
214214

215-
func operation(span: any Span) async -> String {
215+
func operation(span: any Tracing.Span) async -> String {
216216
"world"
217217
}
218218

219219
self.testAsync {
220220
var fromNonAsyncWorld = Baggage.topLevel
221221
fromNonAsyncWorld.traceID = "1234-5678"
222-
let value = await tracer.withAnySpan("hello", baggage: fromNonAsyncWorld) { (span: any Span) -> String in
222+
let value = await tracer.withAnySpan("hello", baggage: fromNonAsyncWorld) { (span: any Tracing.Span) -> String in
223223
XCTAssertEqual(span.baggage.traceID, Baggage.current?.traceID)
224224
XCTAssertEqual(span.baggage.traceID, fromNonAsyncWorld.traceID)
225225
return await operation(span: span)
@@ -244,7 +244,7 @@ final class TracerTests: XCTestCase {
244244
var spanEnded = false
245245
tracer.onEndSpan = { _ in spanEnded = true }
246246

247-
func operation(span: any Span) async throws -> String {
247+
func operation(span: any Tracing.Span) async throws -> String {
248248
throw ExampleSpanError()
249249
}
250250

@@ -274,7 +274,7 @@ final class TracerTests: XCTestCase {
274274
var spanEnded = false
275275
tracer.onEndSpan = { _ in spanEnded = true }
276276

277-
func operation(span: any Span) async throws -> String {
277+
func operation(span: any Tracing.Span) async throws -> String {
278278
throw ExampleSpanError()
279279
}
280280

@@ -304,7 +304,7 @@ final class TracerTests: XCTestCase {
304304
var spanEnded = false
305305
tracer.onEndSpan = { _ in spanEnded = true }
306306

307-
func operation(span: any Span) throws -> String {
307+
func operation(span: any Tracing.Span) throws -> String {
308308
throw ExampleSpanError()
309309
}
310310

0 commit comments

Comments
 (0)