grpc-swift/Tests/GRPCCoreTests/Configuration/ServiceConfigCodingTests.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 Foundation
import GRPCCore
import SwiftProtobuf
import XCTest

@available(gRPCSwift 2.0, *)
final class ServiceConfigCodingTests: XCTestCase {
  private let encoder = JSONEncoder()
  private let decoder = JSONDecoder()

  private func testDecodeThrowsRuntimeError<D: Decodable>(json: String, as: D.Type) throws {
    XCTAssertThrowsError(
      ofType: RuntimeError.self,
      try self.decoder.decode(D.self, from: Data(json.utf8))
    ) { error in
      XCTAssertEqual(error.code, .invalidArgument)
    }
  }

  private func testRoundTripEncodeDecode<C: Codable & Equatable>(_ value: C) throws {
    let encoded = try self.encoder.encode(value)
    let decoded = try self.decoder.decode(C.self, from: encoded)
    XCTAssertEqual(decoded, value)
  }

  func testDecodeRetryThrottlingPolicy() throws {
    let json = """
      {
        "maxTokens": 10,
        "tokenRatio": 0.5
      }
      """

    let expected = try ServiceConfig.RetryThrottling(maxTokens: 10, tokenRatio: 0.5)
    let policy = try self.decoder.decode(
      ServiceConfig.RetryThrottling.self,
      from: Data(json.utf8)
    )

    XCTAssertEqual(policy, expected)
  }

  func testEncodeDecodeRetryThrottlingPolicy() throws {
    let policy = try ServiceConfig.RetryThrottling(maxTokens: 10, tokenRatio: 0.5)
    try self.testRoundTripEncodeDecode(policy)
  }

  func testDecodeRetryThrottlingPolicyWithInvalidTokens() throws {
    let inputs = ["0", "-1", "-42"]
    for input in inputs {
      let json = """
        {
          "maxTokens": \(input),
          "tokenRatio": 0.5
        }
        """

      try self.testDecodeThrowsRuntimeError(
        json: json,
        as: ServiceConfig.RetryThrottling.self
      )
    }
  }

  func testDecodeRetryThrottlingPolicyWithInvalidTokenRatio() throws {
    let inputs = ["0.0", "-1.0", "-42"]
    for input in inputs {
      let json = """
        {
          "maxTokens": 10,
          "tokenRatio": \(input)
        }
        """

      try self.testDecodeThrowsRuntimeError(
        json: json,
        as: ServiceConfig.RetryThrottling.self
      )
    }
  }

