grpc-swift/Tests/GRPCCodeGenTests/Internal/StructuredSwift+ClientTests.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.
 */

import Testing

@testable import GRPCCodeGen

extension StructuredSwiftTests {
  @Suite("Client")
  struct Client {
    @Test(
      "func <Method>(request:serializer:deserializer:options:onResponse:)",
      arguments: AccessModifier.allCases,
      RPCKind.allCases
    )
    @available(gRPCSwift 2.0, *)
    func clientMethodSignature(access: AccessModifier, kind: RPCKind) {
      let decl: FunctionSignatureDescription = .clientMethod(
        accessLevel: access,
        name: "foo",
        input: "FooInput",
        output: "FooOutput",
        streamingInput: kind.streamsInput,
        streamingOutput: kind.streamsOutput,
        includeDefaults: false,
        includeSerializers: true
      )

      let requestType = kind.streamsInput ? "StreamingClientRequest" : "ClientRequest"
      let responseType = kind.streamsOutput ? "StreamingClientResponse" : "ClientResponse"

      let expected = """
        \(access) func foo<Result>(
          request: GRPCCore.\(requestType)<FooInput>,
          serializer: some GRPCCore.MessageSerializer<FooInput>,
          deserializer: some GRPCCore.MessageDeserializer<FooOutput>,
          options: GRPCCore.CallOptions,
          onResponse handleResponse: @Sendable @escaping (GRPCCore.\(responseType)<FooOutput>) async throws -> Result
        ) async throws -> Result where Result: Sendable
        """

      #expect(render(.function(signature: decl)) == expected)
    }

    @Test(
      "func <Method>(request:serializer:deserializer:options:onResponse:) (with defaults)",
      arguments: AccessModifier.allCases,
      [true, false]
    )
    @available(gRPCSwift 2.0, *)
    func clientMethodSignatureWithDefaults(access: AccessModifier, streamsOutput: Bool) {
      let decl: FunctionSignatureDescription = .clientMethod(
        accessLevel: access,
        name: "foo",
        input: "FooInput",
        output: "FooOutput",
        streamingInput: false,
        streamingOutput: streamsOutput,
        includeDefaults: true,
        includeSerializers: false
      )

      let expected: String
      if streamsOutput {
        expected = """
          \(access) func foo<Result>(
            request: GRPCCore.ClientRequest<FooInput>,
            options: GRPCCore.CallOptions = .defaults,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.StreamingClientResponse<FooOutput>) async throws -> Result
          ) async throws -> Result where Result: Sendable
          """
      } else {
        expected = """
          \(access) func foo<Result>(
            request: GRPCCore.ClientRequest<FooInput>,
            options: GRPCCore.CallOptions = .defaults,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.ClientResponse<FooOutput>) async throws -> Result = { response in
              try response.message
            }
          ) async throws -> Result where Result: Sendable
          """
      }

      #expect(render(.function(signature: decl)) == expected)
    }

    @Test("protocol Foo_ClientProtocol: Sendable { ... }", arguments: AccessModifier.allCases)
    @available(gRPCSwift 2.0, *)
    func clientProtocol(access: AccessModifier) {
      let decl: ProtocolDescription = .clientProtocol(
        accessLevel: access,
        name: "Foo_ClientProtocol",
        methods: [
          .init(
            documentation: "/// Some docs",
            name: MethodName(identifyingName: "Bar", typeName: "Bar", functionName: "bar"),
            isInputStreaming: false,
            isOutputStreaming: false,
            inputType: "BarInput",
            outputType: "BarOutput"
          )
        ]
      )

      let expected = """
        \(access) protocol Foo_ClientProtocol: Sendable {
          /// Call the "Bar" method.
          ///
          /// > Source IDL Documentation:
          /// >
          /// > Some docs
          ///
          /// - Parameters:
          ///   - request: A request containing a single `BarInput` message.
          ///   - serializer: A serializer for `BarInput` messages.
          ///   - deserializer: A deserializer for `BarOutput` messages.
          ///   - options: Options to apply to this RPC.
          ///   - handleResponse: A closure which handles the response, the result of which is
          ///       returned to the caller. Returning from the closure will cancel the RPC if it
          ///       hasn't already finished.
          /// - Returns: The result of `handleResponse`.
          func bar<Result>(
            request: GRPCCore.ClientRequest<BarInput>,
            serializer: some GRPCCore.MessageSerializer<BarInput>,
            deserializer: some GRPCCore.MessageDeserializer<BarOutput>,
            options: GRPCCore.CallOptions,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.ClientResponse<BarOutput>) async throws -> Result
          ) async throws -> Result where Result: Sendable
        }
        """

      #expect(render(.protocol(decl)) == expected)
    }

