| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744 |
- //
- // 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, for session: Session, 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, for session: Session, 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, for session: Session, 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, for session: Session, 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 - 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)
- return "iOS"
- #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/Unknown") == true)
- }
- // MARK: Tests - Supported Accept-Encodings
- func testDefaultAcceptEncodingSupportsAppropriateEncodingsOnAppropriateSystems() {
- // Given
- let brotliURL = URL(string: "https://httpbin.org/brotli")!
- let gzipURL = URL(string: "https://httpbin.org/gzip")!
- let deflateURL = URL(string: "https://httpbin.org/deflate")!
- 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<Any, AFError>?
- var gzipResponse: DataResponse<Any, AFError>?
- var deflateResponse: DataResponse<Any, AFError>?
- // When
- AF.request(brotliURL).responseJSON { response in
- brotliResponse = response
- brotliExpectation.fulfill()
- }
- AF.request(gzipURL).responseJSON { response in
- gzipResponse = response
- gzipExpectation.fulfill()
- }
- AF.request(deflateURL).responseJSON { response in
- deflateResponse = response
- deflateExpectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = URL(string: "https://httpbin.org/get")!
- let urlRequest = URLRequest(url: url)
- let expectation = self.expectation(description: "\(url)")
- var response: HTTPURLResponse?
- // When
- session.request(urlRequest)
- .response { resp in
- response = resp.response
- expectation.fulfill()
- }
- .resume()
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = URL(string: "https://httpbin.org/get")!
- let urlRequest = URLRequest(url: url)
- let expectation = self.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, handler: nil)
- // 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 = URL(string: "https://httpbin.org/get")!
- let urlRequest = URLRequest(url: url)
- let expectation = self.expectation(description: "\(url)")
- var response: DataResponse<Data?, AFError>?
- // When
- let request = session.request(urlRequest)
- .resume()
- .cancel()
- .response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = URL(string: "https://httpbin.org/get")!
- let urlRequest = URLRequest(url: url)
- let expectation = self.expectation(description: "\(url)")
- var response: DataResponse<Data?, AFError>?
- // When
- let request = session.request(urlRequest)
- .cancel()
- .resume()
- .response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 expectation = self.expectation(description: "Request created")
- monitor.requestDidCreateTask = { _, _ in expectation.fulfill() }
- var session: Session? = Session(startRequestsImmediately: false, eventMonitors: [monitor])
- let url = URL(string: "https://httpbin.org/get")!
- let urlRequest = URLRequest(url: url)
- // When
- let request = session?.request(urlRequest)
- session = nil
- waitForExpectations(timeout: timeout, handler: nil)
- // Then
- XCTAssertEqual(request?.task?.state, .suspended)
- XCTAssertNil(session, "manager should be nil")
- }
- func testReleasingManagerWithPendingCanceledRequestDeinitializesSuccessfully() {
- // Given
- var session: Session? = Session(startRequestsImmediately: false)
- let url = URL(string: "https://httpbin.org/get")!
- let urlRequest = URLRequest(url: url)
- // When
- let request = session?.request(urlRequest)
- 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 expectation = self.expectation(description: "Request should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.request("https://httpbin.org/get/äëïöü").response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
- }
- func testThatDownloadRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let expectation = self.expectation(description: "Download should fail with error")
- var response: DownloadResponse<URL?, AFError>?
- // When
- session.download("https://httpbin.org/get/äëïöü").response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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, "https://httpbin.org/get/äëïöü")
- }
- func testThatUploadDataRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let expectation = self.expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.upload(Data(), to: "https://httpbin.org/get/äëïöü").response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
- }
- func testThatUploadFileRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let expectation = self.expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.upload(URL(fileURLWithPath: "/invalid"), to: "https://httpbin.org/get/äëïöü").response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
- }
- func testThatUploadStreamRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let expectation = self.expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.upload(InputStream(data: Data()), to: "https://httpbin.org/get/äëïöü").response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
- }
- // MARK: Tests - Request Adapter
- func testThatSessionCallsRequestAdaptersWhenCreatingDataRequest() {
- // Given
- let urlString = "https://httpbin.org/get"
- 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(urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.request(urlString, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 urlString = "https://httpbin.org/get"
- 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(urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.download(urlString, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 urlString = "https://httpbin.org/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: urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.upload(data, to: urlString, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 urlString = "https://httpbin.org/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: urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.upload(fileURL, to: urlString, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 urlString = "https://httpbin.org/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: urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.upload(inputStream, to: urlString, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 urlString = "https://httpbin.org/get"
- 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(urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidFailToAdaptURLRequestWithError = { _, _, _ in expectation2.fulfill() }
- let request2 = session.request(urlString, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout, handler: nil)
- 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 testThatSessionCallsRequestRetrierWhenRequestEncountersError() {
- // Given
- let handler = RequestHandler()
- let session = Session()
- let expectation = self.expectation(description: "request should eventually fail")
- var response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/basic-auth/user/password", interceptor: handler)
- .validate()
- .responseJSON { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = self.expectation(description: "request should eventually fail")
- var response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/basic-auth/user/password", interceptor: requestHandler)
- .validate()
- .responseJSON { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 testThatSessionCallsRequestRetrierWhenRequestInitiallyEncountersAdaptError() {
- // Given
- let handler = RequestHandler()
- handler.adaptedCount = 1
- handler.throwsErrorOnSecondAdapt = true
- handler.shouldApplyAuthorizationHeader = true
- let session = Session()
- let expectation = self.expectation(description: "request should eventually fail")
- var response: DataResponse<Any, AFError>?
- // When
- session.request("https://httpbin.org/basic-auth/user/password", interceptor: handler)
- .validate()
- .responseJSON { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = self.expectation(description: "request should eventually fail")
- var response: DownloadResponse<Any, AFError>?
- let destination: DownloadRequest.Destination = { _, _ in
- let fileURL = self.testDirectoryURL.appendingPathComponent("test-output.json")
- return (fileURL, [.removePreviousFile])
- }
- // When
- session.download("https://httpbin.org/basic-auth/user/password", interceptor: handler, to: destination)
- .validate()
- .responseJSON { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = self.expectation(description: "request should eventually fail")
- var response: DataResponse<Any, AFError>?
- let uploadData = Data("upload data".utf8)
- // When
- session.upload(uploadData, to: "https://httpbin.org/post")
- .validate()
- .responseJSON { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 testThatSessionCallsAdapterWhenRequestIsRetried() {
- // Given
- let handler = RequestHandler()
- handler.shouldApplyAuthorizationHeader = true
- let session = Session(interceptor: handler)
- let expectation = self.expectation(description: "request should eventually succeed")
- var response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/basic-auth/user/password")
- .validate()
- .responseJSON { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = self.expectation(description: "request should eventually fail")
- var response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/basic-auth/user/password")
- .validate()
- .responseJSON { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = self.expectation(description: "request should eventually fail")
- var response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/basic-auth/user/password")
- .validate()
- .responseJSON { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = self.expectation(description: "request should eventually fail")
- var response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/basic-auth/user/password")
- .validate()
- .responseJSON { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = self.expectation(description: "request should eventually fail")
- var response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/image/jpeg", interceptor: handler)
- .validate()
- .responseJSON { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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)
- XCTAssertEqual((response?.error?.underlyingError as? CocoaError)?.code, .propertyListReadCorrupt)
- 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<Any, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/image/jpeg", interceptor: handler)
- .validate()
- .responseJSON { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseJSON { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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)")
- XCTAssertEqual((originalError.asAFError?.underlyingError as? CocoaError)?.code, .propertyListReadCorrupt)
- } 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<Any, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/image/jpeg", interceptor: handler)
- .validate()
- .responseJSON { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseJSON { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: 10, handler: nil)
- // 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)
- XCTAssertEqual((error.underlyingError as? CocoaError)?.code, .propertyListReadCorrupt)
- }
- }
- 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<Any, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/image/jpeg", interceptor: handler)
- .validate()
- .responseJSON { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseJSON { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: 10, handler: nil)
- // 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<Any, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DownloadResponse<Any, AFError>?
- // When
- let request = session.download("https://httpbin.org/image/jpeg", interceptor: handler)
- .validate()
- .responseJSON { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseJSON { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: 10, handler: nil)
- // 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(URLRequest.makeHTTPBinRequest()).response { response in
- error = response.error
- requestExpectation.fulfill()
- }
- session = nil
- waitForExpectations(timeout: timeout, handler: nil)
- // Then
- XCTAssertEqual(error?.isSessionDeinitializedError, true)
- }
- // MARK: Tests - Request Cancellation
- func testThatSessionOnlyCallsResponseSerializerCompletionWhenCancellingInsideCompletion() {
- // Given
- let handler = RequestHandler()
- let session = Session()
- let expectation = self.expectation(description: "request should complete")
- var response: DataResponse<Any, AFError>?
- var completionCallCount = 0
- // When
- let request = session.request("https://httpbin.org/get", interceptor: handler)
- request.validate()
- request.responseJSON { resp in
- request.cancel()
- response = resp
- completionCallCount += 1
- DispatchQueue.main.after(0.01) { expectation.fulfill() }
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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 = self.expectation(description: "request should complete")
- var response: DataResponse<Any, AFError>?
- // When
- let request = session.request("https://httpbin.org/get").responseJSON { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // Then
- XCTAssertEqual(request.state, .finished)
- XCTAssertEqual(response?.result.isSuccess, true)
- }
- }
- // MARK: -
- final class SessionCancellationTestCase: BaseTestCase {
- 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 = URLRequest.makeHTTPBinRequest(path: "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 = URLRequest.makeHTTPBinRequest(path: "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 = URL.makeHTTPBinURL(path: "delay/1")
- 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 = URLRequest.makeHTTPBinRequest(path: "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 = { _, _ 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")
- }
- }
- func testThatGETRequestsWithBodyDataAreConsideredInvalid() {
- // Given
- let session = Session()
- var request = URLRequest.makeHTTPBinRequest()
- request.httpBody = Data("invalid".utf8)
- let expect = expectation(description: "request should complete")
- var response: DataResponse<HTTPBinResponse, AFError>?
- // When
- session.request(request).responseDecodable(of: HTTPBinResponse.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 request = URLRequest.makeHTTPBinRequest()
- let expect = expectation(description: "request should complete")
- var response: DataResponse<HTTPBinResponse, AFError>?
- // When
- session.request(request).responseDecodable(of: HTTPBinResponse.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 SessionConfigurationHeadersTestCase: BaseTestCase {
- enum ConfigurationType {
- case `default`, ephemeral, background
- }
- func testThatDefaultConfigurationHeadersAreSentWithRequest() {
- // Given, When, Then
- executeAuthorizationHeaderTest(for: .default)
- }
- func testThatEphemeralConfigurationHeadersAreSentWithRequest() {
- // Given, When, Then
- executeAuthorizationHeaderTest(for: .ephemeral)
- }
- #if os(macOS)
- func disabled_testThatBackgroundConfigurationHeadersAreSentWithRequest() {
- // Given, When, Then
- executeAuthorizationHeaderTest(for: .background)
- }
- #endif
- 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
- case .background:
- let identifier = "org.alamofire.test.manager-configuration-tests"
- configuration = .background(withIdentifier: identifier)
- }
- var headers = HTTPHeaders.default
- headers["Authorization"] = "Bearer 123456"
- configuration.headers = headers
- return configuration
- }()
- return Session(configuration: configuration)
- }()
- let expectation = self.expectation(description: "request should complete successfully")
- var response: DataResponse<HTTPBinResponse, AFError>?
- // When
- session.request("https://httpbin.org/get")
- .responseDecodable(of: HTTPBinResponse.self) { closureResponse in
- response = closureResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // 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")
- }
- }
|