Skip to content

Fixes double-release of a connection. #295

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 18 additions & 29 deletions Sources/AsyncHTTPClient/HTTPHandler.swift
Original file line number Diff line number Diff line change
Expand Up @@ -814,9 +814,8 @@ extension TaskHandler: ChannelDuplexHandler {
do {
try headers.validate(method: request.method, body: request.body)
} catch {
self.errorCaught(context: context, error: error)
promise?.fail(error)
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
self.state = .endOrError
return
}

Expand All @@ -843,9 +842,8 @@ extension TaskHandler: ChannelDuplexHandler {
self.state = .bodySent
context.eventLoop.assertInEventLoop()
if let expectedBodyLength = self.expectedBodyLength, expectedBodyLength != self.actualBodyLength {
self.state = .endOrError
let error = HTTPClientError.bodyLengthMismatch
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
self.errorCaught(context: context, error: error)
return context.eventLoop.makeFailedFuture(error)
}
return context.writeAndFlush(self.wrapOutboundOut(.end(nil)))
Expand All @@ -855,13 +853,7 @@ extension TaskHandler: ChannelDuplexHandler {
self.callOutToDelegateFireAndForget(self.delegate.didSendRequest)
}.flatMapErrorThrowing { error in
context.eventLoop.assertInEventLoop()
switch self.state {
case .endOrError:
break
default:
self.state = .endOrError
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
}
self.errorCaught(context: context, error: error)
throw error
}.cascade(to: promise)
}
Expand Down Expand Up @@ -906,17 +898,15 @@ extension TaskHandler: ChannelDuplexHandler {
case .idle:
if let limit = self.expectedBodyLength, self.actualBodyLength + part.readableBytes > limit {
let error = HTTPClientError.bodyLengthMismatch
self.state = .endOrError
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
self.errorCaught(context: context, error: error)
promise.fail(error)
return
}
self.actualBodyLength += part.readableBytes
context.writeAndFlush(self.wrapOutboundOut(.body(part)), promise: promise)
default:
let error = HTTPClientError.writeAfterRequestSent
self.state = .endOrError
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
self.errorCaught(context: context, error: error)
promise.fail(error)
}
}
Expand Down Expand Up @@ -983,26 +973,21 @@ extension TaskHandler: ChannelDuplexHandler {
context.read()
}
case .failure(let error):
self.state = .endOrError
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
self.errorCaught(context: context, error: error)
}
}

func userInboundEventTriggered(context: ChannelHandlerContext, event: Any) {
if (event as? IdleStateHandler.IdleStateEvent) == .read {
self.state = .endOrError
let error = HTTPClientError.readTimeout
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
self.errorCaught(context: context, error: HTTPClientError.readTimeout)
} else {
context.fireUserInboundEventTriggered(event)
}
}

func triggerUserOutboundEvent(context: ChannelHandlerContext, event: Any, promise: EventLoopPromise<Void>?) {
if (event as? TaskCancelEvent) != nil {
self.state = .endOrError
let error = HTTPClientError.cancelled
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
self.errorCaught(context: context, error: HTTPClientError.cancelled)
promise?.succeed(())
} else {
context.triggerUserOutboundEvent(event, promise: promise)
Expand All @@ -1014,9 +999,7 @@ extension TaskHandler: ChannelDuplexHandler {
case .endOrError:
break
case .body, .head, .idle, .redirected, .sent, .bodySent:
self.state = .endOrError
let error = HTTPClientError.remoteConnectionClosed
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
self.errorCaught(context: context, error: HTTPClientError.remoteConnectionClosed)
}
context.fireChannelInactive()
}
Expand All @@ -1038,14 +1021,20 @@ extension TaskHandler: ChannelDuplexHandler {
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
}
default:
self.state = .endOrError
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
switch self.state {
case .idle, .bodySent, .sent, .head, .redirected, .body:
self.state = .endOrError
self.failTaskAndNotifyDelegate(error: error, self.delegate.didReceiveError)
case .endOrError:
// error was already handled
break
}
}
}

func handlerAdded(context: ChannelHandlerContext) {
guard context.channel.isActive else {
self.failTaskAndNotifyDelegate(error: HTTPClientError.remoteConnectionClosed, self.delegate.didReceiveError)
self.errorCaught(context: context, error: HTTPClientError.remoteConnectionClosed)
return
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ extension HTTPClientInternalTests {
("testConnectErrorCalloutOnCorrectEL", testConnectErrorCalloutOnCorrectEL),
("testInternalRequestURI", testInternalRequestURI),
("testBodyPartStreamStateChangedBeforeNotification", testBodyPartStreamStateChangedBeforeNotification),
("testHandlerDoubleError", testHandlerDoubleError),
]
}
}
39 changes: 39 additions & 0 deletions Tests/AsyncHTTPClientTests/HTTPClientInternalTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1080,4 +1080,43 @@ class HTTPClientInternalTests: XCTestCase {
XCTAssertNoThrow(try channel.readOutbound(as: HTTPClientRequestPart.self)) // .head
XCTAssertNoThrow(XCTAssertTrue(try channel.finish().isClean))
}

func testHandlerDoubleError() throws {
class ErrorCountingDelegate: HTTPClientResponseDelegate {
typealias Response = Void

var count = 0

func didReceiveError(task: HTTPClient.Task<Response>, _: Error) {
self.count += 1
}

func didFinishRequest(task: HTTPClient.Task<Void>) throws {
return ()
}
}

class SendTwoErrorsHandler: ChannelInboundHandler {
typealias InboundIn = Any

func handlerAdded(context: ChannelHandlerContext) {
context.fireErrorCaught(HTTPClientError.cancelled)
context.fireErrorCaught(HTTPClientError.cancelled)
}
}

let channel = EmbeddedChannel()
let task = Task<Void>(eventLoop: channel.eventLoop, logger: HTTPClient.loggingDisabled)
let delegate = ErrorCountingDelegate()
try channel.pipeline.addHandler(TaskHandler(task: task,
kind: .host,
delegate: delegate,
redirectHandler: nil,
ignoreUncleanSSLShutdown: false,
logger: HTTPClient.loggingDisabled)).wait()

try channel.pipeline.addHandler(SendTwoErrorsHandler()).wait()

XCTAssertEqual(delegate.count, 1)
}
}
1 change: 1 addition & 0 deletions Tests/AsyncHTTPClientTests/HTTPClientTests+XCTest.swift
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ extension HTTPClientTests {
("testContentLengthTooShortFails", testContentLengthTooShortFails),
("testBodyUploadAfterEndFails", testBodyUploadAfterEndFails),
("testNoBytesSentOverBodyLimit", testNoBytesSentOverBodyLimit),
("testDoubleError", testDoubleError),
]
}
}
25 changes: 25 additions & 0 deletions Tests/AsyncHTTPClientTests/HTTPClientTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -2602,4 +2602,29 @@ class HTTPClientTests: XCTestCase {

XCTAssertThrowsError(try future.wait())
}

func testDoubleError() throws {
// This is needed to that connection pool will not get into closed state when we release
// second connection.
_ = 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 { 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")))
}

let promise = self.clientGroup.next().makePromise(of: Void.self)
self.clientGroup.next().scheduleTask(in: .milliseconds(3)) {
writer.write(.byteBuffer(ByteBuffer(string: "1234"))).cascade(to: promise)
}

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.
XCTAssertThrowsError(try self.defaultClient.execute(request: request, deadline: .now() + .milliseconds(2)).wait())
}
}