Put the client connection behind a protocol #727
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Motivation: Generated client stubs may only be initialized using a `ClientConnection` which makes the assumption that a connection will only ever be singular, and that all RPCs for that stub will run on a single event loop. However, there are scenarios where we may want to drive a stub and have multiple connections (load balancing), or no real connection at all (testing). Modifications: - Generated client stubs now depend on the implementation of a `GRPCChannel` - The first argument label for the `init` in generated clients has changed from `connection` to `client` - Added fixits for the above - Updated generated code - `GRPCChannel`s contract ensures that RPCs can be made but do not specify the transport. - `GRPCClient` now requires a `GRPCChannel` - `GRPCClient` provides higher level wrappers for the factory methods on `GRPCChannel` (i.e. provide defaults such as for call options) Result: - We have a better ability, in the future, to use already-generated stubs with different `GRPCChannel`s. - Cleaner abstraction between call and connection.
MrMage
approved these changes
Feb 25, 2020
| @@ -25,32 +24,39 @@ import Logging | |||
| /// - `status`: the status of the gRPC call after it has ended, | |||
| /// - `trailingMetadata`: any metadata returned from the server alongside the `status`. | |||
| public final class ServerStreamingCall<RequestPayload: GRPCPayload, ResponsePayload: GRPCPayload>: BaseClientCall<RequestPayload, ResponsePayload> { | |||
| public init( | |||
| connection: ClientConnection, | |||
|
|
|||
Sources/GRPC/ClientConnection.swift
Outdated
| @@ -265,7 +296,7 @@ extension ClientConnection { | |||
| /// - Parameter backoffIterator: An `Iterator` for `ConnectionBackoff` providing a sequence of | |||
| /// connection timeouts and backoff to use when attempting to create a connection. | |||
| private class func makeChannel( | |||
| configuration: Configuration, | |||
| configuration: ClientConnection.Configuration, | |||
There was a problem hiding this comment.
Is the ClientConnection. prefix necessary?
There was a problem hiding this comment.
Nope, will remove them, that was WIP that didn't get reverted.
|
|
||
| extension GRPCClient { | ||
| @available(*, deprecated, renamed: "init(channel:defaultCallOptions:)", message: "You may also need to regenerate your client code") | ||
| public init(connection: ClientConnection, defaultCallOptions: CallOptions = CallOptions()) { |
There was a problem hiding this comment.
I assume we will delete these before 1.0?
There was a problem hiding this comment.
That's right, this whole file will be removed (there's a TODO at the top of it)
Afraid so; nothing too exciting going on here! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
Generated client stubs may only be initialized using a
ClientConnectionwhich makes the assumption that a connection willonly ever be singular, and that all RPCs for that stub will run on a
single event loop.
However, there are scenarios where we may want to drive a stub and have
multiple connections (load balancing), or no real connection at all
(testing).
Modifications:
GRPCChannelinitin generated clients haschanged from
connectiontoclientGRPCChannels contract ensures that RPCs can be made but do notspecify the transport.
GRPCClientnow requires aGRPCChannelGRPCClientprovides higher level wrappers for the factory methods onGRPCChannel(i.e. provide defaults such as for call options)Result:
stubs with different
GRPCChannels.