    @Test("func foo(...) { try await self.foo(...) }", arguments: AccessModifier.allCases)
    @available(gRPCSwift 2.0, *)
    func clientMethodFunctionWithDefaults(access: AccessModifier) {
      let decl: FunctionDescription = .clientMethodWithDefaults(
        accessLevel: access,
        name: "foo",
        input: "FooInput",
        output: "FooOutput",
        streamingInput: false,
        streamingOutput: false,
        serializer: .identifierPattern("Serialize<FooInput>()"),
        deserializer: .identifierPattern("Deserialize<FooOutput>()")
      )

      let expected = """
        \(access) func foo<Result>(
          request: GRPCCore.ClientRequest<FooInput>,
          options: GRPCCore.CallOptions = .defaults,
          onResponse handleResponse: @Sendable @escaping (GRPCCore.ClientResponse<FooOutput>) async throws -> Result = { response in
            try response.message
          }
        ) async throws -> Result where Result: Sendable {
          try await self.foo(
            request: request,
            serializer: Serialize<FooInput>(),
            deserializer: Deserialize<FooOutput>(),
            options: options,
            onResponse: handleResponse
          )
        }
        """

      #expect(render(.function(decl)) == expected)
    }

    @Test(
      "extension Foo_ClientProtocol { ... } (methods with defaults)",
      arguments: AccessModifier.allCases
    )
    @available(gRPCSwift 2.0, *)
    func extensionWithDefaultClientMethods(access: AccessModifier) {
      let decl: ExtensionDescription = .clientMethodSignatureWithDefaults(
        accessLevel: access,
        name: "Foo_ClientProtocol",
        methods: [
          MethodDescriptor(
            documentation: "",
            name: MethodName(identifyingName: "Bar", typeName: "Bar", functionName: "bar"),
            isInputStreaming: false,
            isOutputStreaming: false,
            inputType: "BarInput",
            outputType: "BarOutput"
          )
        ],
        serializer: { "Serialize<\($0)>()" },
        deserializer: { "Deserialize<\($0)>()" }
      )

      let expected = """
        extension Foo_ClientProtocol {
          /// Call the "Bar" method.
          ///
          /// - Parameters:
          ///   - request: A request containing a single `BarInput` message.
          ///   - options: Options to apply to this RPC.
          ///   - handleResponse: A closure which handles the response, the result of which is
          ///       returned to the caller. Returning from the closure will cancel the RPC if it
          ///       hasn't already finished.
          /// - Returns: The result of `handleResponse`.
          \(access) func bar<Result>(
            request: GRPCCore.ClientRequest<BarInput>,
            options: GRPCCore.CallOptions = .defaults,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.ClientResponse<BarOutput>) async throws -> Result = { response in
              try response.message
            }
          ) async throws -> Result where Result: Sendable {
            try await self.bar(
              request: request,
              serializer: Serialize<BarInput>(),
              deserializer: Deserialize<BarOutput>(),
              options: options,
              onResponse: handleResponse
            )
          }
        }
        """

      #expect(render(.extension(decl)) == expected)
    }

