grpc-swift/Sources/GRPC/ConnectionManagerChannelProvider.swift

/*
 * Copyright 2021, gRPC Authors All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import Logging
import NIOCore
import NIOPosix
import NIOTransportServices

#if canImport(NIOSSL)
import NIOSSL
#endif

#if canImport(Network)
import Network
#endif

@usableFromInline
internal protocol ConnectionManagerChannelProvider {
  /// Make an `EventLoopFuture<Channel>`.
  ///
  /// - Parameters:
  ///   - connectionManager: The `ConnectionManager` requesting the `Channel`.
  ///   - eventLoop: The `EventLoop` to use for the`Channel`.
  ///   - connectTimeout: Optional connection timeout when starting the connection.
  ///   - logger: A logger.
  func makeChannel(
    managedBy connectionManager: ConnectionManager,
    onEventLoop eventLoop: EventLoop,
    connectTimeout: TimeAmount?,
    logger: Logger
  ) -> EventLoopFuture<Channel>
}

@usableFromInline
internal struct DefaultChannelProvider: ConnectionManagerChannelProvider {
  @usableFromInline
  enum TLSMode {
    #if canImport(NIOSSL)
    case configureWithNIOSSL(Result<NIOSSLContext, Error>)
    #endif  // canImport(NIOSSL)
    case configureWithNetworkFramework
    case disabled
  }

  @usableFromInline
  internal var connectionTarget: ConnectionTarget
  @usableFromInline
  internal var connectionKeepalive: ClientConnectionKeepalive
  @usableFromInline
  internal var connectionIdleTimeout: TimeAmount
  @usableFromInline
  internal var connectionMaxAge: TimeAmount?

  @usableFromInline
  internal var tlsMode: TLSMode
  @usableFromInline
  internal var tlsConfiguration: GRPCTLSConfiguration?

  @usableFromInline
  internal var httpTargetWindowSize: Int
  @usableFromInline
  internal var httpMaxFrameSize: Int
  @usableFromInline
  internal var httpMaxResetStreams: Int

  @usableFromInline
  internal var errorDelegate: Optional<ClientErrorDelegate>
  @usableFromInline
  internal var debugChannelInitializer: Optional<(Channel) -> EventLoopFuture<Void>>

  #if canImport(Network)
  @available(macOS 10.14, iOS 12.0, watchOS 6.0, tvOS 12.0, *)
  @usableFromInline
  internal var nwParametersConfigurator: (@Sendable (NWParameters) -> Void)? {
    get {
      self._nwParametersConfigurator as! (@Sendable (NWParameters) -> Void)?
    }
    set {
      self._nwParametersConfigurator = newValue
    }
  }

  private var _nwParametersConfigurator: (any Sendable)?
  #endif

  #if canImport(Network)
  @inlinable
  @available(macOS 10.14, iOS 12.0, watchOS 6.0, tvOS 12.0, *)
  internal init(
    connectionTarget: ConnectionTarget,
    connectionKeepalive: ClientConnectionKeepalive,
    connectionIdleTimeout: TimeAmount,
    connectionMaxAge: TimeAmount?,
    tlsMode: TLSMode,
    tlsConfiguration: GRPCTLSConfiguration?,
    httpTargetWindowSize: Int,
    httpMaxFrameSize: Int,
    httpMaxResetStreams: Int,
    errorDelegate: ClientErrorDelegate?,
    debugChannelInitializer: ((Channel) -> EventLoopFuture<Void>)?,
    nwParametersConfigurator: (@Sendable (NWParameters) -> Void)?
  ) {
    self.init(
      connectionTarget: connectionTarget,
      connectionKeepalive: connectionKeepalive,
      connectionIdleTimeout: connectionIdleTimeout,
      connectionMaxAge: connectionMaxAge,
      tlsMode: tlsMode,
      tlsConfiguration: tlsConfiguration,
      httpTargetWindowSize: httpTargetWindowSize,
      httpMaxFrameSize: httpMaxFrameSize,
      httpMaxResetStreams: httpMaxResetStreams,
      errorDelegate: errorDelegate,
      debugChannelInitializer: debugChannelInitializer
    )

    self.nwParametersConfigurator = nwParametersConfigurator
  }
  #endif

  @inlinable
  internal init(
    connectionTarget: ConnectionTarget,
    connectionKeepalive: ClientConnectionKeepalive,
    connectionIdleTimeout: TimeAmount,
    connectionMaxAge: TimeAmount?,
    tlsMode: TLSMode,
    tlsConfiguration: GRPCTLSConfiguration?,
    httpTargetWindowSize: Int,
    httpMaxFrameSize: Int,
    httpMaxResetStreams: Int,
    errorDelegate: ClientErrorDelegate?,
    debugChannelInitializer: ((Channel) -> EventLoopFuture<Void>)?
  ) {
    self.connectionTarget = connectionTarget
    self.connectionKeepalive = connectionKeepalive
    self.connectionIdleTimeout = connectionIdleTimeout
    self.connectionMaxAge = connectionMaxAge

    self.tlsMode = tlsMode
    self.tlsConfiguration = tlsConfiguration

    self.httpTargetWindowSize = httpTargetWindowSize
    self.httpMaxFrameSize = httpMaxFrameSize
    self.httpMaxResetStreams = httpMaxResetStreams

    self.errorDelegate = errorDelegate
    self.debugChannelInitializer = debugChannelInitializer
  }

  internal init(configuration: ClientConnection.Configuration) {
    // Making a `NIOSSLContext` is expensive and we should only do it (at most) once per TLS
    // configuration. We do it now and store it in our `tlsMode` and surface any error during
    // channel creation (we're limited by our API in when we can throw any error).
    let tlsMode: TLSMode

    if let tlsConfiguration = configuration.tlsConfiguration {
      if tlsConfiguration.isNetworkFrameworkTLSBackend {
        tlsMode = .configureWithNetworkFramework
      } else {
        #if canImport(NIOSSL)
        // The '!' is okay here, we have a `tlsConfiguration` (so we must be using TLS) and we know
        // it's not backed by Network.framework, so it must be backed by NIOSSL.
        tlsMode = .configureWithNIOSSL(Result { try tlsConfiguration.makeNIOSSLContext()! })
        #else
        // TLS is configured, and we aren't using a Network.framework TLS backend, so we must be
        // using NIOSSL, so we must be able to import it.
        fatalError()
        #endif  // canImport(NIOSSL)
      }
    } else {
      tlsMode = .disabled
    }

    self.init(
      connectionTarget: configuration.target,
      connectionKeepalive: configuration.connectionKeepalive,
      connectionIdleTimeout: configuration.connectionIdleTimeout,
      connectionMaxAge: configuration.connectionMaxAge,
      tlsMode: tlsMode,
      tlsConfiguration: configuration.tlsConfiguration,
      httpTargetWindowSize: configuration.httpTargetWindowSize,
      httpMaxFrameSize: configuration.httpMaxFrameSize,
      httpMaxResetStreams: configuration.httpMaxResetStreams,
      errorDelegate: configuration.errorDelegate,
      debugChannelInitializer: configuration.debugChannelInitializer
    )

    #if canImport(Network)
    if #available(macOS 10.14, iOS 12.0, watchOS 6.0, tvOS 12.0, *) {
      self.nwParametersConfigurator = configuration.nwParametersConfigurator
    }
    #endif
  }

  private var serverHostname: String? {
    let hostname = self.tlsConfiguration?.hostnameOverride ?? self.connectionTarget.host
    return hostname.isIPAddress ? nil : hostname
  }

  private var hasTLS: Bool {
    return self.tlsConfiguration != nil
  }

  private func requiresZeroLengthWorkaround(eventLoop: EventLoop) -> Bool {
    return PlatformSupport.requiresZeroLengthWriteWorkaround(group: eventLoop, hasTLS: self.hasTLS)
  }

  @usableFromInline
  internal func makeChannel(
    managedBy connectionManager: ConnectionManager,
    onEventLoop eventLoop: EventLoop,
    connectTimeout: TimeAmount?,
    logger: Logger
  ) -> EventLoopFuture<Channel> {
    let hostname = self.serverHostname
    let needsZeroLengthWriteWorkaround = self.requiresZeroLengthWorkaround(eventLoop: eventLoop)

    var bootstrap = PlatformSupport.makeClientBootstrap(
      group: eventLoop,
      tlsConfiguration: self.tlsConfiguration,
      logger: logger
    )

    bootstrap =
      bootstrap
      .channelOption(ChannelOptions.socket(SocketOptionLevel(SOL_SOCKET), SO_REUSEADDR), value: 1)
      .channelOption(ChannelOptions.socket(IPPROTO_TCP, TCP_NODELAY), value: 1)
      .channelInitializer { channel in
        let sync = channel.pipeline.syncOperations

        do {
          if needsZeroLengthWriteWorkaround {
            try sync.addHandler(NIOFilterEmptyWritesHandler())
          }

          // We have a NIOSSL context to apply. If we're using TLS from NIOTS then the bootstrap
          // will already have the TLS options applied.
          switch self.tlsMode {
          #if canImport(NIOSSL)
          case let .configureWithNIOSSL(sslContext):
            try sync.configureNIOSSLForGRPCClient(
              sslContext: sslContext,
              serverHostname: hostname,
              customVerificationCallback: self.tlsConfiguration?.nioSSLCustomVerificationCallback,
              logger: logger
            )
          #endif  // canImport(NIOSSL)

          // Network.framework TLS configuration is applied when creating the bootstrap so is a
          // no-op here.
          case .configureWithNetworkFramework,
            .disabled:
            ()
          }

          try sync.configureHTTP2AndGRPCHandlersForGRPCClient(
            channel: channel,
            connectionManager: connectionManager,
            connectionKeepalive: self.connectionKeepalive,
            connectionIdleTimeout: self.connectionIdleTimeout,
            connectionMaxAge: self.connectionMaxAge,
            httpTargetWindowSize: self.httpTargetWindowSize,
            httpMaxFrameSize: self.httpMaxFrameSize,
            httpMaxResetStreams: self.httpMaxResetStreams,
            errorDelegate: self.errorDelegate,
            logger: logger
          )
        } catch {
          return channel.eventLoop.makeFailedFuture(error)
        }

        // Run the debug initializer, if there is one.
        if let debugInitializer = self.debugChannelInitializer {
          return debugInitializer(channel)
        } else {
          return channel.eventLoop.makeSucceededVoidFuture()
        }
      }

    if let connectTimeout = connectTimeout {
      _ = bootstrap.connectTimeout(connectTimeout)
    }

    #if canImport(Network)
    if #available(macOS 10.14, iOS 12.0, watchOS 6.0, tvOS 12.0, *),
      let configurator = self.nwParametersConfigurator,
      let transportServicesBootstrap = bootstrap as? NIOTSConnectionBootstrap
    {
      _ = transportServicesBootstrap.configureNWParameters(configurator)
    }
    #endif

    return bootstrap.connect(to: self.connectionTarget)
  }
}