SessionTests.swift 66 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785
  1. //
  2. // SessionTests.swift
  3. //
  4. // Copyright (c) 2014-2018 Alamofire Software Foundation (http://alamofire.org/)
  5. //
  6. // Permission is hereby granted, free of charge, to any person obtaining a copy
  7. // of this software and associated documentation files (the "Software"), to deal
  8. // in the Software without restriction, including without limitation the rights
  9. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. // copies of the Software, and to permit persons to whom the Software is
  11. // furnished to do so, subject to the following conditions:
  12. //
  13. // The above copyright notice and this permission notice shall be included in
  14. // all copies or substantial portions of the Software.
  15. //
  16. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22. // THE SOFTWARE.
  23. //
  24. @testable import Alamofire
  25. import Foundation
  26. import XCTest
  27. final class SessionTestCase: BaseTestCase {
  28. // MARK: Helper Types
  29. private class HTTPMethodAdapter: RequestInterceptor {
  30. let method: HTTPMethod
  31. let throwsError: Bool
  32. var adaptedCount = 0
  33. init(method: HTTPMethod, throwsError: Bool = false) {
  34. self.method = method
  35. self.throwsError = throwsError
  36. }
  37. func adapt(_ urlRequest: URLRequest, using state: RequestAdapterState, completion: @escaping (Result<URLRequest, Error>) -> Void) {
  38. adaptedCount += 1
  39. let result: Result<URLRequest, Error> = Result {
  40. guard !throwsError else { throw AFError.invalidURL(url: "") }
  41. var urlRequest = urlRequest
  42. urlRequest.httpMethod = method.rawValue
  43. return urlRequest
  44. }
  45. completion(result)
  46. }
  47. }
  48. private class HeaderAdapter: RequestInterceptor {
  49. let headers: HTTPHeaders
  50. let throwsError: Bool
  51. var adaptedCount = 0
  52. init(headers: HTTPHeaders = ["field": "value"], throwsError: Bool = false) {
  53. self.headers = headers
  54. self.throwsError = throwsError
  55. }
  56. func adapt(_ urlRequest: URLRequest, using state: RequestAdapterState, completion: @escaping (Result<URLRequest, Error>) -> Void) {
  57. adaptedCount += 1
  58. let result: Result<URLRequest, Error> = Result {
  59. guard !throwsError else { throw AFError.invalidURL(url: "") }
  60. var urlRequest = urlRequest
  61. var finalHeaders = urlRequest.headers
  62. headers.forEach { finalHeaders.add($0) }
  63. urlRequest.headers = finalHeaders
  64. return urlRequest
  65. }
  66. completion(result)
  67. }
  68. }
  69. private class RequestHandler: RequestInterceptor {
  70. var adaptCalledCount = 0
  71. var adaptedCount = 0
  72. var retryCount = 0
  73. var retryCalledCount = 0
  74. var retryErrors: [Error] = []
  75. var shouldApplyAuthorizationHeader = false
  76. var throwsErrorOnFirstAdapt = false
  77. var throwsErrorOnSecondAdapt = false
  78. var throwsErrorOnRetry = false
  79. var shouldRetry = true
  80. var retryDelay: TimeInterval?
  81. func adapt(_ urlRequest: URLRequest,
  82. using state: RequestAdapterState,
  83. completion: @escaping (Result<URLRequest, Error>) -> Void) {
  84. adaptCalledCount += 1
  85. let result: Result<URLRequest, Error> = Result {
  86. if throwsErrorOnFirstAdapt {
  87. throwsErrorOnFirstAdapt = false
  88. throw AFError.invalidURL(url: "/adapt/error/1")
  89. }
  90. if throwsErrorOnSecondAdapt && adaptedCount == 1 {
  91. throwsErrorOnSecondAdapt = false
  92. throw AFError.invalidURL(url: "/adapt/error/2")
  93. }
  94. var urlRequest = urlRequest
  95. adaptedCount += 1
  96. if shouldApplyAuthorizationHeader && adaptedCount > 1 {
  97. urlRequest.headers.update(.authorization(username: "user", password: "password"))
  98. }
  99. return urlRequest
  100. }
  101. completion(result)
  102. }
  103. func retry(_ request: Request,
  104. for session: Session,
  105. dueTo error: Error,
  106. completion: @escaping (RetryResult) -> Void) {
  107. retryCalledCount += 1
  108. if throwsErrorOnRetry {
  109. let error = AFError.invalidURL(url: "/invalid/url/\(retryCalledCount)")
  110. completion(.doNotRetryWithError(error))
  111. return
  112. }
  113. guard shouldRetry else { completion(.doNotRetry); return }
  114. retryCount += 1
  115. retryErrors.append(error)
  116. if retryCount < 2 {
  117. if let retryDelay = retryDelay {
  118. completion(.retryWithDelay(retryDelay))
  119. } else {
  120. completion(.retry)
  121. }
  122. } else {
  123. completion(.doNotRetry)
  124. }
  125. }
  126. }
  127. private class UploadHandler: RequestInterceptor {
  128. var adaptCalledCount = 0
  129. var adaptedCount = 0
  130. var retryCalledCount = 0
  131. var retryCount = 0
  132. var retryErrors: [Error] = []
  133. func adapt(_ urlRequest: URLRequest,
  134. using state: RequestAdapterState,
  135. completion: @escaping (Result<URLRequest, Error>) -> Void) {
  136. adaptCalledCount += 1
  137. let result: Result<URLRequest, Error> = Result {
  138. adaptedCount += 1
  139. if adaptedCount == 1 { throw AFError.invalidURL(url: "") }
  140. return urlRequest
  141. }
  142. completion(result)
  143. }
  144. func retry(_ request: Request,
  145. for session: Session,
  146. dueTo error: Error,
  147. completion: @escaping (RetryResult) -> Void) {
  148. retryCalledCount += 1
  149. retryCount += 1
  150. retryErrors.append(error)
  151. completion(.retry)
  152. }
  153. }
  154. // MARK: Tests - Initialization
  155. func testInitializerWithDefaultArguments() {
  156. // Given, When
  157. let session = Session()
  158. // Then
  159. XCTAssertNotNil(session.session.delegate, "session delegate should not be nil")
  160. XCTAssertTrue(session.delegate === session.session.delegate, "manager delegate should equal session delegate")
  161. XCTAssertNil(session.serverTrustManager, "session server trust policy manager should be nil")
  162. }
  163. func testInitializerWithSpecifiedArguments() {
  164. // Given
  165. let configuration = URLSessionConfiguration.default
  166. let delegate = SessionDelegate()
  167. let serverTrustManager = ServerTrustManager(evaluators: [:])
  168. // When
  169. let session = Session(configuration: configuration,
  170. delegate: delegate,
  171. serverTrustManager: serverTrustManager)
  172. // Then
  173. XCTAssertNotNil(session.session.delegate, "session delegate should not be nil")
  174. XCTAssertTrue(session.delegate === session.session.delegate, "manager delegate should equal session delegate")
  175. XCTAssertNotNil(session.serverTrustManager, "session server trust policy manager should not be nil")
  176. }
  177. func testThatSessionInitializerSucceedsWithDefaultArguments() {
  178. // Given
  179. let delegate = SessionDelegate()
  180. let underlyingQueue = DispatchQueue(label: "underlyingQueue")
  181. let urlSession: URLSession = {
  182. let configuration = URLSessionConfiguration.default
  183. let queue = OperationQueue(underlyingQueue: underlyingQueue, name: "delegateQueue")
  184. return URLSession(configuration: configuration, delegate: delegate, delegateQueue: queue)
  185. }()
  186. // When
  187. let session = Session(session: urlSession, delegate: delegate, rootQueue: underlyingQueue)
  188. // Then
  189. XCTAssertTrue(session.delegate === session.session.delegate, "manager delegate should equal session delegate")
  190. XCTAssertNil(session.serverTrustManager, "session server trust policy manager should be nil")
  191. }
  192. func testThatSessionInitializerSucceedsWithSpecifiedArguments() {
  193. // Given
  194. let delegate = SessionDelegate()
  195. let underlyingQueue = DispatchQueue(label: "underlyingQueue")
  196. let urlSession: URLSession = {
  197. let configuration = URLSessionConfiguration.default
  198. let queue = OperationQueue(underlyingQueue: underlyingQueue, name: "delegateQueue")
  199. return URLSession(configuration: configuration, delegate: delegate, delegateQueue: queue)
  200. }()
  201. let serverTrustManager = ServerTrustManager(evaluators: [:])
  202. // When
  203. let session = Session(session: urlSession,
  204. delegate: delegate,
  205. rootQueue: underlyingQueue,
  206. serverTrustManager: serverTrustManager)
  207. // Then
  208. XCTAssertTrue(session.delegate === session.session.delegate, "manager delegate should equal session delegate")
  209. XCTAssertNotNil(session.serverTrustManager, "session server trust policy manager should not be nil")
  210. }
  211. // MARK: Tests - Parallel Root Queue
  212. func testThatSessionWorksCorrectlyWhenPassedAConcurrentRootQueue() {
  213. // Given
  214. let queue = DispatchQueue(label: "ohNoAParallelQueue", attributes: .concurrent)
  215. let session = Session(rootQueue: queue)
  216. let didFinish = expectation(description: "request did finish")
  217. var receivedResponse: TestResponse?
  218. // When
  219. session.request(.get).responseDecodable(of: TestResponse.self) { response in
  220. receivedResponse = response.value
  221. didFinish.fulfill()
  222. }
  223. waitForExpectations(timeout: timeout)
  224. // Then
  225. XCTAssertNotNil(receivedResponse, "Should receive TestResponse.")
  226. }
  227. // MARK: Tests - Default HTTP Headers
  228. func testDefaultUserAgentHeader() {
  229. // Given, When
  230. let userAgent = HTTPHeaders.default["User-Agent"]
  231. // Then
  232. let osNameVersion: String = {
  233. let version = ProcessInfo.processInfo.operatingSystemVersion
  234. let versionString = "\(version.majorVersion).\(version.minorVersion).\(version.patchVersion)"
  235. let osName: String = {
  236. #if os(iOS)
  237. #if targetEnvironment(macCatalyst)
  238. return "macOS(Catalyst)"
  239. #else
  240. return "iOS"
  241. #endif
  242. #elseif os(watchOS)
  243. return "watchOS"
  244. #elseif os(tvOS)
  245. return "tvOS"
  246. #elseif os(macOS)
  247. return "macOS"
  248. #elseif os(Linux)
  249. return "Linux"
  250. #else
  251. return "Unknown"
  252. #endif
  253. }()
  254. return "\(osName) \(versionString)"
  255. }()
  256. let alamofireVersion = "Alamofire/\(Alamofire.version)"
  257. XCTAssertTrue(userAgent?.contains(alamofireVersion) == true)
  258. XCTAssertTrue(userAgent?.contains(osNameVersion) == true)
  259. XCTAssertTrue(userAgent?.contains("xctest/") == true)
  260. }
  261. // MARK: Tests - Supported Accept-Encodings
  262. func testDefaultAcceptEncodingSupportsAppropriateEncodingsOnAppropriateSystems() {
  263. // Given
  264. let brotliExpectation = expectation(description: "brotli request should complete")
  265. let gzipExpectation = expectation(description: "gzip request should complete")
  266. let deflateExpectation = expectation(description: "deflate request should complete")
  267. var brotliResponse: DataResponse<TestResponse, AFError>?
  268. var gzipResponse: DataResponse<TestResponse, AFError>?
  269. var deflateResponse: DataResponse<TestResponse, AFError>?
  270. // When
  271. AF.request(.compression(.brotli)).responseDecodable(of: TestResponse.self) { response in
  272. brotliResponse = response
  273. brotliExpectation.fulfill()
  274. }
  275. AF.request(.compression(.gzip)).responseDecodable(of: TestResponse.self) { response in
  276. gzipResponse = response
  277. gzipExpectation.fulfill()
  278. }
  279. AF.request(.compression(.deflate)).responseDecodable(of: TestResponse.self) { response in
  280. deflateResponse = response
  281. deflateExpectation.fulfill()
  282. }
  283. waitForExpectations(timeout: timeout)
  284. // Then
  285. if #available(iOS 11.0, macOS 10.13, tvOS 11.0, watchOS 4.0, *) {
  286. XCTAssertTrue(brotliResponse?.result.isSuccess == true)
  287. } else {
  288. XCTAssertTrue(brotliResponse?.result.isFailure == true)
  289. }
  290. XCTAssertTrue(gzipResponse?.result.isSuccess == true)
  291. XCTAssertTrue(deflateResponse?.result.isSuccess == true)
  292. }
  293. // MARK: Tests - Start Requests Immediately
  294. func testSetStartRequestsImmediatelyToFalseAndResumeRequest() {
  295. // Given
  296. let session = Session(startRequestsImmediately: false)
  297. let url = Endpoint().url
  298. let urlRequest = URLRequest(url: url)
  299. let expectation = self.expectation(description: "\(url)")
  300. var response: HTTPURLResponse?
  301. // When
  302. session.request(urlRequest)
  303. .response { resp in
  304. response = resp.response
  305. expectation.fulfill()
  306. }
  307. .resume()
  308. waitForExpectations(timeout: timeout)
  309. // Then
  310. XCTAssertNotNil(response, "response should not be nil")
  311. XCTAssertTrue(response?.statusCode == 200, "response status code should be 200")
  312. }
  313. func testSetStartRequestsImmediatelyToFalseAndCancelledCallsResponseHandlers() {
  314. // Given
  315. let session = Session(startRequestsImmediately: false)
  316. let url = Endpoint().url
  317. let urlRequest = URLRequest(url: url)
  318. let expectation = self.expectation(description: "\(url)")
  319. var response: DataResponse<Data?, AFError>?
  320. // When
  321. let request = session.request(urlRequest)
  322. .cancel()
  323. .response { resp in
  324. response = resp
  325. expectation.fulfill()
  326. }
  327. waitForExpectations(timeout: timeout)
  328. // Then
  329. XCTAssertNotNil(response, "response should not be nil")
  330. XCTAssertTrue(request.isCancelled)
  331. XCTAssertTrue((request.task == nil) || (request.task?.state == .canceling || request.task?.state == .completed))
  332. XCTAssertEqual(request.error?.isExplicitlyCancelledError, true)
  333. }
  334. func testSetStartRequestsImmediatelyToFalseAndResumeThenCancelRequestHasCorrectOutput() {
  335. // Given
  336. let session = Session(startRequestsImmediately: false)
  337. let url = Endpoint().url
  338. let urlRequest = URLRequest(url: url)
  339. let expectation = self.expectation(description: "\(url)")
  340. var response: DataResponse<Data?, AFError>?
  341. // When
  342. let request = session.request(urlRequest)
  343. .response { resp in
  344. response = resp
  345. expectation.fulfill()
  346. }
  347. .resume()
  348. .cancel()
  349. waitForExpectations(timeout: timeout)
  350. // Then
  351. XCTAssertNotNil(response, "response should not be nil")
  352. XCTAssertTrue(request.isCancelled)
  353. XCTAssertTrue((request.task == nil) || (request.task?.state == .canceling || request.task?.state == .completed))
  354. XCTAssertEqual(request.error?.isExplicitlyCancelledError, true)
  355. }
  356. func testSetStartRequestsImmediatelyToFalseAndCancelThenResumeRequestDoesntCreateTaskAndStaysCancelled() {
  357. // Given
  358. let session = Session(startRequestsImmediately: false)
  359. let url = Endpoint().url
  360. let urlRequest = URLRequest(url: url)
  361. let expectation = self.expectation(description: "\(url)")
  362. var response: DataResponse<Data?, AFError>?
  363. // When
  364. let request = session.request(urlRequest)
  365. .response { resp in
  366. response = resp
  367. expectation.fulfill()
  368. }
  369. .cancel()
  370. .resume()
  371. waitForExpectations(timeout: timeout)
  372. // Then
  373. XCTAssertNotNil(response, "response should not be nil")
  374. XCTAssertTrue(request.isCancelled)
  375. XCTAssertTrue((request.task == nil) || (request.task?.state == .canceling || request.task?.state == .completed))
  376. XCTAssertEqual(request.error?.isExplicitlyCancelledError, true)
  377. }
  378. // MARK: Tests - Deinitialization
  379. func testReleasingManagerWithPendingRequestDeinitializesSuccessfully() {
  380. // Given
  381. let monitor = ClosureEventMonitor()
  382. let expectation = self.expectation(description: "Request created")
  383. monitor.requestDidCreateTask = { _, _ in expectation.fulfill() }
  384. var session: Session? = Session(startRequestsImmediately: false, eventMonitors: [monitor])
  385. // When
  386. let request = session?.request(.default)
  387. session = nil
  388. waitForExpectations(timeout: timeout)
  389. // Then
  390. XCTAssertEqual(request?.task?.state, .suspended)
  391. XCTAssertNil(session, "manager should be nil")
  392. }
  393. func testReleasingManagerWithPendingCanceledRequestDeinitializesSuccessfully() {
  394. // Given
  395. var session: Session? = Session(startRequestsImmediately: false)
  396. // When
  397. let request = session?.request(.default)
  398. request?.cancel()
  399. session = nil
  400. let state = request?.state
  401. // Then
  402. XCTAssertTrue(state == .cancelled, "state should be .cancelled")
  403. XCTAssertNil(session, "manager should be nil")
  404. }
  405. // MARK: Tests - Bad Requests
  406. func testThatDataRequestWithInvalidURLStringThrowsResponseHandlerError() {
  407. // Given
  408. let session = Session()
  409. let url = Endpoint().url.absoluteString.appending("/äëïöü")
  410. let expectation = self.expectation(description: "Request should fail with error")
  411. var response: DataResponse<Data?, AFError>?
  412. // When
  413. session.request(url).response { resp in
  414. response = resp
  415. expectation.fulfill()
  416. }
  417. waitForExpectations(timeout: timeout)
  418. // Then
  419. XCTAssertNil(response?.request)
  420. XCTAssertNil(response?.response)
  421. XCTAssertNil(response?.data)
  422. XCTAssertNotNil(response?.error)
  423. XCTAssertEqual(response?.error?.isInvalidURLError, true)
  424. XCTAssertEqual(response?.error?.urlConvertible as? String, url)
  425. }
  426. func testThatDownloadRequestWithInvalidURLStringThrowsResponseHandlerError() {
  427. // Given
  428. let session = Session()
  429. let url = Endpoint().url.absoluteString.appending("/äëïöü")
  430. let expectation = self.expectation(description: "Download should fail with error")
  431. var response: DownloadResponse<URL?, AFError>?
  432. // When
  433. session.download(url).response { resp in
  434. response = resp
  435. expectation.fulfill()
  436. }
  437. waitForExpectations(timeout: timeout)
  438. // Then
  439. XCTAssertNil(response?.request)
  440. XCTAssertNil(response?.response)
  441. XCTAssertNil(response?.fileURL)
  442. XCTAssertNil(response?.resumeData)
  443. XCTAssertNotNil(response?.error)
  444. XCTAssertEqual(response?.error?.isInvalidURLError, true)
  445. XCTAssertEqual(response?.error?.urlConvertible as? String, url)
  446. }
  447. func testThatUploadDataRequestWithInvalidURLStringThrowsResponseHandlerError() {
  448. // Given
  449. let session = Session()
  450. let url = Endpoint().url.absoluteString.appending("/äëïöü")
  451. let expectation = self.expectation(description: "Upload should fail with error")
  452. var response: DataResponse<Data?, AFError>?
  453. // When
  454. session.upload(Data(), to: url).response { resp in
  455. response = resp
  456. expectation.fulfill()
  457. }
  458. waitForExpectations(timeout: timeout)
  459. // Then
  460. XCTAssertNil(response?.request)
  461. XCTAssertNil(response?.response)
  462. XCTAssertNil(response?.data)
  463. XCTAssertNotNil(response?.error)
  464. XCTAssertEqual(response?.error?.isInvalidURLError, true)
  465. XCTAssertEqual(response?.error?.urlConvertible as? String, url)
  466. }
  467. func testThatUploadFileRequestWithInvalidURLStringThrowsResponseHandlerError() {
  468. // Given
  469. let session = Session()
  470. let url = Endpoint().url.absoluteString.appending("/äëïöü")
  471. let expectation = self.expectation(description: "Upload should fail with error")
  472. var response: DataResponse<Data?, AFError>?
  473. // When
  474. session.upload(URL(fileURLWithPath: "/invalid"), to: url).response { resp in
  475. response = resp
  476. expectation.fulfill()
  477. }
  478. waitForExpectations(timeout: timeout)
  479. // Then
  480. XCTAssertNil(response?.request)
  481. XCTAssertNil(response?.response)
  482. XCTAssertNil(response?.data)
  483. XCTAssertNotNil(response?.error)
  484. XCTAssertEqual(response?.error?.isInvalidURLError, true)
  485. XCTAssertEqual(response?.error?.urlConvertible as? String, url)
  486. }
  487. func testThatUploadStreamRequestWithInvalidURLStringThrowsResponseHandlerError() {
  488. // Given
  489. let session = Session()
  490. let url = Endpoint().url.absoluteString.appending("/äëïöü")
  491. let expectation = self.expectation(description: "Upload should fail with error")
  492. var response: DataResponse<Data?, AFError>?
  493. // When
  494. session.upload(InputStream(data: Data()), to: url).response { resp in
  495. response = resp
  496. expectation.fulfill()
  497. }
  498. waitForExpectations(timeout: timeout)
  499. // Then
  500. XCTAssertNil(response?.request)
  501. XCTAssertNil(response?.response)
  502. XCTAssertNil(response?.data)
  503. XCTAssertNotNil(response?.error)
  504. XCTAssertEqual(response?.error?.isInvalidURLError, true)
  505. XCTAssertEqual(response?.error?.urlConvertible as? String, url)
  506. }
  507. // MARK: Tests - Request Adapter
  508. func testThatSessionCallsRequestAdaptersWhenCreatingDataRequest() {
  509. // Given
  510. let endpoint = Endpoint()
  511. let methodAdapter = HTTPMethodAdapter(method: .post)
  512. let headerAdapter = HeaderAdapter()
  513. let monitor = ClosureEventMonitor()
  514. let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
  515. // When
  516. let expectation1 = expectation(description: "Request 1 created")
  517. monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
  518. let request1 = session.request(endpoint)
  519. waitForExpectations(timeout: timeout)
  520. let expectation2 = expectation(description: "Request 2 created")
  521. monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
  522. let request2 = session.request(endpoint, interceptor: headerAdapter)
  523. waitForExpectations(timeout: timeout)
  524. // Then
  525. XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
  526. XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
  527. XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
  528. XCTAssertEqual(methodAdapter.adaptedCount, 2)
  529. XCTAssertEqual(headerAdapter.adaptedCount, 1)
  530. }
  531. func testThatSessionCallsRequestAdaptersWhenCreatingDownloadRequest() {
  532. // Given
  533. let endpoint = Endpoint()
  534. let methodAdapter = HTTPMethodAdapter(method: .post)
  535. let headerAdapter = HeaderAdapter()
  536. let monitor = ClosureEventMonitor()
  537. let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
  538. // When
  539. let expectation1 = expectation(description: "Request 1 created")
  540. monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
  541. let request1 = session.download(endpoint)
  542. waitForExpectations(timeout: timeout)
  543. let expectation2 = expectation(description: "Request 2 created")
  544. monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
  545. let request2 = session.download(endpoint, interceptor: headerAdapter)
  546. waitForExpectations(timeout: timeout)
  547. // Then
  548. XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
  549. XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
  550. XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
  551. XCTAssertEqual(methodAdapter.adaptedCount, 2)
  552. XCTAssertEqual(headerAdapter.adaptedCount, 1)
  553. }
  554. func testThatSessionCallsRequestAdaptersWhenCreatingUploadRequestWithData() {
  555. // Given
  556. let data = Data("data".utf8)
  557. let endpoint = Endpoint.method(.post)
  558. let methodAdapter = HTTPMethodAdapter(method: .get)
  559. let headerAdapter = HeaderAdapter()
  560. let monitor = ClosureEventMonitor()
  561. let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
  562. // When
  563. let expectation1 = expectation(description: "Request 1 created")
  564. monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
  565. let request1 = session.upload(data, to: endpoint)
  566. waitForExpectations(timeout: timeout)
  567. let expectation2 = expectation(description: "Request 2 created")
  568. monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
  569. let request2 = session.upload(data, to: endpoint, interceptor: headerAdapter)
  570. waitForExpectations(timeout: timeout)
  571. // Then
  572. XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
  573. XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
  574. XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
  575. XCTAssertEqual(methodAdapter.adaptedCount, 2)
  576. XCTAssertEqual(headerAdapter.adaptedCount, 1)
  577. }
  578. func testThatSessionCallsRequestAdaptersWhenCreatingUploadRequestWithFile() {
  579. // Given
  580. let fileURL = URL(fileURLWithPath: "/path/to/some/file.txt")
  581. let endpoint = Endpoint.method(.post)
  582. let methodAdapter = HTTPMethodAdapter(method: .get)
  583. let headerAdapter = HeaderAdapter()
  584. let monitor = ClosureEventMonitor()
  585. let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
  586. // When
  587. let expectation1 = expectation(description: "Request 1 created")
  588. monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
  589. let request1 = session.upload(fileURL, to: endpoint)
  590. waitForExpectations(timeout: timeout)
  591. let expectation2 = expectation(description: "Request 2 created")
  592. monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
  593. let request2 = session.upload(fileURL, to: endpoint, interceptor: headerAdapter)
  594. waitForExpectations(timeout: timeout)
  595. // Then
  596. XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
  597. XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
  598. XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
  599. XCTAssertEqual(methodAdapter.adaptedCount, 2)
  600. XCTAssertEqual(headerAdapter.adaptedCount, 1)
  601. }
  602. func testThatSessionCallsRequestAdaptersWhenCreatingUploadRequestWithInputStream() {
  603. // Given
  604. let inputStream = InputStream(data: Data("data".utf8))
  605. let endpoint = Endpoint.method(.post)
  606. let methodAdapter = HTTPMethodAdapter(method: .get)
  607. let headerAdapter = HeaderAdapter()
  608. let monitor = ClosureEventMonitor()
  609. let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
  610. // When
  611. let expectation1 = expectation(description: "Request 1 created")
  612. monitor.requestDidCreateTask = { _, _ in expectation1.fulfill() }
  613. let request1 = session.upload(inputStream, to: endpoint)
  614. waitForExpectations(timeout: timeout)
  615. let expectation2 = expectation(description: "Request 2 created")
  616. monitor.requestDidCreateTask = { _, _ in expectation2.fulfill() }
  617. let request2 = session.upload(inputStream, to: endpoint, interceptor: headerAdapter)
  618. waitForExpectations(timeout: timeout)
  619. // Then
  620. XCTAssertEqual(request1.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
  621. XCTAssertEqual(request2.task?.originalRequest?.httpMethod, methodAdapter.method.rawValue)
  622. XCTAssertEqual(request2.task?.originalRequest?.allHTTPHeaderFields?.count, 1)
  623. XCTAssertEqual(methodAdapter.adaptedCount, 2)
  624. XCTAssertEqual(headerAdapter.adaptedCount, 1)
  625. }
  626. func testThatSessionReturnsRequestAdaptationErrorWhenRequestAdapterThrowsError() {
  627. // Given
  628. let endpoint = Endpoint()
  629. let methodAdapter = HTTPMethodAdapter(method: .post, throwsError: true)
  630. let headerAdapter = HeaderAdapter(throwsError: true)
  631. let monitor = ClosureEventMonitor()
  632. let session = Session(startRequestsImmediately: false, interceptor: methodAdapter, eventMonitors: [monitor])
  633. // When
  634. let expectation1 = expectation(description: "Request 1 created")
  635. monitor.requestDidFailToAdaptURLRequestWithError = { _, _, _ in expectation1.fulfill() }
  636. let request1 = session.request(endpoint)
  637. waitForExpectations(timeout: timeout)
  638. let expectation2 = expectation(description: "Request 2 created")
  639. monitor.requestDidFailToAdaptURLRequestWithError = { _, _, _ in expectation2.fulfill() }
  640. let request2 = session.request(endpoint, interceptor: headerAdapter)
  641. waitForExpectations(timeout: timeout)
  642. let requests = [request1, request2]
  643. // Then
  644. for request in requests {
  645. XCTAssertEqual(request.error?.isRequestAdaptationError, true)
  646. XCTAssertEqual(request.error?.underlyingError?.asAFError?.urlConvertible as? String, "")
  647. }
  648. }
  649. // MARK: Tests - Request Retrier
  650. func testThatSessionCallsRequestRetrierWhenRequestInitiallyEncountersAdaptError() {
  651. // Given
  652. let handler = RequestHandler()
  653. handler.adaptedCount = 1
  654. handler.throwsErrorOnSecondAdapt = true
  655. handler.shouldApplyAuthorizationHeader = true
  656. let session = Session()
  657. let expectation = self.expectation(description: "request should eventually fail")
  658. var response: DataResponse<TestResponse, AFError>?
  659. // When
  660. session.request(.basicAuth(), interceptor: handler)
  661. .validate()
  662. .responseDecodable(of: TestResponse.self) { jsonResponse in
  663. response = jsonResponse
  664. expectation.fulfill()
  665. }
  666. waitForExpectations(timeout: timeout)
  667. // Then
  668. XCTAssertEqual(handler.adaptCalledCount, 2)
  669. XCTAssertEqual(handler.adaptedCount, 2)
  670. XCTAssertEqual(handler.retryCalledCount, 1)
  671. XCTAssertEqual(handler.retryCount, 1)
  672. XCTAssertEqual(response?.result.isSuccess, true)
  673. assert(on: session.rootQueue) {
  674. XCTAssertTrue(session.requestTaskMap.isEmpty)
  675. XCTAssertTrue(session.activeRequests.isEmpty)
  676. }
  677. }
  678. func testThatSessionCallsRequestRetrierWhenDownloadInitiallyEncountersAdaptError() {
  679. // Given
  680. let handler = RequestHandler()
  681. handler.adaptedCount = 1
  682. handler.throwsErrorOnSecondAdapt = true
  683. handler.shouldApplyAuthorizationHeader = true
  684. let session = Session()
  685. let expectation = self.expectation(description: "request should eventually fail")
  686. var response: DownloadResponse<TestResponse, AFError>?
  687. let destination: DownloadRequest.Destination = { _, _ in
  688. let fileURL = self.testDirectoryURL.appendingPathComponent("test-output.json")
  689. return (fileURL, [.removePreviousFile])
  690. }
  691. // When
  692. session.download(.basicAuth(), interceptor: handler, to: destination)
  693. .validate()
  694. .responseDecodable(of: TestResponse.self) { jsonResponse in
  695. response = jsonResponse
  696. expectation.fulfill()
  697. }
  698. waitForExpectations(timeout: timeout)
  699. // Then
  700. XCTAssertEqual(handler.adaptCalledCount, 2)
  701. XCTAssertEqual(handler.adaptedCount, 2)
  702. XCTAssertEqual(handler.retryCalledCount, 1)
  703. XCTAssertEqual(handler.retryCount, 1)
  704. XCTAssertEqual(response?.result.isSuccess, true)
  705. assert(on: session.rootQueue) {
  706. XCTAssertTrue(session.requestTaskMap.isEmpty)
  707. XCTAssertTrue(session.activeRequests.isEmpty)
  708. }
  709. }
  710. func testThatSessionCallsRequestRetrierWhenUploadInitiallyEncountersAdaptError() {
  711. // Given
  712. let handler = UploadHandler()
  713. let session = Session(interceptor: handler)
  714. let expectation = self.expectation(description: "request should eventually fail")
  715. var response: DataResponse<TestResponse, AFError>?
  716. let uploadData = Data("upload data".utf8)
  717. // When
  718. session.upload(uploadData, to: .method(.post))
  719. .validate()
  720. .responseDecodable(of: TestResponse.self) { jsonResponse in
  721. response = jsonResponse
  722. expectation.fulfill()
  723. }
  724. waitForExpectations(timeout: timeout)
  725. // Then
  726. XCTAssertEqual(handler.adaptCalledCount, 2)
  727. XCTAssertEqual(handler.adaptedCount, 2)
  728. XCTAssertEqual(handler.retryCalledCount, 1)
  729. XCTAssertEqual(handler.retryCount, 1)
  730. XCTAssertEqual(response?.result.isSuccess, true)
  731. assert(on: session.rootQueue) {
  732. XCTAssertTrue(session.requestTaskMap.isEmpty)
  733. XCTAssertTrue(session.activeRequests.isEmpty)
  734. }
  735. }
  736. func testThatSessionCallsRequestRetrierWhenRequestEncountersError() {
  737. // Given
  738. let handler = RequestHandler()
  739. let session = Session()
  740. let expectation = self.expectation(description: "request should eventually fail")
  741. var response: DataResponse<TestResponse, AFError>?
  742. // When
  743. let request = session.request(.basicAuth(), interceptor: handler)
  744. .validate()
  745. .responseDecodable(of: TestResponse.self) { jsonResponse in
  746. response = jsonResponse
  747. expectation.fulfill()
  748. }
  749. waitForExpectations(timeout: timeout)
  750. // Then
  751. XCTAssertEqual(handler.adaptCalledCount, 2)
  752. XCTAssertEqual(handler.adaptedCount, 2)
  753. XCTAssertEqual(handler.retryCalledCount, 3)
  754. XCTAssertEqual(handler.retryCount, 3)
  755. XCTAssertEqual(request.retryCount, 1)
  756. XCTAssertEqual(response?.result.isSuccess, false)
  757. assert(on: session.rootQueue) {
  758. XCTAssertTrue(session.requestTaskMap.isEmpty)
  759. XCTAssertTrue(session.activeRequests.isEmpty)
  760. }
  761. }
  762. func testThatSessionCallsRequestRetrierThenSessionRetrierWhenRequestEncountersError() {
  763. // Given
  764. let sessionHandler = RequestHandler()
  765. let requestHandler = RequestHandler()
  766. let session = Session(interceptor: sessionHandler)
  767. let expectation = self.expectation(description: "request should eventually fail")
  768. var response: DataResponse<TestResponse, AFError>?
  769. // When
  770. let request = session.request(.basicAuth(), interceptor: requestHandler)
  771. .validate()
  772. .responseDecodable(of: TestResponse.self) { jsonResponse in
  773. response = jsonResponse
  774. expectation.fulfill()
  775. }
  776. waitForExpectations(timeout: timeout)
  777. // Then
  778. XCTAssertEqual(sessionHandler.adaptCalledCount, 3)
  779. XCTAssertEqual(sessionHandler.adaptedCount, 3)
  780. XCTAssertEqual(sessionHandler.retryCalledCount, 3)
  781. XCTAssertEqual(sessionHandler.retryCount, 3)
  782. XCTAssertEqual(requestHandler.adaptCalledCount, 3)
  783. XCTAssertEqual(requestHandler.adaptedCount, 3)
  784. XCTAssertEqual(requestHandler.retryCalledCount, 4)
  785. XCTAssertEqual(requestHandler.retryCount, 4)
  786. XCTAssertEqual(request.retryCount, 2)
  787. XCTAssertEqual(response?.result.isSuccess, false)
  788. assert(on: session.rootQueue) {
  789. XCTAssertTrue(session.requestTaskMap.isEmpty)
  790. XCTAssertTrue(session.activeRequests.isEmpty)
  791. }
  792. }
  793. func testThatSessionCallsAdapterWhenRequestIsRetried() {
  794. // Given
  795. let handler = RequestHandler()
  796. handler.shouldApplyAuthorizationHeader = true
  797. let session = Session(interceptor: handler)
  798. let expectation = self.expectation(description: "request should eventually succeed")
  799. var response: DataResponse<TestResponse, AFError>?
  800. // When
  801. let request = session.request(.basicAuth())
  802. .validate()
  803. .responseDecodable(of: TestResponse.self) { jsonResponse in
  804. response = jsonResponse
  805. expectation.fulfill()
  806. }
  807. waitForExpectations(timeout: timeout)
  808. // Then
  809. XCTAssertEqual(handler.adaptCalledCount, 2)
  810. XCTAssertEqual(handler.adaptedCount, 2)
  811. XCTAssertEqual(handler.retryCalledCount, 1)
  812. XCTAssertEqual(handler.retryCount, 1)
  813. XCTAssertEqual(request.retryCount, 1)
  814. XCTAssertEqual(response?.result.isSuccess, true)
  815. assert(on: session.rootQueue) {
  816. XCTAssertTrue(session.requestTaskMap.isEmpty)
  817. XCTAssertTrue(session.activeRequests.isEmpty)
  818. }
  819. }
  820. func testThatSessionReturnsRequestAdaptationErrorWhenRequestIsRetried() {
  821. // Given
  822. let handler = RequestHandler()
  823. handler.throwsErrorOnSecondAdapt = true
  824. let session = Session(interceptor: handler)
  825. let expectation = self.expectation(description: "request should eventually fail")
  826. var response: DataResponse<TestResponse, AFError>?
  827. // When
  828. let request = session.request(.basicAuth())
  829. .validate()
  830. .responseDecodable(of: TestResponse.self) { jsonResponse in
  831. response = jsonResponse
  832. expectation.fulfill()
  833. }
  834. waitForExpectations(timeout: timeout)
  835. // Then
  836. XCTAssertEqual(handler.adaptCalledCount, 2)
  837. XCTAssertEqual(handler.adaptedCount, 1)
  838. XCTAssertEqual(handler.retryCalledCount, 3)
  839. XCTAssertEqual(handler.retryCount, 3)
  840. XCTAssertEqual(request.retryCount, 1)
  841. XCTAssertEqual(response?.result.isSuccess, false)
  842. XCTAssertEqual(request.error?.isRequestAdaptationError, true)
  843. XCTAssertEqual(request.error?.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
  844. assert(on: session.rootQueue) {
  845. XCTAssertTrue(session.requestTaskMap.isEmpty)
  846. XCTAssertTrue(session.activeRequests.isEmpty)
  847. }
  848. }
  849. func testThatSessionRetriesRequestWithDelayWhenRetryResultContainsDelay() {
  850. // Given
  851. let handler = RequestHandler()
  852. handler.retryDelay = 0.01
  853. handler.throwsErrorOnSecondAdapt = true
  854. let session = Session(interceptor: handler)
  855. let expectation = self.expectation(description: "request should eventually fail")
  856. var response: DataResponse<TestResponse, AFError>?
  857. // When
  858. let request = session.request(.basicAuth())
  859. .validate()
  860. .responseDecodable(of: TestResponse.self) { jsonResponse in
  861. response = jsonResponse
  862. expectation.fulfill()
  863. }
  864. waitForExpectations(timeout: timeout)
  865. // Then
  866. XCTAssertEqual(handler.adaptCalledCount, 2)
  867. XCTAssertEqual(handler.adaptedCount, 1)
  868. XCTAssertEqual(handler.retryCalledCount, 3)
  869. XCTAssertEqual(handler.retryCount, 3)
  870. XCTAssertEqual(request.retryCount, 1)
  871. XCTAssertEqual(response?.result.isSuccess, false)
  872. XCTAssertEqual(request.error?.isRequestAdaptationError, true)
  873. XCTAssertEqual(request.error?.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
  874. assert(on: session.rootQueue) {
  875. XCTAssertTrue(session.requestTaskMap.isEmpty)
  876. XCTAssertTrue(session.activeRequests.isEmpty)
  877. }
  878. }
  879. func testThatSessionReturnsRequestRetryErrorWhenRequestRetrierThrowsError() {
  880. // Given
  881. let handler = RequestHandler()
  882. handler.throwsErrorOnRetry = true
  883. let session = Session(interceptor: handler)
  884. let expectation = self.expectation(description: "request should eventually fail")
  885. var response: DataResponse<TestResponse, AFError>?
  886. // When
  887. let request = session.request(.basicAuth())
  888. .validate()
  889. .responseDecodable(of: TestResponse.self) { jsonResponse in
  890. response = jsonResponse
  891. expectation.fulfill()
  892. }
  893. waitForExpectations(timeout: timeout)
  894. // Then
  895. XCTAssertEqual(handler.adaptCalledCount, 1)
  896. XCTAssertEqual(handler.adaptedCount, 1)
  897. XCTAssertEqual(handler.retryCalledCount, 2)
  898. XCTAssertEqual(handler.retryCount, 0)
  899. XCTAssertEqual(request.retryCount, 0)
  900. XCTAssertEqual(response?.result.isSuccess, false)
  901. assert(on: session.rootQueue) {
  902. XCTAssertTrue(session.requestTaskMap.isEmpty)
  903. XCTAssertTrue(session.activeRequests.isEmpty)
  904. }
  905. if let error = response?.result.failure {
  906. XCTAssertTrue(error.isRequestRetryError)
  907. XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/invalid/url/2")
  908. } else {
  909. XCTFail("error should not be nil")
  910. }
  911. }
  912. // MARK: Tests - Response Serializer Retry
  913. func testThatSessionCallsRequestRetrierWhenResponseSerializerThrowsError() {
  914. // Given
  915. let handler = RequestHandler()
  916. handler.shouldRetry = false
  917. let session = Session()
  918. let expectation = self.expectation(description: "request should eventually fail")
  919. var response: DataResponse<TestResponse, AFError>?
  920. // When
  921. let request = session.request(.image(.jpeg), interceptor: handler)
  922. .validate()
  923. .responseDecodable(of: TestResponse.self) { jsonResponse in
  924. response = jsonResponse
  925. expectation.fulfill()
  926. }
  927. waitForExpectations(timeout: timeout)
  928. // Then
  929. XCTAssertEqual(handler.adaptCalledCount, 1)
  930. XCTAssertEqual(handler.adaptedCount, 1)
  931. XCTAssertEqual(handler.retryCalledCount, 1)
  932. XCTAssertEqual(handler.retryCount, 0)
  933. XCTAssertEqual(request.retryCount, 0)
  934. XCTAssertEqual(response?.result.isSuccess, false)
  935. XCTAssertEqual(response?.error?.isResponseSerializationError, true)
  936. XCTAssertNotNil(response?.error?.underlyingError as? DecodingError)
  937. assert(on: session.rootQueue) {
  938. XCTAssertTrue(session.requestTaskMap.isEmpty)
  939. XCTAssertTrue(session.activeRequests.isEmpty)
  940. }
  941. }
  942. func testThatSessionCallsRequestRetrierForAllResponseSerializersThatThrowError() throws {
  943. // Given
  944. let handler = RequestHandler()
  945. handler.throwsErrorOnRetry = true
  946. let session = Session()
  947. let json1Expectation = expectation(description: "request should eventually fail")
  948. var json1Response: DataResponse<TestResponse, AFError>?
  949. let json2Expectation = expectation(description: "request should eventually fail")
  950. var json2Response: DataResponse<TestResponse, AFError>?
  951. // When
  952. let request = session.request(.image(.jpeg), interceptor: handler)
  953. .validate()
  954. .responseDecodable(of: TestResponse.self) { response in
  955. json1Response = response
  956. json1Expectation.fulfill()
  957. }
  958. .responseDecodable(of: TestResponse.self) { response in
  959. json2Response = response
  960. json2Expectation.fulfill()
  961. }
  962. waitForExpectations(timeout: timeout)
  963. // Then
  964. XCTAssertEqual(handler.adaptCalledCount, 1)
  965. XCTAssertEqual(handler.adaptedCount, 1)
  966. XCTAssertEqual(handler.retryCalledCount, 2)
  967. XCTAssertEqual(handler.retryCount, 0)
  968. XCTAssertEqual(request.retryCount, 0)
  969. XCTAssertEqual(json1Response?.result.isSuccess, false)
  970. XCTAssertEqual(json2Response?.result.isSuccess, false)
  971. assert(on: session.rootQueue) {
  972. XCTAssertTrue(session.requestTaskMap.isEmpty)
  973. XCTAssertTrue(session.activeRequests.isEmpty)
  974. }
  975. let errors = [json1Response, json2Response].compactMap { $0?.error }
  976. XCTAssertEqual(errors.count, 2)
  977. for (index, error) in errors.enumerated() {
  978. XCTAssertTrue(error.isRequestRetryError)
  979. if case let .requestRetryFailed(retryError, originalError) = error {
  980. XCTAssertEqual(retryError.asAFError?.urlConvertible as? String, "/invalid/url/\(index + 1)")
  981. XCTAssertNotNil(originalError.asAFError?.underlyingError as? DecodingError)
  982. } else {
  983. XCTFail("Error failure reason should be response serialization failure")
  984. }
  985. }
  986. }
  987. func testThatSessionRetriesRequestImmediatelyWhenResponseSerializerRequestsRetry() throws {
  988. // Given
  989. let handler = RequestHandler()
  990. let session = Session()
  991. let json1Expectation = expectation(description: "request should eventually fail")
  992. var json1Response: DataResponse<TestResponse, AFError>?
  993. let json2Expectation = expectation(description: "request should eventually fail")
  994. var json2Response: DataResponse<TestResponse, AFError>?
  995. // When
  996. let request = session.request(.image(.jpeg), interceptor: handler)
  997. .validate()
  998. .responseDecodable(of: TestResponse.self) { response in
  999. json1Response = response
  1000. json1Expectation.fulfill()
  1001. }
  1002. .responseDecodable(of: TestResponse.self) { response in
  1003. json2Response = response
  1004. json2Expectation.fulfill()
  1005. }
  1006. waitForExpectations(timeout: timeout)
  1007. // Then
  1008. XCTAssertEqual(handler.adaptCalledCount, 2)
  1009. XCTAssertEqual(handler.adaptedCount, 2)
  1010. XCTAssertEqual(handler.retryCalledCount, 3)
  1011. XCTAssertEqual(handler.retryCount, 3)
  1012. XCTAssertEqual(request.retryCount, 1)
  1013. XCTAssertEqual(json1Response?.result.isSuccess, false)
  1014. XCTAssertEqual(json2Response?.result.isSuccess, false)
  1015. assert(on: session.rootQueue) {
  1016. XCTAssertTrue(session.requestTaskMap.isEmpty)
  1017. XCTAssertTrue(session.activeRequests.isEmpty)
  1018. }
  1019. let errors = [json1Response, json2Response].compactMap { $0?.error }
  1020. XCTAssertEqual(errors.count, 2)
  1021. for error in errors {
  1022. XCTAssertTrue(error.isResponseSerializationError)
  1023. XCTAssertNotNil(error.underlyingError as? DecodingError)
  1024. }
  1025. }
  1026. func testThatSessionCallsResponseSerializerCompletionsWhenAdapterThrowsErrorDuringRetry() {
  1027. // Four retries should occur given this scenario:
  1028. // 1) Retrier is called from first response serializer failure (trips retry)
  1029. // 2) Retrier is called by Session for adapt error thrown
  1030. // 3) Retrier is called again from first response serializer failure
  1031. // 4) Retrier is called from second response serializer failure
  1032. // Given
  1033. let handler = RequestHandler()
  1034. handler.throwsErrorOnSecondAdapt = true
  1035. let session = Session()
  1036. let json1Expectation = expectation(description: "request should eventually fail")
  1037. var json1Response: DataResponse<TestResponse, AFError>?
  1038. let json2Expectation = expectation(description: "request should eventually fail")
  1039. var json2Response: DataResponse<TestResponse, AFError>?
  1040. // When
  1041. let request = session.request(.image(.jpeg), interceptor: handler)
  1042. .validate()
  1043. .responseDecodable(of: TestResponse.self) { response in
  1044. json1Response = response
  1045. json1Expectation.fulfill()
  1046. }
  1047. .responseDecodable(of: TestResponse.self) { response in
  1048. json2Response = response
  1049. json2Expectation.fulfill()
  1050. }
  1051. waitForExpectations(timeout: timeout)
  1052. // Then
  1053. XCTAssertEqual(handler.adaptCalledCount, 2)
  1054. XCTAssertEqual(handler.adaptedCount, 1)
  1055. XCTAssertEqual(handler.retryCalledCount, 4)
  1056. XCTAssertEqual(handler.retryCount, 4)
  1057. XCTAssertEqual(request.retryCount, 1)
  1058. XCTAssertEqual(json1Response?.result.isSuccess, false)
  1059. XCTAssertEqual(json2Response?.result.isSuccess, false)
  1060. assert(on: session.rootQueue) {
  1061. XCTAssertTrue(session.requestTaskMap.isEmpty)
  1062. XCTAssertTrue(session.activeRequests.isEmpty)
  1063. }
  1064. let errors = [json1Response, json2Response].compactMap { $0?.error }
  1065. XCTAssertEqual(errors.count, 2)
  1066. for error in errors {
  1067. XCTAssertTrue(error.isRequestAdaptationError)
  1068. XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
  1069. }
  1070. }
  1071. func testThatSessionCallsResponseSerializerCompletionsWhenAdapterThrowsErrorDuringRetryForDownloads() {
  1072. // Four retries should occur given this scenario:
  1073. // 1) Retrier is called from first response serializer failure (trips retry)
  1074. // 2) Retrier is called by Session for adapt error thrown
  1075. // 3) Retrier is called again from first response serializer failure
  1076. // 4) Retrier is called from second response serializer failure
  1077. // Given
  1078. let handler = RequestHandler()
  1079. handler.throwsErrorOnSecondAdapt = true
  1080. let session = Session()
  1081. let json1Expectation = expectation(description: "request should eventually fail")
  1082. var json1Response: DownloadResponse<TestResponse, AFError>?
  1083. let json2Expectation = expectation(description: "request should eventually fail")
  1084. var json2Response: DownloadResponse<TestResponse, AFError>?
  1085. // When
  1086. let request = session.download(.image(.jpeg), interceptor: handler)
  1087. .validate()
  1088. .responseDecodable(of: TestResponse.self) { response in
  1089. json1Response = response
  1090. json1Expectation.fulfill()
  1091. }
  1092. .responseDecodable(of: TestResponse.self) { response in
  1093. json2Response = response
  1094. json2Expectation.fulfill()
  1095. }
  1096. waitForExpectations(timeout: timeout)
  1097. // Then
  1098. XCTAssertEqual(handler.adaptCalledCount, 2)
  1099. XCTAssertEqual(handler.adaptedCount, 1)
  1100. XCTAssertEqual(handler.retryCalledCount, 4)
  1101. XCTAssertEqual(handler.retryCount, 4)
  1102. XCTAssertEqual(request.retryCount, 1)
  1103. XCTAssertEqual(json1Response?.result.isSuccess, false)
  1104. XCTAssertEqual(json2Response?.result.isSuccess, false)
  1105. assert(on: session.rootQueue) {
  1106. XCTAssertTrue(session.requestTaskMap.isEmpty)
  1107. XCTAssertTrue(session.activeRequests.isEmpty)
  1108. }
  1109. let errors = [json1Response, json2Response].compactMap { $0?.error }
  1110. XCTAssertEqual(errors.count, 2)
  1111. for error in errors {
  1112. XCTAssertTrue(error.isRequestAdaptationError)
  1113. XCTAssertEqual(error.underlyingError?.asAFError?.urlConvertible as? String, "/adapt/error/2")
  1114. }
  1115. }
  1116. // MARK: Tests - Session Invalidation
  1117. func testThatSessionIsInvalidatedAndAllRequestsCompleteWhenSessionIsDeinitialized() {
  1118. // Given
  1119. let invalidationExpectation = expectation(description: "sessionDidBecomeInvalidWithError should be called")
  1120. let events = ClosureEventMonitor()
  1121. events.sessionDidBecomeInvalidWithError = { _, _ in
  1122. invalidationExpectation.fulfill()
  1123. }
  1124. var session: Session? = Session(startRequestsImmediately: false, eventMonitors: [events])
  1125. var error: AFError?
  1126. let requestExpectation = expectation(description: "request should complete")
  1127. // When
  1128. session?.request(.default).response { response in
  1129. error = response.error
  1130. requestExpectation.fulfill()
  1131. }
  1132. session = nil
  1133. waitForExpectations(timeout: timeout)
  1134. // Then
  1135. XCTAssertEqual(error?.isSessionDeinitializedError, true)
  1136. }
  1137. // MARK: Tests - Request Cancellation
  1138. func testThatSessionOnlyCallsResponseSerializerCompletionWhenCancellingInsideCompletion() {
  1139. // Given
  1140. let handler = RequestHandler()
  1141. let session = Session()
  1142. let expectation = self.expectation(description: "request should complete")
  1143. var response: DataResponse<TestResponse, AFError>?
  1144. var completionCallCount = 0
  1145. // When
  1146. let request = session.request(.default, interceptor: handler)
  1147. request.validate()
  1148. request.responseDecodable(of: TestResponse.self) { resp in
  1149. request.cancel()
  1150. response = resp
  1151. completionCallCount += 1
  1152. DispatchQueue.main.after(0.01) { expectation.fulfill() }
  1153. }
  1154. waitForExpectations(timeout: timeout)
  1155. // Then
  1156. XCTAssertEqual(handler.adaptCalledCount, 1)
  1157. XCTAssertEqual(handler.adaptedCount, 1)
  1158. XCTAssertEqual(handler.retryCalledCount, 0)
  1159. XCTAssertEqual(handler.retryCount, 0)
  1160. XCTAssertEqual(request.retryCount, 0)
  1161. XCTAssertEqual(response?.result.isSuccess, true)
  1162. XCTAssertEqual(completionCallCount, 1)
  1163. assert(on: session.rootQueue) {
  1164. XCTAssertTrue(session.requestTaskMap.isEmpty)
  1165. XCTAssertTrue(session.activeRequests.isEmpty)
  1166. }
  1167. }
  1168. // MARK: Tests - Request State
  1169. func testThatSessionSetsRequestStateWhenStartRequestsImmediatelyIsTrue() {
  1170. // Given
  1171. let session = Session()
  1172. let expectation = self.expectation(description: "request should complete")
  1173. var response: DataResponse<TestResponse, AFError>?
  1174. // When
  1175. let request = session.request(.default).responseDecodable(of: TestResponse.self) { resp in
  1176. response = resp
  1177. expectation.fulfill()
  1178. }
  1179. waitForExpectations(timeout: timeout)
  1180. // Then
  1181. XCTAssertEqual(request.state, .finished)
  1182. XCTAssertEqual(response?.result.isSuccess, true)
  1183. }
  1184. // MARK: Invalid Requests
  1185. func testThatGETRequestsWithBodyDataAreConsideredInvalid() {
  1186. // Given
  1187. let session = Session()
  1188. var request = Endpoint().urlRequest
  1189. request.httpBody = Data("invalid".utf8)
  1190. let expect = expectation(description: "request should complete")
  1191. var response: DataResponse<TestResponse, AFError>?
  1192. // When
  1193. session.request(request).responseDecodable(of: TestResponse.self) { resp in
  1194. response = resp
  1195. expect.fulfill()
  1196. }
  1197. waitForExpectations(timeout: timeout)
  1198. // Then
  1199. XCTAssertEqual(response?.result.isFailure, true)
  1200. XCTAssertEqual(response?.error?.isBodyDataInGETRequest, true)
  1201. }
  1202. func testThatAdaptedGETRequestsWithBodyDataAreConsideredInvalid() {
  1203. // Given
  1204. struct InvalidAdapter: RequestInterceptor {
  1205. func adapt(_ urlRequest: URLRequest,
  1206. for session: Session,
  1207. completion: @escaping (Result<URLRequest, Error>) -> Void) {
  1208. var request = urlRequest
  1209. request.httpBody = Data("invalid".utf8)
  1210. completion(.success(request))
  1211. }
  1212. }
  1213. let session = Session(interceptor: InvalidAdapter())
  1214. let expect = expectation(description: "request should complete")
  1215. var response: DataResponse<TestResponse, AFError>?
  1216. // When
  1217. session.request(.default).responseDecodable(of: TestResponse.self) { resp in
  1218. response = resp
  1219. expect.fulfill()
  1220. }
  1221. waitForExpectations(timeout: timeout)
  1222. // Then
  1223. XCTAssertEqual(response?.result.isFailure, true)
  1224. XCTAssertEqual(response?.error?.isRequestAdaptationError, true)
  1225. XCTAssertEqual(response?.error?.underlyingError?.asAFError?.isBodyDataInGETRequest, true)
  1226. }
  1227. }
  1228. // MARK: -
  1229. final class SessionMassActionTestCase: BaseTestCase {
  1230. func testThatRequestsCanHaveMassActionsPerformed() {
  1231. // Given
  1232. let count = 10
  1233. let createdTasks = expectation(description: "all tasks created")
  1234. createdTasks.expectedFulfillmentCount = count
  1235. let massActions = expectation(description: "cancel all requests should be called")
  1236. let monitor = ClosureEventMonitor()
  1237. monitor.requestDidCreateTask = { _, _ in createdTasks.fulfill() }
  1238. let session = Session(eventMonitors: [monitor])
  1239. let request = Endpoint.delay(1)
  1240. var requests: [DataRequest] = []
  1241. // When
  1242. requests = (0..<count).map { _ in session.request(request) }
  1243. wait(for: [createdTasks], timeout: timeout)
  1244. session.withAllRequests { $0.forEach { $0.suspend() }; massActions.fulfill() }
  1245. wait(for: [massActions], timeout: timeout)
  1246. // Then
  1247. XCTAssertTrue(requests.allSatisfy(\.isSuspended))
  1248. }
  1249. func testThatAutomaticallyResumedRequestsCanBeMassCancelled() {
  1250. // Given
  1251. let count = 100
  1252. let completion = expectation(description: "all requests should finish")
  1253. completion.expectedFulfillmentCount = count
  1254. let createdTasks = expectation(description: "all tasks created")
  1255. createdTasks.expectedFulfillmentCount = count
  1256. let gatheredMetrics = expectation(description: "metrics gathered for all tasks")
  1257. gatheredMetrics.expectedFulfillmentCount = count
  1258. let cancellation = expectation(description: "cancel all requests should be called")
  1259. let monitor = ClosureEventMonitor()
  1260. monitor.requestDidCreateTask = { _, _ in createdTasks.fulfill() }
  1261. monitor.requestDidGatherMetrics = { _, _ in gatheredMetrics.fulfill() }
  1262. let session = Session(eventMonitors: [monitor])
  1263. let request = Endpoint.delay(1)
  1264. var requests: [DataRequest] = []
  1265. var responses: [DataResponse<Data?, AFError>] = []
  1266. // When
  1267. requests = (0..<count).map { _ in session.request(request) }
  1268. wait(for: [createdTasks], timeout: timeout)
  1269. requests.forEach { request in
  1270. request.response { response in
  1271. responses.append(response)
  1272. completion.fulfill()
  1273. }
  1274. }
  1275. session.cancelAllRequests {
  1276. cancellation.fulfill()
  1277. }
  1278. wait(for: [gatheredMetrics, cancellation, completion], timeout: timeout)
  1279. // Then
  1280. XCTAssertTrue(responses.allSatisfy { $0.error?.isExplicitlyCancelledError == true })
  1281. assert(on: session.rootQueue) {
  1282. XCTAssertTrue(session.requestTaskMap.isEmpty, "requestTaskMap should be empty but has \(session.requestTaskMap.count) items")
  1283. XCTAssertTrue(session.activeRequests.isEmpty, "activeRequests should be empty but has \(session.activeRequests.count) items")
  1284. }
  1285. }
  1286. func testThatManuallyResumedRequestsCanBeMassCancelled() {
  1287. // Given
  1288. let count = 100
  1289. let completion = expectation(description: "all requests should finish")
  1290. completion.expectedFulfillmentCount = count
  1291. let createdTasks = expectation(description: "all tasks created")
  1292. createdTasks.expectedFulfillmentCount = count
  1293. let gatheredMetrics = expectation(description: "metrics gathered for all tasks")
  1294. gatheredMetrics.expectedFulfillmentCount = count
  1295. let cancellation = expectation(description: "cancel all requests should be called")
  1296. let monitor = ClosureEventMonitor()
  1297. monitor.requestDidCreateTask = { _, _ in createdTasks.fulfill() }
  1298. monitor.requestDidGatherMetrics = { _, _ in gatheredMetrics.fulfill() }
  1299. let session = Session(startRequestsImmediately: false, eventMonitors: [monitor])
  1300. let request = Endpoint.delay(1)
  1301. var responses: [DataResponse<Data?, AFError>] = []
  1302. // When
  1303. for _ in 0..<count {
  1304. session.request(request).response { response in
  1305. responses.append(response)
  1306. completion.fulfill()
  1307. }
  1308. }
  1309. wait(for: [createdTasks], timeout: timeout)
  1310. session.cancelAllRequests {
  1311. cancellation.fulfill()
  1312. }
  1313. wait(for: [gatheredMetrics, cancellation, completion], timeout: timeout)
  1314. // Then
  1315. XCTAssertTrue(responses.allSatisfy { $0.error?.isExplicitlyCancelledError == true })
  1316. assert(on: session.rootQueue) {
  1317. XCTAssertTrue(session.requestTaskMap.isEmpty, "requestTaskMap should be empty but has \(session.requestTaskMap.count) items")
  1318. XCTAssertTrue(session.activeRequests.isEmpty, "activeRequests should be empty but has \(session.activeRequests.count) items")
  1319. }
  1320. }
  1321. func testThatRetriedRequestsCanBeMassCancelled() {
  1322. // Given
  1323. final class OnceRetrier: RequestInterceptor {
  1324. private var hasRetried = false
  1325. func adapt(_ urlRequest: URLRequest, for session: Session, completion: @escaping (Result<URLRequest, Error>) -> Void) {
  1326. if hasRetried {
  1327. var request = urlRequest
  1328. request.url = Endpoint.delay(1).url
  1329. completion(.success(request))
  1330. } else {
  1331. completion(.success(urlRequest))
  1332. }
  1333. }
  1334. func retry(_ request: Request, for session: Session, dueTo error: Error, completion: @escaping (RetryResult) -> Void) {
  1335. completion(hasRetried ? .doNotRetry : .retry)
  1336. hasRetried = true
  1337. }
  1338. }
  1339. let queue = DispatchQueue(label: "com.alamofire.testQueue")
  1340. let monitor = ClosureEventMonitor(queue: queue)
  1341. let session = Session(rootQueue: queue, interceptor: OnceRetrier(), eventMonitors: [monitor])
  1342. let request = Endpoint.status(401)
  1343. let completion = expectation(description: "all requests should finish")
  1344. let cancellation = expectation(description: "cancel all requests should be called")
  1345. let createTask = expectation(description: "should create task twice")
  1346. createTask.expectedFulfillmentCount = 2
  1347. var tasksCreated = 0
  1348. monitor.requestDidCreateTask = { [unowned session] _, _ in
  1349. tasksCreated += 1
  1350. createTask.fulfill()
  1351. // Cancel after the second task is created to ensure proper lifetime events.
  1352. if tasksCreated == 2 {
  1353. session.cancelAllRequests {
  1354. cancellation.fulfill()
  1355. }
  1356. }
  1357. }
  1358. var received: DataResponse<Data?, AFError>?
  1359. // When
  1360. session.request(request).validate().response { response in
  1361. received = response
  1362. completion.fulfill()
  1363. }
  1364. waitForExpectations(timeout: timeout)
  1365. // Then
  1366. XCTAssertEqual(received?.error?.isExplicitlyCancelledError, true)
  1367. assert(on: session.rootQueue) {
  1368. XCTAssertTrue(session.requestTaskMap.isEmpty, "requestTaskMap should be empty but has \(session.requestTaskMap.count) items")
  1369. XCTAssertTrue(session.activeRequests.isEmpty, "activeRequests should be empty but has \(session.activeRequests.count) items")
  1370. }
  1371. }
  1372. }
  1373. // MARK: -
  1374. final class SessionConfigurationHeadersTestCase: BaseTestCase {
  1375. enum ConfigurationType {
  1376. case `default`, ephemeral
  1377. }
  1378. func testThatDefaultConfigurationHeadersAreSentWithRequest() {
  1379. // Given, When, Then
  1380. executeAuthorizationHeaderTest(for: .default)
  1381. }
  1382. func testThatEphemeralConfigurationHeadersAreSentWithRequest() {
  1383. // Given, When, Then
  1384. executeAuthorizationHeaderTest(for: .ephemeral)
  1385. }
  1386. private func executeAuthorizationHeaderTest(for type: ConfigurationType) {
  1387. // Given
  1388. let session: Session = {
  1389. let configuration: URLSessionConfiguration = {
  1390. let configuration: URLSessionConfiguration
  1391. switch type {
  1392. case .default:
  1393. configuration = .default
  1394. case .ephemeral:
  1395. configuration = .ephemeral
  1396. }
  1397. var headers = HTTPHeaders.default
  1398. headers["Authorization"] = "Bearer 123456"
  1399. configuration.headers = headers
  1400. return configuration
  1401. }()
  1402. return Session(configuration: configuration)
  1403. }()
  1404. let expectation = self.expectation(description: "request should complete successfully")
  1405. var response: DataResponse<TestResponse, AFError>?
  1406. // When
  1407. session.request(.default)
  1408. .responseDecodable(of: TestResponse.self) { closureResponse in
  1409. response = closureResponse
  1410. expectation.fulfill()
  1411. }
  1412. waitForExpectations(timeout: timeout)
  1413. // Then
  1414. XCTAssertNotNil(response?.request, "request should not be nil")
  1415. XCTAssertNotNil(response?.response, "response should not be nil")
  1416. XCTAssertNotNil(response?.data, "data should not be nil")
  1417. XCTAssertEqual(response?.result.isSuccess, true)
  1418. XCTAssertEqual(response?.value?.headers["Authorization"], "Bearer 123456", "Authorization header should match")
  1419. }
  1420. }