Merge branch 'main' into metadata-description

Author: glbrntt

Sources/GRPCCore/Call/Client/ClientResponse.swift

@@ -363,7 +363,7 @@ extension StreamingClientResponse {
 
   /// Returns the messages received from the server.
   ///
-  /// For rejected RPCs the `RPCAsyncSequence` throws a `RPCError``.
+  /// For rejected RPCs (in other words, where ``accepted`` is `failure`), the `RPCAsyncSequence` throws a ``RPCError``.
   public var messages: RPCAsyncSequence<Message, any Error> {
     switch self.accepted {
     case let .success(contents):
@@ -382,4 +382,19 @@ extension StreamingClientResponse {
       return RPCAsyncSequence.throwing(error)
     }
   }
+
+  /// Returns the body parts (i.e. `messages` and `trailingMetadata`) returned from the server.
+  ///
+  /// For rejected RPCs (in other words, where ``accepted`` is `failure`), the `RPCAsyncSequence` throws a ``RPCError``.
+  public var bodyParts: RPCAsyncSequence<Contents.BodyPart, any Error> {
+    switch self.accepted {
+    case let .success(contents):
+      return contents.bodyParts
+
+    case let .failure(error):
+      return RPCAsyncSequence.throwing(error)
+    }
+  }
 }
+
+extension StreamingClientResponse.Contents.BodyPart: Equatable where Message: Equatable {}

Tests/GRPCCoreTests/Call/Client/ClientResponseTests.swift

@@ -53,7 +53,7 @@ final class ClientResponseTests: XCTestCase {
     XCTAssertEqual(response.trailingMetadata, ["bar": "baz"])
   }
 
-  func testAcceptedStreamResponseConvenienceMethods() async throws {
+  func testAcceptedStreamResponseConvenienceMethods_Messages() async throws {
     let response = StreamingClientResponse(
       of: String.self,
       metadata: ["foo": "bar"],
@@ -73,6 +73,29 @@ final class ClientResponseTests: XCTestCase {
     XCTAssertEqual(messages, ["foo", "bar", "baz"])
   }
 
+  func testAcceptedStreamResponseConvenienceMethods_BodyParts() async throws {
+    let response = StreamingClientResponse(
+      of: String.self,
+      metadata: ["foo": "bar"],
+      bodyParts: RPCAsyncSequence(
+        wrapping: AsyncThrowingStream {
+          $0.yield(.message("foo"))
+          $0.yield(.message("bar"))
+          $0.yield(.message("baz"))
+          $0.yield(.trailingMetadata(["baz": "baz"]))
+          $0.finish()
+        }
+      )
+    )
+
+    XCTAssertEqual(response.metadata, ["foo": "bar"])
+    let bodyParts = try await response.bodyParts.collect()
+    XCTAssertEqual(
+      bodyParts,
+      [.message("foo"), .message("bar"), .message("baz"), .trailingMetadata(["baz": "baz"])]
+    )
+  }
+
   func testRejectedStreamResponseConvenienceMethods() async throws {
     let error = RPCError(code: .aborted, message: "error message", metadata: ["bar": "baz"])
     let response = StreamingClientResponse(of: String.self, error: error)
@@ -83,6 +106,11 @@ final class ClientResponseTests: XCTestCase {
     } errorHandler: {
       XCTAssertEqual($0, error)
     }
+    await XCTAssertThrowsRPCErrorAsync {
+      try await response.bodyParts.collect()
+    } errorHandler: {
+      XCTAssertEqual($0, error)
+    }
   }
 
   func testStreamToSingleConversionForValidStream() async throws {

dev/format.sh

@@ -61,6 +61,7 @@ if "$lint"; then
     "${repo}/Tests" \
     "${repo}/Examples" \
     "${repo}/IntegrationTests/Benchmarks/Benchmarks/GRPCSwiftBenchmark" \
+    "${repo}/dev" \
     && SWIFT_FORMAT_RC=$? || SWIFT_FORMAT_RC=$?
 
   if [[ "${SWIFT_FORMAT_RC}" -ne 0 ]]; then
@@ -80,6 +81,7 @@ elif "$format"; then
     "${repo}/Tests" \
     "${repo}/Examples" \
     "${repo}/IntegrationTests/Benchmarks/Benchmarks/GRPCSwiftBenchmark" \
+    "${repo}/dev" \
     && SWIFT_FORMAT_RC=$? || SWIFT_FORMAT_RC=$?
 
   if [[ "${SWIFT_FORMAT_RC}" -ne 0 ]]; then

dev/grpc-dev-tool/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

dev/grpc-dev-tool/Package.swift

@@ -0,0 +1,36 @@
+// swift-tools-version:6.0
+/*
+ * Copyright 2025, 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 PackageDescription
+
+let package = Package(
+  name: "grpc-dev-tool",
+  platforms: [.macOS(.v15)],
+  dependencies: [
+    .package(path: "../.."),
+    .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.5.0"),
+  ],
+  targets: [
+    .executableTarget(
+      name: "grpc-dev-tool",
+      dependencies: [
+        .product(name: "GRPCCodeGen", package: "grpc-swift"),
+        .product(name: "ArgumentParser", package: "swift-argument-parser"),
+      ]
+    )
+  ]
+)

dev/grpc-dev-tool/Sources/grpc-dev-tool/GRPCDevTool.swift

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2025, 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 ArgumentParser
+
+@main
+struct GRPCDevTool: AsyncParsableCommand {
+  static let configuration = CommandConfiguration(
+    commandName: "grpc-dev-tool",
+    subcommands: [GenerateJSON.self]
+  )
+}

dev/grpc-dev-tool/Sources/grpc-dev-tool/Subcommands/GenerateJSON/GRPCCodeGen+Conversions.swift

@@ -0,0 +1,75 @@
+/*
+ * Copyright 2025, 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 GRPCCodeGen
+
+/// Creates a `ServiceDescriptor` from a JSON `ServiceSchema`.
+extension ServiceDescriptor {
+  init(_ service: ServiceSchema) {
+    self.init(
+      documentation: "",
+      name: .init(
+        identifyingName: service.name,
+        typeName: service.name,
+        propertyName: service.name
+      ),
+      methods: service.methods.map {
+        MethodDescriptor($0)
+      }
+    )
+  }
+}
+
+extension MethodDescriptor {
+  /// Creates a `MethodDescriptor` from a JSON `ServiceSchema.Method`.
+  init(_ method: ServiceSchema.Method) {
+    self.init(
+      documentation: "",
+      name: .init(
+        identifyingName: method.name,
+        typeName: method.name,
+        functionName: method.name
+      ),
+      isInputStreaming: method.kind.streamsInput,
+      isOutputStreaming: method.kind.streamsOutput,
+      inputType: method.input,
+      outputType: method.output
+    )
+  }
+}
+
+extension CodeGenerator.Config.AccessLevel {
+  init(_ level: GeneratorConfig.AccessLevel) {
+    switch level {
+    case .internal:
+      self = .internal
+    case .package:
+      self = .package
+    }
+  }
+}
+
+extension CodeGenerator.Config {
+  init(_ config: GeneratorConfig) {
+    self.init(
+      accessLevel: CodeGenerator.Config.AccessLevel(config.accessLevel),
+      accessLevelOnImports: config.accessLevelOnImports,
+      client: config.generateClient,
+      server: config.generateServer,
+      indentation: 2
+    )
+  }
+}

dev/grpc-dev-tool/Sources/grpc-dev-tool/Subcommands/GenerateJSON/GRPCDevUtils+GenerateJSON.swift

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2025, 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 ArgumentParser
+import Foundation
+
+struct GenerateJSON: ParsableCommand {
+  static let configuration = CommandConfiguration(
+    commandName: "generate-json",
+    subcommands: [Generate.self, DumpConfig.self],
+    defaultSubcommand: Generate.self
+  )
+}
+
+extension GenerateJSON {
+  struct Generate: ParsableCommand {
+    @Argument(help: "The path to a JSON input file.")
+    var input: String
+
+    func run() throws {
+      // Decode the input file.
+      let url = URL(filePath: self.input)
+      let data = try Data(contentsOf: url)
+      let json = JSONDecoder()
+      let config = try json.decode(JSONCodeGeneratorRequest.self, from: data)
+
+      // Generate the output and dump it to stdout.
+      let generator = JSONCodeGenerator()
+      let sourceFile = try generator.generate(request: config)
+      print(sourceFile.contents)
+    }
+  }
+}
+
+extension GenerateJSON {
+  struct DumpConfig: ParsableCommand {
+    func run() throws {
+      // Create a request for the code generator using all four RPC kinds.
+      var request = JSONCodeGeneratorRequest(
+        service: ServiceSchema(name: "Echo", methods: []),
+        config: .defaults
+      )
+
+      let methodNames = ["get", "collect", "expand", "update"]
+      let methodKinds: [ServiceSchema.Method.Kind] = [
+        .unary,
+        .clientStreaming,
+        .serverStreaming,
+        .bidiStreaming,
+      ]
+
+      for (name, kind) in zip(methodNames, methodKinds) {
+        let method = ServiceSchema.Method(
+          name: name,
+          input: "EchoRequest",
+          output: "EchoResponse",
+          kind: kind
+        )
+        request.service.methods.append(method)
+      }
+
+      // Encoding the config to JSON and dump it to stdout.
+      let encoder = JSONEncoder()
+      encoder.outputFormatting = [.prettyPrinted]
+      let data = try encoder.encode(request)
+      let json = String(decoding: data, as: UTF8.self)
+      print(json)
+    }
+  }
+}