[Runtime] Async bodies + swift-http-types adoption

Package.swift

@@ -37,7 +37,7 @@ let package = Package(
         )
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-http-types", branch: "main"),
+        .package(url: "https://github.com/apple/swift-http-types", from: "1.0.0"),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
     ],
     targets: [

Sources/OpenAPIRuntime/Conversion/Converter+Client.swift

@@ -136,6 +136,34 @@ extension Converter {
         )
     }
 
+    //    | client | set | request body | urlEncodedForm | codable | optional | setOptionalRequestBodyAsURLEncodedForm |
+    public func setOptionalRequestBodyAsURLEncodedForm<T: Encodable>(
+        _ value: T,
+        headerFields: inout HTTPFields,
+        contentType: String
+    ) throws -> HTTPBody? {
+        try setOptionalRequestBody(
+            value,
+            headerFields: &headerFields,
+            contentType: contentType,
+            convert: convertBodyCodableToURLFormData
+        )
+    }
+
+    //    | client | set | request body | urlEncodedForm | codable | required | setRequiredRequestBodyAsURLEncodedForm |
+    public func setRequiredRequestBodyAsURLEncodedForm<T: Encodable>(
+        _ value: T,
+        headerFields: inout HTTPFields,
+        contentType: String
+    ) throws -> HTTPBody {
+        try setRequiredRequestBody(
+            value,
+            headerFields: &headerFields,
+            contentType: contentType,
+            convert: convertBodyCodableToURLFormData
+        )
+    }
+
     //    | client | get | response body | JSON | required | getResponseBodyAsJSON |
     public func getResponseBodyAsJSON<T: Decodable, C>(
         _ type: T.Type,

Sources/OpenAPIRuntime/Conversion/Converter+Server.swift

@@ -236,6 +236,34 @@ extension Converter {
         )
     }
 
