Resolve ambiguity issue for the stream function, remove @deprecated marking from the original implementation, and make argument labels consistent. (#749)

aryan-25 · web-flow · commit 07536f6a4ee1 · 2024-07-03T16:14:47.000+01:00
diff --git a/Sources/AsyncHTTPClient/HTTPHandler.swift b/Sources/AsyncHTTPClient/HTTPHandler.swift
@@ -111,8 +111,8 @@ extension HTTPClient {
         ///     - length: Body size. If nil, `Transfer-Encoding` will automatically be set to `chunked`. Otherwise a `Content-Length`
         /// header is set with the given `length`.
         ///     - stream: Body chunk provider.
+        @_disfavoredOverload
         @preconcurrency
-        @available(*, deprecated, renamed: "stream(contentLength:bodyStream:)")
         public static func stream(length: Int? = nil, _ stream: @Sendable @escaping (StreamWriter) -> EventLoopFuture<Void>) -> Body {
             return Body(contentLength: length.flatMap { Int64($0) }, stream: stream)
         }
@@ -123,8 +123,8 @@ extension HTTPClient {
         ///     - contentLength: Body size. If nil, `Transfer-Encoding` will automatically be set to `chunked`. Otherwise a `Content-Length`
         /// header is set with the given `contentLength`.
         ///     - bodyStream: Body chunk provider.
-        public static func stream(contentLength: Int64? = nil, bodyStream: @Sendable @escaping (StreamWriter) -> EventLoopFuture<Void>) -> Body {
-            return Body(contentLength: contentLength, stream: bodyStream)
+        public static func stream(contentLength: Int64? = nil, _ stream: @Sendable @escaping (StreamWriter) -> EventLoopFuture<Void>) -> Body {
+            return Body(contentLength: contentLength, stream: stream)
         }
 
         /// Create and stream body using a collection of bytes.
diff --git a/Tests/AsyncHTTPClientTests/HTTPClientTests.swift b/Tests/AsyncHTTPClientTests/HTTPClientTests.swift
@@ -621,7 +621,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
         let request = try HTTPClient.Request(url: self.defaultHTTPBinURLPrefix + "post",
                                              method: .POST,
                                              headers: ["transfer-encoding": "chunked"],
-                                             body: .stream(bodyStream: { streamWriter in
+                                             body: .stream { streamWriter in
                                                  _ = streamWriter.write(.byteBuffer(.init()))
 
                                                  let promise = self.clientGroup.next().makePromise(of: Void.self)
@@ -630,7 +630,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
                                                  }
 
                                                  return promise.futureResult
-                                             }))
+                                             })
 
         XCTAssertThrowsError(try localClient.execute(request: request).wait()) {
             XCTAssertEqual($0 as? HTTPClientError, .writeTimeout)
@@ -1953,9 +1953,9 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
     }
 
     func testValidationErrorsAreSurfaced() throws {
-        let request = try HTTPClient.Request(url: self.defaultHTTPBinURLPrefix + "get", method: .TRACE, body: .stream(bodyStream: { _ in
+        let request = try HTTPClient.Request(url: self.defaultHTTPBinURLPrefix + "get", method: .TRACE, body: .stream { _ in
             self.defaultClient.eventLoopGroup.next().makeSucceededFuture(())
-        }))
+        })
         let runningRequest = self.defaultClient.execute(request: request)
         XCTAssertThrowsError(try runningRequest.wait()) { error in
             XCTAssertEqual(HTTPClientError.traceRequestWithBody, error as? HTTPClientError)
@@ -2048,10 +2048,10 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
             return try? HTTPClient.Request(url: "http://\(localAddress.ipAddress!):\(localAddress.port!)",
                                            method: .POST,
                                            headers: ["transfer-encoding": "chunked"],
-                                           body: .stream(bodyStream: { streamWriter in
+                                           body: .stream { streamWriter in
                                                streamWriterPromise.succeed(streamWriter)
                                                return sentOffAllBodyPartsPromise.futureResult
-                                           }))
+                                           })
         }
 
         guard let server = makeServer(), let request = makeRequest(server: server) else {
@@ -2602,9 +2602,9 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
         }
 
         var request = try HTTPClient.Request(url: "http://localhost:\(server.serverPort)/")
-        request.body = .stream(bodyStream: { writer in
+        request.body = .stream { writer in
             writer.write(.byteBuffer(ByteBuffer(string: "1234")))
-        })
+        }
 
         let future = client.execute(request: request)
 
@@ -2777,7 +2777,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
         }
 
         var request: HTTPClient.Request?
-        XCTAssertNoThrow(request = try Request(url: url, body: .stream(contentLength: 1, bodyStream: uploader)))
+        XCTAssertNoThrow(request = try Request(url: url, body: .stream(contentLength: 1, uploader)))
         XCTAssertThrowsError(try self.defaultClient.execute(request: XCTUnwrap(request)).wait()) {
             XCTAssertEqual($0 as? HTTPClientError, .writeAfterRequestSent)
         }
@@ -2793,7 +2793,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
         _ = self.defaultClient.get(url: "http://localhost:\(self.defaultHTTPBin.port)/events/10/1")
 
         var request = try HTTPClient.Request(url: "http://localhost:\(self.defaultHTTPBin.port)/wait", method: .POST)
-        request.body = .stream(bodyStream: { writer in
+        request.body = .stream { writer in
             // Start writing chunks so tha we will try to write after read timeout is thrown
             for _ in 1...10 {
                 _ = writer.write(.byteBuffer(ByteBuffer(string: "1234")))
@@ -2805,7 +2805,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
             }
 
             return promise.futureResult
-        })
+        }
 
         // We specify a deadline of 2 ms co that request will be timed out before all chunks are writtent,
         // we need to verify that second error on write after timeout does not lead to double-release.
@@ -2968,7 +2968,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
 
         let delegate = ResponseStreamDelegate(eventLoop: delegateEL)
 
-        let body: HTTPClient.Body = .stream(bodyStream: { writer in
+        let body: HTTPClient.Body = .stream { writer in
             let finalPromise = writeEL.makePromise(of: Void.self)
 
             @Sendable func writeLoop(_ writer: HTTPClient.Body.StreamWriter, index: Int) {
@@ -3004,7 +3004,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
             }
 
             return finalPromise.futureResult
-        })
+        }
 
         let request = try! HTTPClient.Request(url: "http://localhost:\(httpBin.port)", body: body)
         let future = httpClient.execute(request: request, delegate: delegate, eventLoop: .delegate(on: delegateEL))
@@ -3068,9 +3068,9 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
         let body = ByteBuffer(bytes: 0..<11)
 
         var request = try Request(url: httpBin.baseURL)
-        request.body = .stream(bodyStream: { writer in
+        request.body = .stream { writer in
             writer.write(.byteBuffer(body))
-        })
+        }
         XCTAssertThrowsError(try self.defaultClient.execute(
             request: request,
             delegate: ResponseAccumulator(request: request, maxBodySize: 10)
@@ -3086,9 +3086,9 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
         let body = ByteBuffer(bytes: 0..<10)
 
         var request = try Request(url: httpBin.baseURL)
-        request.body = .stream(bodyStream: { writer in
+        request.body = .stream { writer in
             writer.write(.byteBuffer(body))
-        })
+        }
         let response = try self.defaultClient.execute(
             request: request,
             delegate: ResponseAccumulator(request: request, maxBodySize: 10)
@@ -3113,7 +3113,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
 
         let delegate = ResponseStreamDelegate(eventLoop: delegateEL)
 
-        let body: HTTPClient.Body = .stream(bodyStream: { writer in
+        let body: HTTPClient.Body = .stream { writer in
             let finalPromise = writeEL.makePromise(of: Void.self)
 
             @Sendable func writeLoop(_ writer: HTTPClient.Body.StreamWriter, index: Int) {
@@ -3143,7 +3143,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
             }
 
             return finalPromise.futureResult
-        })
+        }
 
         let request = try! HTTPClient.Request(url: "http://localhost:\(httpBin.port)", body: body)
         let future = httpClient.execute(request: request, delegate: delegate, eventLoop: .delegate(on: delegateEL))
@@ -3164,7 +3164,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
         let httpClient = HTTPClient(eventLoopGroupProvider: .shared(eventLoopGroup))
         defer { XCTAssertNoThrow(try httpClient.syncShutdown()) }
 
-        let body: HTTPClient.Body = .stream(bodyStream: { writer in
+        let body: HTTPClient.Body = .stream { writer in
             let finalPromise = writeEL.makePromise(of: Void.self)
 
             @Sendable func writeLoop(_ writer: HTTPClient.Body.StreamWriter, index: Int) {
@@ -3194,7 +3194,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
             }
 
             return finalPromise.futureResult
-        })
+        }
 
         let request = try! HTTPClient.Request(url: "http://localhost:\(httpBin.port)", body: body)
         let future = httpClient.execute(request: request)
@@ -3220,7 +3220,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
         let httpClient = HTTPClient(eventLoopGroupProvider: .shared(eventLoopGroup))
         defer { XCTAssertNoThrow(try httpClient.syncShutdown()) }
 
-        let body: HTTPClient.Body = .stream(bodyStream: { writer in
+        let body: HTTPClient.Body = .stream { writer in
             let finalPromise = writeEL.makePromise(of: Void.self)
 
             @Sendable func writeLoop(_ writer: HTTPClient.Body.StreamWriter, index: Int) {
@@ -3250,7 +3250,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
             }
 
             return finalPromise.futureResult
-        })
+        }
 
         let headers = HTTPHeaders([("Connection", "close")])
         let request = try! HTTPClient.Request(url: "http://localhost:\(httpBin.port)", headers: headers, body: body)
diff --git a/Tests/AsyncHTTPClientTests/RequestBagTests.swift b/Tests/AsyncHTTPClientTests/RequestBagTests.swift
@@ -872,11 +872,11 @@ final class RequestBagTests: XCTestCase {
 
             let writerPromise = group.any().makePromise(of: HTTPClient.Body.StreamWriter.self)
             let donePromise = group.any().makePromise(of: Void.self)
-            request.body = .stream(bodyStream: { [leakDetector] writer in
+            request.body = .stream { [leakDetector] writer in
                 _ = leakDetector
                 writerPromise.succeed(writer)
                 return donePromise.futureResult
-            })
+            }
 
             let resultFuture = httpClient.execute(request: request)
             request.body = nil
