Skip to content
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

Jump to bottom

Propagate context to server RPC handlers #2059

Merged
merged 4 commits into from
Sep 19, 2024
Merged

Propagate context to server RPC handlers #2059

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
359c6c3
Propagate context to server RPC handlers
glbrntt Sep 16, 2024
0e8b637
regen
glbrntt Sep 16, 2024
ecb597d
verify context has descriptor
glbrntt Sep 18, 2024
4e962ce
Merge branch 'main' into v2/propagate-server-context
glbrntt Sep 19, 2024
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
98 changes: 76 additions & 22 deletions Examples/v2/echo/Generated/echo.grpc.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,16 +86,28 @@ extension GRPCCore.ServiceDescriptor {
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
internal protocol Echo_EchoStreamingServiceProtocol: GRPCCore.RegistrableRPCService {
/// Immediately returns an echo of a request.
func get(request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>
func get(
request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>

/// Splits a request into words and returns each word in a stream of messages.
func expand(request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>
func expand(
request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>

/// Collects a stream of messages and returns them concatenated when the caller closes.
func collect(request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>
func collect(
request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>

/// Streams back messages as they are received in an input stream.
func update(request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>
func update(
request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>
}

/// Conformance to `GRPCCore.RegistrableRPCService`.
Expand All @@ -107,32 +119,44 @@ extension Echo_Echo.StreamingServiceProtocol {
forMethod: Echo_Echo.Method.Get.descriptor,
deserializer: GRPCProtobuf.ProtobufDeserializer<Echo_EchoRequest>(),
serializer: GRPCProtobuf.ProtobufSerializer<Echo_EchoResponse>(),
handler: { request in
try await self.get(request: request)
handler: { request, context in
try await self.get(
request: request,
context: context
)
}
)
router.registerHandler(
forMethod: Echo_Echo.Method.Expand.descriptor,
deserializer: GRPCProtobuf.ProtobufDeserializer<Echo_EchoRequest>(),
serializer: GRPCProtobuf.ProtobufSerializer<Echo_EchoResponse>(),
handler: { request in
try await self.expand(request: request)
handler: { request, context in
try await self.expand(
request: request,
context: context
)
}
)
router.registerHandler(
forMethod: Echo_Echo.Method.Collect.descriptor,
deserializer: GRPCProtobuf.ProtobufDeserializer<Echo_EchoRequest>(),
serializer: GRPCProtobuf.ProtobufSerializer<Echo_EchoResponse>(),
handler: { request in
try await self.collect(request: request)
handler: { request, context in
try await self.collect(
request: request,
context: context
)
}
)
router.registerHandler(
forMethod: Echo_Echo.Method.Update.descriptor,
deserializer: GRPCProtobuf.ProtobufDeserializer<Echo_EchoRequest>(),
serializer: GRPCProtobuf.ProtobufSerializer<Echo_EchoResponse>(),
handler: { request in
try await self.update(request: request)
handler: { request, context in
try await self.update(
request: request,
context: context
)
}
)
}
Expand All @@ -141,33 +165,63 @@ extension Echo_Echo.StreamingServiceProtocol {
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
internal protocol Echo_EchoServiceProtocol: Echo_Echo.StreamingServiceProtocol {
/// Immediately returns an echo of a request.
func get(request: GRPCCore.ServerRequest.Single<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Single<Echo_EchoResponse>
func get(
request: GRPCCore.ServerRequest.Single<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Single<Echo_EchoResponse>

/// Splits a request into words and returns each word in a stream of messages.
func expand(request: GRPCCore.ServerRequest.Single<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>
func expand(
request: GRPCCore.ServerRequest.Single<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>

/// Collects a stream of messages and returns them concatenated when the caller closes.
func collect(request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Single<Echo_EchoResponse>
func collect(
request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Single<Echo_EchoResponse>

/// Streams back messages as they are received in an input stream.
func update(request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>
func update(
request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse>
}

/// Partial conformance to `Echo_EchoStreamingServiceProtocol`.
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
extension Echo_Echo.ServiceProtocol {
internal func get(request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse> {
let response = try await self.get(request: GRPCCore.ServerRequest.Single(stream: request))
internal func get(
request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse> {
let response = try await self.get(
request: GRPCCore.ServerRequest.Single(stream: request),
context: context
)
return GRPCCore.ServerResponse.Stream(single: response)
}

internal func expand(request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse> {
let response = try await self.expand(request: GRPCCore.ServerRequest.Single(stream: request))
internal func expand(
request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse> {
let response = try await self.expand(
request: GRPCCore.ServerRequest.Single(stream: request),
context: context
)
return response
}

internal func collect(request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse> {
let response = try await self.collect(request: request)
internal func collect(
request: GRPCCore.ServerRequest.Stream<Echo_EchoRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Echo_EchoResponse> {
let response = try await self.collect(
request: request,
context: context
)
return GRPCCore.ServerResponse.Stream(single: response)
}
}
Expand Down
12 changes: 8 additions & 4 deletions Examples/v2/echo/Subcommands/Serve.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,21 +47,24 @@ struct Serve: AsyncParsableCommand {
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
struct EchoService: Echo_EchoServiceProtocol {
func get(
request: ServerRequest.Single<Echo_EchoRequest>
request: ServerRequest.Single<Echo_EchoRequest>,
context: ServerContext
) async throws -> ServerResponse.Single<Echo_EchoResponse> {
return ServerResponse.Single(message: .with { $0.text = request.message.text })
}

func collect(
request: ServerRequest.Stream<Echo_EchoRequest>
request: ServerRequest.Stream<Echo_EchoRequest>,
context: ServerContext
) async throws -> ServerResponse.Single<Echo_EchoResponse> {
let messages = try await request.messages.reduce(into: []) { $0.append($1.text) }
let joined = messages.joined(separator: " ")
return ServerResponse.Single(message: .with { $0.text = joined })
}

func expand(
request: ServerRequest.Single<Echo_EchoRequest>
request: ServerRequest.Single<Echo_EchoRequest>,
context: ServerContext
) async throws -> ServerResponse.Stream<Echo_EchoResponse> {
return ServerResponse.Stream { writer in
let parts = request.message.text.split(separator: " ")
Expand All @@ -72,7 +75,8 @@ struct EchoService: Echo_EchoServiceProtocol {
}

func update(
request: ServerRequest.Stream<Echo_EchoRequest>
request: ServerRequest.Stream<Echo_EchoRequest>,
context: ServerContext
) async throws -> ServerResponse.Stream<Echo_EchoResponse> {
return ServerResponse.Stream { writer in
for try await message in request.messages {
Expand Down
27 changes: 21 additions & 6 deletions Examples/v2/hello-world/Generated/helloworld.grpc.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,10 @@ extension GRPCCore.ServiceDescriptor {
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
internal protocol Helloworld_GreeterStreamingServiceProtocol: GRPCCore.RegistrableRPCService {
/// Sends a greeting
func sayHello(request: GRPCCore.ServerRequest.Stream<Helloworld_HelloRequest>) async throws -> GRPCCore.ServerResponse.Stream<Helloworld_HelloReply>
func sayHello(
request: GRPCCore.ServerRequest.Stream<Helloworld_HelloRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Helloworld_HelloReply>
}

/// Conformance to `GRPCCore.RegistrableRPCService`.
Expand All @@ -72,8 +75,11 @@ extension Helloworld_Greeter.StreamingServiceProtocol {
forMethod: Helloworld_Greeter.Method.SayHello.descriptor,
deserializer: GRPCProtobuf.ProtobufDeserializer<Helloworld_HelloRequest>(),
serializer: GRPCProtobuf.ProtobufSerializer<Helloworld_HelloReply>(),
handler: { request in
try await self.sayHello(request: request)
handler: { request, context in
try await self.sayHello(
request: request,
context: context
)
}
)
}
Expand All @@ -83,14 +89,23 @@ extension Helloworld_Greeter.StreamingServiceProtocol {
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
internal protocol Helloworld_GreeterServiceProtocol: Helloworld_Greeter.StreamingServiceProtocol {
/// Sends a greeting
func sayHello(request: GRPCCore.ServerRequest.Single<Helloworld_HelloRequest>) async throws -> GRPCCore.ServerResponse.Single<Helloworld_HelloReply>
func sayHello(
request: GRPCCore.ServerRequest.Single<Helloworld_HelloRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Single<Helloworld_HelloReply>
}

/// Partial conformance to `Helloworld_GreeterStreamingServiceProtocol`.
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
extension Helloworld_Greeter.ServiceProtocol {
internal func sayHello(request: GRPCCore.ServerRequest.Stream<Helloworld_HelloRequest>) async throws -> GRPCCore.ServerResponse.Stream<Helloworld_HelloReply> {
let response = try await self.sayHello(request: GRPCCore.ServerRequest.Single(stream: request))
internal func sayHello(
request: GRPCCore.ServerRequest.Stream<Helloworld_HelloRequest>,
context: GRPCCore.ServerContext
) async throws -> GRPCCore.ServerResponse.Stream<Helloworld_HelloReply> {
let response = try await self.sayHello(
request: GRPCCore.ServerRequest.Single(stream: request),
context: context
)
return GRPCCore.ServerResponse.Stream(single: response)
}
}
Expand Down
3 changes: 2 additions & 1 deletion Examples/v2/hello-world/Subcommands/Serve.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ struct Serve: AsyncParsableCommand {
@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
struct Greeter: Helloworld_GreeterServiceProtocol {
func sayHello(
request: ServerRequest.Single<Helloworld_HelloRequest>
request: ServerRequest.Single<Helloworld_HelloRequest>,
context: ServerContext
) async throws -> ServerResponse.Single<Helloworld_HelloReply> {
var reply = Helloworld_HelloReply()
let recipient = request.message.name.isEmpty ? "stranger" : request.message.name
Expand Down
Loading
Loading