AuthenticationInterceptorTests.swift 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709
  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, any Error>?
  57. let lock = NSLock()
  58. init(shouldRefreshAsynchronously: Bool = true, refreshResult: Result<TestCredential, any 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(credential.accessToken))
  66. }
  67. func refresh(_ credential: TestCredential,
  68. for session: Session,
  69. completion: @escaping (Result<TestCredential, any 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: any 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. return urlRequest.headers["Authorization"] == credential.accessToken
  99. }
  100. }
  101. final class PathAdapter: RequestAdapter {
  102. var paths: [String]
  103. init(paths: [String]) {
  104. self.paths = paths
  105. }
  106. func adapt(_ urlRequest: URLRequest, for session: Session, completion: @escaping (Result<URLRequest, any Error>) -> Void) {
  107. var request = urlRequest
  108. var urlComponents = URLComponents(url: request.url!, resolvingAgainstBaseURL: false)!
  109. urlComponents.path = paths.removeFirst()
  110. request.url = urlComponents.url
  111. completion(.success(request))
  112. }
  113. }
  114. // MARK: - Tests - Adapt
  115. @MainActor
  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"], "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. @MainActor
  140. func testThatInterceptorQueuesAdaptOperationWhenRefreshing() {
  141. // Given
  142. let credential = TestCredential(requiresRefresh: true)
  143. let authenticator = TestAuthenticator()
  144. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  145. let session = Session()
  146. let expect = expectation(description: "both requests should complete")
  147. expect.expectedFulfillmentCount = 2
  148. var response1: AFDataResponse<Data?>?
  149. var response2: AFDataResponse<Data?>?
  150. // When
  151. let request1 = session.request(.status(200), interceptor: interceptor).validate().response {
  152. response1 = $0
  153. expect.fulfill()
  154. }
  155. let request2 = session.request(.status(202), interceptor: interceptor).validate().response {
  156. response2 = $0
  157. expect.fulfill()
  158. }
  159. waitForExpectations(timeout: timeout)
  160. // Then
  161. XCTAssertEqual(response1?.request?.headers["Authorization"], "a1")
  162. XCTAssertEqual(response2?.request?.headers["Authorization"], "a1")
  163. XCTAssertEqual(response1?.result.isSuccess, true)
  164. XCTAssertEqual(response2?.result.isSuccess, true)
  165. XCTAssertEqual(authenticator.applyCount, 2)
  166. XCTAssertEqual(authenticator.refreshCount, 1)
  167. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  168. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  169. XCTAssertEqual(request1.retryCount, 0)
  170. XCTAssertEqual(request2.retryCount, 0)
  171. }
  172. @MainActor
  173. func testThatInterceptorThrowsMissingCredentialErrorWhenCredentialIsNil() {
  174. // Given
  175. let authenticator = TestAuthenticator()
  176. let interceptor = AuthenticationInterceptor(authenticator: authenticator)
  177. let session = Session()
  178. let expect = expectation(description: "request should complete")
  179. var response: AFDataResponse<Data?>?
  180. // When
  181. let request = session.request(.default, interceptor: interceptor).validate().response {
  182. response = $0
  183. expect.fulfill()
  184. }
  185. waitForExpectations(timeout: timeout)
  186. // Then
  187. XCTAssertEqual(response?.request?.headers.count, 0)
  188. XCTAssertEqual(response?.result.isFailure, true)
  189. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestAdaptationError, true)
  190. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? AuthenticationError, .missingCredential)
  191. XCTAssertEqual(authenticator.applyCount, 0)
  192. XCTAssertEqual(authenticator.refreshCount, 0)
  193. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  194. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  195. XCTAssertEqual(request.retryCount, 0)
  196. }
  197. @MainActor
  198. func testThatInterceptorRethrowsRefreshErrorFromAdapt() {
  199. // Given
  200. let credential = TestCredential(requiresRefresh: true)
  201. let authenticator = TestAuthenticator(refreshResult: .failure(TestAuthError.refreshNetworkFailure))
  202. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  203. let session = Session()
  204. let expect = expectation(description: "request should complete")
  205. var response: AFDataResponse<Data?>?
  206. // When
  207. let request = session.request(.default, interceptor: interceptor).validate().response {
  208. response = $0
  209. expect.fulfill()
  210. }
  211. waitForExpectations(timeout: timeout)
  212. // Then
  213. XCTAssertEqual(response?.request?.headers.count, 0)
  214. XCTAssertEqual(response?.result.isFailure, true)
  215. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestAdaptationError, true)
  216. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? TestAuthError, .refreshNetworkFailure)
  217. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  218. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  219. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  220. }
  221. XCTAssertEqual(authenticator.applyCount, 0)
  222. XCTAssertEqual(authenticator.refreshCount, 1)
  223. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  224. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  225. XCTAssertEqual(request.retryCount, 0)
  226. }
  227. // MARK: - Tests - Retry
  228. // If we not using swift-corelibs-foundation where URLRequest to /invalid/path is a fatal error.
  229. #if !canImport(FoundationNetworking)
  230. @MainActor
  231. func testThatInterceptorDoesNotRetryWithoutResponse() {
  232. // Given
  233. let credential = TestCredential()
  234. let authenticator = TestAuthenticator()
  235. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  236. let urlRequest = URLRequest(url: URL(string: "/invalid/path")!)
  237. let session = Session()
  238. let expect = expectation(description: "request should complete")
  239. var response: AFDataResponse<Data?>?
  240. // When
  241. let request = session.request(urlRequest, interceptor: interceptor).validate().response {
  242. response = $0
  243. expect.fulfill()
  244. }
  245. waitForExpectations(timeout: timeout)
  246. // Then
  247. XCTAssertEqual(response?.request?.headers["Authorization"], "a0")
  248. XCTAssertEqual(response?.result.isFailure, true)
  249. XCTAssertEqual(response?.result.failure?.asAFError?.isSessionTaskError, true)
  250. XCTAssertEqual(authenticator.applyCount, 1)
  251. XCTAssertEqual(authenticator.refreshCount, 0)
  252. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  253. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  254. XCTAssertEqual(request.retryCount, 0)
  255. }
  256. #endif
  257. @MainActor
  258. func testThatInterceptorDoesNotRetryWhenRequestDoesNotFailDueToAuthError() {
  259. // Given
  260. let credential = TestCredential()
  261. let authenticator = TestAuthenticator()
  262. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  263. let session = Session()
  264. let expect = expectation(description: "request should complete")
  265. var response: AFDataResponse<Data?>?
  266. // When
  267. let request = session.request(.status(500), interceptor: interceptor).validate().response {
  268. response = $0
  269. expect.fulfill()
  270. }
  271. waitForExpectations(timeout: timeout)
  272. // Then
  273. XCTAssertEqual(response?.request?.headers["Authorization"], "a0")
  274. XCTAssertEqual(response?.result.isFailure, true)
  275. XCTAssertEqual(response?.result.failure?.asAFError?.isResponseValidationError, true)
  276. XCTAssertEqual(response?.result.failure?.asAFError?.responseCode, 500)
  277. XCTAssertEqual(authenticator.applyCount, 1)
  278. XCTAssertEqual(authenticator.refreshCount, 0)
  279. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  280. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  281. XCTAssertEqual(request.retryCount, 0)
  282. }
  283. @MainActor
  284. func testThatInterceptorThrowsMissingCredentialErrorWhenCredentialIsNilAndRequestShouldBeRetried() {
  285. // Given
  286. let credential = TestCredential()
  287. let authenticator = TestAuthenticator()
  288. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  289. let session = stored(Session())
  290. let expect = expectation(description: "request should complete")
  291. var response: AFDataResponse<Data?>?
  292. // When
  293. let request = session.request(.status(401), interceptor: interceptor)
  294. .validate {
  295. interceptor.credential = nil
  296. }
  297. .response {
  298. response = $0
  299. expect.fulfill()
  300. }
  301. waitForExpectations(timeout: timeout)
  302. // Then
  303. XCTAssertEqual(response?.request?.headers["Authorization"], "a0")
  304. XCTAssertEqual(response?.result.isFailure, true)
  305. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestRetryError, true)
  306. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? AuthenticationError, .missingCredential)
  307. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  308. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  309. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  310. }
  311. XCTAssertEqual(authenticator.applyCount, 1)
  312. XCTAssertEqual(authenticator.refreshCount, 0)
  313. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  314. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  315. XCTAssertEqual(request.retryCount, 0)
  316. }
  317. @MainActor
  318. func testThatInterceptorRetriesRequestThatFailedWithOutdatedCredential() {
  319. // Given
  320. let credential = TestCredential()
  321. let authenticator = TestAuthenticator()
  322. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  323. let session = stored(Session())
  324. let pathAdapter = PathAdapter(paths: ["/status/401", "/status/200"])
  325. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  326. let expect = expectation(description: "request should complete")
  327. var response: AFDataResponse<Data?>?
  328. // When
  329. let request = session.request(.default, interceptor: compositeInterceptor)
  330. .validate {
  331. interceptor.credential = TestCredential(accessToken: "a1",
  332. refreshToken: "r1",
  333. userID: "u0",
  334. expiration: Date(),
  335. requiresRefresh: false)
  336. }
  337. .response {
  338. response = $0
  339. expect.fulfill()
  340. }
  341. waitForExpectations(timeout: timeout)
  342. // Then
  343. XCTAssertEqual(response?.request?.headers["Authorization"], "a1")
  344. XCTAssertEqual(response?.result.isSuccess, true)
  345. XCTAssertEqual(authenticator.applyCount, 2)
  346. XCTAssertEqual(authenticator.refreshCount, 0)
  347. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  348. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 1)
  349. XCTAssertEqual(request.retryCount, 1)
  350. }
  351. // Produces double lock reported in https://github.com/Alamofire/Alamofire/issues/3294#issuecomment-703241558
  352. @MainActor
  353. func testThatInterceptorDoesNotDeadlockWhenAuthenticatorCallsRefreshCompletionSynchronouslyOnCallingQueue() {
  354. // Given
  355. let credential = TestCredential(requiresRefresh: true)
  356. let authenticator = TestAuthenticator(shouldRefreshAsynchronously: false)
  357. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  358. let eventMonitor = ClosureEventMonitor()
  359. eventMonitor.requestDidCreateTask = { _, _ in
  360. interceptor.credential = TestCredential(accessToken: "a1",
  361. refreshToken: "r1",
  362. userID: "u0",
  363. expiration: Date(),
  364. requiresRefresh: false)
  365. }
  366. let session = Session(eventMonitors: [eventMonitor])
  367. let pathAdapter = PathAdapter(paths: ["/status/200"])
  368. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  369. let expect = expectation(description: "request should complete")
  370. var response: AFDataResponse<Data?>?
  371. // When
  372. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  373. response = $0
  374. expect.fulfill()
  375. }
  376. waitForExpectations(timeout: timeout)
  377. // Then
  378. XCTAssertEqual(response?.request?.headers["Authorization"], "a1")
  379. XCTAssertEqual(response?.result.isSuccess, true)
  380. XCTAssertEqual(authenticator.applyCount, 1)
  381. XCTAssertEqual(authenticator.refreshCount, 1)
  382. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 0)
  383. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 0)
  384. XCTAssertEqual(request.retryCount, 0)
  385. }
  386. @MainActor
  387. func testThatInterceptorRetriesRequestAfterRefresh() {
  388. // Given
  389. let credential = TestCredential()
  390. let authenticator = TestAuthenticator()
  391. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  392. let pathAdapter = PathAdapter(paths: ["/status/401", "/status/200"])
  393. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  394. let session = Session()
  395. let expect = expectation(description: "request should complete")
  396. var response: AFDataResponse<Data?>?
  397. // When
  398. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  399. response = $0
  400. expect.fulfill()
  401. }
  402. waitForExpectations(timeout: timeout)
  403. // Then
  404. XCTAssertEqual(response?.request?.headers["Authorization"], "a1")
  405. XCTAssertEqual(response?.result.isSuccess, true)
  406. XCTAssertEqual(authenticator.applyCount, 2)
  407. XCTAssertEqual(authenticator.refreshCount, 1)
  408. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  409. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 1)
  410. XCTAssertEqual(request.retryCount, 1)
  411. }
  412. @MainActor
  413. func testThatInterceptorRethrowsRefreshErrorFromRetry() {
  414. // Given
  415. let credential = TestCredential()
  416. let authenticator = TestAuthenticator(refreshResult: .failure(TestAuthError.refreshNetworkFailure))
  417. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  418. let session = Session()
  419. let expect = expectation(description: "request should complete")
  420. var response: AFDataResponse<Data?>?
  421. // When
  422. let request = session.request(.status(401), interceptor: interceptor).validate().response {
  423. response = $0
  424. expect.fulfill()
  425. }
  426. waitForExpectations(timeout: timeout)
  427. // Then
  428. XCTAssertEqual(response?.request?.headers["Authorization"], "a0")
  429. XCTAssertEqual(response?.result.isFailure, true)
  430. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestRetryError, true)
  431. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? TestAuthError, .refreshNetworkFailure)
  432. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  433. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  434. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  435. }
  436. XCTAssertEqual(authenticator.applyCount, 1)
  437. XCTAssertEqual(authenticator.refreshCount, 1)
  438. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 1)
  439. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 1)
  440. XCTAssertEqual(request.retryCount, 0)
  441. }
  442. @MainActor
  443. func testThatInterceptorTriggersRefreshWithMultipleParallelRequestsReturning401Responses() {
  444. // Given
  445. let credential = TestCredential()
  446. let authenticator = TestAuthenticator()
  447. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  448. let requestCount = 6
  449. let session = stored(Session())
  450. let expect = expectation(description: "both requests should complete")
  451. expect.expectedFulfillmentCount = requestCount
  452. var requests: [Int: Request] = [:]
  453. var responses: [Int: AFDataResponse<Data?>] = [:]
  454. for index in 0..<requestCount {
  455. let pathAdapter = PathAdapter(paths: ["/status/401", "/status/20\(index)"])
  456. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  457. // When
  458. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  459. responses[index] = $0
  460. expect.fulfill()
  461. }
  462. requests[index] = request
  463. }
  464. waitForExpectations(timeout: timeout)
  465. // Then
  466. for index in 0..<requestCount {
  467. let response = responses[index]
  468. XCTAssertEqual(response?.request?.headers["Authorization"], "a1")
  469. XCTAssertEqual(response?.result.isSuccess, true)
  470. let request = requests[index]
  471. XCTAssertEqual(request?.retryCount, 1)
  472. }
  473. XCTAssertEqual(authenticator.applyCount, 12)
  474. XCTAssertEqual(authenticator.refreshCount, 1)
  475. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 6)
  476. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 6)
  477. }
  478. // MARK: - Tests - Excessive Refresh
  479. @MainActor
  480. func testThatInterceptorIgnoresExcessiveRefreshWhenRefreshWindowIsNil() {
  481. // Given
  482. let credential = TestCredential()
  483. let authenticator = TestAuthenticator()
  484. let interceptor = AuthenticationInterceptor(authenticator: authenticator, credential: credential)
  485. let pathAdapter = PathAdapter(paths: ["/status/401",
  486. "/status/401",
  487. "/status/401",
  488. "/status/401",
  489. "/status/401",
  490. "/status/200"])
  491. let compositeInterceptor = Interceptor(adapters: [pathAdapter, interceptor], retriers: [interceptor])
  492. let session = Session()
  493. let expect = expectation(description: "request should complete")
  494. var response: AFDataResponse<Data?>?
  495. // When
  496. let request = session.request(.default, interceptor: compositeInterceptor).validate().response {
  497. response = $0
  498. expect.fulfill()
  499. }
  500. waitForExpectations(timeout: timeout)
  501. // Then
  502. XCTAssertEqual(response?.request?.headers["Authorization"], "a5")
  503. XCTAssertEqual(response?.result.isSuccess, true)
  504. XCTAssertEqual(authenticator.applyCount, 6)
  505. XCTAssertEqual(authenticator.refreshCount, 5)
  506. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 5)
  507. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 5)
  508. XCTAssertEqual(request.retryCount, 5)
  509. }
  510. @MainActor
  511. func testThatInterceptorThrowsExcessiveRefreshErrorWhenExcessiveRefreshOccurs() {
  512. // Given
  513. let credential = TestCredential()
  514. let authenticator = TestAuthenticator()
  515. let interceptor = AuthenticationInterceptor(authenticator: authenticator,
  516. credential: credential,
  517. refreshWindow: .init(interval: 30, maximumAttempts: 2))
  518. let session = Session()
  519. let expect = expectation(description: "request should complete")
  520. var response: AFDataResponse<Data?>?
  521. // When
  522. let request = session.request(.status(401), interceptor: interceptor).validate().response {
  523. response = $0
  524. expect.fulfill()
  525. }
  526. waitForExpectations(timeout: timeout)
  527. // Then
  528. XCTAssertEqual(response?.request?.headers["Authorization"], "a2")
  529. XCTAssertEqual(response?.result.isFailure, true)
  530. XCTAssertEqual(response?.result.failure?.asAFError?.isRequestRetryError, true)
  531. XCTAssertEqual(response?.result.failure?.asAFError?.underlyingError as? AuthenticationError, .excessiveRefresh)
  532. if case let .requestRetryFailed(_, originalError) = response?.result.failure {
  533. XCTAssertEqual(originalError.asAFError?.isResponseValidationError, true)
  534. XCTAssertEqual(originalError.asAFError?.responseCode, 401)
  535. }
  536. XCTAssertEqual(authenticator.applyCount, 3)
  537. XCTAssertEqual(authenticator.refreshCount, 2)
  538. XCTAssertEqual(authenticator.didRequestFailDueToAuthErrorCount, 3)
  539. XCTAssertEqual(authenticator.isRequestAuthenticatedWithCredentialCount, 3)
  540. XCTAssertEqual(request.retryCount, 2)
  541. }
  542. }