123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287 |
- import Foundation
- // MARK: - Method
- public extension Method {
- /// A Boolean value determining whether the request supports multipart.
- var supportsMultipart: Bool {
- switch self {
- case .post, .put, .patch, .connect:
- return true
- default:
- return false
- }
- }
- }
- // MARK: - MoyaProvider
- /// Internal extension to keep the inner-workings outside the main Moya.swift file.
- public extension MoyaProvider {
- /// Performs normal requests.
- func requestNormal(_ target: Target, callbackQueue: DispatchQueue?, progress: Moya.ProgressBlock?, completion: @escaping Moya.Completion) -> Cancellable {
- let endpoint = self.endpoint(target)
- let stubBehavior = self.stubClosure(target)
- let cancellableToken = CancellableWrapper()
- // Allow plugins to modify response
- let pluginsWithCompletion: Moya.Completion = { result in
- let processedResult = self.plugins.reduce(result) { $1.process($0, target: target) }
- completion(processedResult)
- }
- if trackInflights {
- lock.lock()
- var inflightCompletionBlocks = self.inflightRequests[endpoint]
- inflightCompletionBlocks?.append(pluginsWithCompletion)
- self.inflightRequests[endpoint] = inflightCompletionBlocks
- lock.unlock()
- if inflightCompletionBlocks != nil {
- return cancellableToken
- } else {
- lock.lock()
- self.inflightRequests[endpoint] = [pluginsWithCompletion]
- lock.unlock()
- }
- }
- let performNetworking = { (requestResult: Result<URLRequest, MoyaError>) in
- if cancellableToken.isCancelled {
- self.cancelCompletion(pluginsWithCompletion, target: target)
- return
- }
- var request: URLRequest!
- switch requestResult {
- case .success(let urlRequest):
- request = urlRequest
- case .failure(let error):
- pluginsWithCompletion(.failure(error))
- return
- }
- let networkCompletion: Moya.Completion = { result in
- if self.trackInflights {
- self.inflightRequests[endpoint]?.forEach { $0(result) }
- self.lock.lock()
- self.inflightRequests.removeValue(forKey: endpoint)
- self.lock.unlock()
- } else {
- pluginsWithCompletion(result)
- }
- }
- cancellableToken.innerCancellable = self.performRequest(target, request: request, callbackQueue: callbackQueue, progress: progress, completion: networkCompletion, endpoint: endpoint, stubBehavior: stubBehavior)
- }
- requestClosure(endpoint, performNetworking)
- return cancellableToken
- }
- // swiftlint:disable:next function_parameter_count
- private func performRequest(_ target: Target, request: URLRequest, callbackQueue: DispatchQueue?, progress: Moya.ProgressBlock?, completion: @escaping Moya.Completion, endpoint: Endpoint, stubBehavior: Moya.StubBehavior) -> Cancellable {
- switch stubBehavior {
- case .never:
- switch endpoint.task {
- case .requestPlain, .requestData, .requestJSONEncodable, .requestCustomJSONEncodable, .requestParameters, .requestCompositeData, .requestCompositeParameters:
- return self.sendRequest(target, request: request, callbackQueue: callbackQueue, progress: progress, completion: completion)
- case .uploadFile(let file):
- return self.sendUploadFile(target, request: request, callbackQueue: callbackQueue, file: file, progress: progress, completion: completion)
- case .uploadMultipart(let multipartBody), .uploadCompositeMultipart(let multipartBody, _):
- guard !multipartBody.isEmpty && endpoint.method.supportsMultipart else {
- fatalError("\(target) is not a multipart upload target.")
- }
- return self.sendUploadMultipart(target, request: request, callbackQueue: callbackQueue, multipartBody: multipartBody, progress: progress, completion: completion)
- case .downloadDestination(let destination), .downloadParameters(_, _, let destination):
- return self.sendDownloadRequest(target, request: request, callbackQueue: callbackQueue, destination: destination, progress: progress, completion: completion)
- }
- default:
- return self.stubRequest(target, request: request, callbackQueue: callbackQueue, completion: completion, endpoint: endpoint, stubBehavior: stubBehavior)
- }
- }
- func cancelCompletion(_ completion: Moya.Completion, target: Target) {
- let error = MoyaError.underlying(NSError(domain: NSURLErrorDomain, code: NSURLErrorCancelled, userInfo: nil), nil)
- plugins.forEach { $0.didReceive(.failure(error), target: target) }
- completion(.failure(error))
- }
- /// Creates a function which, when called, executes the appropriate stubbing behavior for the given parameters.
- final func createStubFunction(_ token: CancellableToken, forTarget target: Target, withCompletion completion: @escaping Moya.Completion, endpoint: Endpoint, plugins: [PluginType], request: URLRequest) -> (() -> Void) { // swiftlint:disable:this function_parameter_count
- return {
- if token.isCancelled {
- self.cancelCompletion(completion, target: target)
- return
- }
- let validate = { (response: Moya.Response) -> Result<Moya.Response, MoyaError> in
- let validCodes = target.validationType.statusCodes
- guard !validCodes.isEmpty else { return .success(response) }
- if validCodes.contains(response.statusCode) {
- return .success(response)
- } else {
- let statusError = MoyaError.statusCode(response)
- let error = MoyaError.underlying(statusError, response)
- return .failure(error)
- }
- }
- switch endpoint.sampleResponseClosure() {
- case .networkResponse(let statusCode, let data):
- let response = Moya.Response(statusCode: statusCode, data: data, request: request, response: nil)
- let result = validate(response)
- plugins.forEach { $0.didReceive(result, target: target) }
- completion(result)
- case .response(let customResponse, let data):
- let response = Moya.Response(statusCode: customResponse.statusCode, data: data, request: request, response: customResponse)
- let result = validate(response)
- plugins.forEach { $0.didReceive(result, target: target) }
- completion(result)
- case .networkError(let error):
- let error = MoyaError.underlying(error, nil)
- plugins.forEach { $0.didReceive(.failure(error), target: target) }
- completion(.failure(error))
- }
- }
- }
- /// Notify all plugins that a stub is about to be performed. You must call this if overriding `stubRequest`.
- final func notifyPluginsOfImpendingStub(for request: URLRequest, target: Target) -> URLRequest {
- let alamoRequest = session.request(request)
- alamoRequest.cancel()
- let preparedRequest = plugins.reduce(request) { $1.prepare($0, target: target) }
- let stubbedAlamoRequest = RequestTypeWrapper(request: alamoRequest, urlRequest: preparedRequest)
- plugins.forEach { $0.willSend(stubbedAlamoRequest, target: target) }
- return preparedRequest
- }
- }
- private extension MoyaProvider {
- private func interceptor(target: Target) -> MoyaRequestInterceptor {
- return MoyaRequestInterceptor(prepare: { [weak self] urlRequest in
- return self?.plugins.reduce(urlRequest) { $1.prepare($0, target: target) } ?? urlRequest
- })
- }
- private func setup(interceptor: MoyaRequestInterceptor, with target: Target, and request: Request) {
- interceptor.willSend = { [weak self, weak request] urlRequest in
- guard let self = self, let request = request else { return }
- let stubbedAlamoRequest = RequestTypeWrapper(request: request, urlRequest: urlRequest)
- self.plugins.forEach { $0.willSend(stubbedAlamoRequest, target: target) }
- }
- }
- func sendUploadMultipart(_ target: Target, request: URLRequest, callbackQueue: DispatchQueue?, multipartBody: [MultipartFormData], progress: Moya.ProgressBlock? = nil, completion: @escaping Moya.Completion) -> CancellableToken {
- let formData = RequestMultipartFormData()
- formData.applyMoyaMultipartFormData(multipartBody)
- let interceptor = self.interceptor(target: target)
- let request = session.upload(multipartFormData: formData, with: request, interceptor: interceptor)
- setup(interceptor: interceptor, with: target, and: request)
- let validationCodes = target.validationType.statusCodes
- let validatedRequest = validationCodes.isEmpty ? request : request.validate(statusCode: validationCodes)
- return sendAlamofireRequest(validatedRequest, target: target, callbackQueue: callbackQueue, progress: progress, completion: completion)
- }
- func sendUploadFile(_ target: Target, request: URLRequest, callbackQueue: DispatchQueue?, file: URL, progress: ProgressBlock? = nil, completion: @escaping Completion) -> CancellableToken {
- let interceptor = self.interceptor(target: target)
- let uploadRequest = session.upload(file, with: request, interceptor: interceptor)
- setup(interceptor: interceptor, with: target, and: uploadRequest)
- let validationCodes = target.validationType.statusCodes
- let alamoRequest = validationCodes.isEmpty ? uploadRequest : uploadRequest.validate(statusCode: validationCodes)
- return sendAlamofireRequest(alamoRequest, target: target, callbackQueue: callbackQueue, progress: progress, completion: completion)
- }
- func sendDownloadRequest(_ target: Target, request: URLRequest, callbackQueue: DispatchQueue?, destination: @escaping DownloadDestination, progress: ProgressBlock? = nil, completion: @escaping Completion) -> CancellableToken {
- let interceptor = self.interceptor(target: target)
- let downloadRequest = session.download(request, interceptor: interceptor, to: destination)
- setup(interceptor: interceptor, with: target, and: downloadRequest)
- let validationCodes = target.validationType.statusCodes
- let alamoRequest = validationCodes.isEmpty ? downloadRequest : downloadRequest.validate(statusCode: validationCodes)
- return sendAlamofireRequest(alamoRequest, target: target, callbackQueue: callbackQueue, progress: progress, completion: completion)
- }
- func sendRequest(_ target: Target, request: URLRequest, callbackQueue: DispatchQueue?, progress: Moya.ProgressBlock?, completion: @escaping Moya.Completion) -> CancellableToken {
- let interceptor = self.interceptor(target: target)
- let initialRequest = session.request(request, interceptor: interceptor)
- setup(interceptor: interceptor, with: target, and: initialRequest)
- let validationCodes = target.validationType.statusCodes
- let alamoRequest = validationCodes.isEmpty ? initialRequest : initialRequest.validate(statusCode: validationCodes)
- return sendAlamofireRequest(alamoRequest, target: target, callbackQueue: callbackQueue, progress: progress, completion: completion)
- }
- // swiftlint:disable:next cyclomatic_complexity
- func sendAlamofireRequest<T>(_ alamoRequest: T, target: Target, callbackQueue: DispatchQueue?, progress progressCompletion: Moya.ProgressBlock?, completion: @escaping Moya.Completion) -> CancellableToken where T: Requestable, T: Request {
- // Give plugins the chance to alter the outgoing request
- let plugins = self.plugins
- var progressAlamoRequest = alamoRequest
- let progressClosure: (Progress) -> Void = { progress in
- let sendProgress: () -> Void = {
- progressCompletion?(ProgressResponse(progress: progress))
- }
- if let callbackQueue = callbackQueue {
- callbackQueue.async(execute: sendProgress)
- } else {
- sendProgress()
- }
- }
- // Perform the actual request
- if progressCompletion != nil {
- switch progressAlamoRequest {
- case let downloadRequest as DownloadRequest:
- if let downloadRequest = downloadRequest.downloadProgress(closure: progressClosure) as? T {
- progressAlamoRequest = downloadRequest
- }
- case let uploadRequest as UploadRequest:
- if let uploadRequest = uploadRequest.uploadProgress(closure: progressClosure) as? T {
- progressAlamoRequest = uploadRequest
- }
- case let dataRequest as DataRequest:
- if let dataRequest = dataRequest.downloadProgress(closure: progressClosure) as? T {
- progressAlamoRequest = dataRequest
- }
- default: break
- }
- }
- let completionHandler: RequestableCompletion = { response, request, data, error in
- let result = convertResponseToResult(response, request: request, data: data, error: error)
- // Inform all plugins about the response
- plugins.forEach { $0.didReceive(result, target: target) }
- if let progressCompletion = progressCompletion {
- let value = try? result.get()
- switch progressAlamoRequest {
- case let downloadRequest as DownloadRequest:
- progressCompletion(ProgressResponse(progress: downloadRequest.downloadProgress, response: value))
- case let uploadRequest as UploadRequest:
- progressCompletion(ProgressResponse(progress: uploadRequest.uploadProgress, response: value))
- case let dataRequest as DataRequest:
- progressCompletion(ProgressResponse(progress: dataRequest.downloadProgress, response: value))
- default:
- progressCompletion(ProgressResponse(response: value))
- }
- }
- completion(result)
- }
- progressAlamoRequest = progressAlamoRequest.response(callbackQueue: callbackQueue, completionHandler: completionHandler)
- progressAlamoRequest.resume()
- return CancellableToken(request: progressAlamoRequest)
- }
- }
|