    @Test(
      "func foo<Result>(_:metadata:options:onResponse:) -> Result (exploded signature)",
      arguments: AccessModifier.allCases,
      RPCKind.allCases
    )
    @available(gRPCSwift 2.0, *)
    func explodedClientMethodSignature(access: AccessModifier, kind: RPCKind) {
      let decl: FunctionSignatureDescription = .clientMethodExploded(
        accessLevel: access,
        name: "foo",
        input: "Input",
        output: "Output",
        streamingInput: kind.streamsInput,
        streamingOutput: kind.streamsOutput
      )

      let expected: String
      switch kind {
      case .unary:
        expected = """
          \(access) func foo<Result>(
            _ message: Input,
            metadata: GRPCCore.Metadata = [:],
            options: GRPCCore.CallOptions = .defaults,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.ClientResponse<Output>) async throws -> Result = { response in
              try response.message
            }
          ) async throws -> Result where Result: Sendable
          """
      case .clientStreaming:
        expected = """
          \(access) func foo<Result>(
            metadata: GRPCCore.Metadata = [:],
            options: GRPCCore.CallOptions = .defaults,
            requestProducer producer: @Sendable @escaping (GRPCCore.RPCWriter<Input>) async throws -> Void,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.ClientResponse<Output>) async throws -> Result = { response in
              try response.message
            }
          ) async throws -> Result where Result: Sendable
          """
      case .serverStreaming:
        expected = """
          \(access) func foo<Result>(
            _ message: Input,
            metadata: GRPCCore.Metadata = [:],
            options: GRPCCore.CallOptions = .defaults,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.StreamingClientResponse<Output>) async throws -> Result
          ) async throws -> Result where Result: Sendable
          """
      case .bidirectionalStreaming:
        expected = """
          \(access) func foo<Result>(
            metadata: GRPCCore.Metadata = [:],
            options: GRPCCore.CallOptions = .defaults,
            requestProducer producer: @Sendable @escaping (GRPCCore.RPCWriter<Input>) async throws -> Void,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.StreamingClientResponse<Output>) async throws -> Result
          ) async throws -> Result where Result: Sendable
          """
      }

      #expect(render(.function(signature: decl)) == expected)
    }

    @Test(
      "func foo<Result>(_:metadata:options:onResponse:) -> Result (exploded body)",
      arguments: [true, false]
    )
    @available(gRPCSwift 2.0, *)
    func explodedClientMethodBody(streamingInput: Bool) {
      let blocks: [CodeBlock] = .clientMethodExploded(
        name: "foo",
        input: "Input",
        streamingInput: streamingInput
      )

      let expected: String
      if streamingInput {
        expected = """
          let request = GRPCCore.StreamingClientRequest<Input>(
            metadata: metadata,
            producer: producer
          )
          return try await self.foo(
            request: request,
            options: options,
            onResponse: handleResponse
          )
          """

      } else {
        expected = """
          let request = GRPCCore.ClientRequest<Input>(
            message: message,
            metadata: metadata
          )
          return try await self.foo(
            request: request,
            options: options,
            onResponse: handleResponse
          )
          """
      }

      #expect(render(blocks) == expected)
    }

    @Test("extension Foo_ClientProtocol { ... } (exploded)", arguments: AccessModifier.allCases)
    @available(gRPCSwift 2.0, *)
    func explodedClientMethodExtension(access: AccessModifier) {
      let decl: ExtensionDescription = .explodedClientMethods(
        accessLevel: access,
        on: "Foo_ClientProtocol",
        methods: [
          .init(
            documentation: "/// Some docs",
            name: MethodName(identifyingName: "Bar", typeName: "Bar", functionName: "bar"),
            isInputStreaming: false,
            isOutputStreaming: true,
            inputType: "Input",
            outputType: "Output"
          )
        ]
      )

      let expected = """
        extension Foo_ClientProtocol {
          /// Call the "Bar" method.
          ///
          /// > Source IDL Documentation:
          /// >
          /// > Some docs
          ///
          /// - Parameters:
          ///   - message: request message to send.
          ///   - metadata: Additional metadata to send, defaults to empty.
          ///   - options: Options to apply to this RPC, defaults to `.defaults`.
          ///   - handleResponse: A closure which handles the response, the result of which is
          ///       returned to the caller. Returning from the closure will cancel the RPC if it
          ///       hasn't already finished.
          /// - Returns: The result of `handleResponse`.
          \(access) func bar<Result>(
            _ message: Input,
            metadata: GRPCCore.Metadata = [:],
            options: GRPCCore.CallOptions = .defaults,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.StreamingClientResponse<Output>) async throws -> Result
          ) async throws -> Result where Result: Sendable {
            let request = GRPCCore.ClientRequest<Input>(
              message: message,
              metadata: metadata
            )
            return try await self.bar(
              request: request,
              options: options,
              onResponse: handleResponse
            )
          }
        }
        """

      #expect(render(.extension(decl)) == expected)
    }

