Use ServiceConfiguration more widely (#1794)

Motivation:

ServiceConfiguration was recently added which has a lot of overlap with
MethodConfigurations. These should be de-duped where possible.

Modifications:

- Make `MethodConfigurations` underscored-public and refactor to use
  `MethodConfiguration.Name`
- Pass `ServiceConfiguration` instead of `MethodConfigurations` where it
  makes sense
- Update docs and tests

* [ProtobufCodeGen] Use the generated input and output type names (#1792)

Motivation:

protoc-gen-swift generates message type names that are different from the ones in the file descriptors. The CodeGenerationRequest object should contain the generated names for the ProtobufCodeGen.

Modifications:

- the parser uses a SwiftProtobufNamer to get the generated type names
and adds them in the CodeGenerationRequest objects
- propagated the change and modified tests accordingly

Result:

The input and output type names will be the generated ones and the generated code will compile.
Co-authored-by: Gustavo Cairo <[email protected]>

Author: glbrntt

Sources/GRPCCore/GRPCClient.swift

@@ -28,7 +28,7 @@ import Atomics
 ///
 /// However, in most cases you should prefer wrapping the ``GRPCClient`` with a generated stub.
 ///
-/// You can set ``MethodConfiguration``s on this client to override whatever configurations have been
+/// You can set ``ServiceConfiguration``s on this client to override whatever configurations have been
 /// set on the given transport. You can also use ``ClientInterceptor``s to implement cross-cutting
 /// logic which apply to all RPCs. Example uses of interceptors include authentication and logging.
 ///
@@ -37,21 +37,32 @@ import Atomics
 /// The following example demonstrates how to create and configure a client.
 ///
 /// ```swift
-/// // Create a configuration object for the client.
+/// // Create a configuration object for the client and override the timeout for the 'Get' method on
+/// // the 'echo.Echo' service. This configuration takes precedence over any set by the transport.
 /// var configuration = GRPCClient.Configuration()
-///
-/// // Override the timeout for the 'Get' method on the 'echo.Echo' service. This configuration
-/// // takes precedence over any set by the transport.
-/// let echoGet = MethodDescriptor(service: "echo.Echo", method: "Get")
-/// configuration.method.overrides[echoGet] = MethodConfiguration(
-///   executionPolicy: nil,
-///   timeout: .seconds(5)
+/// configuration.service.override = ServiceConfiguration(
+///   methodConfiguration: [
+///     MethodConfiguration(
+///       names: [
+///         MethodConfiguration.Name(service: "echo.Echo", method: "Get")
+///       ],
+///       timeout: .seconds(5)
+///     )
+///   ]
 /// )
 ///
-/// // Configure a fallback timeout for all RPCs if no configuration is provided in the overrides
-/// // or by the transport.
-/// let defaultMethodConfiguration = MethodConfiguration(executionPolicy: nil, timeout: seconds(10))
-/// configuration.method.defaults.setDefaultConfiguration(defaultMethodConfiguration)
+/// // Configure a fallback timeout for all RPCs (indicated by an empty service and method name) if
+/// // no configuration is provided in the overrides or by the transport.
+/// configuration.service.defaults = ServiceConfiguration(
+///   methodConfiguration: [
+///     MethodConfiguration(
+///       names: [
+///         MethodConfiguration.Name(service: "", method: "")
+///       ],
+///       timeout: .seconds(10)
+///     )
+///   ]
+/// )
 ///
 /// // Finally create a transport and instantiate the client, adding an interceptor.
 /// let inProcessServerTransport = InProcessServerTransport()
@@ -114,6 +125,11 @@ public struct GRPCClient: Sendable {
   /// The configuration used by the client.
   public let configuration: Configuration
 
+  /// A cache of method config overrides.
+  private let methodConfigurationOverrides: _MethodConfigurations
+  /// A cache of method config defaults.
+  private let methodConfigurationDefaults: _MethodConfigurations
+
   /// The current state of the client.
   private let state: ManagedAtomic<State>
 
@@ -149,6 +165,14 @@ public struct GRPCClient: Sendable {
     self.transport = transport
     self.interceptors = interceptors
     self.configuration = configuration
+
+    self.methodConfigurationOverrides = _MethodConfigurations(
+      serviceConfiguration: self.configuration.service.overrides
+    )
+    self.methodConfigurationDefaults = _MethodConfigurations(
+      serviceConfiguration: self.configuration.service.defaults
+    )
+
     self.state = ManagedAtomic(.notStarted)
   }
 
@@ -380,15 +404,15 @@ public struct GRPCClient: Sendable {
   }
 
   private func resolveMethodConfiguration(for descriptor: MethodDescriptor) -> MethodConfiguration {
-    if let configuration = self.configuration.method.overrides[descriptor] {
+    if let configuration = self.methodConfigurationOverrides[descriptor] {
       return configuration
     }
 
-    if let configuration = self.transport.executionConfiguration(forMethod: descriptor) {
+    if let configuration = self.transport.configuration(forMethod: descriptor) {
       return configuration
     }
 
-    if let configuration = self.configuration.method.defaults[descriptor] {
+    if let configuration = self.methodConfigurationDefaults[descriptor] {
       return configuration
     }
 
@@ -400,41 +424,44 @@ public struct GRPCClient: Sendable {
 @available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
 extension GRPCClient {
   public struct Configuration: Sendable {
-    /// Configuration for how methods are executed.
+    /// Configuration for how the client interacts with services.
     ///
-    /// Method configuration determines how each RPC is executed by the client. Some services and
+    /// The configuration includes information about how the client should load balance requests,
+    /// how retries should be throttled and how methods should be executed. Some services and
     /// transports provide this information to the client when the server name is resolved. However,
-    /// you override this configuration and set default values should no override be set and the
+    /// you can override this configuration and set default values should no override be set and the
     /// transport doesn't provide a value.
-    public var method: Method
+    ///
+    /// See also ``ServiceConfiguration``.
+    public var service: Service
 
     /// Creates a new default configuration.
     public init() {
-      self.method = Method()
+      self.service = Service()
     }
   }
 }
 
 @available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
 extension GRPCClient.Configuration {
-  /// Configuration for how methods should be executed.
+  /// Configuration for how the client interacts with services.
   ///
   /// In most cases the client should defer to the configuration provided by the transport as this
   /// can be provided to the transport as part of name resolution when establishing a connection.
   ///
   /// The client first checks ``overrides`` for a configuration, followed by the transport, followed
   /// by ``defaults``.
-  public struct Method: Sendable, Hashable {
+  public struct Service: Sendable, Hashable {
     /// Configuration to use in precedence to that provided by the transport.
-    public var overrides: MethodConfigurations
+    public var overrides: ServiceConfiguration
 
     /// Configuration to use only if there are no overrides and the transport doesn't specify
     /// any configuration.
-    public var defaults: MethodConfigurations
+    public var defaults: ServiceConfiguration
 
     public init() {
-      self.overrides = MethodConfigurations()
-      self.defaults = MethodConfigurations()
+      self.overrides = ServiceConfiguration()
+      self.defaults = ServiceConfiguration()
     }
   }
 }

Sources/GRPCCore/MethodConfigurations.swift renamed to Sources/GRPCCore/Internal/_MethodConfigurations.swift

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+// TODO: when swift(>=5.9), use 'package' access level
+
 /// A collection of ``MethodConfiguration``s, mapped to specific methods or services.
 ///
 /// When creating a new instance, no overrides and no default will be set for using when getting
@@ -23,12 +25,20 @@
 ///
 /// Use the subscript to get and set configurations for specific methods.
 @available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
-public struct MethodConfigurations: Sendable, Hashable {
-  private var elements: [MethodDescriptor: MethodConfiguration]
+public struct _MethodConfigurations: Sendable, Hashable {
+  private var elements: [MethodConfiguration.Name: MethodConfiguration]
 
-  /// Create a new ``MethodConfigurations`` with no overrides and no default configuration.
-  public init() {
+  /// Create a new ``_MethodConfigurations``.
+  ///
+  /// - Parameter serviceConfiguration: The configuration to read ``MethodConfiguration`` from.
+  public init(serviceConfiguration: ServiceConfiguration = ServiceConfiguration()) {
     self.elements = [:]
+
+    for configuration in serviceConfiguration.methodConfiguration {
+      for name in configuration.names {
+        self.elements[name] = configuration
+      }
+    }
   }
 
   /// Get or set the corresponding ``MethodConfiguration`` for the given ``MethodDescriptor``.
@@ -44,34 +54,36 @@ public struct MethodConfigurations: Sendable, Hashable {
   ///  - descriptor: The ``MethodDescriptor`` for which to get or set a ``MethodConfiguration``.
   public subscript(_ descriptor: MethodDescriptor) -> MethodConfiguration? {
     get {
-      if let configuration = self.elements[descriptor] {
+      var name = MethodConfiguration.Name(service: descriptor.service, method: descriptor.method)
+
+      if let configuration = self.elements[name] {
         return configuration
       }
 
       // Check if the config is set at the service level by clearing the method.
-      var descriptor = descriptor
-      descriptor.method = ""
+      name.method = ""
 
-      if let configuration = self.elements[descriptor] {
+      if let configuration = self.elements[name] {
         return configuration
       }
 
       // Check if the config is set at the global level by clearing the service and method.
-      descriptor.service = ""
-      return self.elements[descriptor]
+      name.service = ""
+      return self.elements[name]
     }
 
     set {
-      self.elements[descriptor] = newValue
+      let name = MethodConfiguration.Name(service: descriptor.service, method: descriptor.method)
+      self.elements[name] = newValue
     }
   }
 
   /// Set a default configuration for all methods that have no overrides.
   ///
   /// - Parameter configuration: The default configuration.
   public mutating func setDefaultConfiguration(_ configuration: MethodConfiguration?) {
-    let descriptor = MethodDescriptor(service: "", method: "")
-    self.elements[descriptor] = configuration
+    let name = MethodConfiguration.Name(service: "", method: "")
+    self.elements[name] = configuration
   }
 
   /// Set a default configuration for a service.
@@ -87,6 +99,7 @@ public struct MethodConfigurations: Sendable, Hashable {
     _ configuration: MethodConfiguration?,
     forService service: String
   ) {
-    self.elements[MethodDescriptor(service: service, method: "")] = configuration
+    let name = MethodConfiguration.Name(service: "", method: "")
+    self.elements[name] = configuration
   }
 }

Sources/GRPCCore/Transport/ClientTransport.swift

@@ -71,11 +71,9 @@ public protocol ClientTransport: Sendable {
     _ closure: (_ stream: RPCStream<Inbound, Outbound>) async throws -> T
   ) async throws -> T
 
-  /// Returns the execution configuration for a given method.
+  /// Returns the configuration for a given method.
   ///
   /// - Parameter descriptor: The method to lookup configuration for.
-  /// - Returns: Execution configuration for the method, if it exists.
-  func executionConfiguration(
-    forMethod descriptor: MethodDescriptor
-  ) -> MethodConfiguration?
+  /// - Returns: Configuration for the method, if it exists.
+  func configuration(forMethod descriptor: MethodDescriptor) -> MethodConfiguration?
 }

Sources/GRPCCore/Transport/RetryThrottle.swift

@@ -103,6 +103,14 @@ public struct RetryThrottle: Sendable {
     self.scaledTokensAvailable = LockedValueBox(scaledTokens)
   }
 
+  /// Create a new throttle.
+  ///
+  /// - Parameter policy: The policy to use to configure the throttle.
+  @available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
+  public init(policy: ServiceConfiguration.RetryThrottlingPolicy) {
+    self.init(maximumTokens: policy.maxTokens, tokenRatio: policy.tokenRatio)
+  }
+
   /// Records a success, adding a token to the throttle.
   @usableFromInline
   func recordSuccess() {

Sources/GRPCInProcessTransport/InProcessClientTransport.swift

@@ -98,22 +98,22 @@ public struct InProcessClientTransport: ClientTransport {
 
   public let retryThrottle: RetryThrottle?
 
-  private let methodConfiguration: MethodConfigurations
+  private let methodConfiguration: _MethodConfigurations
   private let state: _LockedValueBox<State>
 
   /// Creates a new in-process client transport.
   ///
   /// - Parameters:
   ///   - server: The in-process server transport to connect to.
-  ///   - methodConfiguration: Method specific configuration.
-  ///   - retryThrottle: A throttle to apply to RPCs which are hedged or retried.
+  ///   - serviceConfiguration: Service configuration.
   public init(
     server: InProcessServerTransport,
-    methodConfiguration: MethodConfigurations = MethodConfigurations(),
-    retryThrottle: RetryThrottle? = nil
+    serviceConfiguration: ServiceConfiguration = ServiceConfiguration()
   ) {
-    self.retryThrottle = retryThrottle
-    self.methodConfiguration = methodConfiguration
+    self.retryThrottle = serviceConfiguration.retryThrottlingPolicy.map {
+      RetryThrottle(policy: $0)
+    }
+    self.methodConfiguration = _MethodConfigurations(serviceConfiguration: serviceConfiguration)
     self.state = _LockedValueBox(.unconnected(.init(serverTransport: server)))
   }
 
@@ -336,7 +336,7 @@ public struct InProcessClientTransport: ClientTransport {
   ///
   /// - Parameter descriptor: The method to lookup configuration for.
   /// - Returns: Execution configuration for the method, if it exists.
-  public func executionConfiguration(
+  public func configuration(
     forMethod descriptor: MethodDescriptor
   ) -> MethodConfiguration? {
     self.methodConfiguration[descriptor]

Sources/GRPCInProcessTransport/InProcessTransport.swift

@@ -22,21 +22,16 @@ public enum InProcessTransport {
   /// and a client using that server transport.
   ///
   /// - Parameters:
-  ///   - methodConfiguration: Method specific configuration used by the client transport to
-  ///       determine how RPCs should be executed.
-  ///   - retryThrottle: The retry throttle the client transport uses to determine whether a call
-  ///       should be retried.
+  ///   - serviceConfiguration: Configuration describing how methods should be executed.
   /// - Returns: A tuple containing the connected server and client in-process transports.
   @available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
   public static func makePair(
-    methodConfiguration: MethodConfigurations = MethodConfigurations(),
-    retryThrottle: RetryThrottle? = nil
+    serviceConfiguration: ServiceConfiguration = ServiceConfiguration()
   ) -> (server: InProcessServerTransport, client: InProcessClientTransport) {
     let server = InProcessServerTransport()
     let client = InProcessClientTransport(
       server: server,
-      methodConfiguration: methodConfiguration,
-      retryThrottle: retryThrottle
+      serviceConfiguration: serviceConfiguration
     )
     return (server, client)
   }

Tests/GRPCCoreTests/MethodConfigurationsTests.swift renamed to Tests/GRPCCoreTests/Internal/MethodConfigurationsTests.swift

@@ -25,7 +25,7 @@ final class MethodConfigurationsTests: XCTestCase {
       nonFatalStatusCodes: []
     )
     let defaultConfiguration = MethodConfiguration(names: [], executionPolicy: .hedge(policy))
-    var configurations = MethodConfigurations()
+    var configurations = _MethodConfigurations()
     configurations.setDefaultConfiguration(defaultConfiguration)
     let descriptor = MethodDescriptor(service: "test", method: "first")
     let retryPolicy = RetryPolicy(
@@ -48,7 +48,7 @@ final class MethodConfigurationsTests: XCTestCase {
       nonFatalStatusCodes: []
     )
     let defaultConfiguration = MethodConfiguration(names: [], executionPolicy: .hedge(policy))
-    var configurations = MethodConfigurations()
+    var configurations = _MethodConfigurations()
     configurations.setDefaultConfiguration(defaultConfiguration)
     let firstDescriptor = MethodDescriptor(service: "test", method: "")
     let retryPolicy = RetryPolicy(
@@ -72,7 +72,7 @@ final class MethodConfigurationsTests: XCTestCase {
       nonFatalStatusCodes: []
     )
     let defaultConfiguration = MethodConfiguration(names: [], executionPolicy: .hedge(policy))
-    var configurations = MethodConfigurations()
+    var configurations = _MethodConfigurations()
     configurations.setDefaultConfiguration(defaultConfiguration)
     let firstDescriptor = MethodDescriptor(service: "test1", method: "first")
     let retryPolicy = RetryPolicy(

Tests/GRPCCoreTests/Test Utilities/Transport/AnyTransport.swift

@@ -48,7 +48,7 @@ struct AnyClientTransport: ClientTransport, Sendable {
     }
 
     self._configuration = { descriptor in
-      transport.executionConfiguration(forMethod: descriptor)
+      transport.configuration(forMethod: descriptor)
     }
   }
 
@@ -72,7 +72,7 @@ struct AnyClientTransport: ClientTransport, Sendable {
     return result as! T
   }
 
-  func executionConfiguration(
+  func configuration(
     forMethod descriptor: MethodDescriptor
   ) -> MethodConfiguration? {
     self._configuration(descriptor)

Tests/GRPCCoreTests/Test Utilities/Transport/StreamCountingTransport.swift

@@ -66,10 +66,10 @@ struct StreamCountingClientTransport: ClientTransport, Sendable {
     }
   }
 
-  func executionConfiguration(
+  func configuration(
     forMethod descriptor: MethodDescriptor
   ) -> MethodConfiguration? {
-    self.transport.executionConfiguration(forMethod: descriptor)
+    self.transport.configuration(forMethod: descriptor)
   }
 }