|
@@ -1,7 +1,7 @@
|
|
|
//
|
|
|
// ResponseSerialization.swift
|
|
|
//
|
|
|
-// Copyright (c) 2014 Alamofire Software Foundation (http://alamofire.org/)
|
|
|
+// Copyright (c) 2014-2018 Alamofire Software Foundation (http://alamofire.org/)
|
|
|
//
|
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
@@ -24,80 +24,144 @@
|
|
|
|
|
|
import Foundation
|
|
|
|
|
|
-/// The type in which all data response serializers must conform to in order to serialize a response.
|
|
|
+// MARK: Protocols
|
|
|
+
|
|
|
+/// The type to which all data response serializers must conform in order to serialize a response.
|
|
|
public protocol DataResponseSerializerProtocol {
|
|
|
- /// The type of serialized object to be created by this `DataResponseSerializerType`.
|
|
|
+ /// The type of serialized object to be created.
|
|
|
associatedtype SerializedObject
|
|
|
|
|
|
- /// A closure used by response handlers that takes a request, response, data and error and returns a result.
|
|
|
- var serializeResponse: (URLRequest?, HTTPURLResponse?, Data?, Error?) -> Result<SerializedObject> { get }
|
|
|
+ /// Serialize the response `Data` into the provided type..
|
|
|
+ ///
|
|
|
+ /// - Parameters:
|
|
|
+ /// - request: `URLRequest` which was used to perform the request, if any.
|
|
|
+ /// - response: `HTTPURLResponse` received from the server, if any.
|
|
|
+ /// - data: `Data` returned from the server, if any.
|
|
|
+ /// - error: `Error` produced by Alamofire or the underlying `URLSession` during the request.
|
|
|
+ ///
|
|
|
+ /// - Returns: The `SerializedObject`.
|
|
|
+ /// - Throws: Any `Error` produced during serialization.
|
|
|
+ func serialize(request: URLRequest?, response: HTTPURLResponse?, data: Data?, error: Error?) throws -> SerializedObject
|
|
|
}
|
|
|
|
|
|
-// MARK: -
|
|
|
-
|
|
|
-/// A generic `DataResponseSerializerType` used to serialize a request, response, and data into a serialized object.
|
|
|
-public struct DataResponseSerializer<Value>: DataResponseSerializerProtocol {
|
|
|
- /// The type of serialized object to be created by this `DataResponseSerializer`.
|
|
|
- public typealias SerializedObject = Value
|
|
|
-
|
|
|
- /// A closure used by response handlers that takes a request, response, data and error and returns a result.
|
|
|
- public var serializeResponse: (URLRequest?, HTTPURLResponse?, Data?, Error?) -> Result<Value>
|
|
|
+/// The type to which all download response serializers must conform in order to serialize a response.
|
|
|
+public protocol DownloadResponseSerializerProtocol {
|
|
|
+ /// The type of serialized object to be created.
|
|
|
+ associatedtype SerializedObject
|
|
|
|
|
|
- /// Initializes the `ResponseSerializer` instance with the given serialize response closure.
|
|
|
+ /// Serialize the downloaded response `Data` from disk into the provided type..
|
|
|
///
|
|
|
- /// - parameter serializeResponse: The closure used to serialize the response.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - request: `URLRequest` which was used to perform the request, if any.
|
|
|
+ /// - response: `HTTPURLResponse` received from the server, if any.
|
|
|
+ /// - fileURL: File `URL` to which the response data was downloaded.
|
|
|
+ /// - error: `Error` produced by Alamofire or the underlying `URLSession` during the request.
|
|
|
///
|
|
|
- /// - returns: The new generic response serializer instance.
|
|
|
- public init(serializeResponse: @escaping (URLRequest?, HTTPURLResponse?, Data?, Error?) -> Result<Value>) {
|
|
|
- self.serializeResponse = serializeResponse
|
|
|
- }
|
|
|
+ /// - Returns: The `SerializedObject`.
|
|
|
+ /// - Throws: Any `Error` produced during serialization.
|
|
|
+ func serializeDownload(request: URLRequest?, response: HTTPURLResponse?, fileURL: URL?, error: Error?) throws -> SerializedObject
|
|
|
}
|
|
|
|
|
|
-// MARK: -
|
|
|
+/// A serializer that can handle both data and download responses.
|
|
|
+public protocol ResponseSerializer: DataResponseSerializerProtocol & DownloadResponseSerializerProtocol {
|
|
|
+ /// `DataPreprocessor` used to prepare incoming `Data` for serialization.
|
|
|
+ var dataPreprocessor: DataPreprocessor { get }
|
|
|
+ /// `HTTPMethod`s for which empty response bodies are considered appropriate.
|
|
|
+ var emptyRequestMethods: Set<HTTPMethod> { get }
|
|
|
+ /// HTTP response codes for which empty response bodies are considered appropriate.
|
|
|
+ var emptyResponseCodes: Set<Int> { get }
|
|
|
+}
|
|
|
|
|
|
-/// The type in which all download response serializers must conform to in order to serialize a response.
|
|
|
-public protocol DownloadResponseSerializerProtocol {
|
|
|
- /// The type of serialized object to be created by this `DownloadResponseSerializerType`.
|
|
|
- associatedtype SerializedObject
|
|
|
+/// Type used to preprocess `Data` before it handled by a serializer.
|
|
|
+public protocol DataPreprocessor {
|
|
|
+ /// Process `Data` before it's handled by a serializer.
|
|
|
+ /// - Parameter data: The raw `Data` to process.
|
|
|
+ func preprocess(_ data: Data) throws -> Data
|
|
|
+}
|
|
|
+
|
|
|
+/// `DataPreprocessor` that returns passed `Data` without any transform.
|
|
|
+public struct PassthroughPreprocessor: DataPreprocessor {
|
|
|
+ public init() {}
|
|
|
+
|
|
|
+ public func preprocess(_ data: Data) throws -> Data { data }
|
|
|
+}
|
|
|
+
|
|
|
+/// `DataPreprocessor` that trims Google's typical `)]}',\n` XSSI JSON header.
|
|
|
+public struct GoogleXSSIPreprocessor: DataPreprocessor {
|
|
|
+ public init() {}
|
|
|
|
|
|
- /// A closure used by response handlers that takes a request, response, url and error and returns a result.
|
|
|
- var serializeResponse: (URLRequest?, HTTPURLResponse?, URL?, Error?) -> Result<SerializedObject> { get }
|
|
|
+ public func preprocess(_ data: Data) throws -> Data {
|
|
|
+ (data.prefix(6) == Data(")]}',\n".utf8)) ? data.dropFirst(6) : data
|
|
|
+ }
|
|
|
}
|
|
|
|
|
|
-// MARK: -
|
|
|
+extension ResponseSerializer {
|
|
|
+ /// Default `DataPreprocessor`. `PassthroughPreprocessor` by default.
|
|
|
+ public static var defaultDataPreprocessor: DataPreprocessor { PassthroughPreprocessor() }
|
|
|
+ /// Default `HTTPMethod`s for which empty response bodies are considered appropriate. `[.head]` by default.
|
|
|
+ public static var defaultEmptyRequestMethods: Set<HTTPMethod> { [.head] }
|
|
|
+ /// HTTP response codes for which empty response bodies are considered appropriate. `[204, 205]` by default.
|
|
|
+ public static var defaultEmptyResponseCodes: Set<Int> { [204, 205] }
|
|
|
|
|
|
-/// A generic `DownloadResponseSerializerType` used to serialize a request, response, and data into a serialized object.
|
|
|
-public struct DownloadResponseSerializer<Value>: DownloadResponseSerializerProtocol {
|
|
|
- /// The type of serialized object to be created by this `DownloadResponseSerializer`.
|
|
|
- public typealias SerializedObject = Value
|
|
|
+ public var dataPreprocessor: DataPreprocessor { Self.defaultDataPreprocessor }
|
|
|
+ public var emptyRequestMethods: Set<HTTPMethod> { Self.defaultEmptyRequestMethods }
|
|
|
+ public var emptyResponseCodes: Set<Int> { Self.defaultEmptyResponseCodes }
|
|
|
|
|
|
- /// A closure used by response handlers that takes a request, response, url and error and returns a result.
|
|
|
- public var serializeResponse: (URLRequest?, HTTPURLResponse?, URL?, Error?) -> Result<Value>
|
|
|
+ /// Determines whether the `request` allows empty response bodies, if `request` exists.
|
|
|
+ ///
|
|
|
+ /// - Parameter request: `URLRequest` to evaluate.
|
|
|
+ ///
|
|
|
+ /// - Returns: `Bool` representing the outcome of the evaluation, or `nil` if `request` was `nil`.
|
|
|
+ public func requestAllowsEmptyResponseData(_ request: URLRequest?) -> Bool? {
|
|
|
+ request.flatMap { $0.httpMethod }
|
|
|
+ .flatMap(HTTPMethod.init)
|
|
|
+ .map { emptyRequestMethods.contains($0) }
|
|
|
+ }
|
|
|
+
|
|
|
+ /// Determines whether the `response` allows empty response bodies, if `response` exists`.
|
|
|
+ ///
|
|
|
+ /// - Parameter response: `HTTPURLResponse` to evaluate.
|
|
|
+ ///
|
|
|
+ /// - Returns: `Bool` representing the outcome of the evaluation, or `nil` if `response` was `nil`.
|
|
|
+ public func responseAllowsEmptyResponseData(_ response: HTTPURLResponse?) -> Bool? {
|
|
|
+ response.flatMap { $0.statusCode }
|
|
|
+ .map { emptyResponseCodes.contains($0) }
|
|
|
+ }
|
|
|
|
|
|
- /// Initializes the `ResponseSerializer` instance with the given serialize response closure.
|
|
|
+ /// Determines whether `request` and `response` allow empty response bodies.
|
|
|
///
|
|
|
- /// - parameter serializeResponse: The closure used to serialize the response.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - request: `URLRequest` to evaluate.
|
|
|
+ /// - response: `HTTPURLResponse` to evaluate.
|
|
|
///
|
|
|
- /// - returns: The new generic response serializer instance.
|
|
|
- public init(serializeResponse: @escaping (URLRequest?, HTTPURLResponse?, URL?, Error?) -> Result<Value>) {
|
|
|
- self.serializeResponse = serializeResponse
|
|
|
+ /// - Returns: `true` if `request` or `response` allow empty bodies, `false` otherwise.
|
|
|
+ public func emptyResponseAllowed(forRequest request: URLRequest?, response: HTTPURLResponse?) -> Bool {
|
|
|
+ (requestAllowsEmptyResponseData(request) == true) || (responseAllowsEmptyResponseData(response) == true)
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-// MARK: - Timeline
|
|
|
+/// By default, any serializer declared to conform to both types will get file serialization for free, as it just feeds
|
|
|
+/// the data read from disk into the data response serializer.
|
|
|
+extension DownloadResponseSerializerProtocol where Self: DataResponseSerializerProtocol {
|
|
|
+ public func serializeDownload(request: URLRequest?, response: HTTPURLResponse?, fileURL: URL?, error: Error?) throws -> Self.SerializedObject {
|
|
|
+ guard error == nil else { throw error! }
|
|
|
|
|
|
-extension Request {
|
|
|
- var timeline: Timeline {
|
|
|
- let requestStartTime = self.startTime ?? CFAbsoluteTimeGetCurrent()
|
|
|
- let requestCompletedTime = self.endTime ?? CFAbsoluteTimeGetCurrent()
|
|
|
- let initialResponseTime = self.delegate.initialResponseTime ?? requestCompletedTime
|
|
|
+ guard let fileURL = fileURL else {
|
|
|
+ throw AFError.responseSerializationFailed(reason: .inputFileNil)
|
|
|
+ }
|
|
|
|
|
|
- return Timeline(
|
|
|
- requestStartTime: requestStartTime,
|
|
|
- initialResponseTime: initialResponseTime,
|
|
|
- requestCompletedTime: requestCompletedTime,
|
|
|
- serializationCompletedTime: CFAbsoluteTimeGetCurrent()
|
|
|
- )
|
|
|
+ let data: Data
|
|
|
+ do {
|
|
|
+ data = try Data(contentsOf: fileURL)
|
|
|
+ } catch {
|
|
|
+ throw AFError.responseSerializationFailed(reason: .inputFileReadFailed(at: fileURL))
|
|
|
+ }
|
|
|
+
|
|
|
+ do {
|
|
|
+ return try serialize(request: request, response: response, data: data, error: error)
|
|
|
+ } catch {
|
|
|
+ throw error
|
|
|
+ }
|
|
|
}
|
|
|
}
|
|
|
|
|
@@ -106,25 +170,29 @@ extension Request {
|
|
|
extension DataRequest {
|
|
|
/// Adds a handler to be called once the request has finished.
|
|
|
///
|
|
|
- /// - parameter queue: The queue on which the completion handler is dispatched.
|
|
|
- /// - parameter completionHandler: The code to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is dispatched. `.main` by default.
|
|
|
+ /// - completionHandler: The code to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The request.
|
|
|
@discardableResult
|
|
|
- public func response(queue: DispatchQueue? = nil, completionHandler: @escaping (DefaultDataResponse) -> Void) -> Self {
|
|
|
- delegate.queue.addOperation {
|
|
|
- (queue ?? DispatchQueue.main).async {
|
|
|
- var dataResponse = DefaultDataResponse(
|
|
|
- request: self.request,
|
|
|
- response: self.response,
|
|
|
- data: self.delegate.data,
|
|
|
- error: self.delegate.error,
|
|
|
- timeline: self.timeline
|
|
|
- )
|
|
|
-
|
|
|
- dataResponse.add(self.delegate.metrics)
|
|
|
-
|
|
|
- completionHandler(dataResponse)
|
|
|
+ public func response(queue: DispatchQueue = .main, completionHandler: @escaping (AFDataResponse<Data?>) -> Void) -> Self {
|
|
|
+ appendResponseSerializer {
|
|
|
+ // Start work that should be on the serialization queue.
|
|
|
+ let result = AFResult<Data?>(value: self.data, error: self.error)
|
|
|
+ // End work that should be on the serialization queue.
|
|
|
+
|
|
|
+ self.underlyingQueue.async {
|
|
|
+ let response = DataResponse(request: self.request,
|
|
|
+ response: self.response,
|
|
|
+ data: self.data,
|
|
|
+ metrics: self.metrics,
|
|
|
+ serializationDuration: 0,
|
|
|
+ result: result)
|
|
|
+
|
|
|
+ self.eventMonitor?.request(self, didParseResponse: response)
|
|
|
+
|
|
|
+ self.responseSerializerDidComplete { queue.async { completionHandler(response) } }
|
|
|
}
|
|
|
}
|
|
|
|
|
@@ -133,38 +201,77 @@ extension DataRequest {
|
|
|
|
|
|
/// Adds a handler to be called once the request has finished.
|
|
|
///
|
|
|
- /// - parameter queue: The queue on which the completion handler is dispatched.
|
|
|
- /// - parameter responseSerializer: The response serializer responsible for serializing the request, response,
|
|
|
- /// and data.
|
|
|
- /// - parameter completionHandler: The code to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is dispatched. `.main` by default
|
|
|
+ /// - responseSerializer: The response serializer responsible for serializing the request, response, and data.
|
|
|
+ /// - completionHandler: The code to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The request.
|
|
|
@discardableResult
|
|
|
- public func response<T: DataResponseSerializerProtocol>(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- responseSerializer: T,
|
|
|
- completionHandler: @escaping (DataResponse<T.SerializedObject>) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- delegate.queue.addOperation {
|
|
|
- let result = responseSerializer.serializeResponse(
|
|
|
- self.request,
|
|
|
- self.response,
|
|
|
- self.delegate.data,
|
|
|
- self.delegate.error
|
|
|
- )
|
|
|
-
|
|
|
- var dataResponse = DataResponse<T.SerializedObject>(
|
|
|
- request: self.request,
|
|
|
- response: self.response,
|
|
|
- data: self.delegate.data,
|
|
|
- result: result,
|
|
|
- timeline: self.timeline
|
|
|
- )
|
|
|
-
|
|
|
- dataResponse.add(self.delegate.metrics)
|
|
|
-
|
|
|
- (queue ?? DispatchQueue.main).async { completionHandler(dataResponse) }
|
|
|
+ public func response<Serializer: DataResponseSerializerProtocol>(queue: DispatchQueue = .main,
|
|
|
+ responseSerializer: Serializer,
|
|
|
+ completionHandler: @escaping (AFDataResponse<Serializer.SerializedObject>) -> Void)
|
|
|
+ -> Self {
|
|
|
+ appendResponseSerializer {
|
|
|
+ // Start work that should be on the serialization queue.
|
|
|
+ let start = ProcessInfo.processInfo.systemUptime
|
|
|
+ let result: AFResult<Serializer.SerializedObject> = Result {
|
|
|
+ try responseSerializer.serialize(request: self.request,
|
|
|
+ response: self.response,
|
|
|
+ data: self.data,
|
|
|
+ error: self.error)
|
|
|
+ }.mapError { error in
|
|
|
+ error.asAFError(or: .responseSerializationFailed(reason: .customSerializationFailed(error: error)))
|
|
|
+ }
|
|
|
+
|
|
|
+ let end = ProcessInfo.processInfo.systemUptime
|
|
|
+ // End work that should be on the serialization queue.
|
|
|
+
|
|
|
+ self.underlyingQueue.async {
|
|
|
+ let response = DataResponse(request: self.request,
|
|
|
+ response: self.response,
|
|
|
+ data: self.data,
|
|
|
+ metrics: self.metrics,
|
|
|
+ serializationDuration: end - start,
|
|
|
+ result: result)
|
|
|
+
|
|
|
+ self.eventMonitor?.request(self, didParseResponse: response)
|
|
|
+
|
|
|
+ guard let serializerError = result.failure, let delegate = self.delegate else {
|
|
|
+ self.responseSerializerDidComplete { queue.async { completionHandler(response) } }
|
|
|
+ return
|
|
|
+ }
|
|
|
+
|
|
|
+ delegate.retryResult(for: self, dueTo: serializerError) { retryResult in
|
|
|
+ var didComplete: (() -> Void)?
|
|
|
+
|
|
|
+ defer {
|
|
|
+ if let didComplete = didComplete {
|
|
|
+ self.responseSerializerDidComplete { queue.async { didComplete() } }
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ switch retryResult {
|
|
|
+ case .doNotRetry:
|
|
|
+ didComplete = { completionHandler(response) }
|
|
|
+
|
|
|
+ case let .doNotRetryWithError(retryError):
|
|
|
+ let result: AFResult<Serializer.SerializedObject> = .failure(retryError.asAFError(orFailWith: "Received retryError was not already AFError"))
|
|
|
+
|
|
|
+ let response = DataResponse(request: self.request,
|
|
|
+ response: self.response,
|
|
|
+ data: self.data,
|
|
|
+ metrics: self.metrics,
|
|
|
+ serializationDuration: end - start,
|
|
|
+ result: result)
|
|
|
+
|
|
|
+ didComplete = { completionHandler(response) }
|
|
|
+
|
|
|
+ case .retry, .retryWithDelay:
|
|
|
+ delegate.retryRequest(self, withDelay: retryResult.delay)
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
}
|
|
|
|
|
|
return self
|
|
@@ -174,31 +281,32 @@ extension DataRequest {
|
|
|
extension DownloadRequest {
|
|
|
/// Adds a handler to be called once the request has finished.
|
|
|
///
|
|
|
- /// - parameter queue: The queue on which the completion handler is dispatched.
|
|
|
- /// - parameter completionHandler: The code to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is dispatched. `.main` by default.
|
|
|
+ /// - completionHandler: The code to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The request.
|
|
|
@discardableResult
|
|
|
- public func response(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- completionHandler: @escaping (DefaultDownloadResponse) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- delegate.queue.addOperation {
|
|
|
- (queue ?? DispatchQueue.main).async {
|
|
|
- var downloadResponse = DefaultDownloadResponse(
|
|
|
- request: self.request,
|
|
|
- response: self.response,
|
|
|
- temporaryURL: self.downloadDelegate.temporaryURL,
|
|
|
- destinationURL: self.downloadDelegate.destinationURL,
|
|
|
- resumeData: self.downloadDelegate.resumeData,
|
|
|
- error: self.downloadDelegate.error,
|
|
|
- timeline: self.timeline
|
|
|
- )
|
|
|
-
|
|
|
- downloadResponse.add(self.delegate.metrics)
|
|
|
-
|
|
|
- completionHandler(downloadResponse)
|
|
|
+ public func response(queue: DispatchQueue = .main,
|
|
|
+ completionHandler: @escaping (AFDownloadResponse<URL?>) -> Void)
|
|
|
+ -> Self {
|
|
|
+ appendResponseSerializer {
|
|
|
+ // Start work that should be on the serialization queue.
|
|
|
+ let result = AFResult<URL?>(value: self.fileURL, error: self.error)
|
|
|
+ // End work that should be on the serialization queue.
|
|
|
+
|
|
|
+ self.underlyingQueue.async {
|
|
|
+ let response = DownloadResponse(request: self.request,
|
|
|
+ response: self.response,
|
|
|
+ fileURL: self.fileURL,
|
|
|
+ resumeData: self.resumeData,
|
|
|
+ metrics: self.metrics,
|
|
|
+ serializationDuration: 0,
|
|
|
+ result: result)
|
|
|
+
|
|
|
+ self.eventMonitor?.request(self, didParseResponse: response)
|
|
|
+
|
|
|
+ self.responseSerializerDidComplete { queue.async { completionHandler(response) } }
|
|
|
}
|
|
|
}
|
|
|
|
|
@@ -207,509 +315,802 @@ extension DownloadRequest {
|
|
|
|
|
|
/// Adds a handler to be called once the request has finished.
|
|
|
///
|
|
|
- /// - parameter queue: The queue on which the completion handler is dispatched.
|
|
|
- /// - parameter responseSerializer: The response serializer responsible for serializing the request, response,
|
|
|
- /// and data contained in the destination url.
|
|
|
- /// - parameter completionHandler: The code to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is dispatched. `.main` by default.
|
|
|
+ /// - responseSerializer: The response serializer responsible for serializing the request, response, and data
|
|
|
+ /// contained in the destination `URL`.
|
|
|
+ /// - completionHandler: The code to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The request.
|
|
|
@discardableResult
|
|
|
- public func response<T: DownloadResponseSerializerProtocol>(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- responseSerializer: T,
|
|
|
- completionHandler: @escaping (DownloadResponse<T.SerializedObject>) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- delegate.queue.addOperation {
|
|
|
- let result = responseSerializer.serializeResponse(
|
|
|
- self.request,
|
|
|
- self.response,
|
|
|
- self.downloadDelegate.fileURL,
|
|
|
- self.downloadDelegate.error
|
|
|
- )
|
|
|
-
|
|
|
- var downloadResponse = DownloadResponse<T.SerializedObject>(
|
|
|
- request: self.request,
|
|
|
- response: self.response,
|
|
|
- temporaryURL: self.downloadDelegate.temporaryURL,
|
|
|
- destinationURL: self.downloadDelegate.destinationURL,
|
|
|
- resumeData: self.downloadDelegate.resumeData,
|
|
|
- result: result,
|
|
|
- timeline: self.timeline
|
|
|
- )
|
|
|
-
|
|
|
- downloadResponse.add(self.delegate.metrics)
|
|
|
-
|
|
|
- (queue ?? DispatchQueue.main).async { completionHandler(downloadResponse) }
|
|
|
+ public func response<Serializer: DownloadResponseSerializerProtocol>(queue: DispatchQueue = .main,
|
|
|
+ responseSerializer: Serializer,
|
|
|
+ completionHandler: @escaping (AFDownloadResponse<Serializer.SerializedObject>) -> Void)
|
|
|
+ -> Self {
|
|
|
+ appendResponseSerializer {
|
|
|
+ // Start work that should be on the serialization queue.
|
|
|
+ let start = ProcessInfo.processInfo.systemUptime
|
|
|
+ let result: AFResult<Serializer.SerializedObject> = Result {
|
|
|
+ try responseSerializer.serializeDownload(request: self.request,
|
|
|
+ response: self.response,
|
|
|
+ fileURL: self.fileURL,
|
|
|
+ error: self.error)
|
|
|
+ }.mapError { error in
|
|
|
+ error.asAFError(or: .responseSerializationFailed(reason: .customSerializationFailed(error: error)))
|
|
|
+ }
|
|
|
+ let end = ProcessInfo.processInfo.systemUptime
|
|
|
+ // End work that should be on the serialization queue.
|
|
|
+
|
|
|
+ self.underlyingQueue.async {
|
|
|
+ let response = DownloadResponse(request: self.request,
|
|
|
+ response: self.response,
|
|
|
+ fileURL: self.fileURL,
|
|
|
+ resumeData: self.resumeData,
|
|
|
+ metrics: self.metrics,
|
|
|
+ serializationDuration: end - start,
|
|
|
+ result: result)
|
|
|
+
|
|
|
+ self.eventMonitor?.request(self, didParseResponse: response)
|
|
|
+
|
|
|
+ guard let serializerError = result.failure, let delegate = self.delegate else {
|
|
|
+ self.responseSerializerDidComplete { queue.async { completionHandler(response) } }
|
|
|
+ return
|
|
|
+ }
|
|
|
+
|
|
|
+ delegate.retryResult(for: self, dueTo: serializerError) { retryResult in
|
|
|
+ var didComplete: (() -> Void)?
|
|
|
+
|
|
|
+ defer {
|
|
|
+ if let didComplete = didComplete {
|
|
|
+ self.responseSerializerDidComplete { queue.async { didComplete() } }
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ switch retryResult {
|
|
|
+ case .doNotRetry:
|
|
|
+ didComplete = { completionHandler(response) }
|
|
|
+
|
|
|
+ case let .doNotRetryWithError(retryError):
|
|
|
+ let result: AFResult<Serializer.SerializedObject> = .failure(retryError.asAFError(orFailWith: "Received retryError was not already AFError"))
|
|
|
+
|
|
|
+ let response = DownloadResponse(request: self.request,
|
|
|
+ response: self.response,
|
|
|
+ fileURL: self.fileURL,
|
|
|
+ resumeData: self.resumeData,
|
|
|
+ metrics: self.metrics,
|
|
|
+ serializationDuration: end - start,
|
|
|
+ result: result)
|
|
|
+
|
|
|
+ didComplete = { completionHandler(response) }
|
|
|
+
|
|
|
+ case .retry, .retryWithDelay:
|
|
|
+ delegate.retryRequest(self, withDelay: retryResult.delay)
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
}
|
|
|
|
|
|
return self
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-// MARK: - Data
|
|
|
+// MARK: - URL
|
|
|
|
|
|
-extension Request {
|
|
|
- /// Returns a result data type that contains the response data as-is.
|
|
|
- ///
|
|
|
- /// - parameter response: The response from the server.
|
|
|
- /// - parameter data: The data returned from the server.
|
|
|
- /// - parameter error: The error already encountered if it exists.
|
|
|
- ///
|
|
|
- /// - returns: The result data type.
|
|
|
- public static func serializeResponseData(response: HTTPURLResponse?, data: Data?, error: Error?) -> Result<Data> {
|
|
|
- guard error == nil else { return .failure(error!) }
|
|
|
+/// A `DownloadResponseSerializerProtocol` that performs only `Error` checking and ensures that a downloaded `fileURL`
|
|
|
+/// is present.
|
|
|
+public struct URLResponseSerializer: DownloadResponseSerializerProtocol {
|
|
|
+ /// Creates an instance.
|
|
|
+ public init() {}
|
|
|
|
|
|
- if let response = response, emptyDataStatusCodes.contains(response.statusCode) { return .success(Data()) }
|
|
|
+ public func serializeDownload(request: URLRequest?,
|
|
|
+ response: HTTPURLResponse?,
|
|
|
+ fileURL: URL?,
|
|
|
+ error: Error?) throws -> URL {
|
|
|
+ guard error == nil else { throw error! }
|
|
|
|
|
|
- guard let validData = data else {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputDataNil))
|
|
|
+ guard let url = fileURL else {
|
|
|
+ throw AFError.responseSerializationFailed(reason: .inputFileNil)
|
|
|
}
|
|
|
|
|
|
- return .success(validData)
|
|
|
+ return url
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-extension DataRequest {
|
|
|
- /// Creates a response serializer that returns the associated data as-is.
|
|
|
- ///
|
|
|
- /// - returns: A data response serializer.
|
|
|
- public static func dataResponseSerializer() -> DataResponseSerializer<Data> {
|
|
|
- return DataResponseSerializer { _, response, data, error in
|
|
|
- return Request.serializeResponseData(response: response, data: data, error: error)
|
|
|
- }
|
|
|
- }
|
|
|
-
|
|
|
- /// Adds a handler to be called once the request has finished.
|
|
|
+extension DownloadRequest {
|
|
|
+ /// Adds a handler using a `URLResponseSerializer` to be called once the request is finished.
|
|
|
///
|
|
|
- /// - parameter completionHandler: The code to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is called. `.main` by default.
|
|
|
+ /// - completionHandler: A closure to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The request.
|
|
|
@discardableResult
|
|
|
- public func responseData(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- completionHandler: @escaping (DataResponse<Data>) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- return response(
|
|
|
- queue: queue,
|
|
|
- responseSerializer: DataRequest.dataResponseSerializer(),
|
|
|
- completionHandler: completionHandler
|
|
|
- )
|
|
|
+ public func responseURL(queue: DispatchQueue = .main,
|
|
|
+ completionHandler: @escaping (AFDownloadResponse<URL>) -> Void) -> Self {
|
|
|
+ response(queue: queue, responseSerializer: URLResponseSerializer(), completionHandler: completionHandler)
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-extension DownloadRequest {
|
|
|
- /// Creates a response serializer that returns the associated data as-is.
|
|
|
+// MARK: - Data
|
|
|
+
|
|
|
+/// A `ResponseSerializer` that performs minimal response checking and returns any response `Data` as-is. By default, a
|
|
|
+/// request returning `nil` or no data is considered an error. However, if the request has an `HTTPMethod` or the
|
|
|
+/// response has an HTTP status code valid for empty responses, then an empty `Data` value is returned.
|
|
|
+public final class DataResponseSerializer: ResponseSerializer {
|
|
|
+ public let dataPreprocessor: DataPreprocessor
|
|
|
+ public let emptyResponseCodes: Set<Int>
|
|
|
+ public let emptyRequestMethods: Set<HTTPMethod>
|
|
|
+
|
|
|
+ /// Creates an instance using the provided values.
|
|
|
///
|
|
|
- /// - returns: A data response serializer.
|
|
|
- public static func dataResponseSerializer() -> DownloadResponseSerializer<Data> {
|
|
|
- return DownloadResponseSerializer { _, response, fileURL, error in
|
|
|
- guard error == nil else { return .failure(error!) }
|
|
|
+ /// - Parameters:
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` used to prepare the received `Data` for serialization.
|
|
|
+ /// - emptyResponseCodes: The HTTP response codes for which empty responses are allowed. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: The HTTP request methods for which empty responses are allowed. `[.head]` by default.
|
|
|
+ public init(dataPreprocessor: DataPreprocessor = DataResponseSerializer.defaultDataPreprocessor,
|
|
|
+ emptyResponseCodes: Set<Int> = DataResponseSerializer.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = DataResponseSerializer.defaultEmptyRequestMethods) {
|
|
|
+ self.dataPreprocessor = dataPreprocessor
|
|
|
+ self.emptyResponseCodes = emptyResponseCodes
|
|
|
+ self.emptyRequestMethods = emptyRequestMethods
|
|
|
+ }
|
|
|
|
|
|
- guard let fileURL = fileURL else {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputFileNil))
|
|
|
- }
|
|
|
+ public func serialize(request: URLRequest?, response: HTTPURLResponse?, data: Data?, error: Error?) throws -> Data {
|
|
|
+ guard error == nil else { throw error! }
|
|
|
|
|
|
- do {
|
|
|
- let data = try Data(contentsOf: fileURL)
|
|
|
- return Request.serializeResponseData(response: response, data: data, error: error)
|
|
|
- } catch {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputFileReadFailed(at: fileURL)))
|
|
|
+ guard var data = data, !data.isEmpty else {
|
|
|
+ guard emptyResponseAllowed(forRequest: request, response: response) else {
|
|
|
+ throw AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength)
|
|
|
}
|
|
|
+
|
|
|
+ return Data()
|
|
|
}
|
|
|
+
|
|
|
+ data = try dataPreprocessor.preprocess(data)
|
|
|
+
|
|
|
+ return data
|
|
|
}
|
|
|
+}
|
|
|
|
|
|
- /// Adds a handler to be called once the request has finished.
|
|
|
+extension DataRequest {
|
|
|
+ /// Adds a handler using a `DataResponseSerializer` to be called once the request has finished.
|
|
|
+ ///
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is called. `.main` by default.
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` which processes the received `Data` before calling the
|
|
|
+ /// `completionHandler`. `PassthroughPreprocessor()` by default.
|
|
|
+ /// - emptyResponseCodes: HTTP status codes for which empty responses are always valid. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: `HTTPMethod`s for which empty responses are always valid. `[.head]` by default.
|
|
|
+ /// - completionHandler: A closure to be executed once the request has finished.
|
|
|
+ ///
|
|
|
+ /// - Returns: The request.
|
|
|
+ @discardableResult
|
|
|
+ public func responseData(queue: DispatchQueue = .main,
|
|
|
+ dataPreprocessor: DataPreprocessor = DataResponseSerializer.defaultDataPreprocessor,
|
|
|
+ emptyResponseCodes: Set<Int> = DataResponseSerializer.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = DataResponseSerializer.defaultEmptyRequestMethods,
|
|
|
+ completionHandler: @escaping (AFDataResponse<Data>) -> Void) -> Self {
|
|
|
+ response(queue: queue,
|
|
|
+ responseSerializer: DataResponseSerializer(dataPreprocessor: dataPreprocessor,
|
|
|
+ emptyResponseCodes: emptyResponseCodes,
|
|
|
+ emptyRequestMethods: emptyRequestMethods),
|
|
|
+ completionHandler: completionHandler)
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+extension DownloadRequest {
|
|
|
+ /// Adds a handler using a `DataResponseSerializer` to be called once the request has finished.
|
|
|
///
|
|
|
- /// - parameter completionHandler: The code to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is called. `.main` by default.
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` which processes the received `Data` before calling the
|
|
|
+ /// `completionHandler`. `PassthroughPreprocessor()` by default.
|
|
|
+ /// - emptyResponseCodes: HTTP status codes for which empty responses are always valid. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: `HTTPMethod`s for which empty responses are always valid. `[.head]` by default.
|
|
|
+ /// - completionHandler: A closure to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The request.
|
|
|
@discardableResult
|
|
|
- public func responseData(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- completionHandler: @escaping (DownloadResponse<Data>) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- return response(
|
|
|
- queue: queue,
|
|
|
- responseSerializer: DownloadRequest.dataResponseSerializer(),
|
|
|
- completionHandler: completionHandler
|
|
|
- )
|
|
|
+ public func responseData(queue: DispatchQueue = .main,
|
|
|
+ dataPreprocessor: DataPreprocessor = DataResponseSerializer.defaultDataPreprocessor,
|
|
|
+ emptyResponseCodes: Set<Int> = DataResponseSerializer.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = DataResponseSerializer.defaultEmptyRequestMethods,
|
|
|
+ completionHandler: @escaping (AFDownloadResponse<Data>) -> Void) -> Self {
|
|
|
+ response(queue: queue,
|
|
|
+ responseSerializer: DataResponseSerializer(dataPreprocessor: dataPreprocessor,
|
|
|
+ emptyResponseCodes: emptyResponseCodes,
|
|
|
+ emptyRequestMethods: emptyRequestMethods),
|
|
|
+ completionHandler: completionHandler)
|
|
|
}
|
|
|
}
|
|
|
|
|
|
// MARK: - String
|
|
|
|
|
|
-extension Request {
|
|
|
- /// Returns a result string type initialized from the response data with the specified string encoding.
|
|
|
- ///
|
|
|
- /// - parameter encoding: The string encoding. If `nil`, the string encoding will be determined from the server
|
|
|
- /// response, falling back to the default HTTP default character set, ISO-8859-1.
|
|
|
- /// - parameter response: The response from the server.
|
|
|
- /// - parameter data: The data returned from the server.
|
|
|
- /// - parameter error: The error already encountered if it exists.
|
|
|
- ///
|
|
|
- /// - returns: The result data type.
|
|
|
- public static func serializeResponseString(
|
|
|
- encoding: String.Encoding?,
|
|
|
- response: HTTPURLResponse?,
|
|
|
- data: Data?,
|
|
|
- error: Error?)
|
|
|
- -> Result<String>
|
|
|
- {
|
|
|
- guard error == nil else { return .failure(error!) }
|
|
|
-
|
|
|
- if let response = response, emptyDataStatusCodes.contains(response.statusCode) { return .success("") }
|
|
|
-
|
|
|
- guard let validData = data else {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputDataNil))
|
|
|
+/// A `ResponseSerializer` that decodes the response data as a `String`. By default, a request returning `nil` or no
|
|
|
+/// data is considered an error. However, if the request has an `HTTPMethod` or the response has an HTTP status code
|
|
|
+/// valid for empty responses, then an empty `String` is returned.
|
|
|
+public final class StringResponseSerializer: ResponseSerializer {
|
|
|
+ public let dataPreprocessor: DataPreprocessor
|
|
|
+ /// Optional string encoding used to validate the response.
|
|
|
+ public let encoding: String.Encoding?
|
|
|
+ public let emptyResponseCodes: Set<Int>
|
|
|
+ public let emptyRequestMethods: Set<HTTPMethod>
|
|
|
+
|
|
|
+ /// Creates an instance with the provided values.
|
|
|
+ ///
|
|
|
+ /// - Parameters:
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` used to prepare the received `Data` for serialization.
|
|
|
+ /// - encoding: A string encoding. Defaults to `nil`, in which case the encoding will be determined
|
|
|
+ /// from the server response, falling back to the default HTTP character set, `ISO-8859-1`.
|
|
|
+ /// - emptyResponseCodes: The HTTP response codes for which empty responses are allowed. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: The HTTP request methods for which empty responses are allowed. `[.head]` by default.
|
|
|
+ public init(dataPreprocessor: DataPreprocessor = StringResponseSerializer.defaultDataPreprocessor,
|
|
|
+ encoding: String.Encoding? = nil,
|
|
|
+ emptyResponseCodes: Set<Int> = StringResponseSerializer.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = StringResponseSerializer.defaultEmptyRequestMethods) {
|
|
|
+ self.dataPreprocessor = dataPreprocessor
|
|
|
+ self.encoding = encoding
|
|
|
+ self.emptyResponseCodes = emptyResponseCodes
|
|
|
+ self.emptyRequestMethods = emptyRequestMethods
|
|
|
+ }
|
|
|
+
|
|
|
+ public func serialize(request: URLRequest?, response: HTTPURLResponse?, data: Data?, error: Error?) throws -> String {
|
|
|
+ guard error == nil else { throw error! }
|
|
|
+
|
|
|
+ guard var data = data, !data.isEmpty else {
|
|
|
+ guard emptyResponseAllowed(forRequest: request, response: response) else {
|
|
|
+ throw AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength)
|
|
|
+ }
|
|
|
+
|
|
|
+ return ""
|
|
|
}
|
|
|
|
|
|
+ data = try dataPreprocessor.preprocess(data)
|
|
|
+
|
|
|
var convertedEncoding = encoding
|
|
|
|
|
|
- if let encodingName = response?.textEncodingName as CFString?, convertedEncoding == nil {
|
|
|
- convertedEncoding = String.Encoding(rawValue: CFStringConvertEncodingToNSStringEncoding(
|
|
|
- CFStringConvertIANACharSetNameToEncoding(encodingName))
|
|
|
- )
|
|
|
+ if let encodingName = response?.textEncodingName, convertedEncoding == nil {
|
|
|
+ convertedEncoding = String.Encoding(ianaCharsetName: encodingName)
|
|
|
}
|
|
|
|
|
|
let actualEncoding = convertedEncoding ?? .isoLatin1
|
|
|
|
|
|
- if let string = String(data: validData, encoding: actualEncoding) {
|
|
|
- return .success(string)
|
|
|
- } else {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .stringSerializationFailed(encoding: actualEncoding)))
|
|
|
+ guard let string = String(data: data, encoding: actualEncoding) else {
|
|
|
+ throw AFError.responseSerializationFailed(reason: .stringSerializationFailed(encoding: actualEncoding))
|
|
|
}
|
|
|
+
|
|
|
+ return string
|
|
|
}
|
|
|
}
|
|
|
|
|
|
extension DataRequest {
|
|
|
- /// Creates a response serializer that returns a result string type initialized from the response data with
|
|
|
- /// the specified string encoding.
|
|
|
+ /// Adds a handler using a `StringResponseSerializer` to be called once the request has finished.
|
|
|
///
|
|
|
- /// - parameter encoding: The string encoding. If `nil`, the string encoding will be determined from the server
|
|
|
- /// response, falling back to the default HTTP default character set, ISO-8859-1.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is dispatched. `.main` by default.
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` which processes the received `Data` before calling the
|
|
|
+ /// `completionHandler`. `PassthroughPreprocessor()` by default.
|
|
|
+ /// - encoding: The string encoding. Defaults to `nil`, in which case the encoding will be determined
|
|
|
+ /// from the server response, falling back to the default HTTP character set, `ISO-8859-1`.
|
|
|
+ /// - emptyResponseCodes: HTTP status codes for which empty responses are always valid. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: `HTTPMethod`s for which empty responses are always valid. `[.head]` by default.
|
|
|
+ /// - completionHandler: A closure to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: A string response serializer.
|
|
|
- public static func stringResponseSerializer(encoding: String.Encoding? = nil) -> DataResponseSerializer<String> {
|
|
|
- return DataResponseSerializer { _, response, data, error in
|
|
|
- return Request.serializeResponseString(encoding: encoding, response: response, data: data, error: error)
|
|
|
- }
|
|
|
+ /// - Returns: The request.
|
|
|
+ @discardableResult
|
|
|
+ public func responseString(queue: DispatchQueue = .main,
|
|
|
+ dataPreprocessor: DataPreprocessor = StringResponseSerializer.defaultDataPreprocessor,
|
|
|
+ encoding: String.Encoding? = nil,
|
|
|
+ emptyResponseCodes: Set<Int> = StringResponseSerializer.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = StringResponseSerializer.defaultEmptyRequestMethods,
|
|
|
+ completionHandler: @escaping (AFDataResponse<String>) -> Void) -> Self {
|
|
|
+ response(queue: queue,
|
|
|
+ responseSerializer: StringResponseSerializer(dataPreprocessor: dataPreprocessor,
|
|
|
+ encoding: encoding,
|
|
|
+ emptyResponseCodes: emptyResponseCodes,
|
|
|
+ emptyRequestMethods: emptyRequestMethods),
|
|
|
+ completionHandler: completionHandler)
|
|
|
}
|
|
|
+}
|
|
|
|
|
|
- /// Adds a handler to be called once the request has finished.
|
|
|
+extension DownloadRequest {
|
|
|
+ /// Adds a handler using a `StringResponseSerializer` to be called once the request has finished.
|
|
|
///
|
|
|
- /// - parameter encoding: The string encoding. If `nil`, the string encoding will be determined from the
|
|
|
- /// server response, falling back to the default HTTP default character set,
|
|
|
- /// ISO-8859-1.
|
|
|
- /// - parameter completionHandler: A closure to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is dispatched. `.main` by default.
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` which processes the received `Data` before calling the
|
|
|
+ /// `completionHandler`. `PassthroughPreprocessor()` by default.
|
|
|
+ /// - encoding: The string encoding. Defaults to `nil`, in which case the encoding will be determined
|
|
|
+ /// from the server response, falling back to the default HTTP character set, `ISO-8859-1`.
|
|
|
+ /// - emptyResponseCodes: HTTP status codes for which empty responses are always valid. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: `HTTPMethod`s for which empty responses are always valid. `[.head]` by default.
|
|
|
+ /// - completionHandler: A closure to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The request.
|
|
|
@discardableResult
|
|
|
- public func responseString(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- encoding: String.Encoding? = nil,
|
|
|
- completionHandler: @escaping (DataResponse<String>) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- return response(
|
|
|
- queue: queue,
|
|
|
- responseSerializer: DataRequest.stringResponseSerializer(encoding: encoding),
|
|
|
- completionHandler: completionHandler
|
|
|
- )
|
|
|
+ public func responseString(queue: DispatchQueue = .main,
|
|
|
+ dataPreprocessor: DataPreprocessor = StringResponseSerializer.defaultDataPreprocessor,
|
|
|
+ encoding: String.Encoding? = nil,
|
|
|
+ emptyResponseCodes: Set<Int> = StringResponseSerializer.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = StringResponseSerializer.defaultEmptyRequestMethods,
|
|
|
+ completionHandler: @escaping (AFDownloadResponse<String>) -> Void) -> Self {
|
|
|
+ response(queue: queue,
|
|
|
+ responseSerializer: StringResponseSerializer(dataPreprocessor: dataPreprocessor,
|
|
|
+ encoding: encoding,
|
|
|
+ emptyResponseCodes: emptyResponseCodes,
|
|
|
+ emptyRequestMethods: emptyRequestMethods),
|
|
|
+ completionHandler: completionHandler)
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-extension DownloadRequest {
|
|
|
- /// Creates a response serializer that returns a result string type initialized from the response data with
|
|
|
- /// the specified string encoding.
|
|
|
- ///
|
|
|
- /// - parameter encoding: The string encoding. If `nil`, the string encoding will be determined from the server
|
|
|
- /// response, falling back to the default HTTP default character set, ISO-8859-1.
|
|
|
+// MARK: - JSON
|
|
|
+
|
|
|
+/// A `ResponseSerializer` that decodes the response data using `JSONSerialization`. By default, a request returning
|
|
|
+/// `nil` or no data is considered an error. However, if the request has an `HTTPMethod` or the response has an
|
|
|
+/// HTTP status code valid for empty responses, then an `NSNull` value is returned.
|
|
|
+public final class JSONResponseSerializer: ResponseSerializer {
|
|
|
+ public let dataPreprocessor: DataPreprocessor
|
|
|
+ public let emptyResponseCodes: Set<Int>
|
|
|
+ public let emptyRequestMethods: Set<HTTPMethod>
|
|
|
+ /// `JSONSerialization.ReadingOptions` used when serializing a response.
|
|
|
+ public let options: JSONSerialization.ReadingOptions
|
|
|
+
|
|
|
+ /// Creates an instance with the provided values.
|
|
|
///
|
|
|
- /// - returns: A string response serializer.
|
|
|
- public static func stringResponseSerializer(encoding: String.Encoding? = nil) -> DownloadResponseSerializer<String> {
|
|
|
- return DownloadResponseSerializer { _, response, fileURL, error in
|
|
|
- guard error == nil else { return .failure(error!) }
|
|
|
+ /// - Parameters:
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` used to prepare the received `Data` for serialization.
|
|
|
+ /// - emptyResponseCodes: The HTTP response codes for which empty responses are allowed. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: The HTTP request methods for which empty responses are allowed. `[.head]` by default.
|
|
|
+ /// - options: The options to use. `.allowFragments` by default.
|
|
|
+ public init(dataPreprocessor: DataPreprocessor = JSONResponseSerializer.defaultDataPreprocessor,
|
|
|
+ emptyResponseCodes: Set<Int> = JSONResponseSerializer.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = JSONResponseSerializer.defaultEmptyRequestMethods,
|
|
|
+ options: JSONSerialization.ReadingOptions = .allowFragments) {
|
|
|
+ self.dataPreprocessor = dataPreprocessor
|
|
|
+ self.emptyResponseCodes = emptyResponseCodes
|
|
|
+ self.emptyRequestMethods = emptyRequestMethods
|
|
|
+ self.options = options
|
|
|
+ }
|
|
|
|
|
|
- guard let fileURL = fileURL else {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputFileNil))
|
|
|
- }
|
|
|
+ public func serialize(request: URLRequest?, response: HTTPURLResponse?, data: Data?, error: Error?) throws -> Any {
|
|
|
+ guard error == nil else { throw error! }
|
|
|
|
|
|
- do {
|
|
|
- let data = try Data(contentsOf: fileURL)
|
|
|
- return Request.serializeResponseString(encoding: encoding, response: response, data: data, error: error)
|
|
|
- } catch {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputFileReadFailed(at: fileURL)))
|
|
|
+ guard var data = data, !data.isEmpty else {
|
|
|
+ guard emptyResponseAllowed(forRequest: request, response: response) else {
|
|
|
+ throw AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength)
|
|
|
}
|
|
|
+
|
|
|
+ return NSNull()
|
|
|
+ }
|
|
|
+
|
|
|
+ data = try dataPreprocessor.preprocess(data)
|
|
|
+
|
|
|
+ do {
|
|
|
+ return try JSONSerialization.jsonObject(with: data, options: options)
|
|
|
+ } catch {
|
|
|
+ throw AFError.responseSerializationFailed(reason: .jsonSerializationFailed(error: error))
|
|
|
}
|
|
|
}
|
|
|
+}
|
|
|
|
|
|
- /// Adds a handler to be called once the request has finished.
|
|
|
+extension DataRequest {
|
|
|
+ /// Adds a handler using a `JSONResponseSerializer` to be called once the request has finished.
|
|
|
///
|
|
|
- /// - parameter encoding: The string encoding. If `nil`, the string encoding will be determined from the
|
|
|
- /// server response, falling back to the default HTTP default character set,
|
|
|
- /// ISO-8859-1.
|
|
|
- /// - parameter completionHandler: A closure to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is dispatched. `.main` by default.
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` which processes the received `Data` before calling the
|
|
|
+ /// `completionHandler`. `PassthroughPreprocessor()` by default.
|
|
|
+ /// - encoding: The string encoding. Defaults to `nil`, in which case the encoding will be determined
|
|
|
+ /// from the server response, falling back to the default HTTP character set, `ISO-8859-1`.
|
|
|
+ /// - emptyResponseCodes: HTTP status codes for which empty responses are always valid. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: `HTTPMethod`s for which empty responses are always valid. `[.head]` by default.
|
|
|
+ /// - options: `JSONSerialization.ReadingOptions` used when parsing the response. `.allowFragments`
|
|
|
+ /// by default.
|
|
|
+ /// - completionHandler: A closure to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The request.
|
|
|
@discardableResult
|
|
|
- public func responseString(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- encoding: String.Encoding? = nil,
|
|
|
- completionHandler: @escaping (DownloadResponse<String>) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- return response(
|
|
|
- queue: queue,
|
|
|
- responseSerializer: DownloadRequest.stringResponseSerializer(encoding: encoding),
|
|
|
- completionHandler: completionHandler
|
|
|
- )
|
|
|
+ public func responseJSON(queue: DispatchQueue = .main,
|
|
|
+ dataPreprocessor: DataPreprocessor = JSONResponseSerializer.defaultDataPreprocessor,
|
|
|
+ emptyResponseCodes: Set<Int> = JSONResponseSerializer.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = JSONResponseSerializer.defaultEmptyRequestMethods,
|
|
|
+ options: JSONSerialization.ReadingOptions = .allowFragments,
|
|
|
+ completionHandler: @escaping (AFDataResponse<Any>) -> Void) -> Self {
|
|
|
+ response(queue: queue,
|
|
|
+ responseSerializer: JSONResponseSerializer(dataPreprocessor: dataPreprocessor,
|
|
|
+ emptyResponseCodes: emptyResponseCodes,
|
|
|
+ emptyRequestMethods: emptyRequestMethods,
|
|
|
+ options: options),
|
|
|
+ completionHandler: completionHandler)
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-// MARK: - JSON
|
|
|
+extension DownloadRequest {
|
|
|
+ /// Adds a handler using a `JSONResponseSerializer` to be called once the request has finished.
|
|
|
+ ///
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: The queue on which the completion handler is dispatched. `.main` by default.
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` which processes the received `Data` before calling the
|
|
|
+ /// `completionHandler`. `PassthroughPreprocessor()` by default.
|
|
|
+ /// - encoding: The string encoding. Defaults to `nil`, in which case the encoding will be determined
|
|
|
+ /// from the server response, falling back to the default HTTP character set, `ISO-8859-1`.
|
|
|
+ /// - emptyResponseCodes: HTTP status codes for which empty responses are always valid. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: `HTTPMethod`s for which empty responses are always valid. `[.head]` by default.
|
|
|
+ /// - options: `JSONSerialization.ReadingOptions` used when parsing the response. `.allowFragments`
|
|
|
+ /// by default.
|
|
|
+ /// - completionHandler: A closure to be executed once the request has finished.
|
|
|
+ ///
|
|
|
+ /// - Returns: The request.
|
|
|
+ @discardableResult
|
|
|
+ public func responseJSON(queue: DispatchQueue = .main,
|
|
|
+ dataPreprocessor: DataPreprocessor = JSONResponseSerializer.defaultDataPreprocessor,
|
|
|
+ emptyResponseCodes: Set<Int> = JSONResponseSerializer.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = JSONResponseSerializer.defaultEmptyRequestMethods,
|
|
|
+ options: JSONSerialization.ReadingOptions = .allowFragments,
|
|
|
+ completionHandler: @escaping (AFDownloadResponse<Any>) -> Void) -> Self {
|
|
|
+ response(queue: queue,
|
|
|
+ responseSerializer: JSONResponseSerializer(dataPreprocessor: dataPreprocessor,
|
|
|
+ emptyResponseCodes: emptyResponseCodes,
|
|
|
+ emptyRequestMethods: emptyRequestMethods,
|
|
|
+ options: options),
|
|
|
+ completionHandler: completionHandler)
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+// MARK: - Empty
|
|
|
+
|
|
|
+/// Protocol representing an empty response. Use `T.emptyValue()` to get an instance.
|
|
|
+public protocol EmptyResponse {
|
|
|
+ /// Empty value for the conforming type.
|
|
|
+ ///
|
|
|
+ /// - Returns: Value of `Self` to use for empty values.
|
|
|
+ static func emptyValue() -> Self
|
|
|
+}
|
|
|
+
|
|
|
+/// Type representing an empty value. Use `Empty.value` to get the static instance.
|
|
|
+public struct Empty: Codable {
|
|
|
+ /// Static `Empty` instance used for all `Empty` responses.
|
|
|
+ public static let value = Empty()
|
|
|
+}
|
|
|
+
|
|
|
+extension Empty: EmptyResponse {
|
|
|
+ public static func emptyValue() -> Empty {
|
|
|
+ value
|
|
|
+ }
|
|
|
+}
|
|
|
|
|
|
-extension Request {
|
|
|
- /// Returns a JSON object contained in a result type constructed from the response data using `JSONSerialization`
|
|
|
- /// with the specified reading options.
|
|
|
- ///
|
|
|
- /// - parameter options: The JSON serialization reading options. Defaults to `.allowFragments`.
|
|
|
- /// - parameter response: The response from the server.
|
|
|
- /// - parameter data: The data returned from the server.
|
|
|
- /// - parameter error: The error already encountered if it exists.
|
|
|
- ///
|
|
|
- /// - returns: The result data type.
|
|
|
- public static func serializeResponseJSON(
|
|
|
- options: JSONSerialization.ReadingOptions,
|
|
|
- response: HTTPURLResponse?,
|
|
|
- data: Data?,
|
|
|
- error: Error?)
|
|
|
- -> Result<Any>
|
|
|
- {
|
|
|
- guard error == nil else { return .failure(error!) }
|
|
|
-
|
|
|
- if let response = response, emptyDataStatusCodes.contains(response.statusCode) { return .success(NSNull()) }
|
|
|
-
|
|
|
- guard let validData = data, validData.count > 0 else {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength))
|
|
|
+// MARK: - DataDecoder Protocol
|
|
|
+
|
|
|
+/// Any type which can decode `Data` into a `Decodable` type.
|
|
|
+public protocol DataDecoder {
|
|
|
+ /// Decode `Data` into the provided type.
|
|
|
+ ///
|
|
|
+ /// - Parameters:
|
|
|
+ /// - type: The `Type` to be decoded.
|
|
|
+ /// - data: The `Data` to be decoded.
|
|
|
+ ///
|
|
|
+ /// - Returns: The decoded value of type `D`.
|
|
|
+ /// - Throws: Any error that occurs during decode.
|
|
|
+ func decode<D: Decodable>(_ type: D.Type, from data: Data) throws -> D
|
|
|
+}
|
|
|
+
|
|
|
+/// `JSONDecoder` automatically conforms to `DataDecoder`.
|
|
|
+extension JSONDecoder: DataDecoder {}
|
|
|
+/// `PropertyListDecoder` automatically conforms to `DataDecoder`.
|
|
|
+extension PropertyListDecoder: DataDecoder {}
|
|
|
+
|
|
|
+// MARK: - Decodable
|
|
|
+
|
|
|
+/// A `ResponseSerializer` that decodes the response data as a generic value using any type that conforms to
|
|
|
+/// `DataDecoder`. By default, this is an instance of `JSONDecoder`. Additionally, a request returning `nil` or no data
|
|
|
+/// is considered an error. However, if the request has an `HTTPMethod` or the response has an HTTP status code valid
|
|
|
+/// for empty responses then an empty value will be returned. If the decoded type conforms to `EmptyResponse`, the
|
|
|
+/// type's `emptyValue()` will be returned. If the decoded type is `Empty`, the `.value` instance is returned. If the
|
|
|
+/// decoded type *does not* conform to `EmptyResponse` and isn't `Empty`, an error will be produced.
|
|
|
+public final class DecodableResponseSerializer<T: Decodable>: ResponseSerializer {
|
|
|
+ public let dataPreprocessor: DataPreprocessor
|
|
|
+ /// The `DataDecoder` instance used to decode responses.
|
|
|
+ public let decoder: DataDecoder
|
|
|
+ public let emptyResponseCodes: Set<Int>
|
|
|
+ public let emptyRequestMethods: Set<HTTPMethod>
|
|
|
+
|
|
|
+ /// Creates an instance using the values provided.
|
|
|
+ ///
|
|
|
+ /// - Parameters:
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` used to prepare the received `Data` for serialization.
|
|
|
+ /// - decoder: The `DataDecoder`. `JSONDecoder()` by default.
|
|
|
+ /// - emptyResponseCodes: The HTTP response codes for which empty responses are allowed. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: The HTTP request methods for which empty responses are allowed. `[.head]` by default.
|
|
|
+ public init(dataPreprocessor: DataPreprocessor = DecodableResponseSerializer.defaultDataPreprocessor,
|
|
|
+ decoder: DataDecoder = JSONDecoder(),
|
|
|
+ emptyResponseCodes: Set<Int> = DecodableResponseSerializer.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = DecodableResponseSerializer.defaultEmptyRequestMethods) {
|
|
|
+ self.dataPreprocessor = dataPreprocessor
|
|
|
+ self.decoder = decoder
|
|
|
+ self.emptyResponseCodes = emptyResponseCodes
|
|
|
+ self.emptyRequestMethods = emptyRequestMethods
|
|
|
+ }
|
|
|
+
|
|
|
+ public func serialize(request: URLRequest?, response: HTTPURLResponse?, data: Data?, error: Error?) throws -> T {
|
|
|
+ guard error == nil else { throw error! }
|
|
|
+
|
|
|
+ guard var data = data, !data.isEmpty else {
|
|
|
+ guard emptyResponseAllowed(forRequest: request, response: response) else {
|
|
|
+ throw AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength)
|
|
|
+ }
|
|
|
+
|
|
|
+ guard let emptyResponseType = T.self as? EmptyResponse.Type, let emptyValue = emptyResponseType.emptyValue() as? T else {
|
|
|
+ throw AFError.responseSerializationFailed(reason: .invalidEmptyResponse(type: "\(T.self)"))
|
|
|
+ }
|
|
|
+
|
|
|
+ return emptyValue
|
|
|
}
|
|
|
|
|
|
+ data = try dataPreprocessor.preprocess(data)
|
|
|
+
|
|
|
do {
|
|
|
- let json = try JSONSerialization.jsonObject(with: validData, options: options)
|
|
|
- return .success(json)
|
|
|
+ return try decoder.decode(T.self, from: data)
|
|
|
} catch {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .jsonSerializationFailed(error: error)))
|
|
|
+ throw AFError.responseSerializationFailed(reason: .decodingFailed(error: error))
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
|
|
|
extension DataRequest {
|
|
|
- /// Creates a response serializer that returns a JSON object result type constructed from the response data using
|
|
|
- /// `JSONSerialization` with the specified reading options.
|
|
|
- ///
|
|
|
- /// - parameter options: The JSON serialization reading options. Defaults to `.allowFragments`.
|
|
|
- ///
|
|
|
- /// - returns: A JSON object response serializer.
|
|
|
- public static func jsonResponseSerializer(
|
|
|
- options: JSONSerialization.ReadingOptions = .allowFragments)
|
|
|
- -> DataResponseSerializer<Any>
|
|
|
- {
|
|
|
- return DataResponseSerializer { _, response, data, error in
|
|
|
- return Request.serializeResponseJSON(options: options, response: response, data: data, error: error)
|
|
|
- }
|
|
|
- }
|
|
|
-
|
|
|
- /// Adds a handler to be called once the request has finished.
|
|
|
+ /// Adds a handler using a `DecodableResponseSerializer` to be called once the request has finished.
|
|
|
///
|
|
|
- /// - parameter options: The JSON serialization reading options. Defaults to `.allowFragments`.
|
|
|
- /// - parameter completionHandler: A closure to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - type: `Decodable` type to decode from response data.
|
|
|
+ /// - queue: The queue on which the completion handler is dispatched. `.main` by default.
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` which processes the received `Data` before calling the
|
|
|
+ /// `completionHandler`. `PassthroughPreprocessor()` by default.
|
|
|
+ /// - decoder: `DataDecoder` to use to decode the response. `JSONDecoder()` by default.
|
|
|
+ /// - encoding: The string encoding. Defaults to `nil`, in which case the encoding will be determined
|
|
|
+ /// from the server response, falling back to the default HTTP character set, `ISO-8859-1`.
|
|
|
+ /// - emptyResponseCodes: HTTP status codes for which empty responses are always valid. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: `HTTPMethod`s for which empty responses are always valid. `[.head]` by default.
|
|
|
+ /// - options: `JSONSerialization.ReadingOptions` used when parsing the response. `.allowFragments`
|
|
|
+ /// by default.
|
|
|
+ /// - completionHandler: A closure to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The request.
|
|
|
@discardableResult
|
|
|
- public func responseJSON(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- options: JSONSerialization.ReadingOptions = .allowFragments,
|
|
|
- completionHandler: @escaping (DataResponse<Any>) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- return response(
|
|
|
- queue: queue,
|
|
|
- responseSerializer: DataRequest.jsonResponseSerializer(options: options),
|
|
|
- completionHandler: completionHandler
|
|
|
- )
|
|
|
+ public func responseDecodable<T: Decodable>(of type: T.Type = T.self,
|
|
|
+ queue: DispatchQueue = .main,
|
|
|
+ dataPreprocessor: DataPreprocessor = DecodableResponseSerializer<T>.defaultDataPreprocessor,
|
|
|
+ decoder: DataDecoder = JSONDecoder(),
|
|
|
+ emptyResponseCodes: Set<Int> = DecodableResponseSerializer<T>.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = DecodableResponseSerializer<T>.defaultEmptyRequestMethods,
|
|
|
+ completionHandler: @escaping (AFDataResponse<T>) -> Void) -> Self {
|
|
|
+ response(queue: queue,
|
|
|
+ responseSerializer: DecodableResponseSerializer(dataPreprocessor: dataPreprocessor,
|
|
|
+ decoder: decoder,
|
|
|
+ emptyResponseCodes: emptyResponseCodes,
|
|
|
+ emptyRequestMethods: emptyRequestMethods),
|
|
|
+ completionHandler: completionHandler)
|
|
|
}
|
|
|
}
|
|
|
|
|
|
extension DownloadRequest {
|
|
|
- /// Creates a response serializer that returns a JSON object result type constructed from the response data using
|
|
|
- /// `JSONSerialization` with the specified reading options.
|
|
|
+ /// Adds a handler using a `DecodableResponseSerializer` to be called once the request has finished.
|
|
|
///
|
|
|
- /// - parameter options: The JSON serialization reading options. Defaults to `.allowFragments`.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - type: `Decodable` type to decode from response data.
|
|
|
+ /// - queue: The queue on which the completion handler is dispatched. `.main` by default.
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` which processes the received `Data` before calling the
|
|
|
+ /// `completionHandler`. `PassthroughPreprocessor()` by default.
|
|
|
+ /// - decoder: `DataDecoder` to use to decode the response. `JSONDecoder()` by default.
|
|
|
+ /// - encoding: The string encoding. Defaults to `nil`, in which case the encoding will be determined
|
|
|
+ /// from the server response, falling back to the default HTTP character set, `ISO-8859-1`.
|
|
|
+ /// - emptyResponseCodes: HTTP status codes for which empty responses are always valid. `[204, 205]` by default.
|
|
|
+ /// - emptyRequestMethods: `HTTPMethod`s for which empty responses are always valid. `[.head]` by default.
|
|
|
+ /// - options: `JSONSerialization.ReadingOptions` used when parsing the response. `.allowFragments`
|
|
|
+ /// by default.
|
|
|
+ /// - completionHandler: A closure to be executed once the request has finished.
|
|
|
///
|
|
|
- /// - returns: A JSON object response serializer.
|
|
|
- public static func jsonResponseSerializer(
|
|
|
- options: JSONSerialization.ReadingOptions = .allowFragments)
|
|
|
- -> DownloadResponseSerializer<Any>
|
|
|
- {
|
|
|
- return DownloadResponseSerializer { _, response, fileURL, error in
|
|
|
- guard error == nil else { return .failure(error!) }
|
|
|
+ /// - Returns: The request.
|
|
|
+ @discardableResult
|
|
|
+ public func responseDecodable<T: Decodable>(of type: T.Type = T.self,
|
|
|
+ queue: DispatchQueue = .main,
|
|
|
+ dataPreprocessor: DataPreprocessor = DecodableResponseSerializer<T>.defaultDataPreprocessor,
|
|
|
+ decoder: DataDecoder = JSONDecoder(),
|
|
|
+ emptyResponseCodes: Set<Int> = DecodableResponseSerializer<T>.defaultEmptyResponseCodes,
|
|
|
+ emptyRequestMethods: Set<HTTPMethod> = DecodableResponseSerializer<T>.defaultEmptyRequestMethods,
|
|
|
+ completionHandler: @escaping (AFDownloadResponse<T>) -> Void) -> Self {
|
|
|
+ response(queue: queue,
|
|
|
+ responseSerializer: DecodableResponseSerializer(dataPreprocessor: dataPreprocessor,
|
|
|
+ decoder: decoder,
|
|
|
+ emptyResponseCodes: emptyResponseCodes,
|
|
|
+ emptyRequestMethods: emptyRequestMethods),
|
|
|
+ completionHandler: completionHandler)
|
|
|
+ }
|
|
|
+}
|
|
|
|
|
|
- guard let fileURL = fileURL else {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputFileNil))
|
|
|
- }
|
|
|
+// MARK: - DataStreamRequest
|
|
|
|
|
|
- do {
|
|
|
- let data = try Data(contentsOf: fileURL)
|
|
|
- return Request.serializeResponseJSON(options: options, response: response, data: data, error: error)
|
|
|
- } catch {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputFileReadFailed(at: fileURL)))
|
|
|
- }
|
|
|
- }
|
|
|
- }
|
|
|
+/// A type which can serialize incoming `Data`.
|
|
|
+public protocol DataStreamSerializer {
|
|
|
+ /// Type produced from the serialized `Data`.
|
|
|
+ associatedtype SerializedObject
|
|
|
|
|
|
- /// Adds a handler to be called once the request has finished.
|
|
|
+ /// Serializes incoming `Data` into a `SerializedObject` value.
|
|
|
///
|
|
|
- /// - parameter options: The JSON serialization reading options. Defaults to `.allowFragments`.
|
|
|
- /// - parameter completionHandler: A closure to be executed once the request has finished.
|
|
|
+ /// - Parameter data: `Data` to be serialized.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
- @discardableResult
|
|
|
- public func responseJSON(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- options: JSONSerialization.ReadingOptions = .allowFragments,
|
|
|
- completionHandler: @escaping (DownloadResponse<Any>) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- return response(
|
|
|
- queue: queue,
|
|
|
- responseSerializer: DownloadRequest.jsonResponseSerializer(options: options),
|
|
|
- completionHandler: completionHandler
|
|
|
- )
|
|
|
- }
|
|
|
-}
|
|
|
-
|
|
|
-// MARK: - Property List
|
|
|
-
|
|
|
-extension Request {
|
|
|
- /// Returns a plist object contained in a result type constructed from the response data using
|
|
|
- /// `PropertyListSerialization` with the specified reading options.
|
|
|
- ///
|
|
|
- /// - parameter options: The property list reading options. Defaults to `[]`.
|
|
|
- /// - parameter response: The response from the server.
|
|
|
- /// - parameter data: The data returned from the server.
|
|
|
- /// - parameter error: The error already encountered if it exists.
|
|
|
- ///
|
|
|
- /// - returns: The result data type.
|
|
|
- public static func serializeResponsePropertyList(
|
|
|
- options: PropertyListSerialization.ReadOptions,
|
|
|
- response: HTTPURLResponse?,
|
|
|
- data: Data?,
|
|
|
- error: Error?)
|
|
|
- -> Result<Any>
|
|
|
- {
|
|
|
- guard error == nil else { return .failure(error!) }
|
|
|
-
|
|
|
- if let response = response, emptyDataStatusCodes.contains(response.statusCode) { return .success(NSNull()) }
|
|
|
-
|
|
|
- guard let validData = data, validData.count > 0 else {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputDataNilOrZeroLength))
|
|
|
- }
|
|
|
+ /// - Throws: Any error produced during serialization.
|
|
|
+ func serialize(_ data: Data) throws -> SerializedObject
|
|
|
+}
|
|
|
|
|
|
+/// `DataStreamSerializer` which uses the provided `DataPreprocessor` and `DataDecoder` to serialize the incoming `Data`.
|
|
|
+public struct DecodableStreamSerializer<T: Decodable>: DataStreamSerializer {
|
|
|
+ /// `DataDecoder` used to decode incoming `Data`.
|
|
|
+ public let decoder: DataDecoder
|
|
|
+ /// `DataPreprocessor` incoming `Data` is passed through before being passed to the `DataDecoder`.
|
|
|
+ public let dataPreprocessor: DataPreprocessor
|
|
|
+
|
|
|
+ /// Creates an instance with the provided `DataDecoder` and `DataPreprocessor`.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - decoder: ` DataDecoder` used to decode incoming `Data`.
|
|
|
+ /// - dataPreprocessor: `DataPreprocessor` used to process incoming `Data` before it's passed through the `decoder`.
|
|
|
+ public init(decoder: DataDecoder = JSONDecoder(), dataPreprocessor: DataPreprocessor = PassthroughPreprocessor()) {
|
|
|
+ self.decoder = decoder
|
|
|
+ self.dataPreprocessor = dataPreprocessor
|
|
|
+ }
|
|
|
+
|
|
|
+ public func serialize(_ data: Data) throws -> T {
|
|
|
+ let processedData = try dataPreprocessor.preprocess(data)
|
|
|
do {
|
|
|
- let plist = try PropertyListSerialization.propertyList(from: validData, options: options, format: nil)
|
|
|
- return .success(plist)
|
|
|
+ return try decoder.decode(T.self, from: processedData)
|
|
|
} catch {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .propertyListSerializationFailed(error: error)))
|
|
|
+ throw AFError.responseSerializationFailed(reason: .decodingFailed(error: error))
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-extension DataRequest {
|
|
|
- /// Creates a response serializer that returns an object constructed from the response data using
|
|
|
- /// `PropertyListSerialization` with the specified reading options.
|
|
|
- ///
|
|
|
- /// - parameter options: The property list reading options. Defaults to `[]`.
|
|
|
- ///
|
|
|
- /// - returns: A property list object response serializer.
|
|
|
- public static func propertyListResponseSerializer(
|
|
|
- options: PropertyListSerialization.ReadOptions = [])
|
|
|
- -> DataResponseSerializer<Any>
|
|
|
- {
|
|
|
- return DataResponseSerializer { _, response, data, error in
|
|
|
- return Request.serializeResponsePropertyList(options: options, response: response, data: data, error: error)
|
|
|
- }
|
|
|
+/// `DataStreamSerializer` which performs no serialization on incoming `Data`.
|
|
|
+public struct PassthroughStreamSerializer: DataStreamSerializer {
|
|
|
+ public func serialize(_ data: Data) throws -> Data { data }
|
|
|
+}
|
|
|
+
|
|
|
+/// `DataStreamSerializer` which serializes incoming stream `Data` into `UTF8`-decoded `String` values.
|
|
|
+public struct StringStreamSerializer: DataStreamSerializer {
|
|
|
+ public func serialize(_ data: Data) throws -> String {
|
|
|
+ String(decoding: data, as: UTF8.self)
|
|
|
}
|
|
|
+}
|
|
|
|
|
|
- /// Adds a handler to be called once the request has finished.
|
|
|
+extension DataStreamRequest {
|
|
|
+ /// Adds a `StreamHandler` which performs no parsing on incoming `Data`.
|
|
|
///
|
|
|
- /// - parameter options: The property list reading options. Defaults to `[]`.
|
|
|
- /// - parameter completionHandler: A closure to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: `DispatchQueue` on which to perform `StreamHandler` closure.
|
|
|
+ /// - stream: `StreamHandler` closure called as `Data` is received. May be called multiple times.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The `DataStreamRequest`.
|
|
|
@discardableResult
|
|
|
- public func responsePropertyList(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- options: PropertyListSerialization.ReadOptions = [],
|
|
|
- completionHandler: @escaping (DataResponse<Any>) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- return response(
|
|
|
- queue: queue,
|
|
|
- responseSerializer: DataRequest.propertyListResponseSerializer(options: options),
|
|
|
- completionHandler: completionHandler
|
|
|
- )
|
|
|
+ public func responseStream(on queue: DispatchQueue = .main, stream: @escaping Handler<Data, Never>) -> Self {
|
|
|
+ let parser = { [unowned self] (data: Data) in
|
|
|
+ queue.async {
|
|
|
+ self.capturingError {
|
|
|
+ try stream(.init(event: .stream(.success(data)), token: .init(self)))
|
|
|
+ }
|
|
|
+
|
|
|
+ self.updateAndCompleteIfPossible()
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ $streamMutableState.write { $0.streams.append(parser) }
|
|
|
+ appendStreamCompletion(on: queue, stream: stream)
|
|
|
+
|
|
|
+ return self
|
|
|
}
|
|
|
-}
|
|
|
|
|
|
-extension DownloadRequest {
|
|
|
- /// Creates a response serializer that returns an object constructed from the response data using
|
|
|
- /// `PropertyListSerialization` with the specified reading options.
|
|
|
+ /// Adds a `StreamHandler` which uses the provided `DataStreamSerializer` to process incoming `Data`.
|
|
|
///
|
|
|
- /// - parameter options: The property list reading options. Defaults to `[]`.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - serializer: `DataStreamSerializer` used to process incoming `Data`. Its work is done on the `serializationQueue`.
|
|
|
+ /// - queue: `DispatchQueue` on which to perform `StreamHandler` closure.
|
|
|
+ /// - stream: `StreamHandler` closure called as `Data` is received. May be called multiple times.
|
|
|
///
|
|
|
- /// - returns: A property list object response serializer.
|
|
|
- public static func propertyListResponseSerializer(
|
|
|
- options: PropertyListSerialization.ReadOptions = [])
|
|
|
- -> DownloadResponseSerializer<Any>
|
|
|
- {
|
|
|
- return DownloadResponseSerializer { _, response, fileURL, error in
|
|
|
- guard error == nil else { return .failure(error!) }
|
|
|
-
|
|
|
- guard let fileURL = fileURL else {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputFileNil))
|
|
|
+ /// - Returns: The `DataStreamRequest`.
|
|
|
+ @discardableResult
|
|
|
+ public func responseStream<Serializer: DataStreamSerializer>(using serializer: Serializer,
|
|
|
+ on queue: DispatchQueue = .main,
|
|
|
+ stream: @escaping Handler<Serializer.SerializedObject, AFError>) -> Self {
|
|
|
+ let parser = { [unowned self] (data: Data) in
|
|
|
+ self.serializationQueue.async {
|
|
|
+ // Start work on serialization queue.
|
|
|
+ let result = Result { try serializer.serialize(data) }
|
|
|
+ .mapError { $0.asAFError(or: .responseSerializationFailed(reason: .customSerializationFailed(error: $0))) }
|
|
|
+ // End work on serialization queue.
|
|
|
+ self.underlyingQueue.async {
|
|
|
+ self.eventMonitor?.request(self, didParseStream: result)
|
|
|
+
|
|
|
+ if result.isFailure, self.automaticallyCancelOnStreamError {
|
|
|
+ self.cancel()
|
|
|
+ }
|
|
|
+
|
|
|
+ queue.async {
|
|
|
+ self.capturingError {
|
|
|
+ try stream(.init(event: .stream(result), token: .init(self)))
|
|
|
+ }
|
|
|
+
|
|
|
+ self.updateAndCompleteIfPossible()
|
|
|
+ }
|
|
|
+ }
|
|
|
}
|
|
|
+ }
|
|
|
+
|
|
|
+ $streamMutableState.write { $0.streams.append(parser) }
|
|
|
+ appendStreamCompletion(on: queue, stream: stream)
|
|
|
|
|
|
- do {
|
|
|
- let data = try Data(contentsOf: fileURL)
|
|
|
- return Request.serializeResponsePropertyList(options: options, response: response, data: data, error: error)
|
|
|
- } catch {
|
|
|
- return .failure(AFError.responseSerializationFailed(reason: .inputFileReadFailed(at: fileURL)))
|
|
|
+ return self
|
|
|
+ }
|
|
|
+
|
|
|
+ /// Adds a `StreamHandler` which parses incoming `Data` as a UTF8 `String`.
|
|
|
+ ///
|
|
|
+ /// - Parameters:
|
|
|
+ /// - queue: `DispatchQueue` on which to perform `StreamHandler` closure.
|
|
|
+ /// - stream: `StreamHandler` closure called as `Data` is received. May be called multiple times.
|
|
|
+ ///
|
|
|
+ /// - Returns: The `DataStreamRequest`.
|
|
|
+ @discardableResult
|
|
|
+ public func responseStreamString(on queue: DispatchQueue = .main,
|
|
|
+ stream: @escaping Handler<String, Never>) -> Self {
|
|
|
+ let parser = { [unowned self] (data: Data) in
|
|
|
+ self.serializationQueue.async {
|
|
|
+ // Start work on serialization queue.
|
|
|
+ let string = String(decoding: data, as: UTF8.self)
|
|
|
+ // End work on serialization queue.
|
|
|
+ self.underlyingQueue.async {
|
|
|
+ self.eventMonitor?.request(self, didParseStream: .success(string))
|
|
|
+
|
|
|
+ queue.async {
|
|
|
+ self.capturingError {
|
|
|
+ try stream(.init(event: .stream(.success(string)), token: .init(self)))
|
|
|
+ }
|
|
|
+
|
|
|
+ self.updateAndCompleteIfPossible()
|
|
|
+ }
|
|
|
+ }
|
|
|
}
|
|
|
}
|
|
|
+
|
|
|
+ $streamMutableState.write { $0.streams.append(parser) }
|
|
|
+ appendStreamCompletion(on: queue, stream: stream)
|
|
|
+
|
|
|
+ return self
|
|
|
}
|
|
|
|
|
|
- /// Adds a handler to be called once the request has finished.
|
|
|
+ private func updateAndCompleteIfPossible() {
|
|
|
+ $streamMutableState.write { state in
|
|
|
+ state.numberOfExecutingStreams -= 1
|
|
|
+
|
|
|
+ guard state.numberOfExecutingStreams == 0, !state.enqueuedCompletionEvents.isEmpty else { return }
|
|
|
+
|
|
|
+ let completionEvents = state.enqueuedCompletionEvents
|
|
|
+ self.underlyingQueue.async { completionEvents.forEach { $0() } }
|
|
|
+ state.enqueuedCompletionEvents.removeAll()
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ /// Adds a `StreamHandler` which parses incoming `Data` using the provided `DataDecoder`.
|
|
|
///
|
|
|
- /// - parameter options: The property list reading options. Defaults to `[]`.
|
|
|
- /// - parameter completionHandler: A closure to be executed once the request has finished.
|
|
|
+ /// - Parameters:
|
|
|
+ /// - type: `Decodable` type to parse incoming `Data` into.
|
|
|
+ /// - queue: `DispatchQueue` on which to perform `StreamHandler` closure.
|
|
|
+ /// - decoder: `DataDecoder` used to decode the incoming `Data`.
|
|
|
+ /// - preprocessor: `DataPreprocessor` used to process the incoming `Data` before it's passed to the `decoder`.
|
|
|
+ /// - stream: `StreamHandler` closure called as `Data` is received. May be called multiple times.
|
|
|
///
|
|
|
- /// - returns: The request.
|
|
|
+ /// - Returns: The `DataStreamRequest`.
|
|
|
@discardableResult
|
|
|
- public func responsePropertyList(
|
|
|
- queue: DispatchQueue? = nil,
|
|
|
- options: PropertyListSerialization.ReadOptions = [],
|
|
|
- completionHandler: @escaping (DownloadResponse<Any>) -> Void)
|
|
|
- -> Self
|
|
|
- {
|
|
|
- return response(
|
|
|
- queue: queue,
|
|
|
- responseSerializer: DownloadRequest.propertyListResponseSerializer(options: options),
|
|
|
- completionHandler: completionHandler
|
|
|
- )
|
|
|
- }
|
|
|
-}
|
|
|
-
|
|
|
-/// A set of HTTP response status code that do not contain response data.
|
|
|
-private let emptyDataStatusCodes: Set<Int> = [204, 205]
|
|
|
+ public func responseStreamDecodable<T: Decodable>(of type: T.Type = T.self,
|
|
|
+ on queue: DispatchQueue = .main,
|
|
|
+ using decoder: DataDecoder = JSONDecoder(),
|
|
|
+ preprocessor: DataPreprocessor = PassthroughPreprocessor(),
|
|
|
+ stream: @escaping Handler<T, AFError>) -> Self {
|
|
|
+ responseStream(using: DecodableStreamSerializer<T>(decoder: decoder, dataPreprocessor: preprocessor),
|
|
|
+ stream: stream)
|
|
|
+ }
|
|
|
+}
|