| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881 |
- //
- // 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 final class HTTPMethodAdapter: RequestInterceptor {
- let method: HTTPMethod
- let throwsError: Bool
- let adaptedCount = Protected(0)
- init(method: HTTPMethod, throwsError: Bool = false) {
- self.method = method
- self.throwsError = throwsError
- }
- func adapt(_ urlRequest: URLRequest, using state: RequestAdapterState, completion: @escaping (Result<URLRequest, any Error>) -> Void) {
- adaptedCount.write { $0 += 1 }
- let result: Result<URLRequest, any Error> = Result {
- guard !throwsError else { throw AFError.invalidURL(url: "") }
- var urlRequest = urlRequest
- urlRequest.httpMethod = method.rawValue
- return urlRequest
- }
- completion(result)
- }
- }
- private final class HeaderAdapter: RequestInterceptor {
- let headers: HTTPHeaders
- let throwsError: Bool
- let adaptedCount = Protected(0)
- init(headers: HTTPHeaders = ["field": "value"], throwsError: Bool = false) {
- self.headers = headers
- self.throwsError = throwsError
- }
- func adapt(_ urlRequest: URLRequest, using state: RequestAdapterState, completion: @escaping (Result<URLRequest, any Error>) -> Void) {
- adaptedCount.write { $0 += 1 }
- let result: Result<URLRequest, any 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 final class RequestHandler: RequestInterceptor {
- struct MutableState {
- var adaptCalledCount = 0
- var adaptedCount = 0
- var retryCount = 0
- var retryCalledCount = 0
- var retryErrors: [any Error] = []
- var shouldApplyAuthorizationHeader = false
- var throwsErrorOnFirstAdapt = false
- var throwsErrorOnSecondAdapt = false
- var throwsErrorOnRetry = false
- var shouldRetry = true
- var retryDelay: TimeInterval?
- }
- private let mutableState: Protected<MutableState>
- var adaptCalledCount: Int { mutableState.adaptCalledCount }
- var adaptedCount: Int { mutableState.adaptedCount }
- var retryCalledCount: Int { mutableState.retryCalledCount }
- var retryCount: Int { mutableState.retryCount }
- var retryErrors: [any Error] { mutableState.retryErrors }
- init(adaptedCount: Int = 0,
- throwsErrorOnSecondAdapt: Bool = false,
- throwsErrorOnRetry: Bool = false,
- shouldApplyAuthorizationHeader: Bool = false,
- shouldRetry: Bool = true,
- retryDelay: TimeInterval? = nil) {
- mutableState = Protected(.init(adaptedCount: adaptedCount,
- shouldApplyAuthorizationHeader: shouldApplyAuthorizationHeader,
- throwsErrorOnSecondAdapt: throwsErrorOnSecondAdapt,
- throwsErrorOnRetry: throwsErrorOnRetry,
- shouldRetry: shouldRetry,
- retryDelay: retryDelay))
- }
- func adapt(_ urlRequest: URLRequest,
- using state: RequestAdapterState,
- completion: @escaping (Result<URLRequest, any Error>) -> Void) {
- let result = mutableState.write { mutableState in
- mutableState.adaptCalledCount += 1
- let result: Result<URLRequest, any Error> = Result {
- if mutableState.throwsErrorOnFirstAdapt {
- mutableState.throwsErrorOnFirstAdapt = false
- throw AFError.invalidURL(url: "/adapt/error/1")
- }
- if mutableState.throwsErrorOnSecondAdapt && mutableState.adaptedCount == 1 {
- mutableState.throwsErrorOnSecondAdapt = false
- throw AFError.invalidURL(url: "/adapt/error/2")
- }
- var urlRequest = urlRequest
- mutableState.adaptedCount += 1
- if mutableState.shouldApplyAuthorizationHeader && mutableState.adaptedCount > 1 {
- urlRequest.headers.update(.authorization(username: "user", password: "password"))
- }
- return urlRequest
- }
- return result
- }
- completion(result)
- }
- func retry(_ request: Request,
- for session: Session,
- dueTo error: any Error,
- completion: @escaping (RetryResult) -> Void) {
- let result: RetryResult = mutableState.write { mutableState in
- mutableState.retryCalledCount += 1
- if mutableState.throwsErrorOnRetry {
- let error = AFError.invalidURL(url: "/invalid/url/\(mutableState.retryCalledCount)")
- return .doNotRetryWithError(error)
- }
- guard mutableState.shouldRetry else { return .doNotRetry }
- mutableState.retryCount += 1
- mutableState.retryErrors.append(error)
- if mutableState.retryCount < 2 {
- if let retryDelay = mutableState.retryDelay {
- return .retryWithDelay(retryDelay)
- } else {
- return .retry
- }
- } else {
- return .doNotRetry
- }
- }
- completion(result)
- }
- }
- private final class UploadHandler: RequestInterceptor {
- struct MutableState {
- var adaptCalledCount = 0
- var adaptedCount = 0
- var retryCalledCount = 0
- var retryCount = 0
- var retryErrors: [any Error] = []
- }
- private let mutableState = Protected(MutableState())
- var adaptCalledCount: Int { mutableState.adaptCalledCount }
- var adaptedCount: Int { mutableState.adaptedCount }
- var retryCalledCount: Int { mutableState.retryCalledCount }
- var retryCount: Int { mutableState.retryCount }
- var retryErrors: [any Error] { mutableState.retryErrors }
- func adapt(_ urlRequest: URLRequest,
- using state: RequestAdapterState,
- completion: @escaping (Result<URLRequest, any Error>) -> Void) {
- let result: Result<URLRequest, any Error> = mutableState.write { mutableState in
- mutableState.adaptCalledCount += 1
- return Result {
- mutableState.adaptedCount += 1
- if mutableState.adaptedCount == 1 { throw AFError.invalidURL(url: "") }
- return urlRequest
- }
- }
- completion(result)
- }
- func retry(_ request: Request,
- for session: Session,
- dueTo error: any Error,
- completion: @escaping (RetryResult) -> Void) {
- mutableState.write { mutableState in
- mutableState.retryCalledCount += 1
- mutableState.retryCount += 1
- mutableState.retryErrors.append(error)
- }
- completion(.retry)
- }
- }
- // MARK: Tests - Initialization
- @MainActor
- 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")
- }
- @MainActor
- 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")
- }
- @MainActor
- 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")
- }
- @MainActor
- func testThatSessionInitializerSucceedsWithSpecifiedArguments() {
- // Given
- let delegate = SessionDelegate()
- let underlyingQueue = DispatchQueue(label: "underlyingQueue")
- let urlSession: URLSession = {
- let configuration = URLSessionConfiguration.default
- let queue = OperationQueue(underlyingQueue: underlyingQueue, name: "delegateQueue")
- return URLSession(configuration: configuration, delegate: delegate, delegateQueue: queue)
- }()
- let serverTrustManager = ServerTrustManager(evaluators: [:])
- // When
- let session = Session(session: urlSession,
- delegate: delegate,
- rootQueue: underlyingQueue,
- serverTrustManager: serverTrustManager)
- // Then
- XCTAssertTrue(session.delegate === session.session.delegate, "manager delegate should equal session delegate")
- XCTAssertNotNil(session.serverTrustManager, "session server trust policy manager should not be nil")
- }
- // MARK: Tests - Parallel Root Queue
- @MainActor
- func testThatSessionWorksCorrectlyWhenPassedAConcurrentRootQueue() {
- // Given
- let queue = DispatchQueue(label: "ohNoAParallelQueue", attributes: .concurrent)
- let session = Session(rootQueue: queue)
- let didFinish = expectation(description: "request did finish")
- var receivedResponse: TestResponse?
- // When
- session.request(.get).responseDecodable(of: TestResponse.self) { response in
- receivedResponse = response.value
- didFinish.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(receivedResponse, "Should receive TestResponse.")
- }
- // MARK: Tests - Default HTTP Headers
- @MainActor
- func testDefaultUserAgentHeader() {
- // Given, When
- let userAgent = HTTPHeaders.default["User-Agent"]
- // Then
- let osNameVersion: String = {
- let version = ProcessInfo.processInfo.operatingSystemVersion
- let versionString = "\(version.majorVersion).\(version.minorVersion).\(version.patchVersion)"
- let osName: String = {
- #if os(iOS)
- #if targetEnvironment(macCatalyst)
- return "macOS(Catalyst)"
- #else
- return "iOS"
- #endif
- #elseif os(watchOS)
- return "watchOS"
- #elseif os(tvOS)
- return "tvOS"
- #elseif os(macOS)
- #if targetEnvironment(macCatalyst)
- return "macOS(Catalyst)"
- #else
- return "macOS"
- #endif
- #elseif os(visionOS)
- return "visionOS"
- #elseif os(Linux)
- return "Linux"
- #elseif os(Windows)
- return "Windows"
- #elseif os(Android)
- return "Android"
- #elseif os(WASI)
- return "WASI"
- #else
- return "Unknown"
- #endif
- }()
- return "\(osName) \(versionString)"
- }()
- let alamofireVersion = "Alamofire/\(AFInfo.version)"
- XCTAssertTrue(userAgent?.contains(alamofireVersion) == true)
- XCTAssertTrue(userAgent?.contains(osNameVersion) == true)
- XCTAssertTrue(userAgent?.contains("xctest/") == true)
- }
- // MARK: Tests - Supported Accept-Encodings
- // Disabled due to HTTPBin flakiness.
- @MainActor
- func disabled_testDefaultAcceptEncodingSupportsAppropriateEncodingsOnAppropriateSystems() {
- // Given
- let brotliExpectation = expectation(description: "brotli request should complete")
- let gzipExpectation = expectation(description: "gzip request should complete")
- let deflateExpectation = expectation(description: "deflate request should complete")
- var brotliResponse: DataResponse<TestResponse, AFError>?
- var gzipResponse: DataResponse<TestResponse, AFError>?
- var deflateResponse: DataResponse<TestResponse, AFError>?
- // When
- AF.request(.compression(.brotli)).responseDecodable(of: TestResponse.self) { response in
- brotliResponse = response
- brotliExpectation.fulfill()
- }
- AF.request(.compression(.gzip)).responseDecodable(of: TestResponse.self) { response in
- gzipResponse = response
- gzipExpectation.fulfill()
- }
- AF.request(.compression(.deflate)).responseDecodable(of: TestResponse.self) { response in
- deflateResponse = response
- deflateExpectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- if #available(iOS 11.0, macOS 10.13, tvOS 11.0, watchOS 4.0, *) {
- XCTAssertTrue(brotliResponse?.result.isSuccess == true)
- } else {
- XCTAssertTrue(brotliResponse?.result.isFailure == true)
- }
- XCTAssertTrue(gzipResponse?.result.isSuccess == true)
- XCTAssertTrue(deflateResponse?.result.isSuccess == true)
- }
- // MARK: Tests - Start Requests Immediately
- @MainActor
- func testSetStartRequestsImmediatelyToFalseAndResumeRequest() {
- // Given
- let session = Session(startRequestsImmediately: false)
- let url = Endpoint().url
- let urlRequest = URLRequest(url: url)
- let expectation = expectation(description: "\(url)")
- var response: HTTPURLResponse?
- // When
- session.request(urlRequest)
- .response { resp in
- response = resp.response
- expectation.fulfill()
- }
- .resume()
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(response, "response should not be nil")
- XCTAssertTrue(response?.statusCode == 200, "response status code should be 200")
- }
- @MainActor
- func testSetStartRequestsImmediatelyToFalseAndCancelledCallsResponseHandlers() {
- // Given
- let session = Session(startRequestsImmediately: false)
- let url = Endpoint().url
- let urlRequest = URLRequest(url: url)
- let expectation = expectation(description: "\(url)")
- var response: DataResponse<Data?, AFError>?
- // When
- let request = session.request(urlRequest)
- .cancel()
- .response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(response, "response should not be nil")
- XCTAssertTrue(request.isCancelled)
- XCTAssertTrue((request.task == nil) || (request.task?.state == .canceling || request.task?.state == .completed))
- XCTAssertEqual(request.error?.isExplicitlyCancelledError, true)
- }
- @MainActor
- func testSetStartRequestsImmediatelyToFalseAndResumeThenCancelRequestHasCorrectOutput() {
- // Given
- let session = Session(startRequestsImmediately: false)
- let url = Endpoint().url
- let urlRequest = URLRequest(url: url)
- let expectation = expectation(description: "\(url)")
- var response: DataResponse<Data?, AFError>?
- // When
- let request = session.request(urlRequest)
- .response { resp in
- response = resp
- expectation.fulfill()
- }
- .resume()
- .cancel()
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(response, "response should not be nil")
- XCTAssertTrue(request.isCancelled)
- XCTAssertTrue((request.task == nil) || (request.task?.state == .canceling || request.task?.state == .completed))
- XCTAssertEqual(request.error?.isExplicitlyCancelledError, true)
- }
- @MainActor
- func testSetStartRequestsImmediatelyToFalseAndCancelThenResumeRequestDoesntCreateTaskAndStaysCancelled() {
- // Given
- let session = Session(startRequestsImmediately: false)
- let url = Endpoint().url
- let urlRequest = URLRequest(url: url)
- let expectation = expectation(description: "\(url)")
- var response: DataResponse<Data?, AFError>?
- // When
- let request = session.request(urlRequest)
- .response { resp in
- response = resp
- expectation.fulfill()
- }
- .cancel()
- .resume()
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(response, "response should not be nil")
- XCTAssertTrue(request.isCancelled)
- XCTAssertTrue((request.task == nil) || (request.task?.state == .canceling || request.task?.state == .completed))
- XCTAssertEqual(request.error?.isExplicitlyCancelledError, true)
- }
- // MARK: Tests - Deinitialization
- @MainActor
- func testReleasingManagerWithPendingRequestDeinitializesSuccessfully() {
- // Given
- let monitor = ClosureEventMonitor()
- let didCreateRequest = expectation(description: "Request created")
- monitor.requestDidCreateTask = { _, _ in didCreateRequest.fulfill() }
- var session: Session? = Session(startRequestsImmediately: false, eventMonitors: [monitor])
- weak var weakSession = session
- // When
- let request = session?.request(.default)
- session = nil
- waitForExpectations(timeout: timeout)
- // Then
- if #available(macOS 13, iOS 16, tvOS 16, watchOS 9, *) {
- // On 2022 OS versions and later, URLSessionTasks are completed even if not resumed before invalidating a session.
- XCTAssertTrue([.canceling, .completed].contains(request?.task?.state))
- } else {
- XCTAssertEqual(request?.task?.state, .suspended)
- }
- XCTAssertNil(session, "session should be nil")
- XCTAssertNil(weakSession, "weak session should be nil")
- }
- func testReleasingManagerWithPendingCanceledRequestDeinitializesSuccessfully() {
- // Given
- var session: Session? = Session(startRequestsImmediately: false)
- // When
- let request = session?.request(.default)
- request?.cancel()
- session = nil
- let state = request?.state
- // Then
- XCTAssertTrue(state == .cancelled, "state should be .cancelled")
- XCTAssertNil(session, "manager should be nil")
- }
- // MARK: Tests - Bad Requests
- @MainActor
- func testThatDataRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let url = ""
- let expectation = expectation(description: "Request should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.request(url).response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, url)
- }
- @MainActor
- func testThatDownloadRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let url = ""
- let expectation = expectation(description: "Download should fail with error")
- var response: DownloadResponse<URL?, AFError>?
- // When
- session.download(url).response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.fileURL)
- XCTAssertNil(response?.resumeData)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, url)
- }
- @MainActor
- func testThatUploadDataRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let url = ""
- let expectation = expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.upload(Data(), to: url).response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, url)
- }
- @MainActor
- func testThatUploadFileRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let url = ""
- let expectation = expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.upload(URL(fileURLWithPath: "/invalid"), to: url).response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, url)
- }
- @MainActor
- func testThatUploadStreamRequestWithInvalidURLStringThrowsResponseHandlerError() {
- // Given
- let session = Session()
- let url = ""
- let expectation = expectation(description: "Upload should fail with error")
- var response: DataResponse<Data?, AFError>?
- // When
- session.upload(InputStream(data: Data()), to: url).response { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNil(response?.request)
- XCTAssertNil(response?.response)
- XCTAssertNil(response?.data)
- XCTAssertNotNil(response?.error)
- XCTAssertEqual(response?.error?.isInvalidURLError, true)
- XCTAssertEqual(response?.error?.urlConvertible as? String, url)
- }
- // MARK: Tests - Request Adapter
- @MainActor
- func testThatSessionCallsRequestAdaptersWhenCreatingDataRequest() {
- // Given
- let endpoint = Endpoint()
- let methodAdapter = HTTPMethodAdapter(method: .post)
- let headerAdapter = HeaderAdapter()
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.request(endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.request(endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
- XCTAssertEqual(methodAdapter.adaptedCount.value, 2)
- XCTAssertEqual(headerAdapter.adaptedCount.value, 1)
- }
- @MainActor
- func testThatSessionCallsRequestAdaptersWhenCreatingDownloadRequest() {
- // Given
- let endpoint = Endpoint()
- let methodAdapter = HTTPMethodAdapter(method: .post)
- let headerAdapter = HeaderAdapter()
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.download(endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.download(endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
- XCTAssertEqual(methodAdapter.adaptedCount.value, 2)
- XCTAssertEqual(headerAdapter.adaptedCount.value, 1)
- }
- @MainActor
- func testThatSessionCallsRequestAdaptersWhenCreatingUploadRequestWithData() {
- // Given
- let data = Data("data".utf8)
- let endpoint = Endpoint.method(.post)
- let methodAdapter = HTTPMethodAdapter(method: .get)
- let headerAdapter = HeaderAdapter()
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.upload(data, to: endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.upload(data, to: endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
- XCTAssertEqual(methodAdapter.adaptedCount.value, 2)
- XCTAssertEqual(headerAdapter.adaptedCount.value, 1)
- }
- @MainActor
- func testThatSessionCallsRequestAdaptersWhenCreatingUploadRequestWithFile() {
- // Given
- let fileURL = URL(fileURLWithPath: "/path/to/some/file.txt")
- let endpoint = Endpoint.method(.post)
- let methodAdapter = HTTPMethodAdapter(method: .get)
- let headerAdapter = HeaderAdapter()
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.upload(fileURL, to: endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.upload(fileURL, to: endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
- XCTAssertEqual(methodAdapter.adaptedCount.value, 2)
- XCTAssertEqual(headerAdapter.adaptedCount.value, 1)
- }
- @MainActor
- func testThatSessionCallsRequestAdaptersWhenCreatingUploadRequestWithInputStream() {
- // Given
- let inputStream = InputStream(data: Data("data".utf8))
- let endpoint = Endpoint.method(.post)
- let methodAdapter = HTTPMethodAdapter(method: .get)
- let headerAdapter = HeaderAdapter()
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
- let request1 = session.upload(inputStream, to: endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
- let request2 = session.upload(inputStream, to: endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
- XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
- XCTAssertEqual(methodAdapter.adaptedCount.value, 2)
- XCTAssertEqual(headerAdapter.adaptedCount.value, 1)
- }
- @MainActor
- func testThatSessionReturnsRequestAdaptationErrorWhenRequestAdapterThrowsError() {
- // Given
- let endpoint = Endpoint()
- let methodAdapter = HTTPMethodAdapter(method: .post, throwsError: true)
- let headerAdapter = HeaderAdapter(throwsError: true)
- let monitor = ClosureEventMonitor()
- let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
- // When
- let expectation1 = expectation(description: "Request 1 created")
- monitor.requestDidFailToAdaptURLRequestWithError = { _, _, _ in expectation1.fulfill() }
- let request1 = session.request(endpoint)
- waitForExpectations(timeout: timeout)
- let expectation2 = expectation(description: "Request 2 created")
- monitor.requestDidFailToAdaptURLRequestWithError = { _, _, _ in expectation2.fulfill() }
- let request2 = session.request(endpoint, interceptor: headerAdapter)
- waitForExpectations(timeout: timeout)
- let requests = [request1, request2]
- // Then
- for request in requests {
- XCTAssertEqual(request.error?.isRequestAdaptationError, true)
- XCTAssertEqual(request.error?.underlyingError?.asAFError?.urlConvertible as? String, "")
- }
- }
- // MARK: Tests - Request Retrier
- @MainActor
- func testThatSessionCallsRequestRetrierWhenRequestInitiallyEncountersAdaptError() {
- // Given
- let handler = RequestHandler(adaptedCount: 1, throwsErrorOnSecondAdapt: true, shouldApplyAuthorizationHeader: true)
- let session = Session()
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- session.request(.basicAuth(), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 1)
- XCTAssertEqual(handler.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, true)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- @MainActor
- func testThatSessionCallsRequestRetrierWhenDownloadInitiallyEncountersAdaptError() {
- // Given
- let handler = RequestHandler(adaptedCount: 1, throwsErrorOnSecondAdapt: true, shouldApplyAuthorizationHeader: true)
- let session = Session()
- let expectation = expectation(description: "request should eventually fail")
- var response: DownloadResponse<TestResponse, AFError>?
- let destination: DownloadRequest.Destination = { _, _ in
- let fileURL = self.testDirectoryURL.appendingPathComponent("test-output.json")
- return (fileURL, [.removePreviousFile])
- }
- // When
- session.download(.basicAuth(), interceptor: handler, to: destination)
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 1)
- XCTAssertEqual(handler.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, true)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- @MainActor
- func testThatSessionCallsRequestRetrierWhenUploadInitiallyEncountersAdaptError() {
- // Given
- let handler = UploadHandler()
- let session = Session(interceptor: handler)
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- let uploadData = Data("upload data".utf8)
- // When
- session.upload(uploadData, to: .method(.post))
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 1)
- XCTAssertEqual(handler.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, true)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- @MainActor
- func testThatSessionCallsRequestRetrierWhenRequestEncountersError() {
- // Given
- let handler = RequestHandler()
- let session = Session()
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth(), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 3)
- XCTAssertEqual(handler.retryCount, 3)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- @MainActor
- func testThatSessionCallsRequestRetrierThenSessionRetrierWhenRequestEncountersError() {
- // Given
- let sessionHandler = RequestHandler()
- let requestHandler = RequestHandler()
- let session = Session(interceptor: sessionHandler)
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth(), interceptor: requestHandler)
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(sessionHandler.adaptCalledCount, 3)
- XCTAssertEqual(sessionHandler.adaptedCount, 3)
- XCTAssertEqual(sessionHandler.retryCalledCount, 3)
- XCTAssertEqual(sessionHandler.retryCount, 3)
- XCTAssertEqual(requestHandler.adaptCalledCount, 3)
- XCTAssertEqual(requestHandler.adaptedCount, 3)
- XCTAssertEqual(requestHandler.retryCalledCount, 4)
- XCTAssertEqual(requestHandler.retryCount, 4)
- XCTAssertEqual(request.retryCount, 2)
- XCTAssertEqual(response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- @MainActor
- func testThatSessionCallsAdapterWhenRequestIsRetried() {
- // Given
- let handler = RequestHandler(shouldApplyAuthorizationHeader: true)
- let session = Session(interceptor: handler)
- let expectation = expectation(description: "request should eventually succeed")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth())
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 1)
- XCTAssertEqual(handler.retryCount, 1)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, true)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- @MainActor
- func testThatSessionReturnsRequestAdaptationErrorWhenRequestIsRetried() {
- // Given
- let handler = RequestHandler(throwsErrorOnSecondAdapt: true)
- let session = Session(interceptor: handler)
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth())
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 3)
- XCTAssertEqual(handler.retryCount, 3)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, false)
- XCTAssertEqual(request.error?.isRequestAdaptationError, true)
- XCTAssertEqual(request.error?.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- @MainActor
- func testThatSessionRetriesRequestWithDelayWhenRetryResultContainsDelay() {
- // Given
- let handler = RequestHandler(throwsErrorOnSecondAdapt: true, retryDelay: 0.01)
- let session = Session(interceptor: handler)
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth())
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 3)
- XCTAssertEqual(handler.retryCount, 3)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(response?.result.isSuccess, false)
- XCTAssertEqual(request.error?.isRequestAdaptationError, true)
- XCTAssertEqual(request.error?.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- @MainActor
- func testThatSessionReturnsRequestRetryErrorWhenRequestRetrierThrowsError() {
- // Given
- let handler = RequestHandler(throwsErrorOnRetry: true)
- let session = Session(interceptor: handler)
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.basicAuth())
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 1)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 2)
- XCTAssertEqual(handler.retryCount, 0)
- XCTAssertEqual(request.retryCount, 0)
- XCTAssertEqual(response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- if let error = response?.result.failure {
- XCTAssertTrue(error.isRequestRetryError)
- XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/invalid/url/2")
- } else {
- XCTFail("error should not be nil")
- }
- }
- // MARK: Tests - Response Serializer Retry
- @MainActor
- func testThatSessionCallsRequestRetrierWhenResponseSerializerThrowsError() {
- // Given
- let handler = RequestHandler(shouldRetry: false)
- let session = Session()
- let expectation = expectation(description: "request should eventually fail")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.image(.jpeg), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { jsonResponse in
- response = jsonResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 1)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 1)
- XCTAssertEqual(handler.retryCount, 0)
- XCTAssertEqual(request.retryCount, 0)
- XCTAssertEqual(response?.result.isSuccess, false)
- XCTAssertEqual(response?.error?.isResponseSerializationError, true)
- XCTAssertNotNil(response?.error?.underlyingError as? DecodingError)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- @MainActor
- func testThatSessionCallsRequestRetrierForAllResponseSerializersThatThrowError() throws {
- // Given
- let handler = RequestHandler(throwsErrorOnRetry: true)
- let session = Session()
- let json1Expectation = expectation(description: "request should eventually fail")
- var json1Response: DataResponse<TestResponse, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.image(.jpeg), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseDecodable(of: TestResponse.self) { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 1)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 2)
- XCTAssertEqual(handler.retryCount, 0)
- XCTAssertEqual(request.retryCount, 0)
- XCTAssertEqual(json1Response?.result.isSuccess, false)
- XCTAssertEqual(json2Response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- let errors = [json1Response, json2Response].compactMap { $0?.error }
- XCTAssertEqual(errors.count, 2)
- for (index, error) in errors.enumerated() {
- XCTAssertTrue(error.isRequestRetryError)
- if case let .requestRetryFailed(retryError, originalError) = error {
- XCTAssertEqual(retryError.asAFError?.urlConvertible as? String, "/invalid/url/\(index + 1)")
- XCTAssertNotNil(originalError.asAFError?.underlyingError as? DecodingError)
- } else {
- XCTFail("Error failure reason should be response serialization failure")
- }
- }
- }
- @MainActor
- func testThatSessionRetriesRequestImmediatelyWhenResponseSerializerRequestsRetry() throws {
- // Given
- let handler = RequestHandler()
- let session = Session()
- let json1Expectation = expectation(description: "request should eventually fail")
- var json1Response: DataResponse<TestResponse, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.image(.jpeg), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseDecodable(of: TestResponse.self) { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 2)
- XCTAssertEqual(handler.retryCalledCount, 3)
- XCTAssertEqual(handler.retryCount, 3)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(json1Response?.result.isSuccess, false)
- XCTAssertEqual(json2Response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- let errors = [json1Response, json2Response].compactMap { $0?.error }
- XCTAssertEqual(errors.count, 2)
- for error in errors {
- XCTAssertTrue(error.isResponseSerializationError)
- XCTAssertNotNil(error.underlyingError as? DecodingError)
- }
- }
- @MainActor
- 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(throwsErrorOnSecondAdapt: true)
- let session = Session()
- let json1Expectation = expectation(description: "request should eventually fail")
- var json1Response: DataResponse<TestResponse, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.image(.jpeg), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseDecodable(of: TestResponse.self) { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 4)
- XCTAssertEqual(handler.retryCount, 4)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(json1Response?.result.isSuccess, false)
- XCTAssertEqual(json2Response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- let errors = [json1Response, json2Response].compactMap { $0?.error }
- XCTAssertEqual(errors.count, 2)
- for error in errors {
- XCTAssertTrue(error.isRequestAdaptationError)
- XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
- }
- }
- @MainActor
- 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(throwsErrorOnSecondAdapt: true)
- let session = Session()
- let json1Expectation = expectation(description: "request should eventually fail")
- var json1Response: DownloadResponse<TestResponse, AFError>?
- let json2Expectation = expectation(description: "request should eventually fail")
- var json2Response: DownloadResponse<TestResponse, AFError>?
- // When
- let request = session.download(.image(.jpeg), interceptor: handler)
- .validate()
- .responseDecodable(of: TestResponse.self) { response in
- json1Response = response
- json1Expectation.fulfill()
- }
- .responseDecodable(of: TestResponse.self) { response in
- json2Response = response
- json2Expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 2)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 4)
- XCTAssertEqual(handler.retryCount, 4)
- XCTAssertEqual(request.retryCount, 1)
- XCTAssertEqual(json1Response?.result.isSuccess, false)
- XCTAssertEqual(json2Response?.result.isSuccess, false)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- let errors = [json1Response, json2Response].compactMap { $0?.error }
- XCTAssertEqual(errors.count, 2)
- for error in errors {
- XCTAssertTrue(error.isRequestAdaptationError)
- XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
- }
- }
- // MARK: Tests - Session Invalidation
- @MainActor
- func testThatSessionIsInvalidatedAndAllRequestsCompleteWhenSessionIsDeinitialized() {
- // Given
- let invalidationExpectation = expectation(description: "sessionDidBecomeInvalidWithError should be called")
- let events = ClosureEventMonitor()
- events.sessionDidBecomeInvalidWithError = { _, _ in
- invalidationExpectation.fulfill()
- }
- var session: Session? = Session(startRequestsImmediately: false, eventMonitors: [events])
- var error: AFError?
- let requestExpectation = expectation(description: "request should complete")
- // When
- session?.request(.default).response { response in
- error = response.error
- requestExpectation.fulfill()
- }
- session = nil
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(error?.isSessionDeinitializedError, true)
- }
- // MARK: Tests - Request Cancellation
- @MainActor
- func testThatSessionOnlyCallsResponseSerializerCompletionWhenCancellingInsideCompletion() {
- // Given
- let handler = RequestHandler()
- let session = Session()
- let expectation = expectation(description: "request should complete")
- var response: DataResponse<TestResponse, AFError>?
- var completionCallCount = 0
- // When
- let request = session.request(.default, interceptor: handler)
- request.validate()
- request.responseDecodable(of: TestResponse.self) { resp in
- request.cancel()
- response = resp
- completionCallCount += 1
- DispatchQueue.main.after(0.01) { expectation.fulfill() }
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(handler.adaptCalledCount, 1)
- XCTAssertEqual(handler.adaptedCount, 1)
- XCTAssertEqual(handler.retryCalledCount, 0)
- XCTAssertEqual(handler.retryCount, 0)
- XCTAssertEqual(request.retryCount, 0)
- XCTAssertEqual(response?.result.isSuccess, true)
- XCTAssertEqual(completionCallCount, 1)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty)
- XCTAssertTrue(session.activeRequests.isEmpty)
- }
- }
- // MARK: Tests - Request State
- @MainActor
- func testThatSessionSetsRequestStateWhenStartRequestsImmediatelyIsTrue() {
- // Given
- let session = Session()
- let expectation = expectation(description: "request should complete")
- var response: DataResponse<TestResponse, AFError>?
- // When
- let request = session.request(.default).responseDecodable(of: TestResponse.self) { resp in
- response = resp
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(request.state, .finished)
- XCTAssertEqual(response?.result.isSuccess, true)
- }
- // MARK: Invalid Requests
- @MainActor
- func testThatGETRequestsWithBodyDataAreConsideredInvalid() {
- // Given
- let session = Session()
- var request = Endpoint().urlRequest
- request.httpBody = Data("invalid".utf8)
- let expect = expectation(description: "request should complete")
- var response: DataResponse<TestResponse, AFError>?
- // When
- session.request(request).responseDecodable(of: TestResponse.self) { resp in
- response = resp
- expect.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(response?.result.isFailure, true)
- XCTAssertEqual(response?.error?.isBodyDataInGETRequest, true)
- }
- @MainActor
- func testThatAdaptedGETRequestsWithBodyDataAreConsideredInvalid() {
- // Given
- struct InvalidAdapter: RequestInterceptor {
- func adapt(_ urlRequest: URLRequest,
- for session: Session,
- completion: @escaping (Result<URLRequest, any Error>) -> Void) {
- var request = urlRequest
- request.httpBody = Data("invalid".utf8)
- completion(.success(request))
- }
- }
- let session = Session(interceptor: InvalidAdapter())
- let expect = expectation(description: "request should complete")
- var response: DataResponse<TestResponse, AFError>?
- // When
- session.request(.default).responseDecodable(of: TestResponse.self) { resp in
- response = resp
- expect.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(response?.result.isFailure, true)
- XCTAssertEqual(response?.error?.isRequestAdaptationError, true)
- XCTAssertEqual(response?.error?.underlyingError?.asAFError?.isBodyDataInGETRequest, true)
- }
- }
- // MARK: -
- final class SessionMassActionTestCase: BaseTestCase {
- func testThatRequestsCanHaveMassActionsPerformed() {
- // Given
- let count = 10
- let createdTasks = expectation(description: "all tasks created")
- createdTasks.expectedFulfillmentCount = count
- let massActions = expectation(description: "cancel all requests should be called")
- let monitor = ClosureEventMonitor()
- monitor.requestDidCreateTask = { _, _ in createdTasks.fulfill() }
- let session = Session(eventMonitors: [monitor])
- let request = Endpoint.delay(1)
- var requests: [DataRequest] = []
- // When
- requests = (0..<count).map { _ in session.request(request) }
- wait(for: [createdTasks], timeout: timeout)
- session.withAllRequests { $0.forEach { $0.suspend() }; massActions.fulfill() }
- wait(for: [massActions], timeout: timeout)
- // Then
- XCTAssertTrue(requests.allSatisfy(\.isSuspended))
- }
- @MainActor
- func testThatAutomaticallyResumedRequestsCanBeMassCancelled() {
- // Given
- let count = 100
- let completion = expectation(description: "all requests should finish")
- completion.expectedFulfillmentCount = count
- let createdTasks = expectation(description: "all tasks created")
- createdTasks.expectedFulfillmentCount = count
- let gatheredMetrics = expectation(description: "metrics gathered for all tasks")
- gatheredMetrics.expectedFulfillmentCount = count
- let cancellation = expectation(description: "cancel all requests should be called")
- let monitor = ClosureEventMonitor()
- monitor.requestDidCreateTask = { _, _ in createdTasks.fulfill() }
- monitor.requestDidGatherMetrics = { _, _ in gatheredMetrics.fulfill() }
- let session = Session(eventMonitors: [monitor])
- let request = Endpoint.delay(1)
- var requests: [DataRequest] = []
- var responses: [DataResponse<Data?, AFError>] = []
- // When
- requests = (0..<count).map { _ in session.request(request) }
- wait(for: [createdTasks], timeout: timeout)
- for request in requests {
- 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")
- }
- }
- @MainActor
- func testThatManuallyResumedRequestsCanBeMassCancelled() {
- // Given
- let count = 100
- let completion = expectation(description: "all requests should finish")
- completion.expectedFulfillmentCount = count
- let createdTasks = expectation(description: "all tasks created")
- createdTasks.expectedFulfillmentCount = count
- let gatheredMetrics = expectation(description: "metrics gathered for all tasks")
- gatheredMetrics.expectedFulfillmentCount = count
- let cancellation = expectation(description: "cancel all requests should be called")
- let monitor = ClosureEventMonitor()
- monitor.requestDidCreateTask = { _, _ in createdTasks.fulfill() }
- monitor.requestDidGatherMetrics = { _, _ in gatheredMetrics.fulfill() }
- let session = Session(startRequestsImmediately: false, eventMonitors: [monitor])
- let request = Endpoint.delay(1)
- var responses: [DataResponse<Data?, AFError>] = []
- // When
- for _ in 0..<count {
- session.request(request).response { response in
- responses.append(response)
- completion.fulfill()
- }
- }
- wait(for: [createdTasks], timeout: timeout)
- session.cancelAllRequests {
- cancellation.fulfill()
- }
- wait(for: [gatheredMetrics, cancellation, completion], timeout: timeout)
- // Then
- XCTAssertTrue(responses.allSatisfy { $0.error?.isExplicitlyCancelledError == true })
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty, "requestTaskMap should be empty but has \(session.requestTaskMap.count) items")
- XCTAssertTrue(session.activeRequests.isEmpty, "activeRequests should be empty but has \(session.activeRequests.count) items")
- }
- }
- @MainActor
- func testThatRetriedRequestsCanBeMassCancelled() {
- // Given
- final class OnceRetrier: RequestInterceptor {
- private var hasRetried = false
- func adapt(_ urlRequest: URLRequest, for session: Session, completion: @escaping (Result<URLRequest, any Error>) -> Void) {
- if hasRetried {
- var request = urlRequest
- request.url = Endpoint.delay(1).url
- completion(.success(request))
- } else {
- completion(.success(urlRequest))
- }
- }
- func retry(_ request: Request, for session: Session, dueTo error: any Error, completion: @escaping (RetryResult) -> Void) {
- completion(hasRetried ? .doNotRetry : .retry)
- hasRetried = true
- }
- }
- let queue = DispatchQueue(label: "com.alamofire.testQueue")
- let monitor = ClosureEventMonitor(queue: queue)
- let session = Session(rootQueue: queue, interceptor: OnceRetrier(), eventMonitors: [monitor])
- let request = Endpoint.status(401)
- let completion = expectation(description: "all requests should finish")
- let cancellation = expectation(description: "cancel all requests should be called")
- let createTask = expectation(description: "should create task twice")
- createTask.expectedFulfillmentCount = 2
- var tasksCreated = 0
- monitor.requestDidCreateTask = { [unowned session] _, _ in
- tasksCreated += 1
- createTask.fulfill()
- // Cancel after the second task is created to ensure proper lifetime events.
- if tasksCreated == 2 {
- session.cancelAllRequests {
- cancellation.fulfill()
- }
- }
- }
- var received: DataResponse<Data?, AFError>?
- // When
- session.request(request).validate().response { response in
- received = response
- completion.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertEqual(received?.error?.isExplicitlyCancelledError, true)
- assert(on: session.rootQueue) {
- XCTAssertTrue(session.requestTaskMap.isEmpty, "requestTaskMap should be empty but has \(session.requestTaskMap.count) items")
- XCTAssertTrue(session.activeRequests.isEmpty, "activeRequests should be empty but has \(session.activeRequests.count) items")
- }
- }
- }
- // MARK: -
- final class SessionConfigurationHeadersTestCase: BaseTestCase {
- enum ConfigurationType {
- case `default`, ephemeral
- }
- @MainActor
- func testThatDefaultConfigurationHeadersAreSentWithRequest() {
- // Given, When, Then
- executeAuthorizationHeaderTest(for: .default)
- }
- @MainActor
- func testThatEphemeralConfigurationHeadersAreSentWithRequest() {
- // Given, When, Then
- executeAuthorizationHeaderTest(for: .ephemeral)
- }
- @MainActor
- private func executeAuthorizationHeaderTest(for type: ConfigurationType) {
- // Given
- let session: Session = {
- let configuration: URLSessionConfiguration = {
- let configuration: URLSessionConfiguration = switch type {
- case .default:
- .default
- case .ephemeral:
- .ephemeral
- }
- var headers = HTTPHeaders.default
- headers["Authorization"] = "Bearer 123456"
- configuration.headers = headers
- return configuration
- }()
- return Session(configuration: configuration)
- }()
- let expectation = expectation(description: "request should complete successfully")
- var response: DataResponse<TestResponse, AFError>?
- // When
- session.request(.default)
- .responseDecodable(of: TestResponse.self) { closureResponse in
- response = closureResponse
- expectation.fulfill()
- }
- waitForExpectations(timeout: timeout)
- // Then
- XCTAssertNotNil(response?.request, "request should not be nil")
- XCTAssertNotNil(response?.response, "response should not be nil")
- XCTAssertNotNil(response?.data, "data should not be nil")
- XCTAssertEqual(response?.result.isSuccess, true)
- XCTAssertEqual(response?.value?.headers["Authorization"], "Bearer 123456", "Authorization header should match")
- }
- }
|