Skip to content

Commit 2078e42

Browse files
slashmoslashmo
committed
Use context wording in use cases
1 parent b422718 commit 2078e42

File tree

7 files changed

+32
-40
lines changed

7 files changed

+32
-40
lines changed

‎UseCases/Package.resolved

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎UseCases/Package.swift

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,19 @@ let package = Package(
1010
],
1111
dependencies: [
1212
.package(name: "gsoc-swift-tracing", path: "../"),
13-
.package(
14-
name: "swift-baggage-context",
15-
url: "https://github.com/slashmo/gsoc-swift-baggage-context.git",
16-
from: "0.1.0"
17-
),
1813
.package(url: "https://github.com/swift-server/async-http-client.git", from: "1.1.1"),
1914
.package(url: "https://github.com/apple/swift-nio.git", from: "2.18.0")
2015
],
2116
targets: [
2217
.target(name: "ManualContextPropagation", dependencies: [
23-
.product(name: "Baggage", package: "swift-baggage-context"),
2418
.product(name: "Instrumentation", package: "gsoc-swift-tracing"),
2519
]),
2620
.target(name: "ManualAsyncHTTPClient", dependencies: [
27-
.product(name: "Baggage", package: "swift-baggage-context"),
2821
.product(name: "Instrumentation", package: "gsoc-swift-tracing"),
2922
.product(name: "NIOInstrumentation", package: "gsoc-swift-tracing"),
3023
.product(name: "AsyncHTTPClient", package: "async-http-client")
3124
]),
3225
.target(name: "HTTPEndToEnd", dependencies: [
33-
.product(name: "Baggage", package: "swift-baggage-context"),
3426
.product(name: "BaggageLogging", package: "gsoc-swift-tracing"),
3527
.product(name: "Instrumentation", package: "gsoc-swift-tracing"),
3628
.product(name: "NIOInstrumentation", package: "gsoc-swift-tracing"),

‎UseCases/Sources/HTTPEndToEnd/InstrumentedHTTPClient.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ struct InstrumentedHTTPClient {
2929
}
3030

3131
// TODO: deadline: NIODeadline? would move into baggage?
32-
public func get(url: String, baggage: BaggageContext = .init()) -> EventLoopFuture<HTTPClient.Response> {
32+
public func get(url: String, context: BaggageContext = .init()) -> EventLoopFuture<HTTPClient.Response> {
3333
do {
3434
let request = try HTTPClient.Request(url: url, method: .GET)
35-
return self.execute(request: request, baggage: baggage)
35+
return self.execute(request: request, context: context)
3636
} catch {
3737
return self.client.eventLoopGroup.next().makeFailedFuture(error)
3838
}
3939
}
4040

41-
func execute(request: HTTPClient.Request, baggage: BaggageContext) -> EventLoopFuture<HTTPClient.Response> {
41+
func execute(request: HTTPClient.Request, context: BaggageContext) -> EventLoopFuture<HTTPClient.Response> {
4242
var request = request
43-
self.instrument.inject(baggage, into: &request.headers, using: HTTPHeadersInjector())
44-
baggage.logger.info("🌎 InstrumentedHTTPClient: Execute request")
43+
self.instrument.inject(context, into: &request.headers, using: HTTPHeadersInjector())
44+
context.logger.info("🌎 InstrumentedHTTPClient: Execute request")
4545
return self.client.execute(request: request)
4646
}
4747

‎UseCases/Sources/HTTPEndToEnd/Services/OrderServiceHandler.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ final class OrderServiceHandler: ChannelInboundHandler {
4747
baggage.logger.info("🧾 Asking StorageService if your product exists")
4848

4949
let request = try! HTTPClient.Request(url: "http://localhost:8081")
50-
self.httpClient.execute(request: request, baggage: baggage).whenComplete { _ in
50+
self.httpClient.execute(request: request, context: baggage).whenComplete { _ in
5151
let responseHead = HTTPResponseHead(version: requestHead.version, status: .created)
5252
context.eventLoop.execute {
5353
context.channel.write(self.wrapOutboundOut(.head(responseHead)), promise: nil)

‎UseCases/Sources/HTTPEndToEnd/main.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,22 +77,22 @@ private final class FakeTracer: Instrument {
7777
static let defaultTraceID = UUID().uuidString
7878

7979
func inject<Carrier, Injector>(
80-
_ baggage: BaggageContext, into carrier: inout Carrier, using injector: Injector
80+
_ context: BaggageContext, into carrier: inout Carrier, using injector: Injector
8181
)
8282
where
8383
Injector: InjectorProtocol,
8484
Carrier == Injector.Carrier {
85-
guard let traceID = baggage[TraceIDKey.self] else { return }
85+
guard let traceID = context[TraceIDKey.self] else { return }
8686
injector.inject(traceID, forKey: Self.headerName, into: &carrier)
8787
}
8888

8989
func extract<Carrier, Extractor>(
90-
_ carrier: Carrier, into baggage: inout BaggageContext, using extractor: Extractor
90+
_ carrier: Carrier, into context: inout BaggageContext, using extractor: Extractor
9191
)
9292
where
9393
Extractor: ExtractorProtocol,
9494
Carrier == Extractor.Carrier {
9595
let traceID = extractor.extract(key: Self.headerName, from: carrier) ?? Self.defaultTraceID
96-
baggage[TraceIDKey.self] = traceID
96+
context[TraceIDKey.self] = traceID
9797
}
9898
}

‎UseCases/Sources/ManualAsyncHTTPClient/main.swift

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ let server = FakeHTTPServer(
2626
url: "https://swift.org",
2727
headers: ["Accept": "application/json"]
2828
)
29-
client.execute(request: outgoingRequest, baggage: context)
29+
client.execute(request: outgoingRequest, context: context)
3030
return FakeHTTPResponse()
3131
}
3232

@@ -43,9 +43,9 @@ struct InstrumentedHTTPClient {
4343
self.instrument = instrument
4444
}
4545

46-
func execute(request: HTTPClient.Request, baggage: BaggageContext) {
46+
func execute(request: HTTPClient.Request, context: BaggageContext) {
4747
var request = request
48-
self.instrument.inject(baggage, into: &request.headers, using: HTTPHeadersInjector())
48+
self.instrument.inject(context, into: &request.headers, using: HTTPHeadersInjector())
4949
print(request.headers)
5050
}
5151
}
@@ -68,10 +68,10 @@ struct FakeHTTPServer {
6868
}
6969

7070
func receive(_ request: HTTPClient.Request) {
71-
var baggage = BaggageContext()
71+
var context = BaggageContext()
7272
print("\(String(describing: Self.self)): Extracting context values from request headers into context")
73-
self.instrument.extract(request.headers, into: &baggage, using: HTTPHeadersExtractor())
74-
_ = self.catchAllHandler(baggage, request, self.client)
73+
self.instrument.extract(request.headers, into: &context, using: HTTPHeadersExtractor())
74+
_ = self.catchAllHandler(context, request, self.client)
7575
}
7676
}
7777

@@ -86,22 +86,22 @@ private final class FakeTracer: Instrument {
8686
static let defaultTraceID = UUID().uuidString
8787

8888
func inject<Carrier, Injector>(
89-
_ baggage: BaggageContext, into carrier: inout Carrier, using injector: Injector
89+
_ context: BaggageContext, into carrier: inout Carrier, using injector: Injector
9090
)
9191
where
9292
Injector: InjectorProtocol,
9393
Carrier == Injector.Carrier {
94-
guard let traceID = baggage[TraceIDKey.self] else { return }
94+
guard let traceID = context[TraceIDKey.self] else { return }
9595
injector.inject(traceID, forKey: Self.headerName, into: &carrier)
9696
}
9797

9898
func extract<Carrier, Extractor>(
99-
_ carrier: Carrier, into baggage: inout BaggageContext, using extractor: Extractor
99+
_ carrier: Carrier, into context: inout BaggageContext, using extractor: Extractor
100100
)
101101
where
102102
Extractor: ExtractorProtocol,
103103
Carrier == Extractor.Carrier {
104104
let traceID = extractor.extract(key: Self.headerName, from: carrier) ?? Self.defaultTraceID
105-
baggage[TraceIDKey.self] = traceID
105+
context[TraceIDKey.self] = traceID
106106
}
107107
}

‎UseCases/Sources/ManualContextPropagation/main.swift

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ import Instrumentation
1717

1818
// MARK: - Demo
1919

20-
let server = FakeHTTPServer(instrument: FakeTracer()) { baggage, _, client in
20+
let server = FakeHTTPServer(instrument: FakeTracer()) { context, _, client in
2121
print("=== Perform subsequent request ===")
2222
let outgoingRequest = FakeHTTPRequest(path: "/other-service", headers: [("Content-Type", "application/json")])
23-
client.performRequest(baggage, request: outgoingRequest)
23+
client.performRequest(context, request: outgoingRequest)
2424
return FakeHTTPResponse()
2525
}
2626

@@ -64,10 +64,10 @@ struct FakeHTTPServer {
6464
}
6565

6666
func receive(_ request: FakeHTTPRequest) {
67-
var baggage = BaggageContext()
67+
var context = BaggageContext()
6868
print("\(String(describing: Self.self)): Extracting context values from request headers into context")
69-
self.instrument.extract(request.headers, into: &baggage, using: HTTPHeadersExtractor())
70-
_ = self.catchAllHandler(baggage, request, self.client)
69+
self.instrument.extract(request.headers, into: &context, using: HTTPHeadersExtractor())
70+
_ = self.catchAllHandler(context, request, self.client)
7171
}
7272
}
7373

@@ -80,10 +80,10 @@ struct FakeHTTPClient {
8080
self.instrument = instrument
8181
}
8282

83-
func performRequest(_ baggage: BaggageContext, request: FakeHTTPRequest) {
83+
func performRequest(_ context: BaggageContext, request: FakeHTTPRequest) {
8484
var request = request
8585
print("\(String(describing: Self.self)): Injecting context values into request headers")
86-
self.instrument.inject(baggage, into: &request.headers, using: HTTPHeadersInjector())
86+
self.instrument.inject(context, into: &request.headers, using: HTTPHeadersInjector())
8787
print(request)
8888
}
8989
}
@@ -99,22 +99,22 @@ private final class FakeTracer: Instrument {
9999
static let defaultTraceID = UUID().uuidString
100100

101101
func inject<Carrier, Injector>(
102-
_ baggage: BaggageContext, into carrier: inout Carrier, using injector: Injector
102+
_ context: BaggageContext, into carrier: inout Carrier, using injector: Injector
103103
)
104104
where
105105
Injector: InjectorProtocol,
106106
Carrier == Injector.Carrier {
107-
guard let traceID = baggage[TraceIDKey.self] else { return }
107+
guard let traceID = context[TraceIDKey.self] else { return }
108108
injector.inject(traceID, forKey: Self.headerName, into: &carrier)
109109
}
110110

111111
func extract<Carrier, Extractor>(
112-
_ carrier: Carrier, into baggage: inout BaggageContext, using extractor: Extractor
112+
_ carrier: Carrier, into context: inout BaggageContext, using extractor: Extractor
113113
)
114114
where
115115
Extractor: ExtractorProtocol,
116116
Carrier == Extractor.Carrier {
117117
let traceID = extractor.extract(key: Self.headerName, from: carrier) ?? Self.defaultTraceID
118-
baggage[TraceIDKey.self] = traceID
118+
context[TraceIDKey.self] = traceID
119119
}
120120
}

0 commit comments

Comments
 (0)