Skip to content

Propagate HTTPClient.Task<Response> failures to subsequent redirect tasks #814

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 6 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
10 changes: 8 additions & 2 deletions Sources/AsyncHTTPClient/HTTPHandler.swift
Original file line number Diff line number Diff line change
Expand Up @@ -956,7 +956,7 @@ internal struct RedirectHandler<ResponseType> {
status: HTTPResponseStatus,
to redirectURL: URL,
promise: EventLoopPromise<ResponseType>
) {
) -> HTTPClient.Task<ResponseType>? {
do {
var redirectState = self.redirectState
try redirectState.redirect(to: redirectURL.absoluteString)
Expand All @@ -976,13 +976,19 @@ internal struct RedirectHandler<ResponseType> {
headers: headers,
body: body
)
self.execute(newRequest, redirectState).futureResult.whenComplete { result in

let newTask = self.execute(newRequest, redirectState)

newTask.futureResult.whenComplete { result in
promise.futureResult.eventLoop.execute {
promise.completeWith(result)
}
}

return newTask
} catch {
promise.fail(error)
return nil
}
}
}
Expand Down
8 changes: 6 additions & 2 deletions Sources/AsyncHTTPClient/RequestBag+StateMachine.swift
Original file line number Diff line number Diff line change
Expand Up @@ -594,6 +594,7 @@ extension RequestBag.StateMachine {
enum FailAction {
case failTask(Error, HTTPRequestScheduler?, HTTPRequestExecutor?)
case cancelExecutor(HTTPRequestExecutor)
case propagateCancellation
case none
}

Expand Down Expand Up @@ -624,8 +625,11 @@ extension RequestBag.StateMachine {
self.state = .finished(error: error)
return .failTask(error, nil, nil)
case .finished(.none):
// An error occurred after the request has finished. Ignore...
return .none
if (error as? HTTPClientError) == .cancelled {
return .propagateCancellation
} else {
return .none
}
case .deadlineExceededWhileQueued:
let realError: Error = {
if (error as? HTTPClientError) == .cancelled {
Expand Down
11 changes: 8 additions & 3 deletions Sources/AsyncHTTPClient/RequestBag.swift
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ final class RequestBag<Delegate: HTTPClientResponseDelegate> {
// the consume body part stack depth is synchronized on the task event loop.
private var consumeBodyPartStackDepth: Int

// if a redirect occurs, we store the task for it so we can propagate cancellation
private var redirectTask: HTTPClient.Task<Delegate.Response>? = nil

// MARK: HTTPClientTask properties

var logger: Logger {
Expand Down Expand Up @@ -234,7 +237,7 @@ final class RequestBag<Delegate: HTTPClientResponseDelegate> {
executor.demandResponseBodyStream(self)

case .redirect(let executor, let handler, let head, let newURL):
handler.redirect(status: head.status, to: newURL, promise: self.task.promise)
self.redirectTask = handler.redirect(status: head.status, to: newURL, promise: self.task.promise)
executor.cancelRequest(self)

case .forwardResponseHead(let head):
Expand All @@ -258,7 +261,7 @@ final class RequestBag<Delegate: HTTPClientResponseDelegate> {
executor.demandResponseBodyStream(self)

case .redirect(let executor, let handler, let head, let newURL):
handler.redirect(status: head.status, to: newURL, promise: self.task.promise)
self.redirectTask = handler.redirect(status: head.status, to: newURL, promise: self.task.promise)
executor.cancelRequest(self)

case .forwardResponsePart(let part):
Expand Down Expand Up @@ -294,7 +297,7 @@ final class RequestBag<Delegate: HTTPClientResponseDelegate> {
}

case .redirect(let handler, let head, let newURL):
handler.redirect(status: head.status, to: newURL, promise: self.task.promise)
self.redirectTask = handler.redirect(status: head.status, to: newURL, promise: self.task.promise)
}
}

Expand Down Expand Up @@ -368,6 +371,8 @@ final class RequestBag<Delegate: HTTPClientResponseDelegate> {
self.failTask0(error)
case .cancelExecutor(let executor):
executor.cancelRequest(self)
case .propagateCancellation:
self.redirectTask?.cancel()
case .none:
break
}
Expand Down