AuthenticationInterceptorTests.swift 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695
  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. func testThatInterceptorDoesNotRetryWithoutResponse() {
  226. // Given
  227. let credential = TestCredential()
  228. let authenticator = TestAuthenticator()
  229. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  230. let urlRequest = URLRequest(url: URL(string: "/invalid/path")!)
  231. let session = Session()
  232. let expect = expectation(description: "request should complete")
  233. var response: AFDataResponse<Data?>?
  234. // When
  235. let request = session.request(urlRequest, interceptor: interceptor).validate().response {
  236. response = $0
  237. expect.fulfill()
  238. }
  239. waitForExpectations(timeout: timeout)
  240. // Then
  241. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a0")
  242. XCTAssertEqual(response?.result.isFailure, true)
  243. XCTAssertEqual(response?.result.failure?.asAFError?.isSessionTaskError, true)
  244. XCTAssertEqual(authenticator.applyCount, 1)
  245. XCTAssertEqual(authenticator.refreshCount, 0)
  246. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  247. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  248. XCTAssertEqual(request.retryCount, 0)
  249. }
  250. func testThatInterceptorDoesNotRetryWhenRequestDoesNotFailDueToAuthError() {
  251. // Given
  252. let credential = TestCredential()
  253. let authenticator = TestAuthenticator()
  254. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  255. let session = Session()
  256. let expect = expectation(description: "request should complete")
  257. var response: AFDataResponse<Data?>?
  258. // When
  259. let request = session.request(.status(500), interceptor: interceptor).validate().response {
  260. response = $0
  261. expect.fulfill()
  262. }
  263. waitForExpectations(timeout: timeout)
  264. // Then
  265. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a0")
  266. XCTAssertEqual(response?.result.isFailure, true)
  267. XCTAssertEqual(response?.result.failure?.asAFError?.isResponseValidationError, true)
  268. XCTAssertEqual(response?.result.failure?.asAFError?.responseCode, 500)
  269. XCTAssertEqual(authenticator.applyCount, 1)
  270. XCTAssertEqual(authenticator.refreshCount, 0)
  271. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  272. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  273. XCTAssertEqual(request.retryCount, 0)
  274. }
  275. func testThatInterceptorThrowsMissingCredentialErrorWhenCredentialIsNilAndRequestShouldBeRetried() {
  276. // Given
  277. let credential = TestCredential()
  278. let authenticator = TestAuthenticator()
  279. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  280. let eventMonitor = ClosureEventMonitor()
  281. eventMonitor.requestDidCreateTask = { _, _ in interceptor.credential = nil }
  282. let session = Session(eventMonitors: [eventMonitor])
  283. let expect = expectation(description: "request should complete")
  284. var response: AFDataResponse<Data?>?
  285. // When
  286. let request = session.request(.status(401), interceptor: interceptor).validate().response {
  287. response = $0
  288. expect.fulfill()
  289. }
  290. waitForExpectations(timeout: timeout)
  291. // Then
  292. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a0")
  293. XCTAssertEqual(response?.result.isFailure, true)
  294. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestRetryError, true)
  295. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? AuthenticationError, .missingCredential)
  296. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  297. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  298. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  299. }
  300. XCTAssertEqual(authenticator.applyCount, 1)
  301. XCTAssertEqual(authenticator.refreshCount, 0)
  302. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  303. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  304. XCTAssertEqual(request.retryCount, 0)
  305. }
  306. func testThatInterceptorRetriesRequestThatFailedWithOutdatedCredential() {
  307. // Given
  308. let credential = TestCredential()
  309. let authenticator = TestAuthenticator()
  310. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  311. let eventMonitor = ClosureEventMonitor()
  312. eventMonitor.requestDidCreateTask = { _, _ in
  313. interceptor.credential = TestCredential(accessToken: "a1",
  314. refreshToken: "r1",
  315. userID: "u0",
  316. expiration: Date(),
  317. requiresRefresh: false)
  318. }
  319. let session = Session(eventMonitors: [eventMonitor])
  320. let pathAdapter = PathAdapter(paths: ["/status/401", "/status/200"])
  321. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  322. let expect = expectation(description: "request should complete")
  323. var response: AFDataResponse<Data?>?
  324. // When
  325. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  326. response = $0
  327. expect.fulfill()
  328. }
  329. waitForExpectations(timeout: timeout)
  330. // Then
  331. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a1")
  332. XCTAssertEqual(response?.result.isSuccess, true)
  333. XCTAssertEqual(authenticator.applyCount, 2)
  334. XCTAssertEqual(authenticator.refreshCount, 0)
  335. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  336. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 1)
  337. XCTAssertEqual(request.retryCount, 1)
  338. }
  339. // Produces double lock reported in https://github.com/Alamofire/Alamofire/issues/3294#issuecomment-703241558
  340. func testThatInterceptorDoesNotDeadlockWhenAuthenticatorCallsRefreshCompletionSynchronouslyOnCallingQueue() {
  341. // Given
  342. let credential = TestCredential(requiresRefresh: true)
  343. let authenticator = TestAuthenticator(shouldRefreshAsynchronously: false)
  344. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  345. let eventMonitor = ClosureEventMonitor()
  346. eventMonitor.requestDidCreateTask = { _, _ in
  347. interceptor.credential = TestCredential(accessToken: "a1",
  348. refreshToken: "r1",
  349. userID: "u0",
  350. expiration: Date(),
  351. requiresRefresh: false)
  352. }
  353. let session = Session(eventMonitors: [eventMonitor])
  354. let pathAdapter = PathAdapter(paths: ["/status/200"])
  355. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  356. let expect = expectation(description: "request should complete")
  357. var response: AFDataResponse<Data?>?
  358. // When
  359. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  360. response = $0
  361. expect.fulfill()
  362. }
  363. waitForExpectations(timeout: timeout)
  364. // Then
  365. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a1")
  366. XCTAssertEqual(response?.result.isSuccess, true)
  367. XCTAssertEqual(authenticator.applyCount, 1)
  368. XCTAssertEqual(authenticator.refreshCount, 1)
  369. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  370. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  371. XCTAssertEqual(request.retryCount, 0)
  372. }
  373. func testThatInterceptorRetriesRequestAfterRefresh() {
  374. // Given
  375. let credential = TestCredential()
  376. let authenticator = TestAuthenticator()
  377. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  378. let pathAdapter = PathAdapter(paths: ["/status/401", "/status/200"])
  379. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  380. let session = Session()
  381. let expect = expectation(description: "request should complete")
  382. var response: AFDataResponse<Data?>?
  383. // When
  384. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  385. response = $0
  386. expect.fulfill()
  387. }
  388. waitForExpectations(timeout: timeout)
  389. // Then
  390. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a1")
  391. XCTAssertEqual(response?.result.isSuccess, true)
  392. XCTAssertEqual(authenticator.applyCount, 2)
  393. XCTAssertEqual(authenticator.refreshCount, 1)
  394. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  395. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 1)
  396. XCTAssertEqual(request.retryCount, 1)
  397. }
  398. func testThatInterceptorRethrowsRefreshErrorFromRetry() {
  399. // Given
  400. let credential = TestCredential()
  401. let authenticator = TestAuthenticator(refreshResult: .failure(TestAuthError.refreshNetworkFailure))
  402. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  403. let session = Session()
  404. let expect = expectation(description: "request should complete")
  405. var response: AFDataResponse<Data?>?
  406. // When
  407. let request = session.request(.status(401), interceptor: interceptor).validate().response {
  408. response = $0
  409. expect.fulfill()
  410. }
  411. waitForExpectations(timeout: timeout)
  412. // Then
  413. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a0")
  414. XCTAssertEqual(response?.result.isFailure, true)
  415. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestRetryError, true)
  416. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? TestAuthError, .refreshNetworkFailure)
  417. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  418. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  419. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  420. }
  421. XCTAssertEqual(authenticator.applyCount, 1)
  422. XCTAssertEqual(authenticator.refreshCount, 1)
  423. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  424. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 1)
  425. XCTAssertEqual(request.retryCount, 0)
  426. }
  427. func testThatInterceptorTriggersRefreshWithMultipleParallelRequestsReturning401Responses() {
  428. // Given
  429. let credential = TestCredential()
  430. let authenticator = TestAuthenticator()
  431. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  432. let requestCount = 6
  433. let session = Session()
  434. let expect = expectation(description: "both requests should complete")
  435. expect.expectedFulfillmentCount = requestCount
  436. var requests: [Int: Request] = [:]
  437. var responses: [Int: AFDataResponse<Data?>] = [:]
  438. for index in 0..<requestCount {
  439. let pathAdapter = PathAdapter(paths: ["/status/401", "/status/20\(index)"])
  440. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  441. // When
  442. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  443. responses[index] = $0
  444. expect.fulfill()
  445. }
  446. requests[index] = request
  447. }
  448. waitForExpectations(timeout: timeout)
  449. // Then
  450. for index in 0..<requestCount {
  451. let response = responses[index]
  452. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a1")
  453. XCTAssertEqual(response?.result.isSuccess, true)
  454. let request = requests[index]
  455. XCTAssertEqual(request?.retryCount, 1)
  456. }
  457. XCTAssertEqual(authenticator.applyCount, 12)
  458. XCTAssertEqual(authenticator.refreshCount, 1)
  459. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 6)
  460. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 6)
  461. }
  462. // MARK: - Tests - Excessive Refresh
  463. func testThatInterceptorIgnoresExcessiveRefreshWhenRefreshWindowIsNil() {
  464. // Given
  465. let credential = TestCredential()
  466. let authenticator = TestAuthenticator()
  467. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  468. let pathAdapter = PathAdapter(paths: ["/status/401",
  469. "/status/401",
  470. "/status/401",
  471. "/status/401",
  472. "/status/401",
  473. "/status/200"])
  474. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  475. let session = Session()
  476. let expect = expectation(description: "request should complete")
  477. var response: AFDataResponse<Data?>?
  478. // When
  479. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  480. response = $0
  481. expect.fulfill()
  482. }
  483. waitForExpectations(timeout: timeout)
  484. // Then
  485. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a5")
  486. XCTAssertEqual(response?.result.isSuccess, true)
  487. XCTAssertEqual(authenticator.applyCount, 6)
  488. XCTAssertEqual(authenticator.refreshCount, 5)
  489. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 5)
  490. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 5)
  491. XCTAssertEqual(request.retryCount, 5)
  492. }
  493. func testThatInterceptorThrowsExcessiveRefreshErrorWhenExcessiveRefreshOccurs() {
  494. // Given
  495. let credential = TestCredential()
  496. let authenticator = TestAuthenticator()
  497. let interceptor = AuthenticationInterceptor(authenticator: authenticator,
  498. credential: credential,
  499. refreshWindow: .init(interval: 30, maximumAttempts: 2))
  500. let session = Session()
  501. let expect = expectation(description: "request should complete")
  502. var response: AFDataResponse<Data?>?
  503. // When
  504. let request = session.request(.status(401), interceptor: interceptor).validate().response {
  505. response = $0
  506. expect.fulfill()
  507. }
  508. waitForExpectations(timeout: timeout)
  509. // Then
  510. XCTAssertEqual(response?.request?.headers["Authorization"], "Bearer a2")
  511. XCTAssertEqual(response?.result.isFailure, true)
  512. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestRetryError, true)
  513. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? AuthenticationError, .excessiveRefresh)
  514. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  515. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  516. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  517. }
  518. XCTAssertEqual(authenticator.applyCount, 3)
  519. XCTAssertEqual(authenticator.refreshCount, 2)
  520. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 3)
  521. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 3)
  522. XCTAssertEqual(request.retryCount, 2)
  523. }
  524. }