    @Test(
      "func foo(request:serializer:deserializer:options:onResponse:) (client method impl.)",
      arguments: AccessModifier.allCases
    )
    @available(gRPCSwift 2.0, *)
    func clientMethodImplementation(access: AccessModifier) {
      let decl: FunctionDescription = .clientMethod(
        accessLevel: access,
        name: "foo",
        input: "Input",
        output: "Output",
        serviceEnum: "BarService",
        methodEnum: "Foo",
        streamingInput: false,
        streamingOutput: false
      )

      let expected = """
        \(access) func foo<Result>(
          request: GRPCCore.ClientRequest<Input>,
          serializer: some GRPCCore.MessageSerializer<Input>,
          deserializer: some GRPCCore.MessageDeserializer<Output>,
          options: GRPCCore.CallOptions = .defaults,
          onResponse handleResponse: @Sendable @escaping (GRPCCore.ClientResponse<Output>) async throws -> Result = { response in
            try response.message
          }
        ) async throws -> Result where Result: Sendable {
          try await self.client.unary(
            request: request,
            descriptor: BarService.Method.Foo.descriptor,
            serializer: serializer,
            deserializer: deserializer,
            options: options,
            onResponse: handleResponse
          )
        }
        """

      #expect(render(.function(decl)) == expected)
    }

