AuthenticationInterceptorTests.swift 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697
  1. //
  2. // AuthenticationInterceptorTests.swift
  3. //
  4. // Copyright (c) 2020 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 AuthenticationInterceptorTestCase: BaseTestCase {
  28. // MARK: - Helper Types
  29. struct TestCredential: AuthenticationCredential {
  30. let accessToken: String
  31. let refreshToken: String
  32. let userID: String
  33. let expiration: Date
  34. let requiresRefresh: Bool
  35. init(accessToken: String = "a0",
  36. refreshToken: String = "r0",
  37. userID: String = "u0",
  38. expiration: Date = Date(),
  39. requiresRefresh: Bool = false) {
  40. self.accessToken = accessToken
  41. self.refreshToken = refreshToken
  42. self.userID = userID
  43. self.expiration = expiration
  44. self.requiresRefresh = requiresRefresh
  45. }
  46. }
  47. enum TestAuthError: Error {
  48. case refreshNetworkFailure
  49. }
  50. final class TestAuthenticator: Authenticator {
  51. private(set) var applyCount = 0
  52. private(set) var refreshCount = 0
  53. private(set) var didRequestFailDueToAuthErrorCount = 0
  54. private(set) var isRequestAuthenticatedWithCredentialCount = 0
  55. let shouldRefreshAsynchronously: Bool
  56. let refreshResult: Result<TestCredential, Error>?
  57. let lock = NSLock()
  58. init(shouldRefreshAsynchronously: Bool = true, refreshResult: Result<TestCredential, Error>? = nil) {
  59. self.shouldRefreshAsynchronously = shouldRefreshAsynchronously
  60. self.refreshResult = refreshResult
  61. }
  62. func apply(_ credential: TestCredential, to urlRequest: inout URLRequest) {
  63. lock.lock(); defer { lock.unlock() }
  64. applyCount += 1
  65. urlRequest.headers.add(.authorization(bearerToken: credential.accessToken))
  66. }
  67. func refresh(_ credential: TestCredential,
  68. for session: Session,
  69. completion: @escaping (Result<TestCredential, Error>) -> Void) {
  70. lock.lock()
  71. refreshCount += 1
  72. let result = refreshResult ?? .success(
  73. TestCredential(accessToken: "a\(refreshCount)",
  74. refreshToken: "a\(refreshCount)",
  75. userID: "u1",
  76. expiration: Date())
  77. )
  78. if shouldRefreshAsynchronously {
  79. // The 10 ms delay here is important to allow multiple requests to queue up while refreshing.
  80. DispatchQueue.global(qos: .utility).asyncAfter(deadline: .now() + 0.01) { completion(result) }
  81. lock.unlock()
  82. } else {
  83. lock.unlock()
  84. completion(result)
  85. }
  86. }
  87. func didRequest(_ urlRequest: URLRequest,
  88. with response: HTTPURLResponse,
  89. failDueToAuthenticationError error: Error)
  90. -> Bool {
  91. lock.lock(); defer { lock.unlock() }
  92. didRequestFailDueToAuthErrorCount += 1
  93. return response.statusCode == 401
  94. }
  95. func isRequest(_ urlRequest: URLRequest, authenticatedWith credential: TestCredential) -> Bool {
  96. lock.lock(); defer { lock.unlock() }
  97. isRequestAuthenticatedWithCredentialCount += 1
  98. let bearerToken = HTTPHeader.authorization(bearerToken: credential.accessToken).value
  99. return urlRequest.headers["Authorization"] == bearerToken
  100. }
  101. }
  102. final class PathAdapter: RequestAdapter {
  103. var paths: [String]
  104. init(paths: [String]) {
  105. self.paths = paths
  106. }
  107. func adapt(_ urlRequest: URLRequest, for session: Session, completion: @escaping (Result<URLRequest, Error>) -> Void) {
  108. var request = urlRequest
  109. var urlComponents = URLComponents(url: request.url!, resolvingAgainstBaseURL: false)!
  110. urlComponents.path = paths.removeFirst()
  111. request.url = urlComponents.url
  112. completion(.success(request))
  113. }
  114. }
  115. // MARK: - Tests - Adapt
  116. func testThatInterceptorCanAdaptURLRequest() {
  117. // Given
  118. let credential = TestCredential()
  119. let authenticator = TestAuthenticator()
  120. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  121. let session = Session()
  122. let expect = expectation(description: "request should complete")
  123. var response: AFDataResponse<Data?>?
  124. // When
  125. let request = session.request(.default, interceptor: interceptor).validate().response {
  126. response = $0
  127. expect.fulfill()
  128. }
  129. waitForExpectations(timeout: timeout)
  130. // Then
  131. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a0")
  132. XCTAssertEqual(response?.result.isSuccess, true)
  133. XCTAssertEqual(authenticator.applyCount, 1)
  134. XCTAssertEqual(authenticator.refreshCount, 0)
  135. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  136. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  137. XCTAssertEqual(request.retryCount, 0)
  138. }
  139. func testThatInterceptorQueuesAdaptOperationWhenRefreshing() {
  140. // Given
  141. let credential = TestCredential(requiresRefresh: true)
  142. let authenticator = TestAuthenticator()
  143. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  144. let session = Session()
  145. let expect = expectation(description: "both requests should complete")
  146. expect.expectedFulfillmentCount = 2
  147. var response1: AFDataResponse<Data?>?
  148. var response2: AFDataResponse<Data?>?
  149. // When
  150. let request1 = session.request(.status(200), interceptor: interceptor).validate().response {
  151. response1 = $0
  152. expect.fulfill()
  153. }
  154. let request2 = session.request(.status(202), interceptor: interceptor).validate().response {
  155. response2 = $0
  156. expect.fulfill()
  157. }
  158. waitForExpectations(timeout: timeout)
  159. // Then
  160. XCTAssertEqual(response1?.request?.headers["Authorization"], "Bearer a1")
  161. XCTAssertEqual(response2?.request?.headers["Authorization"], "Bearer a1")
  162. XCTAssertEqual(response1?.result.isSuccess, true)
  163. XCTAssertEqual(response2?.result.isSuccess, true)
  164. XCTAssertEqual(authenticator.applyCount, 2)
  165. XCTAssertEqual(authenticator.refreshCount, 1)
  166. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  167. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  168. XCTAssertEqual(request1.retryCount, 0)
  169. XCTAssertEqual(request2.retryCount, 0)
  170. }
  171. func testThatInterceptorThrowsMissingCredentialErrorWhenCredentialIsNil() {
  172. // Given
  173. let authenticator = TestAuthenticator()
  174. let interceptor = AuthenticationInterceptor(authenticator: authenticator)
  175. let session = Session()
  176. let expect = expectation(description: "request should complete")
  177. var response: AFDataResponse<Data?>?
  178. // When
  179. let request = session.request(.default, interceptor: interceptor).validate().response {
  180. response = $0
  181. expect.fulfill()
  182. }
  183. waitForExpectations(timeout: timeout)
  184. // Then
  185. XCTAssertEqual(response?.request?.headers.count, 0)
  186. XCTAssertEqual(response?.result.isFailure, true)
  187. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestAdaptationError, true)
  188. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? AuthenticationError, .missingCredential)
  189. XCTAssertEqual(authenticator.applyCount, 0)
  190. XCTAssertEqual(authenticator.refreshCount, 0)
  191. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  192. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  193. XCTAssertEqual(request.retryCount, 0)
  194. }
  195. func testThatInterceptorRethrowsRefreshErrorFromAdapt() {
  196. // Given
  197. let credential = TestCredential(requiresRefresh: true)
  198. let authenticator = TestAuthenticator(refreshResult: .failure(TestAuthError.refreshNetworkFailure))
  199. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  200. let session = Session()
  201. let expect = expectation(description: "request should complete")
  202. var response: AFDataResponse<Data?>?
  203. // When
  204. let request = session.request(.default, interceptor: interceptor).validate().response {
  205. response = $0
  206. expect.fulfill()
  207. }
  208. waitForExpectations(timeout: timeout)
  209. // Then
  210. XCTAssertEqual(response?.request?.headers.count, 0)
  211. XCTAssertEqual(response?.result.isFailure, true)
  212. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestAdaptationError, true)
  213. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? TestAuthError, .refreshNetworkFailure)
  214. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  215. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  216. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  217. }
  218. XCTAssertEqual(authenticator.applyCount, 0)
  219. XCTAssertEqual(authenticator.refreshCount, 1)
  220. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  221. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  222. XCTAssertEqual(request.retryCount, 0)
  223. }
  224. // MARK: - Tests - Retry
  225. #if !(os(Linux) || os(Windows)) // URLRequest to /invalid/path is a fatal error.
  226. func testThatInterceptorDoesNotRetryWithoutResponse() {
  227. // Given
  228. let credential = TestCredential()
  229. let authenticator = TestAuthenticator()
  230. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  231. let urlRequest = URLRequest(url: URL(string: "/invalid/path")!)
  232. let session = Session()
  233. let expect = expectation(description: "request should complete")
  234. var response: AFDataResponse<Data?>?
  235. // When
  236. let request = session.request(urlRequest, interceptor: interceptor).validate().response {
  237. response = $0
  238. expect.fulfill()
  239. }
  240. waitForExpectations(timeout: timeout)
  241. // Then
  242. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a0")
  243. XCTAssertEqual(response?.result.isFailure, true)
  244. XCTAssertEqual(response?.result.failure?.asAFError?.isSessionTaskError, true)
  245. XCTAssertEqual(authenticator.applyCount, 1)
  246. XCTAssertEqual(authenticator.refreshCount, 0)
  247. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  248. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  249. XCTAssertEqual(request.retryCount, 0)
  250. }
  251. #endif
  252. func testThatInterceptorDoesNotRetryWhenRequestDoesNotFailDueToAuthError() {
  253. // Given
  254. let credential = TestCredential()
  255. let authenticator = TestAuthenticator()
  256. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  257. let session = Session()
  258. let expect = expectation(description: "request should complete")
  259. var response: AFDataResponse<Data?>?
  260. // When
  261. let request = session.request(.status(500), interceptor: interceptor).validate().response {
  262. response = $0
  263. expect.fulfill()
  264. }
  265. waitForExpectations(timeout: timeout)
  266. // Then
  267. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a0")
  268. XCTAssertEqual(response?.result.isFailure, true)
  269. XCTAssertEqual(response?.result.failure?.asAFError?.isResponseValidationError, true)
  270. XCTAssertEqual(response?.result.failure?.asAFError?.responseCode, 500)
  271. XCTAssertEqual(authenticator.applyCount, 1)
  272. XCTAssertEqual(authenticator.refreshCount, 0)
  273. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  274. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  275. XCTAssertEqual(request.retryCount, 0)
  276. }
  277. func testThatInterceptorThrowsMissingCredentialErrorWhenCredentialIsNilAndRequestShouldBeRetried() {
  278. // Given
  279. let credential = TestCredential()
  280. let authenticator = TestAuthenticator()
  281. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  282. let eventMonitor = ClosureEventMonitor()
  283. eventMonitor.requestDidCreateTask = { _, _ in interceptor.credential = nil }
  284. let session = Session(eventMonitors: [eventMonitor])
  285. let expect = expectation(description: "request should complete")
  286. var response: AFDataResponse<Data?>?
  287. // When
  288. let request = session.request(.status(401), interceptor: interceptor).validate().response {
  289. response = $0
  290. expect.fulfill()
  291. }
  292. waitForExpectations(timeout: timeout)
  293. // Then
  294. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a0")
  295. XCTAssertEqual(response?.result.isFailure, true)
  296. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestRetryError, true)
  297. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? AuthenticationError, .missingCredential)
  298. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  299. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  300. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  301. }
  302. XCTAssertEqual(authenticator.applyCount, 1)
  303. XCTAssertEqual(authenticator.refreshCount, 0)
  304. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  305. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  306. XCTAssertEqual(request.retryCount, 0)
  307. }
  308. func testThatInterceptorRetriesRequestThatFailedWithOutdatedCredential() {
  309. // Given
  310. let credential = TestCredential()
  311. let authenticator = TestAuthenticator()
  312. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  313. let eventMonitor = ClosureEventMonitor()
  314. eventMonitor.requestDidCreateTask = { _, _ in
  315. interceptor.credential = TestCredential(accessToken: "a1",
  316. refreshToken: "r1",
  317. userID: "u0",
  318. expiration: Date(),
  319. requiresRefresh: false)
  320. }
  321. let session = Session(eventMonitors: [eventMonitor])
  322. let pathAdapter = PathAdapter(paths: ["/status/401", "/status/200"])
  323. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  324. let expect = expectation(description: "request should complete")
  325. var response: AFDataResponse<Data?>?
  326. // When
  327. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  328. response = $0
  329. expect.fulfill()
  330. }
  331. waitForExpectations(timeout: timeout)
  332. // Then
  333. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a1")
  334. XCTAssertEqual(response?.result.isSuccess, true)
  335. XCTAssertEqual(authenticator.applyCount, 2)
  336. XCTAssertEqual(authenticator.refreshCount, 0)
  337. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  338. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 1)
  339. XCTAssertEqual(request.retryCount, 1)
  340. }
  341. // Produces double lock reported in https://github.com/Alamofire/Alamofire/issues/3294#issuecomment-703241558
  342. func testThatInterceptorDoesNotDeadlockWhenAuthenticatorCallsRefreshCompletionSynchronouslyOnCallingQueue() {
  343. // Given
  344. let credential = TestCredential(requiresRefresh: true)
  345. let authenticator = TestAuthenticator(shouldRefreshAsynchronously: false)
  346. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  347. let eventMonitor = ClosureEventMonitor()
  348. eventMonitor.requestDidCreateTask = { _, _ in
  349. interceptor.credential = TestCredential(accessToken: "a1",
  350. refreshToken: "r1",
  351. userID: "u0",
  352. expiration: Date(),
  353. requiresRefresh: false)
  354. }
  355. let session = Session(eventMonitors: [eventMonitor])
  356. let pathAdapter = PathAdapter(paths: ["/status/200"])
  357. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  358. let expect = expectation(description: "request should complete")
  359. var response: AFDataResponse<Data?>?
  360. // When
  361. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  362. response = $0
  363. expect.fulfill()
  364. }
  365. waitForExpectations(timeout: timeout)
  366. // Then
  367. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a1")
  368. XCTAssertEqual(response?.result.isSuccess, true)
  369. XCTAssertEqual(authenticator.applyCount, 1)
  370. XCTAssertEqual(authenticator.refreshCount, 1)
  371. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  372. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  373. XCTAssertEqual(request.retryCount, 0)
  374. }
  375. func testThatInterceptorRetriesRequestAfterRefresh() {
  376. // Given
  377. let credential = TestCredential()
  378. let authenticator = TestAuthenticator()
  379. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  380. let pathAdapter = PathAdapter(paths: ["/status/401", "/status/200"])
  381. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  382. let session = Session()
  383. let expect = expectation(description: "request should complete")
  384. var response: AFDataResponse<Data?>?
  385. // When
  386. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  387. response = $0
  388. expect.fulfill()
  389. }
  390. waitForExpectations(timeout: timeout)
  391. // Then
  392. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a1")
  393. XCTAssertEqual(response?.result.isSuccess, true)
  394. XCTAssertEqual(authenticator.applyCount, 2)
  395. XCTAssertEqual(authenticator.refreshCount, 1)
  396. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  397. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 1)
  398. XCTAssertEqual(request.retryCount, 1)
  399. }
  400. func testThatInterceptorRethrowsRefreshErrorFromRetry() {
  401. // Given
  402. let credential = TestCredential()
  403. let authenticator = TestAuthenticator(refreshResult: .failure(TestAuthError.refreshNetworkFailure))
  404. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  405. let session = Session()
  406. let expect = expectation(description: "request should complete")
  407. var response: AFDataResponse<Data?>?
  408. // When
  409. let request = session.request(.status(401), interceptor: interceptor).validate().response {
  410. response = $0
  411. expect.fulfill()
  412. }
  413. waitForExpectations(timeout: timeout)
  414. // Then
  415. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a0")
  416. XCTAssertEqual(response?.result.isFailure, true)
  417. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestRetryError, true)
  418. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? TestAuthError, .refreshNetworkFailure)
  419. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  420. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  421. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  422. }
  423. XCTAssertEqual(authenticator.applyCount, 1)
  424. XCTAssertEqual(authenticator.refreshCount, 1)
  425. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  426. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 1)
  427. XCTAssertEqual(request.retryCount, 0)
  428. }
  429. func testThatInterceptorTriggersRefreshWithMultipleParallelRequestsReturning401Responses() {
  430. // Given
  431. let credential = TestCredential()
  432. let authenticator = TestAuthenticator()
  433. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  434. let requestCount = 6
  435. let session = Session()
  436. let expect = expectation(description: "both requests should complete")
  437. expect.expectedFulfillmentCount = requestCount
  438. var requests: [Int: Request] = [:]
  439. var responses: [Int: AFDataResponse<Data?>] = [:]
  440. for index in 0..<requestCount {
  441. let pathAdapter = PathAdapter(paths: ["/status/401", "/status/20\(index)"])
  442. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  443. // When
  444. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  445. responses[index] = $0
  446. expect.fulfill()
  447. }
  448. requests[index] = request
  449. }
  450. waitForExpectations(timeout: timeout)
  451. // Then
  452. for index in 0..<requestCount {
  453. let response = responses[index]
  454. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a1")
  455. XCTAssertEqual(response?.result.isSuccess, true)
  456. let request = requests[index]
  457. XCTAssertEqual(request?.retryCount, 1)
  458. }
  459. XCTAssertEqual(authenticator.applyCount, 12)
  460. XCTAssertEqual(authenticator.refreshCount, 1)
  461. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 6)
  462. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 6)
  463. }
  464. // MARK: - Tests - Excessive Refresh
  465. func testThatInterceptorIgnoresExcessiveRefreshWhenRefreshWindowIsNil() {
  466. // Given
  467. let credential = TestCredential()
  468. let authenticator = TestAuthenticator()
  469. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  470. let pathAdapter = PathAdapter(paths: ["/status/401",
  471. "/status/401",
  472. "/status/401",
  473. "/status/401",
  474. "/status/401",
  475. "/status/200"])
  476. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  477. let session = Session()
  478. let expect = expectation(description: "request should complete")
  479. var response: AFDataResponse<Data?>?
  480. // When
  481. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  482. response = $0
  483. expect.fulfill()
  484. }
  485. waitForExpectations(timeout: timeout)
  486. // Then
  487. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a5")
  488. XCTAssertEqual(response?.result.isSuccess, true)
  489. XCTAssertEqual(authenticator.applyCount, 6)
  490. XCTAssertEqual(authenticator.refreshCount, 5)
  491. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 5)
  492. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 5)
  493. XCTAssertEqual(request.retryCount, 5)
  494. }
  495. func testThatInterceptorThrowsExcessiveRefreshErrorWhenExcessiveRefreshOccurs() {
  496. // Given
  497. let credential = TestCredential()
  498. let authenticator = TestAuthenticator()
  499. let interceptor = AuthenticationInterceptor(authenticator: authenticator,
  500. credential: credential,
  501. refreshWindow: .init(interval: 30, maximumAttempts: 2))
  502. let session = Session()
  503. let expect = expectation(description: "request should complete")
  504. var response: AFDataResponse<Data?>?
  505. // When
  506. let request = session.request(.status(401), interceptor: interceptor).validate().response {
  507. response = $0
  508. expect.fulfill()
  509. }
  510. waitForExpectations(timeout: timeout)
  511. // Then
  512. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a2")
  513. XCTAssertEqual(response?.result.isFailure, true)
  514. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestRetryError, true)
  515. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? AuthenticationError, .excessiveRefresh)
  516. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  517. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  518. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  519. }
  520. XCTAssertEqual(authenticator.applyCount, 3)
  521. XCTAssertEqual(authenticator.refreshCount, 2)
  522. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 3)
  523. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 3)
  524. XCTAssertEqual(request.retryCount, 2)
  525. }
  526. }