extract response

Author: dankinsoid

Sources/SwiftAPIClient/Modifiers/ErrorHandler.swift

@@ -45,7 +45,9 @@ public struct APIErrorContext: Equatable {
 
 	public var request: HTTPRequestComponents?
 	public var response: Data?
-	public var status: HTTPResponse.Status?
+	
+	public var httpResponse: HTTPResponse?
+	public var status: HTTPResponse.Status? { httpResponse?.status }
 	public var codeLocation: CodeLocation
 	public var fileID: String {
 		get { codeLocation.fileID }
@@ -67,6 +69,7 @@ public struct APIErrorContext: Equatable {
 	public init(
 		request: HTTPRequestComponents? = nil,
 		response: Data? = nil,
+		httpResponse: HTTPResponse? = nil,
 		status: HTTPResponse.Status? = nil,
 		fileID: String,
 		line: UInt,
@@ -75,6 +78,7 @@ public struct APIErrorContext: Equatable {
 		self.init(
 			request: request,
 			response: response,
+			httpResponse: httpResponse,
 			status: status,
 			codeLocation: CodeLocation(
 				fileID: fileID,
@@ -87,25 +91,28 @@ public struct APIErrorContext: Equatable {
 	public init(
 		request: HTTPRequestComponents? = nil,
 		response: Data? = nil,
+		httpResponse: HTTPResponse? = nil,
 		status: HTTPResponse.Status? = nil,
 		codeLocation: CodeLocation
 	) {
 		self.request = request
+		self.httpResponse = httpResponse
 		self.response = response
-		self.status = status
 		self.codeLocation = codeLocation
 	}
 
 	@available(*, deprecated, message: "Use init(request:response:status:codeLocation:) instead")
 	public init(
 		request: HTTPRequestComponents? = nil,
 		response: Data? = nil,
+		httpResponse: HTTPResponse? = nil,
 		status: HTTPResponse.Status? = nil,
 		fileIDLine: CodeLocation
 	) {
 		self.init(
 			request: request,
 			response: response,
+			httpResponse: httpResponse,
 			status: status,
 			fileID: fileIDLine.fileID,
 			line: fileIDLine.line,

Sources/SwiftAPIClient/Modifiers/HTTPResponseValidator.swift

@@ -32,7 +32,7 @@ public extension HTTPResponseValidator {
 	static func statusCode(_ codes: ClosedRange<Int>) -> Self {
 		HTTPResponseValidator { response, _, configs in
 			guard codes.contains(response.status.code) || configs.ignoreStatusCodeValidator else {
-				throw InvalidStatusCode(response.status)
+				throw InvalidStatusCode(response: response)
 			}
 		}
 	}
@@ -43,25 +43,32 @@ public extension HTTPResponseValidator {
 	static func statusCode(_ kind: HTTPResponse.Status.Kind) -> Self {
 		HTTPResponseValidator { response, _, configs in
 			guard response.status.kind == kind || configs.ignoreStatusCodeValidator else {
-				throw InvalidStatusCode(response.status)
+				throw InvalidStatusCode(response: response)
 			}
 		}
 	}
 }
 
+/// An error indicating that an HTTP response has an invalid status code.
 public struct InvalidStatusCode: Error, LocalizedError, CustomStringConvertible {
-
-    /// The invalid status code.
-    public let status: HTTPResponse.Status
-
-    public init(_ status: HTTPResponse.Status) {
-        self.status = status
-    }
-
-    public var errorDescription: String? { description }
-    public var description: String {
-        "Invalid status code: \(status.code) \(status.reasonPhrase)"
-    }
+	
+	/// The invalid status code.
+	public var status: HTTPResponse.Status { response.status }
+	public let response: HTTPResponse
+	
+	@available(*, deprecated, message: "Use init(response: HTTPResponse) instead")
+	public init(_ status: HTTPResponse.Status) {
+		self.init(response: HTTPResponse(status: status))
+	}
+	
+	public init(response: HTTPResponse) {
+		self.response = response
+	}
+	
+	public var errorDescription: String? { description }
+	public var description: String {
+		"Invalid status code: \(status.code) \(status.reasonPhrase)"
+	}
 }
 
 public extension HTTPResponseValidator {
@@ -107,34 +114,30 @@ public extension APIClient.Configs {
 	}
 }
 
-func extractStatusCodeEvenFailed<T>(_ request: () async throws -> (T, HTTPResponse)) async throws -> (Result<(T, HTTPResponse), Error>, HTTPResponse.Status) {
-	let status: HTTPResponse.Status
+func extractResponseEvenFailed<T>(_ request: () async throws -> (T, HTTPResponse)) async throws -> (Result<(T, HTTPResponse), Error>, HTTPResponse) {
+	let response: HTTPResponse
 	let result: Result<(T, HTTPResponse), Error>
 	do {
 		let value = try await request()
-		status = value.1.status
+		response = value.1
 		result = .success(value)
 	} catch let error as InvalidStatusCode {
-		status = error.status
+		response = error.response
 		result = .failure(error)
 	} catch let error as APIClientError {
-		if let code = error.context.status {
-			status = code
+		if let httpResponse = error.context.httpResponse {
+			response = httpResponse
 			result = .failure(error)
 		} else {
 			throw error
 		}
 	} catch {
 		throw error
 	}
-	return (result, status)
+	return (result, response)
 }
 
-func extractStatusCode(from error: Error) -> HTTPResponse.Status? {
-	if let error = error as? InvalidStatusCode {
-		return error.status
-	} else if let error = error as? APIClientError {
-		return error.context.status
-	}
-	return nil
+func extractStatusCodeEvenFailed<T>(_ request: () async throws -> (T, HTTPResponse)) async throws -> (Result<(T, HTTPResponse), Error>, HTTPResponse.Status) {
+	let (result, response) = try await extractResponseEvenFailed(request)
+	return (result, response.status)
 }

Sources/SwiftAPIClient/Modifiers/RetryModifier.swift

@@ -269,7 +269,7 @@ public struct RetryRequestCondition {
 	}
 
 	/// A `RetryRequestCondition` that retries the request when the response status code indicates a failure that is typically transient.
-	public static let retryStatusCode = RetryRequestCondition.statusCodes([408, 421, 429, 500, 502, 503, 504, 509])
+	public static let retryStatusCode = RetryRequestCondition.statusCodes(408, 421, 429, 500, 502, 503, 504, 509)
 
 	/// A `RetryRequestCondition` that retries the request when the response status code is `429 Too Many Requests`.
 	public static let rateLimitExceeded = RetryRequestCondition.statusCodes(.tooManyRequests)
@@ -344,7 +344,7 @@ private struct retryMiddleware: HTTPClientMiddleware {
 			}
 		}
 		var count = 0
-		var status: HTTPResponse.Status?
+		var response: HTTPResponse?
 		var retryAfterHeader: TimeInterval = 0
 
 		func needRetry(_ result: Result<HTTPResponse, Error>) -> Bool {
@@ -361,7 +361,7 @@ private struct retryMiddleware: HTTPClientMiddleware {
 			if count > 0 {
 				let interval = UInt64(max(retryAfterHeader, interval(count - 1)) * 1_000_000_000)
 				if interval > 0 {
-					if let status, let hash = backoffPolicy.scopeHash(request), backoffPolicy.isGlobalBackoff(request, status) {
+					if let response, let hash = backoffPolicy.scopeHash(request), backoffPolicy.isGlobalBackoff(request, response.status) {
 						_ = try await withThrowingSynchronizedAccess(id: hash) {
 							try await Task.sleep(nanoseconds: interval)
 							return interval
@@ -372,23 +372,24 @@ private struct retryMiddleware: HTTPClientMiddleware {
 				}
 			}
 			count += 1
-			let (result, sts) = try await extractStatusCodeEvenFailed {
+			let (result, rsp) = try await extractResponseEvenFailed {
 				try await next(request, configs)
 			}
-			status = sts
+			response = rsp
 			return try result.get()
 		}
 
 		while true {
 			do {
-			 let (data, response) = try await retry()
-				if [429, 503].contains((status ?? response.status).code) {
-					retryAfterHeader = response.headerFields[.retryAfter].flatMap {
+			 let (data, httpResponse) = try await retry()
+				// 429 and 503 may include Retry-After header by RFC 7231
+				if [429, 503].contains(httpResponse.status.code) {
+					retryAfterHeader = httpResponse.headerFields[.retryAfter].flatMap {
 						decodeRetryAfterHeader($0, formatter: configs.retryAfterHeaderDateFormatter)
 					} ?? 0
 				}
-				if !needRetry(.success(response)) {
-					return (data, response)
+				if !needRetry(.success(httpResponse)) {
+					return (data, httpResponse)
 				}
 		 } catch {
 			 if !needRetry(.failure(error)) {