SessionTests.swift 65 KB

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