+    //    | server | get | request body | URLEncodedForm | codable | optional | getOptionalRequestBodyAsURLEncodedForm |
+    public func getOptionalRequestBodyAsURLEncodedForm<T: Decodable, C>(
+        _ type: T.Type,
+        from data: HTTPBody?,
+        transforming transform: (T) -> C
+    ) async throws -> C? {
+        try await getOptionalBufferingRequestBody(
+            type,
+            from: data,
+            transforming: transform,
+            convert: convertURLEncodedFormToCodable
+        )
+    }
+
+    //    | server | get | request body | URLEncodedForm | codable | required | getRequiredRequestBodyAsURLEncodedForm |
+    public func getRequiredRequestBodyAsURLEncodedForm<T: Decodable, C>(
+        _ type: T.Type,
+        from data: HTTPBody?,
+        transforming transform: (T) -> C
+    ) async throws -> C {
+        try await getRequiredBufferingRequestBody(
+            type,
+            from: data,
+            transforming: transform,
+            convert: convertURLEncodedFormToCodable
+        )
+    }
+
     //    | server | set | response body | JSON | required | setResponseBodyAsJSON |
     public func setResponseBodyAsJSON<T: Encodable>(
         _ value: T,

Sources/OpenAPIRuntime/Conversion/CurrencyExtensions.swift

@@ -49,7 +49,7 @@ extension HTTPField.Name {
     /// - Parameter name: A field name.
     /// - Throws: If the name isn't a valid field name.
     init(validated name: String) throws {
-        guard let fieldName = Self.init(name) else {
+        guard let fieldName = Self(name) else {
             throw RuntimeError.invalidHeaderFieldName(name)
         }
         self = fieldName
@@ -171,7 +171,44 @@ extension Converter {
         _ value: T
     ) throws -> HTTPBody {
         let data = try encoder.encode(value)
-        return HTTPBody(data: data)
+        return HTTPBody(data)
+    }
+
+    /// Returns a value decoded from a URL-encoded form body.
+    /// - Parameter body: The body containing the raw URL-encoded form bytes.
+    /// - Returns: A decoded value.
+    func convertURLEncodedFormToCodable<T: Decodable>(
+        _ body: HTTPBody
+    ) async throws -> T {
+        let decoder = URIDecoder(
+            configuration: .init(
+                style: .form,
+                explode: true,
+                spaceEscapingCharacter: .plus,
+                dateTranscoder: configuration.dateTranscoder
+            )
+        )
+        let data = try await Data(collecting: body, upTo: .max)
+        let uriString = Substring(decoding: data, as: UTF8.self)
+        return try decoder.decode(T.self, from: uriString)
+    }
+
+    /// Returns a URL-encoded form string for the provided encodable value.
+    /// - Parameter value: The value to encode.
+    /// - Returns: The raw URL-encoded form body.
+    func convertBodyCodableToURLFormData<T: Encodable>(
+        _ value: T
+    ) throws -> HTTPBody {
+        let encoder = URIEncoder(
+            configuration: .init(
+                style: .form,
+                explode: true,
+                spaceEscapingCharacter: .plus,
+                dateTranscoder: configuration.dateTranscoder
+            )
+        )
+        let encodedString = try encoder.encode(value, forKey: "")
+        return HTTPBody(encodedString)
     }
 
     /// Returns a JSON string for the provided encodable value.

Sources/OpenAPIRuntime/Interface/HTTPBody.swift

@@ -167,6 +167,19 @@ public final class HTTPBody: @unchecked Sendable {
     /// A flag indicating whether an iterator has already been created.
     private var locked_iteratorCreated: Bool = false
 
+    /// Runs the provided closure in a scope where the `iteratorCreated` value
+    /// is locked and available both for reading and writing.
+    /// - Parameter work: A closure that is provided with a read-write reference
+    ///   to the `iteratorCreated` value.
+    /// - Returns: Whatever value the closure returned.
+    private func withIteratorCreated<R>(_ work: (inout Bool) throws -> R) rethrows -> R {
+        lock.lock()
+        defer {
+            lock.unlock()
+        }
+        return try work(&locked_iteratorCreated)
+    }
+
     /// Creates a new body.
     /// - Parameters:
     ///   - sequence: The input sequence providing the byte chunks.
@@ -325,7 +338,7 @@ extension HTTPBody {
     /// Creates a new body with the provided async sequence.
     /// - Parameters:
     ///   - sequence: An async sequence that provides the byte chunks.
-    ///   - length: The total lenght of the body.
+    ///   - length: The total length of the body.
     ///   - iterationBehavior: The iteration behavior of the sequence, which
     ///     indicates whether it can be iterated multiple times.
     @inlinable public convenience init<Bytes: AsyncSequence>(
@@ -343,7 +356,7 @@ extension HTTPBody {
     /// Creates a new body with the provided async sequence of byte sequences.
     /// - Parameters:
     ///   - sequence: An async sequence that provides the byte chunks.
-    ///   - length: The total lenght of the body.
+    ///   - length: The total length of the body.
     ///   - iterationBehavior: The iteration behavior of the sequence, which
     ///     indicates whether it can be iterated multiple times.
     @inlinable public convenience init<Bytes: AsyncSequence>(
@@ -366,16 +379,14 @@ extension HTTPBody: AsyncSequence {
     public typealias AsyncIterator = Iterator
     public func makeAsyncIterator() -> AsyncIterator {
         if iterationBehavior == .single {
-            lock.lock()
-            defer {
-                lock.unlock()
-            }
-            guard !locked_iteratorCreated else {
-                fatalError(
-                    "OpenAPIRuntime.HTTPBody attempted to create a second iterator, but the underlying sequence is only safe to be iterated once."
-                )
+            withIteratorCreated { iteratorCreated in
+                guard !iteratorCreated else {
+                    fatalError(
+                        "OpenAPIRuntime.HTTPBody attempted to create a second iterator, but the underlying sequence is only safe to be iterated once."
+                    )
+                }
+                iteratorCreated = true
             }
-            locked_iteratorCreated = true
         }
         return sequence.makeAsyncIterator()
     }
@@ -427,18 +438,14 @@ extension HTTPBody {
         // iterate a sequence for the second time, if it's only safe to be
         // iterated once.
         if iterationBehavior == .single {
-            try {
-                lock.lock()
-                defer {
-                    lock.unlock()
-                }
-                guard !locked_iteratorCreated else {
+            try withIteratorCreated { iteratorCreated in
+                guard !iteratorCreated else {
                     throw TooManyIterationsError()
                 }
-            }()
+            }
         }
 
-        var buffer = ByteChunk.init()
+        var buffer = ByteChunk()
         for try await chunk in self {
             guard buffer.count + chunk.count <= maxBytes else {
                 throw TooManyBytesError(maxBytes: maxBytes)
@@ -490,7 +497,7 @@ extension HTTPBody {
         length: Length
     ) {
         self.init(
-            ByteChunk.init(string),
+            ByteChunk(string),
             length: length
         )
     }
@@ -502,7 +509,7 @@ extension HTTPBody {
         _ string: some StringProtocol & Sendable
     ) {
         self.init(
-            ByteChunk.init(string),
+            ByteChunk(string),
             length: .known(string.count)
         )
     }
@@ -540,7 +547,7 @@ extension HTTPBody {
     /// Creates a new body with the provided async sequence of string chunks.
     /// - Parameters:
     ///   - sequence: An async sequence that provides the string chunks.
-    ///   - length: The total lenght of the body.
+    ///   - length: The total length of the body.
     ///   - iterationBehavior: The iteration behavior of the sequence, which
     ///     indicates whether it can be iterated multiple times.
     @inlinable public convenience init<Strings: AsyncSequence>(
@@ -567,7 +574,7 @@ extension HTTPBody.ByteChunk {
 
 extension String {
     /// Creates a string by accumulating the full body in-memory into a single buffer up to
-    /// the provided maximum number of bytes, converting it to string using the provided encoding.
+    /// the provided maximum number of bytes, converting it to string using UTF-8 encoding.
     /// - Parameters:
     ///   - body: The HTTP body to collect.
     ///   - maxBytes: The maximum number of bytes this method is allowed
@@ -610,13 +617,13 @@ extension HTTPBody {
 
     /// Creates a new body from the provided data chunk.
     /// - Parameter data: A single data chunk.
-    public convenience init(data: Data) {
+    public convenience init(_ data: Data) {
         self.init(ArraySlice(data))
     }
 }
 
 extension Data {
-    /// Creates a string by accumulating the full body in-memory into a single buffer up to
+    /// Creates a Data by accumulating the full body in-memory into a single buffer up to
     /// the provided maximum number of bytes and converting it to `Data`.
     /// - Parameters:
     ///   - body: The HTTP body to collect.

Sources/OpenAPIRuntime/Interface/ServerTransport.swift

@@ -111,7 +111,7 @@ public protocol ServerTransport {
     ///   - handler: A handler to be invoked when an HTTP request is received.
     ///   - method: An HTTP request method.
     ///   - path: A URL template for the path, for example `/pets/{petId}`.
-    /// - Important: The `path` can have mixed component, such
+    /// - Important: The `path` can have mixed components, such
     ///   as `/file/{name}.zip`.
     func register(
         _ handler: @Sendable @escaping (HTTPRequest, HTTPBody?, ServerRequestMetadata) async throws -> (

Tests/OpenAPIRuntimeTests/Conversion/Test_Converter+Client.swift

@@ -12,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 import XCTest
-@_spi(Generated)@testable import OpenAPIRuntime
+@_spi(Generated) import OpenAPIRuntime
 import HTTPTypes
 
 final class Test_ClientConverterExtensions: Test_Runtime {
@@ -170,8 +170,8 @@ final class Test_ClientConverterExtensions: Test_Runtime {
     }
 
     //    | client | set | request body | urlEncodedForm | codable | optional | setRequiredRequestBodyAsURLEncodedForm |
-    func test_setOptionalRequestBodyAsURLEncodedForm_codable() throws {
-        var headerFields: [HeaderField] = []
+    func test_setOptionalRequestBodyAsURLEncodedForm_codable() async throws {
+        var headerFields: HTTPFields = [:]
         let body = try converter.setOptionalRequestBodyAsURLEncodedForm(
             testStructDetailed,
             headerFields: &headerFields,
@@ -183,28 +183,28 @@ final class Test_ClientConverterExtensions: Test_Runtime {
             return
         }
 
-        XCTAssertEqualStringifiedData(body, testStructURLFormString)
+        try await XCTAssertEqualStringifiedData(body, testStructURLFormString)
         XCTAssertEqual(
             headerFields,
             [
-                .init(name: "content-type", value: "application/x-www-form-urlencoded")
+                .contentType: "application/x-www-form-urlencoded"
             ]
         )
     }
 
     //    | client | set | request body | urlEncodedForm | codable | required | setRequiredRequestBodyAsURLEncodedForm |
-    func test_setRequiredRequestBodyAsURLEncodedForm_codable() throws {
-        var headerFields: [HeaderField] = []
+    func test_setRequiredRequestBodyAsURLEncodedForm_codable() async throws {
+        var headerFields: HTTPFields = [:]
         let body = try converter.setRequiredRequestBodyAsURLEncodedForm(
             testStructDetailed,
             headerFields: &headerFields,
             contentType: "application/x-www-form-urlencoded"
         )
-        XCTAssertEqualStringifiedData(body, testStructURLFormString)
+        try await XCTAssertEqualStringifiedData(body, testStructURLFormString)
         XCTAssertEqual(
             headerFields,
             [
-                .init(name: "content-type", value: "application/x-www-form-urlencoded")
+                .contentType: "application/x-www-form-urlencoded"
             ]
         )
     }
@@ -213,7 +213,7 @@ final class Test_ClientConverterExtensions: Test_Runtime {
     func test_setOptionalRequestBodyAsBinary_data() async throws {
         var headerFields: HTTPFields = [:]
         let body = try converter.setOptionalRequestBodyAsBinary(
-            .init(data: testStringData),
+            .init(testStringData),
             headerFields: &headerFields,
             contentType: "application/octet-stream"
         )
@@ -247,7 +247,7 @@ final class Test_ClientConverterExtensions: Test_Runtime {
     func test_getResponseBodyAsJSON_codable() async throws {
         let value: TestPet = try await converter.getResponseBodyAsJSON(
             TestPet.self,
-            from: .init(data: testStructData),
+            from: .init(testStructData),
             transforming: { $0 }
         )
         XCTAssertEqual(value, testStruct)

Tests/OpenAPIRuntimeTests/Conversion/Test_Converter+Common.swift

@@ -12,12 +12,12 @@
 //
 //===----------------------------------------------------------------------===//
 import XCTest
-@_spi(Generated)@testable import OpenAPIRuntime
+@_spi(Generated) import OpenAPIRuntime
 import HTTPTypes
 
 extension HTTPField.Name {
     static var foo: Self {
-        .init("foo")!
+        Self("foo")!
     }
 }