    @Test("struct FooClient: Foo_ClientProtocol { ... }", arguments: AccessModifier.allCases)
    @available(gRPCSwift 2.0, *)
    func client(access: AccessModifier) {
      let decl: StructDescription = .client(
        accessLevel: access,
        name: "FooClient",
        serviceEnum: "BarService",
        clientProtocol: "Foo_ClientProtocol",
        methods: [
          .init(
            documentation: "/// Unary docs",
            name: MethodName(
              identifyingName: "Unary",
              typeName: "Unary",
              functionName: "unary"
            ),
            isInputStreaming: false,
            isOutputStreaming: false,
            inputType: "Input",
            outputType: "Output"
          ),
          .init(
            documentation: "/// ClientStreaming docs",
            name: MethodName(
              identifyingName: "ClientStreaming",
              typeName: "ClientStreaming",
              functionName: "clientStreaming"
            ),

            isInputStreaming: true,
            isOutputStreaming: false,
            inputType: "Input",
            outputType: "Output"
          ),
          .init(
            documentation: "/// ServerStreaming docs",
            name: MethodName(
              identifyingName: "ServerStreaming",
              typeName: "ServerStreaming",
              functionName: "serverStreaming"
            ),
            isInputStreaming: false,
            isOutputStreaming: true,
            inputType: "Input",
            outputType: "Output"
          ),
          .init(
            documentation: "/// BidiStreaming docs",
            name: MethodName(
              identifyingName: "BidiStreaming",
              typeName: "BidiStreaming",
              functionName: "bidiStreaming"
            ),
            isInputStreaming: true,
            isOutputStreaming: true,
            inputType: "Input",
            outputType: "Output"
          ),
        ]
      )

      let expected = """
        \(access) struct FooClient<Transport>: Foo_ClientProtocol where Transport: GRPCCore.ClientTransport {
          private let client: GRPCCore.GRPCClient<Transport>

          /// Creates a new client wrapping the provided `GRPCCore.GRPCClient`.
          ///
          /// - Parameters:
          ///   - client: A `GRPCCore.GRPCClient` providing a communication channel to the service.
          \(access) init(wrapping client: GRPCCore.GRPCClient<Transport>) {
            self.client = client
          }

          /// Call the "Unary" method.
          ///
          /// > Source IDL Documentation:
          /// >
          /// > Unary docs
          ///
          /// - Parameters:
          ///   - request: A request containing a single `Input` message.
          ///   - serializer: A serializer for `Input` messages.
          ///   - deserializer: A deserializer for `Output` messages.
          ///   - options: Options to apply to this RPC.
          ///   - handleResponse: A closure which handles the response, the result of which is
          ///       returned to the caller. Returning from the closure will cancel the RPC if it
          ///       hasn't already finished.
          /// - Returns: The result of `handleResponse`.
          \(access) func unary<Result>(
            request: GRPCCore.ClientRequest<Input>,
            serializer: some GRPCCore.MessageSerializer<Input>,
            deserializer: some GRPCCore.MessageDeserializer<Output>,
            options: GRPCCore.CallOptions = .defaults,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.ClientResponse<Output>) async throws -> Result = { response in
              try response.message
            }
          ) async throws -> Result where Result: Sendable {
            try await self.client.unary(
              request: request,
              descriptor: BarService.Method.Unary.descriptor,
              serializer: serializer,
              deserializer: deserializer,
              options: options,
              onResponse: handleResponse
            )
          }

          /// Call the "ClientStreaming" method.
          ///
          /// > Source IDL Documentation:
          /// >
          /// > ClientStreaming docs
          ///
          /// - Parameters:
          ///   - request: A streaming request producing `Input` messages.
          ///   - serializer: A serializer for `Input` messages.
          ///   - deserializer: A deserializer for `Output` messages.
          ///   - options: Options to apply to this RPC.
          ///   - handleResponse: A closure which handles the response, the result of which is
          ///       returned to the caller. Returning from the closure will cancel the RPC if it
          ///       hasn't already finished.
          /// - Returns: The result of `handleResponse`.
          \(access) func clientStreaming<Result>(
            request: GRPCCore.StreamingClientRequest<Input>,
            serializer: some GRPCCore.MessageSerializer<Input>,
            deserializer: some GRPCCore.MessageDeserializer<Output>,
            options: GRPCCore.CallOptions = .defaults,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.ClientResponse<Output>) async throws -> Result = { response in
              try response.message
            }
          ) async throws -> Result where Result: Sendable {
            try await self.client.clientStreaming(
              request: request,
              descriptor: BarService.Method.ClientStreaming.descriptor,
              serializer: serializer,
              deserializer: deserializer,
              options: options,
              onResponse: handleResponse
            )
          }

          /// Call the "ServerStreaming" method.
          ///
          /// > Source IDL Documentation:
          /// >
          /// > ServerStreaming docs
          ///
          /// - Parameters:
          ///   - request: A request containing a single `Input` message.
          ///   - serializer: A serializer for `Input` messages.
          ///   - deserializer: A deserializer for `Output` messages.
          ///   - options: Options to apply to this RPC.
          ///   - handleResponse: A closure which handles the response, the result of which is
          ///       returned to the caller. Returning from the closure will cancel the RPC if it
          ///       hasn't already finished.
          /// - Returns: The result of `handleResponse`.
          \(access) func serverStreaming<Result>(
            request: GRPCCore.ClientRequest<Input>,
            serializer: some GRPCCore.MessageSerializer<Input>,
            deserializer: some GRPCCore.MessageDeserializer<Output>,
            options: GRPCCore.CallOptions = .defaults,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.StreamingClientResponse<Output>) async throws -> Result
          ) async throws -> Result where Result: Sendable {
            try await self.client.serverStreaming(
              request: request,
              descriptor: BarService.Method.ServerStreaming.descriptor,
              serializer: serializer,
              deserializer: deserializer,
              options: options,
              onResponse: handleResponse
            )
          }

          /// Call the "BidiStreaming" method.
          ///
          /// > Source IDL Documentation:
          /// >
          /// > BidiStreaming docs
          ///
          /// - Parameters:
          ///   - request: A streaming request producing `Input` messages.
          ///   - serializer: A serializer for `Input` messages.
          ///   - deserializer: A deserializer for `Output` messages.
          ///   - options: Options to apply to this RPC.
          ///   - handleResponse: A closure which handles the response, the result of which is
          ///       returned to the caller. Returning from the closure will cancel the RPC if it
          ///       hasn't already finished.
          /// - Returns: The result of `handleResponse`.
          \(access) func bidiStreaming<Result>(
            request: GRPCCore.StreamingClientRequest<Input>,
            serializer: some GRPCCore.MessageSerializer<Input>,
            deserializer: some GRPCCore.MessageDeserializer<Output>,
            options: GRPCCore.CallOptions = .defaults,
            onResponse handleResponse: @Sendable @escaping (GRPCCore.StreamingClientResponse<Output>) async throws -> Result
          ) async throws -> Result where Result: Sendable {
            try await self.client.bidirectionalStreaming(
              request: request,
              descriptor: BarService.Method.BidiStreaming.descriptor,
              serializer: serializer,
              deserializer: deserializer,
              options: options,
              onResponse: handleResponse
            )
          }
        }
        """

      #expect(render(.struct(decl)) == expected)
    }
  }
}