Skip to content

Add request context to HTTPClientError.unexpectedStatusCode and CustomStringConvertible conformance #175

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

Open
krishnapermi wants to merge 2 commits into
base: main
Choose a base branch
from
+31 −5
Open

Add request context to HTTPClientError.unexpectedStatusCode and CustomStringConvertible conformance #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
941f15b
Add request context to unexpectedStatusCode and CustomStringConvertib…
krishnapermi Jul 3, 2026
30471a1
Fix catch clauses for unexpectedStatusCode after request parameter ad…
krishnapermi Jul 3, 2026
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
32 changes: 29 additions & 3 deletions Sources/ContainerRegistry/HTTPClient.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import HTTPTypesFoundation
///
/// The response to a `HEAD` request does not include a body so if an error is thrown, `data` will be `nil`
public enum HTTPClientError: Error {
case unexpectedStatusCode(status: HTTPResponse.Status, response: HTTPResponse, data: Data?)
case unexpectedStatusCode(request: HTTPRequest, status: HTTPResponse.Status, response: HTTPResponse, data: Data?)
case unexpectedContentType(String)
case missingContentType
case missingResponseHeader(String)
Expand Down Expand Up @@ -85,9 +85,9 @@ extension URLSession: HTTPClient {

// A HEAD request has no response body and cannot be decoded
if request.method == .head {
throw HTTPClientError.unexpectedStatusCode(status: response.status, response: response, data: nil)
throw HTTPClientError.unexpectedStatusCode(request: request, status: response.status, response: response, data: nil)
}
throw HTTPClientError.unexpectedStatusCode(status: response.status, response: response, data: responseData)
throw HTTPClientError.unexpectedStatusCode(request: request, status: response.status, response: response, data: responseData)
}

return response
Expand Down Expand Up @@ -135,6 +135,32 @@ extension URLSession: HTTPClient {
}
}

extension HTTPClientError: CustomStringConvertible {

@euanh euanh Sep 7, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This duplicates the CustomStringConvertible extension defined in containertool, which causes the compiler to print a warning:

swift-container-plugin/Sources/containertool/Extensions/Errors+CustomStringConvertible.swift

Line 17 in 014894f

extension HTTPClientError: Swift.CustomStringConvertible {

I think it's better to let the client define the custom printing of error messages, instead than doing it the library, because the client may want to present the errors in a particular way.

/// Human-readable description of an HTTPClientError, including the registry hostname where available.
public var description: String {
switch self {
case let .unexpectedStatusCode(request, status, _, _):
let host = request.url?.host ?? "unknown registry"
if status == .unauthorized || status == .forbidden {
return "Authentication failed for registry \"\(host)\": the server returned HTTP \(status.code). Ensure your credentials are correct."
}
return "Registry \"\(host)\" returned an unexpected HTTP \(status.code) response."
case let .unexpectedContentType(type):
return "Unexpected content type: \(type)"
case .missingContentType:
return "Response is missing a content type"
case let .missingResponseHeader(header):
return "Response is missing the '\(header)' header"
case let .authenticationChallenge(_, request, _):
let host = request.url?.host ?? "unknown registry"
return "Registry \"\(host)\" requires authentication."
case let .unauthorized(request, _):
let host = request.url?.host ?? "unknown registry"
return "Authentication failed for registry \"\(host)\": credentials were rejected."
}
}
}

extension HTTPRequest {
/// Constructs a HTTPRequest pre-configured with method, url and content types.
/// - Parameters:
Expand Down
4 changes: 2 additions & 2 deletions Sources/ContainerRegistry/RegistryClient.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ extension RegistryClient {

do {
return try await client.executeRequestThrowing(request, expectingStatus: success)
} catch HTTPClientError.unexpectedStatusCode(let status, _, let .some(responseData))
} catch HTTPClientError.unexpectedStatusCode(_, let status, _, let .some(responseData))
where errors.contains(status)
{
// Try to decode as JSON; if that fails, throw a generic error with the raw response body
Expand Down Expand Up @@ -416,7 +416,7 @@ extension RegistryClient {

do {
return try await client.executeRequestThrowing(request, uploading: payload, expectingStatus: success)
} catch HTTPClientError.unexpectedStatusCode(let status, _, let .some(responseData))
} catch HTTPClientError.unexpectedStatusCode(_, let status, _, let .some(responseData))
where errors.contains(status)
{
// Try to decode as JSON; if that fails, throw a generic error with the raw response body
Expand Down
Loading