grpc-swift/Sources/GRPCInProcessTransport/InProcessTransport+Server.swift

/*
 * Copyright 2024, 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.
 */

public import GRPCCore
private import Synchronization

@available(gRPCSwift 2.0, *)
extension InProcessTransport {
  /// An in-process implementation of a `ServerTransport`.
  ///
  /// This is useful when you're interested in testing your application without any actual networking layers
  /// involved, as the client and server will communicate directly with each other via in-process streams.
  ///
  /// To use this server, you call ``listen(streamHandler:)`` and iterate over the returned `AsyncSequence` to get all
  /// RPC requests made from clients (as `RPCStream`s).
  /// To stop listening to new requests, call ``beginGracefulShutdown()``.
  ///
  /// - SeeAlso: `ClientTransport`
  public final class Server: ServerTransport, Sendable {
    public typealias Bytes = [UInt8]

    public typealias Inbound = RPCAsyncSequence<RPCRequestPart<Bytes>, any Error>
    public typealias Outbound = RPCWriter<RPCResponsePart<Bytes>>.Closable

    private let newStreams: AsyncStream<RPCStream<Inbound, Outbound>>
    private let newStreamsContinuation: AsyncStream<RPCStream<Inbound, Outbound>>.Continuation
    package let peer: String

    private struct State: Sendable {
      private var _nextID: UInt64
      private var handles: [UInt64: ServerContext.RPCCancellationHandle]
      private var isShutdown: Bool

      private mutating func nextID() -> UInt64 {
        let id = self._nextID
        self._nextID &+= 1
        return id
      }

      init() {
        self._nextID = 0
        self.handles = [:]
        self.isShutdown = false
      }

      mutating func addHandle(_ handle: ServerContext.RPCCancellationHandle) -> (UInt64, Bool) {
        let handleID = self.nextID()
        self.handles[handleID] = handle
        return (handleID, self.isShutdown)
      }

      mutating func removeHandle(withID id: UInt64) {
        self.handles.removeValue(forKey: id)
      }

      mutating func beginShutdown() -> [ServerContext.RPCCancellationHandle] {
        self.isShutdown = true
        let values = Array(self.handles.values)
        self.handles.removeAll()
        return values
      }
    }

    private let handles: Mutex<State>

    /// Creates a new instance of ``Server``.
    ///
    /// - Parameters:
    ///   - peer: The system's PID for the running client and server.
    package init(peer: String) {
      (self.newStreams, self.newStreamsContinuation) = AsyncStream.makeStream()
      self.handles = Mutex(State())
      self.peer = peer
    }

    /// Publish a new ``RPCStream``, which will be returned by the transport's ``events``
    /// successful case.
    ///
    /// - Parameter stream: The new ``RPCStream`` to publish.
    /// - Throws: ``RPCError`` with code ``RPCError/Code-swift.struct/failedPrecondition``
    /// if the server transport stopped listening to new streams (i.e., if ``beginGracefulShutdown()`` has been called).
    internal func acceptStream(_ stream: RPCStream<Inbound, Outbound>) throws {
      let yieldResult = self.newStreamsContinuation.yield(stream)
      if case .terminated = yieldResult {
        throw RPCError(
          code: .failedPrecondition,
          message: "The server transport is closed."
        )
      }
    }

    public func listen(
      streamHandler: @escaping @Sendable (
        _ stream: RPCStream<Inbound, Outbound>,
        _ context: ServerContext
      ) async -> Void
    ) async throws {
      await withDiscardingTaskGroup { group in
        for await stream in self.newStreams {
          group.addTask {
            await withServerContextRPCCancellationHandle { handle in
              let (id, isShutdown) = self.handles.withLock({ $0.addHandle(handle) })
              defer {
                self.handles.withLock { $0.removeHandle(withID: id) }
              }

              // This happens if `beginGracefulShutdown` is called after the stream is added to
              // new streams but before it's dequeued.
              if isShutdown {
                handle.cancel()
              }

              let context = ServerContext(
                descriptor: stream.descriptor,
                remotePeer: self.peer,
                localPeer: self.peer,
                cancellation: handle
              )
              await streamHandler(stream, context)
            }
          }
        }
      }
    }

    /// Stop listening to any new `RPCStream` publications.
    ///
    /// - SeeAlso: `ServerTransport`
    public func beginGracefulShutdown() {
      self.newStreamsContinuation.finish()
      for handle in self.handles.withLock({ $0.beginShutdown() }) {
        handle.cancel()
      }
    }
  }
}