| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793 |
- //
- // SessionTests.swift
- //
- // 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
- // in the Software without restriction, including without limitation the rights
- // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- // copies of the Software, and to permit persons to whom the Software is
- // furnished to do so, subject to the following conditions:
- //
- // The above copyright notice and this permission notice shall be included in
- // all copies or substantial portions of the Software.
- //
- // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- // THE SOFTWARE.
- //
- @testable import Alamofire
- import Foundation
- import XCTest
- final class SessionTestCase: BaseTestCase {
- // MARK: Helper Types
- private class HTTPMethodAdapter: RequestInterceptor {
- let method: HTTPMethod
- let throwsError: Bool
- var adaptedCount = 0
- init(method: HTTPMethod, throwsError: Bool = false) {
- self.method = method
- self.throwsError = throwsError
- }
- func adapt(_ urlRequest: URLRequest, using state: RequestAdapterState, completion: @escaping (Result<URLRequest, Error>) -> Void) {
- adaptedCount += 1
- let result: Result<URLRequest, Error> = Result {
- guard !throwsError else { throw AFError.invalidURL(url: "") }
- var urlRequest = urlRequest
- urlRequest.httpMethod = method.rawValue
- return urlRequest
- }
- completion(result)
- }
- }
- private class HeaderAdapter: RequestInterceptor {
- let headers: HTTPHeaders
- let throwsError: Bool
- var adaptedCount = 0
- init(headers: HTTPHeaders = ["field": "value"], throwsError: Bool = false) {
- self.headers = headers
- self.throwsError = throwsError
- }
- func adapt(_ urlRequest: URLRequest, using state: RequestAdapterState, completion: @escaping (Result<URLRequest, Error>) -> Void) {
- adaptedCount += 1
- let result: Result<URLRequest, Error> = Result {
- guard !throwsError else { throw AFError.invalidURL(url: "") }
- var urlRequest = urlRequest
- var finalHeaders = urlRequest.headers
- headers.forEach { finalHeaders.add($0) }
- urlRequest.headers = finalHeaders
- return urlRequest
- }
- completion(result)
- }
- }
- private class RequestHandler: RequestInterceptor {
- var adaptCalledCount = 0
- var adaptedCount = 0
- var retryCount = 0
- var retryCalledCount = 0
- var retryErrors: [Error] = []
- var shouldApplyAuthorizationHeader = false
- var throwsErrorOnFirstAdapt = false
- var throwsErrorOnSecondAdapt = false
- var throwsErrorOnRetry = false
- var shouldRetry = true
- var retryDelay: TimeInterval?
- func adapt(_ urlRequest: URLRequest,
- using state: RequestAdapterState,
- completion: @escaping (Result<URLRequest, Error>) -> Void) {
- adaptCalledCount += 1
- let result: Result<URLRequest, Error> = Result {
- if throwsErrorOnFirstAdapt {
- throwsErrorOnFirstAdapt = false
- throw AFError.invalidURL(url: "/adapt/error/1")
- }
- if throwsErrorOnSecondAdapt && adaptedCount == 1 {
- throwsErrorOnSecondAdapt = false
- throw AFError.invalidURL(url: "/adapt/error/2")
- }
- var urlRequest = urlRequest
- adaptedCount += 1
- if shouldApplyAuthorizationHeader && adaptedCount > 1 {
- urlRequest.headers.update(.authorization(username: "user", password: "password"))
- }
- return urlRequest
- }
- completion(result)
- }
- func retry(_ request: Request,
- for session: Session,
- dueTo error: Error,
- completion: @escaping (RetryResult) -> Void) {
- retryCalledCount += 1
- if throwsErrorOnRetry {
- let error = AFError.invalidURL(url: "/invalid/url/\(retryCalledCount)")
- completion(.doNotRetryWithError(error))
- return
- }
- guard shouldRetry else { completion(.doNotRetry); return }
- retryCount += 1
- retryErrors.append(error)
- if retryCount < 2 {
- if let retryDelay = retryDelay {
- completion(.retryWithDelay(retryDelay))
- } else {
- completion(.retry)
- }
- } else {
- completion(.doNotRetry)
- }
- }
- }
- private class UploadHandler: RequestInterceptor {
- var adaptCalledCount = 0
- var adaptedCount = 0
- var retryCalledCount = 0
- var retryCount = 0
- var retryErrors: [Error] = []
- func adapt(_ urlRequest: URLRequest,
- using state: RequestAdapterState,
- completion: @escaping (Result<URLRequest, Error>) -> Void) {
- adaptCalledCount += 1
- let result: Result<URLRequest, Error> = Result {
- adaptedCount += 1
- if adaptedCount == 1 { throw AFError.invalidURL(url: "") }
- return urlRequest
- }
- completion(result)
- }
- func retry(_ request: Request,
- for session: Session,
- dueTo error: Error,
- completion: @escaping (RetryResult) -> Void) {
- retryCalledCount += 1
- retryCount += 1
- retryErrors.append(error)
- completion(.retry)
- }
- }
- // MARK: Tests - Initialization
- func testInitializerWithDefaultArguments() {
- // Given, When
- let session = Session()
- // Then
- XCTAssertNotNil(session.session.delegate, "session delegate should not be nil")
- XCTAssertTrue(session.delegate === session.session.delegate, "manager delegate should equal session delegate")
- XCTAssertNil(session.serverTrustManager, "session server trust policy manager should be nil")
- }
- func testInitializerWithSpecifiedArguments() {
- // Given
- let configuration = URLSessionConfiguration.default
- let delegate = SessionDelegate()
- let serverTrustManager = ServerTrustManager(evaluators: [:])
- // When
- let session = Session(configuration: configuration,
- delegate: delegate,
- serverTrustManager: serverTrustManager)
- // Then
- XCTAssertNotNil(session.session.delegate, "session delegate should not be nil")
- XCTAssertTrue(session.delegate === session.session.delegate, "manager delegate should equal session delegate")
- XCTAssertNotNil(session.serverTrustManager, "session server trust policy manager should not be nil")
- }
- func testThatSessionInitializerSucceedsWithDefaultArguments() {
- // Given
- let delegate = SessionDelegate()
- let underlyingQueue = DispatchQueue(label: "underlyingQueue")
- let urlSession: URLSession = {
- let configuration = URLSessionConfiguration.default
- let queue = OperationQueue(underlyingQueue: underlyingQueue, name: "delegateQueue")
- return URLSession(configuration: configuration, delegate: delegate, delegateQueue: queue)
- }()
- // When
- let session = Session(session: urlSession, delegate: delegate, rootQueue: underlyingQueue)
- // Then
- XCTAssertTrue(session.delegate === session.session.delegate, "manager delegate should equal session delegate")
- XCTAssertNil(session.serverTrustManager, "session server trust policy manager should be nil")
- }
- func testThatSessionInitializerSucceedsWithSpecifiedArguments() {
- // Given
- let delegate = SessionDelegate()
- let underlyingQueue = DispatchQueue(label: "underlyingQueue")
- let urlSession: URLSession = {
- let configuration = URLSessionConfiguration.default
- let queue = OperationQueue(underlyingQueue: underlyingQueue, name: "delegateQueue")
- return URLSession(configuration: configuration, delegate: delegate, delegateQueue: queue)
- }()
- let serverTrustManager = ServerTrustManager(evaluators: [:])
- // When
- let session = Session(session: urlSession,
- delegate: delegate,
- rootQueue: underlyingQueue,
- serverTrustManager: serverTrustManager)
- // Then
- XCTAssertTrue(session.delegate === session.session.delegate, "manager delegate should equal session delegate")
- XCTAssertNotNil(session.serverTrustManager, "session server trust policy manager should not be nil")
- }
- // MARK: Tests - Parallel Root Queue
- func testThatSessionWorksCorrectlyWhenPassedAConcurrentRootQueue() {
- // Given
- let queue = DispatchQueue(label: "ohNoAParallelQueue", attributes: .concurrent)
- let session = Session(rootQueue: queue)
- let didFinish = expectation(description: "request did finish")
- var receivedResponse: TestResponse?
- // When
- session.request(.get).responseDecodable(of: TestResponse.self) { response in
- receivedResponse = response.value
- didFinish.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(receivedResponse, "Should receive TestResponse.")
- }
- // MARK: Tests - Default HTTP Headers
- func testDefaultUserAgentHeader() {
- // Given, When
- let userAgent = HTTPHeaders.default["User-Agent"]
- // Then
- let osNameVersion: String = {
- let version = ProcessInfo.processInfo.operatingSystemVersion
- let versionString = "\(version.majorVersion).\(version.minorVersion).\(version.patchVersion)"
- let osName: String = {
- #if os(iOS)
- #if targetEnvironment(macCatalyst)
- return "macOS(Catalyst)"
- #else
- return "iOS"
- #endif
- #elseif os(watchOS)
- return "watchOS"
- #elseif os(tvOS)
- return "tvOS"
- #elseif os(macOS)
- return "macOS"
- #elseif os(Linux)
- return "Linux"
- #else
- return "Unknown"
- #endif
- }()
- return "\(osName) \(versionString)"
- }()
- let alamofireVersion = "Alamofire/\(Alamofire.version)"
- XCTAssertTrue(userAgent?.contains(alamofireVersion) == true)
- XCTAssertTrue(userAgent?.contains(osNameVersion) == true)
- XCTAssertTrue(userAgent?.contains("xctest/") == true)
- }
- // MARK: Tests - Supported Accept-Encodings
- // Disabled due to HTTPBin flakiness.
- func _testDefaultAcceptEncodingSupportsAppropriateEncodingsOnAppropriateSystems() {
- // Given
- let brotliExpectation = expectation(description: "brotli request should complete")
- let gzipExpectation = expectation(description: "gzip request should complete")
- let deflateExpectation = expectation(description: "deflate request should complete")
- var brotliResponse: DataResponse<TestResponse, AFError>?
- var gzipResponse: DataResponse<TestResponse, AFError>?
- var deflateResponse: DataResponse<TestResponse, AFError>?
- // When
- AF.request(.compression(.brotli)).responseDecodable(of: TestResponse.self) { response in
- brotliResponse = response
- brotliExpectation.fulfill()
- }
- AF.request(.compression(.gzip)).responseDecodable(of: TestResponse.self) { response in
- gzipResponse = response
- gzipExpectation.fulfill()
- }
- AF.request(.compression(.deflate)).responseDecodable(of: TestResponse.self) { response in
- deflateResponse = response
- deflateExpectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- if #available(iOS 11.0, macOS 10.13, tvOS 11.0, watchOS 4.0, *) {
- XCTAssertTrue(brotliResponse?.result.isSuccess == true)
- } else {
- XCTAssertTrue(brotliResponse?.result.isFailure == true)
- }
- XCTAssertTrue(gzipResponse?.result.isSuccess == true)
- XCTAssertTrue(deflateResponse?.result.isSuccess == true)
- }
- // MARK: Tests - Start Requests Immediately
- func testSetStartRequestsImmediatelyToFalseAndResumeRequest() {
- // Given
- let session = Session(startRequestsImmediately: false)
- let url = Endpoint().url
- let urlRequest = URLRequest(url: url)
- let expectation = expectation(description: "\(url)")
- var response: HTTPURLResponse?
- // When
- session.request(urlRequest)
- .response { resp in
- response = resp.response
- expectation.fulfill()
- }
- .resume()
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(response, "response should not be nil")
- XCTAssertTrue(response?.statusCode == 200, "response status code should be 200")
- }
- func testSetStartRequestsImmediatelyToFalseAndCancelledCallsResponseHandlers() {
- // Given
- let session = Session(startRequestsImmediately: false)
- let url = Endpoint().url
- let urlRequest = URLRequest(url: url)
- let expectation = expectation(description: "\(url)")
- var response: DataResponse<Data?, AFError>?
- // When
- let request = session.request(urlRequest)
- .cancel()
- .response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(response, "response should not be nil")
- XCTAssertTrue(request.isCancelled)
- XCTAssertTrue((request.task == nil) || (request.task?.state == .canceling || request.task?.state == .completed))
- XCTAssertEqual(request.error?.isExplicitlyCancelledError, true)
- }
- func testSetStartRequestsImmediatelyToFalseAndResumeThenCancelRequestHasCorrectOutput() {
- // Given
- let session = Session(startRequestsImmediately: false)
- let url = Endpoint().url
- let urlRequest = URLRequest(url: url)
- let expectation = expectation(description: "\(url)")
- var response: DataResponse<Data?, AFError>?
- // When
- let request = session.request(urlRequest)
- .response { resp in
- response = resp
- expectation.fulfill()
- }
- .resume()
- .cancel()
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(response, "response should not be nil")
- XCTAssertTrue(request.isCancelled)
- XCTAssertTrue((request.task == nil) || (request.task?.state == .canceling || request.task?.state == .completed))
- XCTAssertEqual(request.error?.isExplicitlyCancelledError, true)
- }
- func testSetStartRequestsImmediatelyToFalseAndCancelThenResumeRequestDoesntCreateTaskAndStaysCancelled() {
- // Given
- let session = Session(startRequestsImmediately: false)
- let url = Endpoint().url
- let urlRequest = URLRequest(url: url)
- let expectation = expectation(description: "\(url)")
- var response: DataResponse<Data?, AFError>?
- // When
- let request = session.request(urlRequest)
- .response { resp in
- response = resp
- expectation.fulfill()
- }
- .cancel()
- .resume()
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(response, "response should not be nil")
- XCTAssertTrue(request.isCancelled)
- XCTAssertTrue((request.task == nil) || (request.task?.state == .canceling || request.task?.state == .completed))
- XCTAssertEqual(request.error?.isExplicitlyCancelledError, true)
- }
- // MARK: Tests - Deinitialization
- func testReleasingManagerWithPendingRequestDeinitializesSuccessfully() {
- // Given
- let monitor = ClosureEventMonitor()
- let didCreateRequest = expectation(description: "Request created")
- monitor.requestDidCreateTask = { _, _ in didCreateRequest.fulfill() }
- var session: Session? = Session(startRequestsImmediately: false, eventMonitors: [monitor])
- weak var weakSession = session
- // When
- let request = session?.request(.default)
- session = nil
- waitForExpectations(timeout: timeout)
- // Then
- if #available(macOS 13, iOS 16, tvOS 16, watchOS 9, *) {
- // On 2022 OS versions and later, URLSessionTasks are completed even if not resumed before invalidating a session.
- XCTAssertTrue([.canceling, .completed].contains(request?.task?.state))
- } else {
- XCTAssertEqual(request?.task?.state, .suspended)
- }
- XCTAssertNil(session, "session should be nil")
- XCTAssertNil(weakSession, "weak session should be nil")
- }
- func testReleasingManagerWithPendingCanceledRequestDeinitializesSuccessfully() {
- // Given
- var session: Session? = Session(startRequestsImmediately: false)
- // When
- let request = session?.request(.default)
- request?.cancel()
- session = nil
- let state = request?.state
- // Then
- XCTAssertTrue(state == .cancelled, "state should be .cancelled")
- XCTAssertNil(session, "manager should be nil")
- }
- // MARK: Tests - Bad Requests
- func testThatDataRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let url = ""
- let expectation = expectation(description: "Request should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.request(url).response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, url)
- }
- func testThatDownloadRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let url = ""
- let expectation = expectation(description: "Download should fail with error")
- var response: DownloadResponse<URL?, AFError>?
- // When
- session.download(url).response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.fileURL)
- XCTAssertNil(response?.resumeData)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, url)
- }
- func testThatUploadDataRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let url = ""
- let expectation = expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.upload(Data(), to: url).response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, url)
- }
- func testThatUploadFileRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let url = ""
- let expectation = expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.upload(URL(fileURLWithPath: "/invalid"), to: url).response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, url)
- }
- func testThatUploadStreamRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let url = ""
- let expectation = expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.upload(InputStream(data: Data()), to: url).response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, url)
- }
- // MARK: Tests - Request Adapter
- func testThatSessionCallsRequestAdaptersWhenCreatingDataRequest() {
- // Given
- let endpoint = Endpoint()
- let methodAdapter = HTTPMethodAdapter(method: .post)
- let headerAdapter = HeaderAdapter()
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.request(endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.request(endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
- XCTAssertEqual(methodAdapter.adaptedCount, 2)
- XCTAssertEqual(headerAdapter.adaptedCount, 1)
- }
- func testThatSessionCallsRequestAdaptersWhenCreatingDownloadRequest() {
- // Given
- let endpoint = Endpoint()
- let methodAdapter = HTTPMethodAdapter(method: .post)
- let headerAdapter = HeaderAdapter()
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.download(endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.download(endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
- XCTAssertEqual(methodAdapter.adaptedCount, 2)
- XCTAssertEqual(headerAdapter.adaptedCount, 1)
- }
- func testThatSessionCallsRequestAdaptersWhenCreatingUploadRequestWithData() {
- // Given
- let data = Data("data".utf8)
- let endpoint = Endpoint.method(.post)
- let methodAdapter = HTTPMethodAdapter(method: .get)
- let headerAdapter = HeaderAdapter()
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.upload(data, to: endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.upload(data, to: endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
- XCTAssertEqual(methodAdapter.adaptedCount, 2)
- XCTAssertEqual(headerAdapter.adaptedCount, 1)
- }
- func testThatSessionCallsRequestAdaptersWhenCreatingUploadRequestWithFile() {
- // Given
- let fileURL = URL(fileURLWithPath: "/path/to/some/file.txt")
- let endpoint = Endpoint.method(.post)
- let methodAdapter = HTTPMethodAdapter(method: .get)
- let headerAdapter = HeaderAdapter()
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.upload(fileURL, to: endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.upload(fileURL, to: endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
- XCTAssertEqual(methodAdapter.adaptedCount, 2)
- XCTAssertEqual(headerAdapter.adaptedCount, 1)
- }
- func testThatSessionCallsRequestAdaptersWhenCreatingUploadRequestWithInputStream() {
- // Given
- let inputStream = InputStream(data: Data("data".utf8))
- let endpoint = Endpoint.method(.post)
- let methodAdapter = HTTPMethodAdapter(method: .get)
- let headerAdapter = HeaderAdapter()
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.upload(inputStream, to: endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.upload(inputStream, to: endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
- XCTAssertEqual(methodAdapter.adaptedCount, 2)
- XCTAssertEqual(headerAdapter.adaptedCount, 1)
- }
- func testThatSessionReturnsRequestAdaptationErrorWhenRequestAdapterThrowsError() {
- // Given
- let endpoint = Endpoint()
- let methodAdapter = HTTPMethodAdapter(method: .post, throwsError: true)
- let headerAdapter = HeaderAdapter(throwsError: true)
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidFailToAdaptURLRequestWithError = { _, _, _ in expectation1.fulfill() }
- let request1 = session.request(endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidFailToAdaptURLRequestWithError = { _, _, _ in expectation2.fulfill() }
- let request2 = session.request(endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- let requests = [request1, request2]
- // Then
- for request in requests {
- XCTAssertEqual(request.error?.isRequestAdaptationError, true)
- XCTAssertEqual(request.error?.underlyingError?.asAFError?.urlConvertible as? String, "")
- }
- }
- // MARK: Tests - Request Retrier
- func testThatSessionCallsRequestRetrierWhenRequestInitiallyEncountersAdaptError() {
- // Given
- let handler = RequestHandler()
- handler.adaptedCount = 1
- handler.throwsErrorOnSecondAdapt = true
- handler.shouldApplyAuthorizationHeader = true
- let session = Session()
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- session.request(.basicAuth(), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 1)
- XCTAssertEqual(handler.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, true)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- func testThatSessionCallsRequestRetrierWhenDownloadInitiallyEncountersAdaptError() {
- // Given
- let handler = RequestHandler()
- handler.adaptedCount = 1
- handler.throwsErrorOnSecondAdapt = true
- handler.shouldApplyAuthorizationHeader = true
- let session = Session()
- let expectation = expectation(description: "request should eventually fail")
- var response: DownloadResponse<TestResponse, AFError>?
- let destination: DownloadRequest.Destination = { _, _ in
- let fileURL = self.testDirectoryURL.appendingPathComponent("test-output.json")
- return (fileURL, [.removePreviousFile])
- }
- // When
- session.download(.basicAuth(), interceptor: handler, to: destination)
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 1)
- XCTAssertEqual(handler.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, true)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- func testThatSessionCallsRequestRetrierWhenUploadInitiallyEncountersAdaptError() {
- // Given
- let handler = UploadHandler()
- let session = Session(interceptor: handler)
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- let uploadData = Data("upload data".utf8)
- // When
- session.upload(uploadData, to: .method(.post))
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 1)
- XCTAssertEqual(handler.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, true)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- func testThatSessionCallsRequestRetrierWhenRequestEncountersError() {
- // Given
- let handler = RequestHandler()
- let session = Session()
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth(), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 3)
- XCTAssertEqual(handler.retryCount, 3)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- func testThatSessionCallsRequestRetrierThenSessionRetrierWhenRequestEncountersError() {
- // Given
- let sessionHandler = RequestHandler()
- let requestHandler = RequestHandler()
- let session = Session(interceptor: sessionHandler)
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth(), interceptor: requestHandler)
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(sessionHandler.adaptCalledCount, 3)
- XCTAssertEqual(sessionHandler.adaptedCount, 3)
- XCTAssertEqual(sessionHandler.retryCalledCount, 3)
- XCTAssertEqual(sessionHandler.retryCount, 3)
- XCTAssertEqual(requestHandler.adaptCalledCount, 3)
- XCTAssertEqual(requestHandler.adaptedCount, 3)
- XCTAssertEqual(requestHandler.retryCalledCount, 4)
- XCTAssertEqual(requestHandler.retryCount, 4)
- XCTAssertEqual(request.retryCount, 2)
- XCTAssertEqual(response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- func testThatSessionCallsAdapterWhenRequestIsRetried() {
- // Given
- let handler = RequestHandler()
- handler.shouldApplyAuthorizationHeader = true
- let session = Session(interceptor: handler)
- let expectation = expectation(description: "request should eventually succeed")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth())
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 1)
- XCTAssertEqual(handler.retryCount, 1)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, true)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- func testThatSessionReturnsRequestAdaptationErrorWhenRequestIsRetried() {
- // Given
- let handler = RequestHandler()
- handler.throwsErrorOnSecondAdapt = true
- let session = Session(interceptor: handler)
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth())
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 3)
- XCTAssertEqual(handler.retryCount, 3)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, false)
- XCTAssertEqual(request.error?.isRequestAdaptationError, true)
- XCTAssertEqual(request.error?.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- func testThatSessionRetriesRequestWithDelayWhenRetryResultContainsDelay() {
- // Given
- let handler = RequestHandler()
- handler.retryDelay = 0.01
- handler.throwsErrorOnSecondAdapt = true
- let session = Session(interceptor: handler)
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth())
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 3)
- XCTAssertEqual(handler.retryCount, 3)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, false)
- XCTAssertEqual(request.error?.isRequestAdaptationError, true)
- XCTAssertEqual(request.error?.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- func testThatSessionReturnsRequestRetryErrorWhenRequestRetrierThrowsError() {
- // Given
- let handler = RequestHandler()
- handler.throwsErrorOnRetry = true
- let session = Session(interceptor: handler)
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth())
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 1)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 2)
- XCTAssertEqual(handler.retryCount, 0)
- XCTAssertEqual(request.retryCount, 0)
- XCTAssertEqual(response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- if let error = response?.result.failure {
- XCTAssertTrue(error.isRequestRetryError)
- XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/invalid/url/2")
- } else {
- XCTFail("error should not be nil")
- }
- }
- // MARK: Tests - Response Serializer Retry
- func testThatSessionCallsRequestRetrierWhenResponseSerializerThrowsError() {
- // Given
- let handler = RequestHandler()
- handler.shouldRetry = false
- let session = Session()
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.image(.jpeg), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 1)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 1)
- XCTAssertEqual(handler.retryCount, 0)
- XCTAssertEqual(request.retryCount, 0)
- XCTAssertEqual(response?.result.isSuccess, false)
- XCTAssertEqual(response?.error?.isResponseSerializationError, true)
- XCTAssertNotNil(response?.error?.underlyingError as? DecodingError)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- func testThatSessionCallsRequestRetrierForAllResponseSerializersThatThrowError() throws {
- // Given
- let handler = RequestHandler()
- handler.throwsErrorOnRetry = true
- let session = Session()
- let json1Expectation = expectation(description: "request should eventually fail")
- var json1Response: DataResponse<TestResponse, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.image(.jpeg), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseDecodable(of: TestResponse.self) { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 1)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 2)
- XCTAssertEqual(handler.retryCount, 0)
- XCTAssertEqual(request.retryCount, 0)
- XCTAssertEqual(json1Response?.result.isSuccess, false)
- XCTAssertEqual(json2Response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- let errors = [json1Response, json2Response].compactMap { $0?.error }
- XCTAssertEqual(errors.count, 2)
- for (index, error) in errors.enumerated() {
- XCTAssertTrue(error.isRequestRetryError)
- if case let .requestRetryFailed(retryError, originalError) = error {
- XCTAssertEqual(retryError.asAFError?.urlConvertible as? String, "/invalid/url/\(index + 1)")
- XCTAssertNotNil(originalError.asAFError?.underlyingError as? DecodingError)
- } else {
- XCTFail("Error failure reason should be response serialization failure")
- }
- }
- }
- func testThatSessionRetriesRequestImmediatelyWhenResponseSerializerRequestsRetry() throws {
- // Given
- let handler = RequestHandler()
- let session = Session()
- let json1Expectation = expectation(description: "request should eventually fail")
- var json1Response: DataResponse<TestResponse, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.image(.jpeg), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseDecodable(of: TestResponse.self) { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 3)
- XCTAssertEqual(handler.retryCount, 3)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(json1Response?.result.isSuccess, false)
- XCTAssertEqual(json2Response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- let errors = [json1Response, json2Response].compactMap { $0?.error }
- XCTAssertEqual(errors.count, 2)
- for error in errors {
- XCTAssertTrue(error.isResponseSerializationError)
- XCTAssertNotNil(error.underlyingError as? DecodingError)
- }
- }
- func testThatSessionCallsResponseSerializerCompletionsWhenAdapterThrowsErrorDuringRetry() {
- // Four retries should occur given this scenario:
- // 1) Retrier is called from first response serializer failure (trips retry)
- // 2) Retrier is called by Session for adapt error thrown
- // 3) Retrier is called again from first response serializer failure
- // 4) Retrier is called from second response serializer failure
- // Given
- let handler = RequestHandler()
- handler.throwsErrorOnSecondAdapt = true
- let session = Session()
- let json1Expectation = expectation(description: "request should eventually fail")
- var json1Response: DataResponse<TestResponse, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.image(.jpeg), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseDecodable(of: TestResponse.self) { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 4)
- XCTAssertEqual(handler.retryCount, 4)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(json1Response?.result.isSuccess, false)
- XCTAssertEqual(json2Response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- let errors = [json1Response, json2Response].compactMap { $0?.error }
- XCTAssertEqual(errors.count, 2)
- for error in errors {
- XCTAssertTrue(error.isRequestAdaptationError)
- XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
- }
- }
- func testThatSessionCallsResponseSerializerCompletionsWhenAdapterThrowsErrorDuringRetryForDownloads() {
- // Four retries should occur given this scenario:
- // 1) Retrier is called from first response serializer failure (trips retry)
- // 2) Retrier is called by Session for adapt error thrown
- // 3) Retrier is called again from first response serializer failure
- // 4) Retrier is called from second response serializer failure
- // Given
- let handler = RequestHandler()
- handler.throwsErrorOnSecondAdapt = true
- let session = Session()
- let json1Expectation = expectation(description: "request should eventually fail")
- var json1Response: DownloadResponse<TestResponse, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DownloadResponse<TestResponse, AFError>?
- // When
- let request = session.download(.image(.jpeg), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseDecodable(of: TestResponse.self) { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 4)
- XCTAssertEqual(handler.retryCount, 4)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(json1Response?.result.isSuccess, false)
- XCTAssertEqual(json2Response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- let errors = [json1Response, json2Response].compactMap { $0?.error }
- XCTAssertEqual(errors.count, 2)
- for error in errors {
- XCTAssertTrue(error.isRequestAdaptationError)
- XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
- }
- }
- // MARK: Tests - Session Invalidation
- func testThatSessionIsInvalidatedAndAllRequestsCompleteWhenSessionIsDeinitialized() {
- // Given
- let invalidationExpectation = expectation(description: "sessionDidBecomeInvalidWithError should be called")
- let events = ClosureEventMonitor()
- events.sessionDidBecomeInvalidWithError = { _, _ in
- invalidationExpectation.fulfill()
- }
- var session: Session? = Session(startRequestsImmediately: false, eventMonitors: [events])
- var error: AFError?
- let requestExpectation = expectation(description: "request should complete")
- // When
- session?.request(.default).response { response in
- error = response.error
- requestExpectation.fulfill()
- }
- session = nil
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(error?.isSessionDeinitializedError, true)
- }
- // MARK: Tests - Request Cancellation
- func testThatSessionOnlyCallsResponseSerializerCompletionWhenCancellingInsideCompletion() {
- // Given
- let handler = RequestHandler()
- let session = Session()
- let expectation = expectation(description: "request should complete")
- var response: DataResponse<TestResponse, AFError>?
- var completionCallCount = 0
- // When
- let request = session.request(.default, interceptor: handler)
- request.validate()
- request.responseDecodable(of: TestResponse.self) { resp in
- request.cancel()
- response = resp
- completionCallCount += 1
- DispatchQueue.main.after(0.01) { expectation.fulfill() }
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 1)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 0)
- XCTAssertEqual(handler.retryCount, 0)
- XCTAssertEqual(request.retryCount, 0)
- XCTAssertEqual(response?.result.isSuccess, true)
- XCTAssertEqual(completionCallCount, 1)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- // MARK: Tests - Request State
- func testThatSessionSetsRequestStateWhenStartRequestsImmediatelyIsTrue() {
- // Given
- let session = Session()
- let expectation = expectation(description: "request should complete")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.default).responseDecodable(of: TestResponse.self) { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request.state, .finished)
- XCTAssertEqual(response?.result.isSuccess, true)
- }
- // MARK: Invalid Requests
- func testThatGETRequestsWithBodyDataAreConsideredInvalid() {
- // Given
- let session = Session()
- var request = Endpoint().urlRequest
- request.httpBody = Data("invalid".utf8)
- let expect = expectation(description: "request should complete")
- var response: DataResponse<TestResponse, AFError>?
- // When
- session.request(request).responseDecodable(of: TestResponse.self) { resp in
- response = resp
- expect.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(response?.result.isFailure, true)
- XCTAssertEqual(response?.error?.isBodyDataInGETRequest, true)
- }
- func testThatAdaptedGETRequestsWithBodyDataAreConsideredInvalid() {
- // Given
- struct InvalidAdapter: RequestInterceptor {
- func adapt(_ urlRequest: URLRequest,
- for session: Session,
- completion: @escaping (Result<URLRequest, Error>) -> Void) {
- var request = urlRequest
- request.httpBody = Data("invalid".utf8)
- completion(.success(request))
- }
- }
- let session = Session(interceptor: InvalidAdapter())
- let expect = expectation(description: "request should complete")
- var response: DataResponse<TestResponse, AFError>?
- // When
- session.request(.default).responseDecodable(of: TestResponse.self) { resp in
- response = resp
- expect.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(response?.result.isFailure, true)
- XCTAssertEqual(response?.error?.isRequestAdaptationError, true)
- XCTAssertEqual(response?.error?.underlyingError?.asAFError?.isBodyDataInGETRequest, true)
- }
- }
- // MARK: -
- final class SessionMassActionTestCase: BaseTestCase {
- func testThatRequestsCanHaveMassActionsPerformed() {
- // Given
- let count = 10
- let createdTasks = expectation(description: "all tasks created")
- createdTasks.expectedFulfillmentCount = count
- let massActions = expectation(description: "cancel all requests should be called")
- let monitor = ClosureEventMonitor()
- monitor.requestDidCreateTask = { _, _ in createdTasks.fulfill() }
- let session = Session(eventMonitors: [monitor])
- let request = Endpoint.delay(1)
- var requests: [DataRequest] = []
- // When
- requests = (0..<count).map { _ in session.request(request) }
- wait(for: [createdTasks], timeout: timeout)
- session.withAllRequests { $0.forEach { $0.suspend() }; massActions.fulfill() }
- wait(for: [massActions], timeout: timeout)
- // Then
- XCTAssertTrue(requests.allSatisfy(\.isSuspended))
- }
- func testThatAutomaticallyResumedRequestsCanBeMassCancelled() {
- // Given
- let count = 100
- let completion = expectation(description: "all requests should finish")
- completion.expectedFulfillmentCount = count
- let createdTasks = expectation(description: "all tasks created")
- createdTasks.expectedFulfillmentCount = count
- let gatheredMetrics = expectation(description: "metrics gathered for all tasks")
- gatheredMetrics.expectedFulfillmentCount = count
- let cancellation = expectation(description: "cancel all requests should be called")
- let monitor = ClosureEventMonitor()
- monitor.requestDidCreateTask = { _, _ in createdTasks.fulfill() }
- monitor.requestDidGatherMetrics = { _, _ in gatheredMetrics.fulfill() }
- let session = Session(eventMonitors: [monitor])
- let request = Endpoint.delay(1)
- var requests: [DataRequest] = []
- var responses: [DataResponse<Data?, AFError>] = []
- // When
- requests = (0..<count).map { _ in session.request(request) }
- wait(for: [createdTasks], timeout: timeout)
- requests.forEach { request in
- request.response { response in
- responses.append(response)
- completion.fulfill()
- }
- }
- session.cancelAllRequests {
- cancellation.fulfill()
- }
- wait(for: [gatheredMetrics, cancellation, completion], timeout: timeout)
- // Then
- XCTAssertTrue(responses.allSatisfy { $0.error?.isExplicitlyCancelledError == true })
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty, "requestTaskMap should be empty but has \(session.requestTaskMap.count) items")
- XCTAssertTrue(session.activeRequests.isEmpty, "activeRequests should be empty but has \(session.activeRequests.count) items")
- }
- }
- func testThatManuallyResumedRequestsCanBeMassCancelled() {
- // Given
- let count = 100
- let completion = expectation(description: "all requests should finish")
- completion.expectedFulfillmentCount = count
- let createdTasks = expectation(description: "all tasks created")
- createdTasks.expectedFulfillmentCount = count
- let gatheredMetrics = expectation(description: "metrics gathered for all tasks")
- gatheredMetrics.expectedFulfillmentCount = count
- let cancellation = expectation(description: "cancel all requests should be called")
- let monitor = ClosureEventMonitor()
- monitor.requestDidCreateTask = { _, _ in createdTasks.fulfill() }
- monitor.requestDidGatherMetrics = { _, _ in gatheredMetrics.fulfill() }
- let session = Session(startRequestsImmediately: false, eventMonitors: [monitor])
- let request = Endpoint.delay(1)
- var responses: [DataResponse<Data?, AFError>] = []
- // When
- for _ in 0..<count {
- session.request(request).response { response in
- responses.append(response)
- completion.fulfill()
- }
- }
- wait(for: [createdTasks], timeout: timeout)
- session.cancelAllRequests {
- cancellation.fulfill()
- }
- wait(for: [gatheredMetrics, cancellation, completion], timeout: timeout)
- // Then
- XCTAssertTrue(responses.allSatisfy { $0.error?.isExplicitlyCancelledError == true })
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty, "requestTaskMap should be empty but has \(session.requestTaskMap.count) items")
- XCTAssertTrue(session.activeRequests.isEmpty, "activeRequests should be empty but has \(session.activeRequests.count) items")
- }
- }
- func testThatRetriedRequestsCanBeMassCancelled() {
- // Given
- final class OnceRetrier: RequestInterceptor {
- private var hasRetried = false
- func adapt(_ urlRequest: URLRequest, for session: Session, completion: @escaping (Result<URLRequest, Error>) -> Void) {
- if hasRetried {
- var request = urlRequest
- request.url = Endpoint.delay(1).url
- completion(.success(request))
- } else {
- completion(.success(urlRequest))
- }
- }
- func retry(_ request: Request, for session: Session, dueTo error: Error, completion: @escaping (RetryResult) -> Void) {
- completion(hasRetried ? .doNotRetry : .retry)
- hasRetried = true
- }
- }
- let queue = DispatchQueue(label: "com.alamofire.testQueue")
- let monitor = ClosureEventMonitor(queue: queue)
- let session = Session(rootQueue: queue, interceptor: OnceRetrier(), eventMonitors: [monitor])
- let request = Endpoint.status(401)
- let completion = expectation(description: "all requests should finish")
- let cancellation = expectation(description: "cancel all requests should be called")
- let createTask = expectation(description: "should create task twice")
- createTask.expectedFulfillmentCount = 2
- var tasksCreated = 0
- monitor.requestDidCreateTask = { [unowned session] _, _ in
- tasksCreated += 1
- createTask.fulfill()
- // Cancel after the second task is created to ensure proper lifetime events.
- if tasksCreated == 2 {
- session.cancelAllRequests {
- cancellation.fulfill()
- }
- }
- }
- var received: DataResponse<Data?, AFError>?
- // When
- session.request(request).validate().response { response in
- received = response
- completion.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(received?.error?.isExplicitlyCancelledError, true)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty, "requestTaskMap should be empty but has \(session.requestTaskMap.count) items")
- XCTAssertTrue(session.activeRequests.isEmpty, "activeRequests should be empty but has \(session.activeRequests.count) items")
- }
- }
- }
- // MARK: -
- final class SessionConfigurationHeadersTestCase: BaseTestCase {
- enum ConfigurationType {
- case `default`, ephemeral
- }
- func testThatDefaultConfigurationHeadersAreSentWithRequest() {
- // Given, When, Then
- executeAuthorizationHeaderTest(for: .default)
- }
- func testThatEphemeralConfigurationHeadersAreSentWithRequest() {
- // Given, When, Then
- executeAuthorizationHeaderTest(for: .ephemeral)
- }
- private func executeAuthorizationHeaderTest(for type: ConfigurationType) {
- // Given
- let session: Session = {
- let configuration: URLSessionConfiguration = {
- let configuration: URLSessionConfiguration
- switch type {
- case .default:
- configuration = .default
- case .ephemeral:
- configuration = .ephemeral
- }
- var headers = HTTPHeaders.default
- headers["Authorization"] = "Bearer 123456"
- configuration.headers = headers
- return configuration
- }()
- return Session(configuration: configuration)
- }()
- let expectation = expectation(description: "request should complete successfully")
- var response: DataResponse<TestResponse, AFError>?
- // When
- session.request(.default)
- .responseDecodable(of: TestResponse.self) { closureResponse in
- response = closureResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(response?.request, "request should not be nil")
- XCTAssertNotNil(response?.response, "response should not be nil")
- XCTAssertNotNil(response?.data, "data should not be nil")
- XCTAssertEqual(response?.result.isSuccess, true)
- XCTAssertEqual(response?.value?.headers["Authorization"], "Bearer 123456", "Authorization header should match")
- }
- }
|