| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581 |
- //
- // 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
- 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 (AFResult<URLRequest>) -> Void) {
- adaptedCount += 1
- let result: AFResult<URLRequest> = AFResult {
- 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 (AFResult<URLRequest>) -> Void) {
- adaptedCount += 1
- let result: AFResult<URLRequest> = AFResult {
- guard !throwsError else { throw AFError.invalidURL(url: "") }
- var urlRequest = urlRequest
- var finalHeaders = urlRequest.httpHeaders
- headers.forEach { finalHeaders.add($0) }
- urlRequest.httpHeaders = 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 (AFResult<URLRequest>) -> Void) {
- adaptCalledCount += 1
- let result: AFResult<URLRequest> = AFResult {
- 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.httpHeaders.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 (AFResult<URLRequest>) -> Void) {
- adaptCalledCount += 1
- let result: AFResult<URLRequest> = AFResult {
- 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: String = {
- guard
- let afInfo = Bundle(for: Session.self).infoDictionary,
- let build = afInfo["CFBundleShortVersionString"]
- else { return "Unknown" }
- return "Alamofire/\(build)"
- }()
- XCTAssertTrue(userAgent?.contains(alamofireVersion) == true)
- XCTAssertTrue(userAgent?.contains(osNameVersion) == true)
- XCTAssertTrue(userAgent?.contains("Unknown/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>?
- var gzipResponse: DataResponse<Any>?
- var deflateResponse: DataResponse<Any>?
- // 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?>?
- // 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))
- guard let error = request.error?.asAFError, case .explicitlyCancelled = error else {
- XCTFail("Request should have an .explicitlyCancelled error.")
- return
- }
- }
- 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?>?
- // 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))
- guard let error = request.error?.asAFError, case .explicitlyCancelled = error else {
- XCTFail("Request should have an .explicitlyCancelled error.")
- return
- }
- }
- 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?>?
- // 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))
- guard let error = request.error?.asAFError, case .explicitlyCancelled = error else {
- XCTFail("Request should have an .explicitlyCancelled error.")
- return
- }
- }
- // 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?>?
- // 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)
- if let error = response?.error?.asAFError {
- XCTAssertTrue(error.isInvalidURLError)
- XCTAssertEqual(error.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
- } else {
- XCTFail("error should not be nil")
- }
- }
- func testThatDownloadRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let expectation = self.expectation(description: "Download should fail with error")
- var response: DownloadResponse<URL?>?
- // 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)
- if let error = response?.error?.asAFError {
- XCTAssertTrue(error.isInvalidURLError)
- XCTAssertEqual(error.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
- } else {
- XCTFail("error should not be nil")
- }
- }
- func testThatUploadDataRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let expectation = self.expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?>?
- // 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)
- if let error = response?.error?.asAFError {
- XCTAssertTrue(error.isInvalidURLError)
- XCTAssertEqual(error.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
- } else {
- XCTFail("error should not be nil")
- }
- }
- func testThatUploadFileRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let expectation = self.expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?>?
- // 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)
- if let error = response?.error?.asAFError {
- XCTAssertTrue(error.isInvalidURLError)
- XCTAssertEqual(error.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
- } else {
- XCTFail("error should not be nil")
- }
- }
- func testThatUploadStreamRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let expectation = self.expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?>?
- // 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)
- if let error = response?.error?.asAFError {
- XCTAssertTrue(error.isInvalidURLError)
- XCTAssertEqual(error.urlConvertible as? String, "https://httpbin.org/get/äëïöü")
- } else {
- XCTFail("error should not be nil")
- }
- }
- // 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 = self.expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.request(urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = self.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 = self.expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.download(urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = self.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 = self.expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.upload(data, to: urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = self.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 = self.expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.upload(fileURL, to: urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = self.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 = self.expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.upload(inputStream, to: urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = self.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 = self.expectation(description: "Request 1 created")
- monitor.requestDidFailToAdaptURLRequestWithError = { _, _, _ in expectation1.fulfill() }
- let request1 = session.request(urlString)
- waitForExpectations(timeout: timeout, handler: nil)
- let expectation2 = self.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 {
- if let error = request.error?.asAFError {
- XCTAssertTrue(error.isRequestAdaptationError)
- XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "")
- } else {
- XCTFail("error should not be nil")
- }
- }
- }
- // 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>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.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>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.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>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.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>?
- 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)
- XCTAssertTrue(session.requestTaskMap.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>?
- 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)
- XCTAssertTrue(session.requestTaskMap.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>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.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>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- if let error = response?.result.error?.asAFError {
- XCTAssertTrue(error.isRequestAdaptationError)
- XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
- } else {
- XCTFail("error should not be nil")
- }
- }
- 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>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- if let error = response?.result.error?.asAFError {
- XCTAssertTrue(error.isRequestAdaptationError)
- XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
- } else {
- XCTFail("error should not be nil")
- }
- }
- 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>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- if let error = response?.result.error?.asAFError {
- 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>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- if let error = response?.error?.asAFError {
- XCTAssertTrue(error.isResponseSerializationError)
- XCTAssertTrue(error.localizedDescription.starts(with: "JSON could not be serialized"))
- } else {
- XCTFail("error should not be nil")
- }
- }
- func testThatSessionCallsRequestRetrierForAllResponseSerializersThatThrowError() throws {
- // Given
- let handler = RequestHandler()
- handler.throwsErrorOnRetry = true
- let session = Session()
- let json1Expectation = self.expectation(description: "request should eventually fail")
- var json1Response: DataResponse<Any>?
- let json2Expectation = self.expectation(description: "request should eventually fail")
- var json2Response: DataResponse<Any>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- let errors: [AFError] = [json1Response, json2Response].compactMap { $0?.error?.asAFError }
- XCTAssertEqual(errors.count, 2)
- for (index, error) in errors.enumerated() {
- XCTAssertTrue(error.isRequestRetryError)
- XCTAssertEqual(error.localizedDescription.starts(with: "Request retry failed with retry error"), true)
- if case let .requestRetryFailed(retryError, originalError) = error {
- XCTAssertEqual(try retryError.asAFError?.urlConvertible?.asURL().absoluteString, "/invalid/url/\(index + 1)")
- XCTAssertTrue(originalError.localizedDescription.starts(with: "JSON could not be serialized"))
- } else {
- XCTFail("Error failure reason should be response serialization failure")
- }
- }
- }
- func testThatSessionRetriesRequestImmediatelyWhenResponseSerializerRequestsRetry() throws {
- // Given
- let handler = RequestHandler()
- let session = Session()
- let json1Expectation = self.expectation(description: "request should eventually fail")
- var json1Response: DataResponse<Any>?
- let json2Expectation = self.expectation(description: "request should eventually fail")
- var json2Response: DataResponse<Any>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- let errors: [AFError] = [json1Response, json2Response].compactMap { $0?.error?.asAFError }
- XCTAssertEqual(errors.count, 2)
- for error in errors {
- XCTAssertTrue(error.isResponseSerializationError)
- XCTAssertTrue(error.localizedDescription.starts(with: "JSON could not be serialized"))
- }
- }
- 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 = self.expectation(description: "request should eventually fail")
- var json1Response: DataResponse<Any>?
- let json2Expectation = self.expectation(description: "request should eventually fail")
- var json2Response: DataResponse<Any>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- let errors: [AFError] = [json1Response, json2Response].compactMap { $0?.error?.asAFError }
- XCTAssertEqual(errors.count, 2)
- for error in errors {
- XCTAssertTrue(error.isRequestAdaptationError)
- XCTAssertEqual(error.localizedDescription, "Request adaption failed with error: URL is not valid: /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 = self.expectation(description: "request should eventually fail")
- var json1Response: DownloadResponse<Any>?
- let json2Expectation = self.expectation(description: "request should eventually fail")
- var json2Response: DownloadResponse<Any>?
- // 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)
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- let errors: [AFError] = [json1Response, json2Response].compactMap { $0?.error?.asAFError }
- XCTAssertEqual(errors.count, 2)
- for error in errors {
- XCTAssertTrue(error.isRequestAdaptationError)
- XCTAssertEqual(error.localizedDescription, "Request adaption failed with error: URL is not valid: /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: Error?
- 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
- assertErrorIsAFError(error) { XCTAssertTrue($0.isSessionDeinitializedError) }
- }
- // 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>?
- 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)
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertEqual(completionCallCount, 1)
- }
- // MARK: Tests - Request State
- func testThatSessionSetsRequestStateWhenStartRequestsImmediatelyIsTrue() {
- // Given
- let session = Session()
- let expectation = self.expectation(description: "request should complete")
- var response: DataResponse<Any>?
- // 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, .resumed)
- XCTAssertEqual(response?.result.isSuccess, true)
- }
- }
- // MARK: -
- class SessionManagerConfigurationHeadersTestCase: 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 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.httpHeaders = headers
- return configuration
- }()
- return Session(configuration: configuration)
- }()
- let expectation = self.expectation(description: "request should complete successfully")
- var response: DataResponse<Any>?
- // When
- session.request("https://httpbin.org/headers")
- .responseJSON { closureResponse in
- response = closureResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout, handler: nil)
- // Then
- if let response = response {
- XCTAssertNotNil(response.request, "request should not be nil")
- XCTAssertNotNil(response.response, "response should not be nil")
- XCTAssertNotNil(response.data, "data should not be nil")
- XCTAssertTrue(response.result.isSuccess, "result should be a success")
- if
- let response = response.result.value as? [String: Any],
- let headers = response["headers"] as? [String: String],
- let authorization = headers["Authorization"]
- {
- XCTAssertEqual(authorization, "Bearer 123456", "authorization header value does not match")
- } else {
- XCTFail("failed to extract authorization header value")
- }
- } else {
- XCTFail("response should not be nil")
- }
- }
- }
|