Skip to content

Call span.end() in the happy path in withSpan #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 15, 2020
Merged

Call span.end() in the happy path in withSpan #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e1a9087
Test that withSpan() calls end() as expected
JensAyton Dec 14, 2020
44dbf9b
Call span.end() in the happy path in withSpan
JensAyton Dec 14, 2020
58318a0
Apply suggestions from code review
ktoso Dec 14, 2020
01f7d7b
Update TracerTests.swift
ktoso Dec 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Sources/Tracing/Tracer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@ extension Tracer {
_ function: (Span) throws -> T
) rethrows -> T {
let span = self.startSpan(operationName, context: context, ofKind: kind)
defer { span.end() }
do {
return try function(span)
} catch {
span.recordError(error)
span.end()
throw error // rethrow
}
}
Expand All @@ -125,11 +125,11 @@ extension Tracer {
_ function: (Span) throws -> T
) rethrows -> T {
let span = self.startSpan(operationName, baggage: baggage, ofKind: kind)
defer { span.end() }
do {
return try function(span)
} catch {
span.recordError(error)
span.end()
throw error // rethrow
}
}
Expand Down
6 changes: 4 additions & 2 deletions Tests/TracingTests/TestTracer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import Tracing

final class TestTracer: Tracer {
private(set) var spans = [TestSpan]()
var onEndSpan: (Span) -> Void = { _ in }

func startSpan(
_ operationName: String,
Expand All @@ -30,8 +31,9 @@ final class TestTracer: Tracer {
operationName: operationName,
startTime: time,
baggage: baggage,
kind: kind
) { _ in }
kind: kind,
onEnd: onEndSpan
)
self.spans.append(span)
return span
}
Expand Down
8 changes: 8 additions & 0 deletions Tests/TracingTests/TracerTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,15 @@ final class TracerTests: XCTestCase {
InstrumentationSystem.bootstrapInternal(NoOpTracer())
}

var spanEnded = false
tracer.onEndSpan = { _ in spanEnded = true }

let value = tracer.withSpan("hello", baggage: .topLevel) { _ in
"yes"
}

XCTAssertEqual(value, "yes")
XCTAssertTrue(spanEnded)
}

func testWithSpan_throws() {
Expand All @@ -77,11 +81,15 @@ final class TracerTests: XCTestCase {
InstrumentationSystem.bootstrapInternal(NoOpTracer())
}

var spanEnded = false
tracer.onEndSpan = { _ in spanEnded = true }

do {
_ = try tracer.withSpan("hello", baggage: .topLevel) { _ in
throw ExampleSpanError()
}
} catch {
XCTAssertTrue(spanEnded)
XCTAssertEqual(error as? ExampleSpanError, ExampleSpanError())
return
}
Expand Down