Skip to content

Resolve ambiguity issue for the stream function #749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 3, 2024
Merged

Resolve ambiguity issue for the stream function #749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Sources/AsyncHTTPClient/HTTPHandler.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}
Expand All @@ -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.
Expand Down
46 changes: 23 additions & 23 deletions Tests/AsyncHTTPClientTests/HTTPClientTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -630,7 +630,7 @@ final class HTTPClientTests: XCTestCaseHTTPClientTestsBaseClass {
}

return promise.futureResult
}))
})

XCTAssertThrowsError(try localClient.execute(request: request).wait()) {
XCTAssertEqual($0 as? HTTPClientError, .writeTimeout)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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 {
Expand Down Expand Up @@ -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)

Expand Down Expand Up @@ -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)
}
Expand All @@ -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")))
Expand All @@ -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.
Expand Down Expand Up @@ -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) {
Expand Down Expand Up @@ -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))
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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) {
Expand Down Expand Up @@ -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))
Expand All @@ -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) {
Expand Down Expand Up @@ -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)
Expand All @@ -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) {
Expand Down Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions Tests/AsyncHTTPClientTests/RequestBagTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down