  func testDecodePickFirstPolicy() throws {
    let inputs: [(String, ServiceConfig.LoadBalancingConfig.PickFirst)] = [
      (#"{"shuffleAddressList": true}"#, .init(shuffleAddressList: true)),
      (#"{"shuffleAddressList": false}"#, .init(shuffleAddressList: false)),
      (#"{}"#, .init(shuffleAddressList: false)),
    ]

    for (input, expected) in inputs {
      let pickFirst = try self.decoder.decode(
        ServiceConfig.LoadBalancingConfig.PickFirst.self,
        from: Data(input.utf8)
      )

      XCTAssertEqual(pickFirst, expected)
    }
  }

  func testEncodePickFirstPolicy() throws {
    let inputs: [(ServiceConfig.LoadBalancingConfig.PickFirst, String)] = [
      (.init(shuffleAddressList: true), #"{"shuffleAddressList":true}"#),
      (.init(shuffleAddressList: false), #"{"shuffleAddressList":false}"#),
    ]

    for (input, expected) in inputs {
      let encoded = try self.encoder.encode(input)
      XCTAssertEqual(String(decoding: encoded, as: UTF8.self), expected)
    }
  }

  func testDecodeRoundRobinPolicy() throws {
    let json = "{}"
    let policy = try self.decoder.decode(
      ServiceConfig.LoadBalancingConfig.RoundRobin.self,
      from: Data(json.utf8)
    )
    XCTAssertEqual(policy, ServiceConfig.LoadBalancingConfig.RoundRobin())
  }

  func testEncodeRoundRobinPolicy() throws {
    let policy = ServiceConfig.LoadBalancingConfig.RoundRobin()
    let encoded = try self.encoder.encode(policy)
    XCTAssertEqual(String(decoding: encoded, as: UTF8.self), "{}")
  }

  func testDecodeLoadBalancingConfiguration() throws {
    let inputs: [(String, ServiceConfig.LoadBalancingConfig)] = [
      (#"{"round_robin": {}}"#, .roundRobin),
      (#"{"pick_first": {}}"#, .pickFirst(shuffleAddressList: false)),
      (#"{"pick_first": {"shuffleAddressList": false}}"#, .pickFirst(shuffleAddressList: false)),
    ]

    for (input, expected) in inputs {
      let decoded = try self.decoder.decode(
        ServiceConfig.LoadBalancingConfig.self,
        from: Data(input.utf8)
      )
      XCTAssertEqual(decoded, expected)
    }
  }

  func testEncodeLoadBalancingConfiguration() throws {
    let inputs: [(ServiceConfig.LoadBalancingConfig, String)] = [
      (.roundRobin, #"{"round_robin":{}}"#),
      (.pickFirst(shuffleAddressList: false), #"{"pick_first":{"shuffleAddressList":false}}"#),
    ]

    for (input, expected) in inputs {
      let encoded = try self.encoder.encode(input)
      XCTAssertEqual(String(decoding: encoded, as: UTF8.self), expected)
    }
  }

  func testDecodeServiceConfigFromProtoJSON() throws {
    let serviceConfig = Grpc_ServiceConfig_ServiceConfig.with {
      $0.methodConfig = [
        Grpc_ServiceConfig_MethodConfig.with {
          $0.name = [
            Grpc_ServiceConfig_MethodConfig.Name.with {
              $0.service = "foo.Foo"
              $0.method = "Bar"
            }
          ]
          $0.timeout = .with { $0.seconds = 1 }
          $0.maxRequestMessageBytes = 123
          $0.maxResponseMessageBytes = 456
        }

      ]
      $0.loadBalancingConfig = [
        .with { $0.roundRobin = .init() },
        .with { $0.pickFirst = .with { $0.shuffleAddressList = true } },
      ]
      $0.retryThrottling = .with {
        $0.maxTokens = 10
        $0.tokenRatio = 0.1
      }
    }

    let encoded = try serviceConfig.jsonUTF8Data()
    let decoded = try self.decoder.decode(ServiceConfig.self, from: encoded)

    let expected = ServiceConfig(
      methodConfig: [
        MethodConfig(
          names: [
            MethodConfig.Name(service: "foo.Foo", method: "Bar")
          ],
          timeout: .seconds(1),
          maxRequestMessageBytes: 123,
          maxResponseMessageBytes: 456
        )
      ],
      loadBalancingConfig: [
        .roundRobin,
        .pickFirst(shuffleAddressList: true),
      ],
      retryThrottling: try ServiceConfig.RetryThrottling(maxTokens: 10, tokenRatio: 0.1)
    )

    XCTAssertEqual(decoded, expected)
  }

  func testEncodeAndDecodeServiceConfig() throws {
    let serviceConfig = ServiceConfig(
      methodConfig: [
        MethodConfig(
          names: [
            MethodConfig.Name(service: "echo.Echo", method: "Get"),
            MethodConfig.Name(service: "greeter.HelloWorld"),
          ],
          timeout: .seconds(42),
          maxRequestMessageBytes: 2048,
          maxResponseMessageBytes: 4096,
          executionPolicy: .hedge(
            HedgingPolicy(
              maxAttempts: 3,
              hedgingDelay: .seconds(1),
              nonFatalStatusCodes: [.aborted]
            )
          )
        ),
        MethodConfig(
          names: [
            MethodConfig.Name(service: "echo.Echo", method: "Update")
          ],
          timeout: .seconds(300),
          maxRequestMessageBytes: 10_000
        ),
      ],
      loadBalancingConfig: [
        .pickFirst(shuffleAddressList: true),
        .roundRobin,
      ],
      retryThrottling: try ServiceConfig.RetryThrottling(maxTokens: 10, tokenRatio: 3.141)
    )

    try self.testRoundTripEncodeDecode(serviceConfig)
  }
}