EventMonitor.swift 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919
  1. //
  2. // EventMonitor.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. import Foundation
  25. /// Protocol outlining the lifetime events inside Alamofire. It includes both events received from the various
  26. /// `URLSession` delegate protocols as well as various events from the lifetime of `Request` and its subclasses.
  27. public protocol EventMonitor: Sendable {
  28. /// The `DispatchQueue` on which events will be called.
  29. var queue: DispatchQueue { get }
  30. // MARK: - URLSession Events
  31. // MARK: URLSessionDelegate Events
  32. /// Event called during `URLSessionDelegate`'s `urlSession(_:didBecomeInvalidWithError:)` method.
  33. func urlSession(_ session: URLSession, didBecomeInvalidWithError error: (any Error)?)
  34. // MARK: URLSessionTaskDelegate Events
  35. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didReceive:completionHandler:)` method.
  36. func urlSession(_ session: URLSession, task: URLSessionTask, didReceive challenge: URLAuthenticationChallenge)
  37. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)` method.
  38. func urlSession(_ session: URLSession,
  39. task: URLSessionTask,
  40. didSendBodyData bytesSent: Int64,
  41. totalBytesSent: Int64,
  42. totalBytesExpectedToSend: Int64)
  43. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:needNewBodyStream:)` method.
  44. func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask)
  45. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)` method.
  46. func urlSession(_ session: URLSession,
  47. task: URLSessionTask,
  48. willPerformHTTPRedirection response: HTTPURLResponse,
  49. newRequest request: URLRequest)
  50. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didFinishCollecting:)` method.
  51. func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics)
  52. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:task:didCompleteWithError:)` method.
  53. func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: (any Error)?)
  54. /// Event called during `URLSessionTaskDelegate`'s `urlSession(_:taskIsWaitingForConnectivity:)` method.
  55. func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask)
  56. // MARK: URLSessionDataDelegate Events
  57. /// Event called during `URLSessionDataDelegate`'s `urlSession(_:dataTask:didReceive:completionHandler:)` method.
  58. func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive response: URLResponse)
  59. /// Event called during `URLSessionDataDelegate`'s `urlSession(_:dataTask:didReceive:)` method.
  60. func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data)
  61. /// Event called during `URLSessionDataDelegate`'s `urlSession(_:dataTask:willCacheResponse:completionHandler:)` method.
  62. func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, willCacheResponse proposedResponse: CachedURLResponse)
  63. // MARK: URLSessionDownloadDelegate Events
  64. /// Event called during `URLSessionDownloadDelegate`'s `urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)` method.
  65. func urlSession(_ session: URLSession,
  66. downloadTask: URLSessionDownloadTask,
  67. didResumeAtOffset fileOffset: Int64,
  68. expectedTotalBytes: Int64)
  69. /// Event called during `URLSessionDownloadDelegate`'s `urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)` method.
  70. func urlSession(_ session: URLSession,
  71. downloadTask: URLSessionDownloadTask,
  72. didWriteData bytesWritten: Int64,
  73. totalBytesWritten: Int64,
  74. totalBytesExpectedToWrite: Int64)
  75. /// Event called during `URLSessionDownloadDelegate`'s `urlSession(_:downloadTask:didFinishDownloadingTo:)` method.
  76. func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL)
  77. // MARK: - Request Events
  78. /// Event called when a `URLRequest` is first created for a `Request`. If a `RequestAdapter` is active, the
  79. /// `URLRequest` will be adapted before being issued.
  80. func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest)
  81. /// Event called when the attempt to create a `URLRequest` from a `Request`'s original `URLRequestConvertible` value fails.
  82. func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError)
  83. /// Event called when a `RequestAdapter` adapts the `Request`'s initial `URLRequest`.
  84. func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest)
  85. /// Event called when a `RequestAdapter` fails to adapt the `Request`'s initial `URLRequest`.
  86. func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: AFError)
  87. /// Event called when a final `URLRequest` is created for a `Request`.
  88. func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest)
  89. /// Event called when a `URLSessionTask` subclass instance is created for a `Request`.
  90. func request(_ request: Request, didCreateTask task: URLSessionTask)
  91. /// Event called when a `Request` receives a `URLSessionTaskMetrics` value.
  92. func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics)
  93. /// Event called when a `Request` fails due to an error created by Alamofire. e.g. When certificate pinning fails.
  94. func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError)
  95. /// Event called when a `Request`'s task completes, possibly with an error. A `Request` may receive this event
  96. /// multiple times if it is retried.
  97. func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?)
  98. /// Event called when a `Request` is about to be retried.
  99. func requestIsRetrying(_ request: Request)
  100. /// Event called when a `Request` finishes and response serializers are being called.
  101. func requestDidFinish(_ request: Request)
  102. /// Event called when a `Request` receives a `resume` call.
  103. func requestDidResume(_ request: Request)
  104. /// Event called when a `Request`'s associated `URLSessionTask` is resumed.
  105. func request(_ request: Request, didResumeTask task: URLSessionTask)
  106. /// Event called when a `Request` receives a `suspend` call.
  107. func requestDidSuspend(_ request: Request)
  108. /// Event called when a `Request`'s associated `URLSessionTask` is suspended.
  109. func request(_ request: Request, didSuspendTask task: URLSessionTask)
  110. /// Event called when a `Request` receives a `cancel` call.
  111. func requestDidCancel(_ request: Request)
  112. /// Event called when a `Request`'s associated `URLSessionTask` is cancelled.
  113. func request(_ request: Request, didCancelTask task: URLSessionTask)
  114. // MARK: DataRequest Events
  115. /// Event called when a `DataRequest` calls a `Validation`.
  116. func request(_ request: DataRequest,
  117. didValidateRequest urlRequest: URLRequest?,
  118. response: HTTPURLResponse,
  119. data: Data?,
  120. withResult result: Request.ValidationResult)
  121. /// Event called when a `DataRequest` creates a `DataResponse<Data?>` value without calling a `ResponseSerializer`.
  122. func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>)
  123. /// Event called when a `DataRequest` calls a `ResponseSerializer` and creates a generic `DataResponse<Value, AFError>`.
  124. func request<Value: Sendable>(_ request: DataRequest, didParseResponse response: DataResponse<Value, AFError>)
  125. // MARK: DataStreamRequest Events
  126. /// Event called when a `DataStreamRequest` calls a `Validation` closure.
  127. ///
  128. /// - Parameters:
  129. /// - request: `DataStreamRequest` which is calling the `Validation`.
  130. /// - urlRequest: `URLRequest` of the request being validated.
  131. /// - response: `HTTPURLResponse` of the request being validated.
  132. /// - result: Produced `ValidationResult`.
  133. func request(_ request: DataStreamRequest,
  134. didValidateRequest urlRequest: URLRequest?,
  135. response: HTTPURLResponse,
  136. withResult result: Request.ValidationResult)
  137. /// Event called when a `DataStreamSerializer` produces a value from streamed `Data`.
  138. ///
  139. /// - Parameters:
  140. /// - request: `DataStreamRequest` for which the value was serialized.
  141. /// - result: `Result` of the serialization attempt.
  142. func request<Value: Sendable>(_ request: DataStreamRequest, didParseStream result: Result<Value, AFError>)
  143. // MARK: UploadRequest Events
  144. /// Event called when an `UploadRequest` creates its `Uploadable` value, indicating the type of upload it represents.
  145. func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable)
  146. /// Event called when an `UploadRequest` failed to create its `Uploadable` value due to an error.
  147. func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError)
  148. /// Event called when an `UploadRequest` provides the `InputStream` from its `Uploadable` value. This only occurs if
  149. /// the `InputStream` does not wrap a `Data` value or file `URL`.
  150. func request(_ request: UploadRequest, didProvideInputStream stream: InputStream)
  151. // MARK: DownloadRequest Events
  152. /// Event called when a `DownloadRequest`'s `URLSessionDownloadTask` finishes and the temporary file has been moved.
  153. func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>)
  154. /// Event called when a `DownloadRequest`'s `Destination` closure is called and creates the destination URL the
  155. /// downloaded file will be moved to.
  156. func request(_ request: DownloadRequest, didCreateDestinationURL url: URL)
  157. /// Event called when a `DownloadRequest` calls a `Validation`.
  158. func request(_ request: DownloadRequest,
  159. didValidateRequest urlRequest: URLRequest?,
  160. response: HTTPURLResponse,
  161. fileURL: URL?,
  162. withResult result: Request.ValidationResult)
  163. /// Event called when a `DownloadRequest` creates a `DownloadResponse<URL?, AFError>` without calling a `ResponseSerializer`.
  164. func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>)
  165. /// Event called when a `DownloadRequest` calls a `DownloadResponseSerializer` and creates a generic `DownloadResponse<Value, AFError>`
  166. func request<Value: Sendable>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value, AFError>)
  167. }
  168. extension EventMonitor {
  169. /// The default queue on which `CompositeEventMonitor`s will call the `EventMonitor` methods. `.main` by default.
  170. public var queue: DispatchQueue { .main }
  171. // MARK: Default Implementations
  172. public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: (any Error)?) {}
  173. public func urlSession(_ session: URLSession,
  174. task: URLSessionTask,
  175. didReceive challenge: URLAuthenticationChallenge) {}
  176. public func urlSession(_ session: URLSession,
  177. task: URLSessionTask,
  178. didSendBodyData bytesSent: Int64,
  179. totalBytesSent: Int64,
  180. totalBytesExpectedToSend: Int64) {}
  181. public func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {}
  182. public func urlSession(_ session: URLSession,
  183. task: URLSessionTask,
  184. willPerformHTTPRedirection response: HTTPURLResponse,
  185. newRequest request: URLRequest) {}
  186. public func urlSession(_ session: URLSession,
  187. task: URLSessionTask,
  188. didFinishCollecting metrics: URLSessionTaskMetrics) {}
  189. public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: (any Error)?) {}
  190. public func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {}
  191. public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive response: URLResponse) {}
  192. public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {}
  193. public func urlSession(_ session: URLSession,
  194. dataTask: URLSessionDataTask,
  195. willCacheResponse proposedResponse: CachedURLResponse) {}
  196. public func urlSession(_ session: URLSession,
  197. downloadTask: URLSessionDownloadTask,
  198. didResumeAtOffset fileOffset: Int64,
  199. expectedTotalBytes: Int64) {}
  200. public func urlSession(_ session: URLSession,
  201. downloadTask: URLSessionDownloadTask,
  202. didWriteData bytesWritten: Int64,
  203. totalBytesWritten: Int64,
  204. totalBytesExpectedToWrite: Int64) {}
  205. public func urlSession(_ session: URLSession,
  206. downloadTask: URLSessionDownloadTask,
  207. didFinishDownloadingTo location: URL) {}
  208. public func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest) {}
  209. public func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError) {}
  210. public func request(_ request: Request,
  211. didAdaptInitialRequest initialRequest: URLRequest,
  212. to adaptedRequest: URLRequest) {}
  213. public func request(_ request: Request,
  214. didFailToAdaptURLRequest initialRequest: URLRequest,
  215. withError error: AFError) {}
  216. public func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {}
  217. public func request(_ request: Request, didCreateTask task: URLSessionTask) {}
  218. public func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {}
  219. public func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError) {}
  220. public func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?) {}
  221. public func requestIsRetrying(_ request: Request) {}
  222. public func requestDidFinish(_ request: Request) {}
  223. public func requestDidResume(_ request: Request) {}
  224. public func request(_ request: Request, didResumeTask task: URLSessionTask) {}
  225. public func requestDidSuspend(_ request: Request) {}
  226. public func request(_ request: Request, didSuspendTask task: URLSessionTask) {}
  227. public func requestDidCancel(_ request: Request) {}
  228. public func request(_ request: Request, didCancelTask task: URLSessionTask) {}
  229. public func request(_ request: DataRequest,
  230. didValidateRequest urlRequest: URLRequest?,
  231. response: HTTPURLResponse,
  232. data: Data?,
  233. withResult result: Request.ValidationResult) {}
  234. public func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>) {}
  235. public func request<Value: Sendable>(_ request: DataRequest, didParseResponse response: DataResponse<Value, AFError>) {}
  236. public func request(_ request: DataStreamRequest,
  237. didValidateRequest urlRequest: URLRequest?,
  238. response: HTTPURLResponse,
  239. withResult result: Request.ValidationResult) {}
  240. public func request<Value: Sendable>(_ request: DataStreamRequest, didParseStream result: Result<Value, AFError>) {}
  241. public func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {}
  242. public func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError) {}
  243. public func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {}
  244. public func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>) {}
  245. public func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {}
  246. public func request(_ request: DownloadRequest,
  247. didValidateRequest urlRequest: URLRequest?,
  248. response: HTTPURLResponse,
  249. fileURL: URL?,
  250. withResult result: Request.ValidationResult) {}
  251. public func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>) {}
  252. public func request<Value: Sendable>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value, AFError>) {}
  253. }
  254. /// An `EventMonitor` which can contain multiple `EventMonitor`s and calls their methods on their queues.
  255. public final class CompositeEventMonitor: EventMonitor {
  256. public let queue: DispatchQueue
  257. /// Underlying `EventMonitor`s performed by the instance.
  258. public var monitors: [any EventMonitor] {
  259. _monitors.read(\.self)
  260. }
  261. let _monitors: Protected<[any EventMonitor]>
  262. /// Creates an instance from the provided `DispatchQueue` and `EventMonitor`s.
  263. ///
  264. /// - Parameters:
  265. /// - queue: `DispatchQueue` on which the events will be called.
  266. /// `DispatchQueue(label: "org.alamofire.compositeEventMonitor")` by default.
  267. /// - monitors: `EventMonitor`s performed.
  268. ///
  269. init(queue: DispatchQueue = DispatchQueue(label: "org.alamofire.compositeEventMonitor"), monitors: [any EventMonitor]) {
  270. self.queue = queue
  271. _monitors = Protected(monitors)
  272. }
  273. func performEvent(_ event: sending @escaping (any EventMonitor) -> Void) {
  274. _monitors.read { monitors in
  275. for monitor in monitors {
  276. monitor.queue.async { event(monitor) }
  277. }
  278. }
  279. }
  280. public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: (any Error)?) {
  281. performEvent { $0.urlSession(session, didBecomeInvalidWithError: error) }
  282. }
  283. public func urlSession(_ session: URLSession,
  284. task: URLSessionTask,
  285. didReceive challenge: URLAuthenticationChallenge) {
  286. performEvent { $0.urlSession(session, task: task, didReceive: challenge) }
  287. }
  288. public func urlSession(_ session: URLSession,
  289. task: URLSessionTask,
  290. didSendBodyData bytesSent: Int64,
  291. totalBytesSent: Int64,
  292. totalBytesExpectedToSend: Int64) {
  293. performEvent {
  294. $0.urlSession(session,
  295. task: task,
  296. didSendBodyData: bytesSent,
  297. totalBytesSent: totalBytesSent,
  298. totalBytesExpectedToSend: totalBytesExpectedToSend)
  299. }
  300. }
  301. public func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {
  302. performEvent {
  303. $0.urlSession(session, taskNeedsNewBodyStream: task)
  304. }
  305. }
  306. public func urlSession(_ session: URLSession,
  307. task: URLSessionTask,
  308. willPerformHTTPRedirection response: HTTPURLResponse,
  309. newRequest request: URLRequest) {
  310. performEvent {
  311. $0.urlSession(session,
  312. task: task,
  313. willPerformHTTPRedirection: response,
  314. newRequest: request)
  315. }
  316. }
  317. public func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
  318. performEvent { $0.urlSession(session, task: task, didFinishCollecting: metrics) }
  319. }
  320. public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: (any Error)?) {
  321. performEvent { $0.urlSession(session, task: task, didCompleteWithError: error) }
  322. }
  323. @available(macOS 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
  324. public func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {
  325. performEvent { $0.urlSession(session, taskIsWaitingForConnectivity: task) }
  326. }
  327. public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive response: URLResponse) {
  328. performEvent { $0.urlSession(session, dataTask: dataTask, didReceive: response) }
  329. }
  330. public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {
  331. performEvent { $0.urlSession(session, dataTask: dataTask, didReceive: data) }
  332. }
  333. public func urlSession(_ session: URLSession,
  334. dataTask: URLSessionDataTask,
  335. willCacheResponse proposedResponse: CachedURLResponse) {
  336. performEvent { $0.urlSession(session, dataTask: dataTask, willCacheResponse: proposedResponse) }
  337. }
  338. public func urlSession(_ session: URLSession,
  339. downloadTask: URLSessionDownloadTask,
  340. didResumeAtOffset fileOffset: Int64,
  341. expectedTotalBytes: Int64) {
  342. performEvent {
  343. $0.urlSession(session,
  344. downloadTask: downloadTask,
  345. didResumeAtOffset: fileOffset,
  346. expectedTotalBytes: expectedTotalBytes)
  347. }
  348. }
  349. public func urlSession(_ session: URLSession,
  350. downloadTask: URLSessionDownloadTask,
  351. didWriteData bytesWritten: Int64,
  352. totalBytesWritten: Int64,
  353. totalBytesExpectedToWrite: Int64) {
  354. performEvent {
  355. $0.urlSession(session,
  356. downloadTask: downloadTask,
  357. didWriteData: bytesWritten,
  358. totalBytesWritten: totalBytesWritten,
  359. totalBytesExpectedToWrite: totalBytesExpectedToWrite)
  360. }
  361. }
  362. public func urlSession(_ session: URLSession,
  363. downloadTask: URLSessionDownloadTask,
  364. didFinishDownloadingTo location: URL) {
  365. performEvent { $0.urlSession(session, downloadTask: downloadTask, didFinishDownloadingTo: location) }
  366. }
  367. public func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest) {
  368. performEvent { $0.request(request, didCreateInitialURLRequest: urlRequest) }
  369. }
  370. public func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError) {
  371. performEvent { $0.request(request, didFailToCreateURLRequestWithError: error) }
  372. }
  373. public func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest) {
  374. performEvent { $0.request(request, didAdaptInitialRequest: initialRequest, to: adaptedRequest) }
  375. }
  376. public func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: AFError) {
  377. performEvent { $0.request(request, didFailToAdaptURLRequest: initialRequest, withError: error) }
  378. }
  379. public func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {
  380. performEvent { $0.request(request, didCreateURLRequest: urlRequest) }
  381. }
  382. public func request(_ request: Request, didCreateTask task: URLSessionTask) {
  383. performEvent { $0.request(request, didCreateTask: task) }
  384. }
  385. public func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {
  386. performEvent { $0.request(request, didGatherMetrics: metrics) }
  387. }
  388. public func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError) {
  389. performEvent { $0.request(request, didFailTask: task, earlyWithError: error) }
  390. }
  391. public func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?) {
  392. performEvent { $0.request(request, didCompleteTask: task, with: error) }
  393. }
  394. public func requestIsRetrying(_ request: Request) {
  395. performEvent { $0.requestIsRetrying(request) }
  396. }
  397. public func requestDidFinish(_ request: Request) {
  398. performEvent { $0.requestDidFinish(request) }
  399. }
  400. public func requestDidResume(_ request: Request) {
  401. performEvent { $0.requestDidResume(request) }
  402. }
  403. public func request(_ request: Request, didResumeTask task: URLSessionTask) {
  404. performEvent { $0.request(request, didResumeTask: task) }
  405. }
  406. public func requestDidSuspend(_ request: Request) {
  407. performEvent { $0.requestDidSuspend(request) }
  408. }
  409. public func request(_ request: Request, didSuspendTask task: URLSessionTask) {
  410. performEvent { $0.request(request, didSuspendTask: task) }
  411. }
  412. public func requestDidCancel(_ request: Request) {
  413. performEvent { $0.requestDidCancel(request) }
  414. }
  415. public func request(_ request: Request, didCancelTask task: URLSessionTask) {
  416. performEvent { $0.request(request, didCancelTask: task) }
  417. }
  418. public func request(_ request: DataRequest,
  419. didValidateRequest urlRequest: URLRequest?,
  420. response: HTTPURLResponse,
  421. data: Data?,
  422. withResult result: Request.ValidationResult) {
  423. performEvent { $0.request(request,
  424. didValidateRequest: urlRequest,
  425. response: response,
  426. data: data,
  427. withResult: result)
  428. }
  429. }
  430. public func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>) {
  431. performEvent { $0.request(request, didParseResponse: response) }
  432. }
  433. public func request<Value>(_ request: DataRequest, didParseResponse response: DataResponse<Value, AFError>) {
  434. performEvent { $0.request(request, didParseResponse: response) }
  435. }
  436. public func request(_ request: DataStreamRequest,
  437. didValidateRequest urlRequest: URLRequest?,
  438. response: HTTPURLResponse,
  439. withResult result: Request.ValidationResult) {
  440. performEvent { $0.request(request,
  441. didValidateRequest: urlRequest,
  442. response: response,
  443. withResult: result)
  444. }
  445. }
  446. public func request<Value: Sendable>(_ request: DataStreamRequest, didParseStream result: Result<Value, AFError>) {
  447. performEvent { $0.request(request, didParseStream: result) }
  448. }
  449. public func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {
  450. performEvent { $0.request(request, didCreateUploadable: uploadable) }
  451. }
  452. public func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError) {
  453. performEvent { $0.request(request, didFailToCreateUploadableWithError: error) }
  454. }
  455. public func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {
  456. performEvent { $0.request(request, didProvideInputStream: stream) }
  457. }
  458. public func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>) {
  459. performEvent { $0.request(request, didFinishDownloadingUsing: task, with: result) }
  460. }
  461. public func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {
  462. performEvent { $0.request(request, didCreateDestinationURL: url) }
  463. }
  464. public func request(_ request: DownloadRequest,
  465. didValidateRequest urlRequest: URLRequest?,
  466. response: HTTPURLResponse,
  467. fileURL: URL?,
  468. withResult result: Request.ValidationResult) {
  469. performEvent { $0.request(request,
  470. didValidateRequest: urlRequest,
  471. response: response,
  472. fileURL: fileURL,
  473. withResult: result) }
  474. }
  475. public func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>) {
  476. performEvent { $0.request(request, didParseResponse: response) }
  477. }
  478. public func request<Value: Sendable>(_ request: DownloadRequest, didParseResponse response: DownloadResponse<Value, AFError>) {
  479. performEvent { $0.request(request, didParseResponse: response) }
  480. }
  481. }
  482. /// `EventMonitor` that allows optional closures to be set to receive events.
  483. open class ClosureEventMonitor: EventMonitor, @unchecked Sendable {
  484. /// Closure called on the `urlSession(_:didBecomeInvalidWithError:)` event.
  485. open var sessionDidBecomeInvalidWithError: ((URLSession, (any Error)?) -> Void)?
  486. /// Closure called on the `urlSession(_:task:didReceive:completionHandler:)`.
  487. open var taskDidReceiveChallenge: ((URLSession, URLSessionTask, URLAuthenticationChallenge) -> Void)?
  488. /// Closure that receives `urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)` event.
  489. open var taskDidSendBodyData: ((URLSession, URLSessionTask, Int64, Int64, Int64) -> Void)?
  490. /// Closure called on the `urlSession(_:task:needNewBodyStream:)` event.
  491. open var taskNeedNewBodyStream: ((URLSession, URLSessionTask) -> Void)?
  492. /// Closure called on the `urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)` event.
  493. open var taskWillPerformHTTPRedirection: ((URLSession, URLSessionTask, HTTPURLResponse, URLRequest) -> Void)?
  494. /// Closure called on the `urlSession(_:task:didFinishCollecting:)` event.
  495. open var taskDidFinishCollectingMetrics: ((URLSession, URLSessionTask, URLSessionTaskMetrics) -> Void)?
  496. /// Closure called on the `urlSession(_:task:didCompleteWithError:)` event.
  497. open var taskDidComplete: ((URLSession, URLSessionTask, (any Error)?) -> Void)?
  498. /// Closure called on the `urlSession(_:taskIsWaitingForConnectivity:)` event.
  499. open var taskIsWaitingForConnectivity: ((URLSession, URLSessionTask) -> Void)?
  500. /// Closure called on the `urlSession(_:dataTask:didReceive:completionHandler:)` event.
  501. open var dataTaskDidReceiveResponse: ((URLSession, URLSessionDataTask, URLResponse) -> Void)?
  502. /// Closure that receives the `urlSession(_:dataTask:didReceive:)` event.
  503. open var dataTaskDidReceiveData: ((URLSession, URLSessionDataTask, Data) -> Void)?
  504. /// Closure called on the `urlSession(_:dataTask:willCacheResponse:completionHandler:)` event.
  505. open var dataTaskWillCacheResponse: ((URLSession, URLSessionDataTask, CachedURLResponse) -> Void)?
  506. /// Closure called on the `urlSession(_:downloadTask:didFinishDownloadingTo:)` event.
  507. open var downloadTaskDidFinishDownloadingToURL: ((URLSession, URLSessionDownloadTask, URL) -> Void)?
  508. /// Closure called on the `urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)`
  509. /// event.
  510. open var downloadTaskDidWriteData: ((URLSession, URLSessionDownloadTask, Int64, Int64, Int64) -> Void)?
  511. /// Closure called on the `urlSession(_:downloadTask:didResumeAtOffset:expectedTotalBytes:)` event.
  512. open var downloadTaskDidResumeAtOffset: ((URLSession, URLSessionDownloadTask, Int64, Int64) -> Void)?
  513. // MARK: - Request Events
  514. /// Closure called on the `request(_:didCreateInitialURLRequest:)` event.
  515. open var requestDidCreateInitialURLRequest: ((Request, URLRequest) -> Void)?
  516. /// Closure called on the `request(_:didFailToCreateURLRequestWithError:)` event.
  517. open var requestDidFailToCreateURLRequestWithError: ((Request, AFError) -> Void)?
  518. /// Closure called on the `request(_:didAdaptInitialRequest:to:)` event.
  519. open var requestDidAdaptInitialRequestToAdaptedRequest: ((Request, URLRequest, URLRequest) -> Void)?
  520. /// Closure called on the `request(_:didFailToAdaptURLRequest:withError:)` event.
  521. open var requestDidFailToAdaptURLRequestWithError: ((Request, URLRequest, AFError) -> Void)?
  522. /// Closure called on the `request(_:didCreateURLRequest:)` event.
  523. open var requestDidCreateURLRequest: ((Request, URLRequest) -> Void)?
  524. /// Closure called on the `request(_:didCreateTask:)` event.
  525. open var requestDidCreateTask: ((Request, URLSessionTask) -> Void)?
  526. /// Closure called on the `request(_:didGatherMetrics:)` event.
  527. open var requestDidGatherMetrics: ((Request, URLSessionTaskMetrics) -> Void)?
  528. /// Closure called on the `request(_:didFailTask:earlyWithError:)` event.
  529. open var requestDidFailTaskEarlyWithError: ((Request, URLSessionTask, AFError) -> Void)?
  530. /// Closure called on the `request(_:didCompleteTask:with:)` event.
  531. open var requestDidCompleteTaskWithError: ((Request, URLSessionTask, AFError?) -> Void)?
  532. /// Closure called on the `requestIsRetrying(_:)` event.
  533. open var requestIsRetrying: ((Request) -> Void)?
  534. /// Closure called on the `requestDidFinish(_:)` event.
  535. open var requestDidFinish: ((Request) -> Void)?
  536. /// Closure called on the `requestDidResume(_:)` event.
  537. open var requestDidResume: ((Request) -> Void)?
  538. /// Closure called on the `request(_:didResumeTask:)` event.
  539. open var requestDidResumeTask: ((Request, URLSessionTask) -> Void)?
  540. /// Closure called on the `requestDidSuspend(_:)` event.
  541. open var requestDidSuspend: ((Request) -> Void)?
  542. /// Closure called on the `request(_:didSuspendTask:)` event.
  543. open var requestDidSuspendTask: ((Request, URLSessionTask) -> Void)?
  544. /// Closure called on the `requestDidCancel(_:)` event.
  545. open var requestDidCancel: ((Request) -> Void)?
  546. /// Closure called on the `request(_:didCancelTask:)` event.
  547. open var requestDidCancelTask: ((Request, URLSessionTask) -> Void)?
  548. /// Closure called on the `request(_:didValidateRequest:response:data:withResult:)` event.
  549. open var requestDidValidateRequestResponseDataWithResult: ((DataRequest, URLRequest?, HTTPURLResponse, Data?, Request.ValidationResult) -> Void)?
  550. /// Closure called on the `request(_:didParseResponse:)` event.
  551. open var requestDidParseResponse: ((DataRequest, DataResponse<Data?, AFError>) -> Void)?
  552. /// Closure called on the `request(_:didValidateRequest:response:withResult:)` event.
  553. open var requestDidValidateRequestResponseWithResult: ((DataStreamRequest, URLRequest?, HTTPURLResponse, Request.ValidationResult) -> Void)?
  554. /// Closure called on the `request(_:didCreateUploadable:)` event.
  555. open var requestDidCreateUploadable: ((UploadRequest, UploadRequest.Uploadable) -> Void)?
  556. /// Closure called on the `request(_:didFailToCreateUploadableWithError:)` event.
  557. open var requestDidFailToCreateUploadableWithError: ((UploadRequest, AFError) -> Void)?
  558. /// Closure called on the `request(_:didProvideInputStream:)` event.
  559. open var requestDidProvideInputStream: ((UploadRequest, InputStream) -> Void)?
  560. /// Closure called on the `request(_:didFinishDownloadingUsing:with:)` event.
  561. open var requestDidFinishDownloadingUsingTaskWithResult: ((DownloadRequest, URLSessionTask, Result<URL, AFError>) -> Void)?
  562. /// Closure called on the `request(_:didCreateDestinationURL:)` event.
  563. open var requestDidCreateDestinationURL: ((DownloadRequest, URL) -> Void)?
  564. /// Closure called on the `request(_:didValidateRequest:response:temporaryURL:destinationURL:withResult:)` event.
  565. open var requestDidValidateRequestResponseFileURLWithResult: ((DownloadRequest, URLRequest?, HTTPURLResponse, URL?, Request.ValidationResult) -> Void)?
  566. /// Closure called on the `request(_:didParseResponse:)` event.
  567. open var requestDidParseDownloadResponse: ((DownloadRequest, DownloadResponse<URL?, AFError>) -> Void)?
  568. public let queue: DispatchQueue
  569. /// Creates an instance using the provided queue.
  570. ///
  571. /// - Parameter queue: `DispatchQueue` on which events will fired. `.main` by default.
  572. public init(queue: DispatchQueue = .main) {
  573. self.queue = queue
  574. }
  575. open func urlSession(_ session: URLSession, didBecomeInvalidWithError error: (any Error)?) {
  576. sessionDidBecomeInvalidWithError?(session, error)
  577. }
  578. open func urlSession(_ session: URLSession, task: URLSessionTask, didReceive challenge: URLAuthenticationChallenge) {
  579. taskDidReceiveChallenge?(session, task, challenge)
  580. }
  581. open func urlSession(_ session: URLSession,
  582. task: URLSessionTask,
  583. didSendBodyData bytesSent: Int64,
  584. totalBytesSent: Int64,
  585. totalBytesExpectedToSend: Int64) {
  586. taskDidSendBodyData?(session, task, bytesSent, totalBytesSent, totalBytesExpectedToSend)
  587. }
  588. open func urlSession(_ session: URLSession, taskNeedsNewBodyStream task: URLSessionTask) {
  589. taskNeedNewBodyStream?(session, task)
  590. }
  591. open func urlSession(_ session: URLSession,
  592. task: URLSessionTask,
  593. willPerformHTTPRedirection response: HTTPURLResponse,
  594. newRequest request: URLRequest) {
  595. taskWillPerformHTTPRedirection?(session, task, response, request)
  596. }
  597. open func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
  598. taskDidFinishCollectingMetrics?(session, task, metrics)
  599. }
  600. open func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: (any Error)?) {
  601. taskDidComplete?(session, task, error)
  602. }
  603. @available(macOS 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *)
  604. open func urlSession(_ session: URLSession, taskIsWaitingForConnectivity task: URLSessionTask) {
  605. taskIsWaitingForConnectivity?(session, task)
  606. }
  607. open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive response: URLResponse) {
  608. dataTaskDidReceiveResponse?(session, dataTask, response)
  609. }
  610. open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {
  611. dataTaskDidReceiveData?(session, dataTask, data)
  612. }
  613. open func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, willCacheResponse proposedResponse: CachedURLResponse) {
  614. dataTaskWillCacheResponse?(session, dataTask, proposedResponse)
  615. }
  616. open func urlSession(_ session: URLSession,
  617. downloadTask: URLSessionDownloadTask,
  618. didResumeAtOffset fileOffset: Int64,
  619. expectedTotalBytes: Int64) {
  620. downloadTaskDidResumeAtOffset?(session, downloadTask, fileOffset, expectedTotalBytes)
  621. }
  622. open func urlSession(_ session: URLSession,
  623. downloadTask: URLSessionDownloadTask,
  624. didWriteData bytesWritten: Int64,
  625. totalBytesWritten: Int64,
  626. totalBytesExpectedToWrite: Int64) {
  627. downloadTaskDidWriteData?(session, downloadTask, bytesWritten, totalBytesWritten, totalBytesExpectedToWrite)
  628. }
  629. open func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL) {
  630. downloadTaskDidFinishDownloadingToURL?(session, downloadTask, location)
  631. }
  632. // MARK: Request Events
  633. open func request(_ request: Request, didCreateInitialURLRequest urlRequest: URLRequest) {
  634. requestDidCreateInitialURLRequest?(request, urlRequest)
  635. }
  636. open func request(_ request: Request, didFailToCreateURLRequestWithError error: AFError) {
  637. requestDidFailToCreateURLRequestWithError?(request, error)
  638. }
  639. open func request(_ request: Request, didAdaptInitialRequest initialRequest: URLRequest, to adaptedRequest: URLRequest) {
  640. requestDidAdaptInitialRequestToAdaptedRequest?(request, initialRequest, adaptedRequest)
  641. }
  642. open func request(_ request: Request, didFailToAdaptURLRequest initialRequest: URLRequest, withError error: AFError) {
  643. requestDidFailToAdaptURLRequestWithError?(request, initialRequest, error)
  644. }
  645. open func request(_ request: Request, didCreateURLRequest urlRequest: URLRequest) {
  646. requestDidCreateURLRequest?(request, urlRequest)
  647. }
  648. open func request(_ request: Request, didCreateTask task: URLSessionTask) {
  649. requestDidCreateTask?(request, task)
  650. }
  651. open func request(_ request: Request, didGatherMetrics metrics: URLSessionTaskMetrics) {
  652. requestDidGatherMetrics?(request, metrics)
  653. }
  654. open func request(_ request: Request, didFailTask task: URLSessionTask, earlyWithError error: AFError) {
  655. requestDidFailTaskEarlyWithError?(request, task, error)
  656. }
  657. open func request(_ request: Request, didCompleteTask task: URLSessionTask, with error: AFError?) {
  658. requestDidCompleteTaskWithError?(request, task, error)
  659. }
  660. open func requestIsRetrying(_ request: Request) {
  661. requestIsRetrying?(request)
  662. }
  663. open func requestDidFinish(_ request: Request) {
  664. requestDidFinish?(request)
  665. }
  666. open func requestDidResume(_ request: Request) {
  667. requestDidResume?(request)
  668. }
  669. public func request(_ request: Request, didResumeTask task: URLSessionTask) {
  670. requestDidResumeTask?(request, task)
  671. }
  672. open func requestDidSuspend(_ request: Request) {
  673. requestDidSuspend?(request)
  674. }
  675. public func request(_ request: Request, didSuspendTask task: URLSessionTask) {
  676. requestDidSuspendTask?(request, task)
  677. }
  678. open func requestDidCancel(_ request: Request) {
  679. requestDidCancel?(request)
  680. }
  681. public func request(_ request: Request, didCancelTask task: URLSessionTask) {
  682. requestDidCancelTask?(request, task)
  683. }
  684. open func request(_ request: DataRequest,
  685. didValidateRequest urlRequest: URLRequest?,
  686. response: HTTPURLResponse,
  687. data: Data?,
  688. withResult result: Request.ValidationResult) {
  689. requestDidValidateRequestResponseDataWithResult?(request, urlRequest, response, data, result)
  690. }
  691. open func request(_ request: DataRequest, didParseResponse response: DataResponse<Data?, AFError>) {
  692. requestDidParseResponse?(request, response)
  693. }
  694. public func request(_ request: DataStreamRequest, didValidateRequest urlRequest: URLRequest?, response: HTTPURLResponse, withResult result: Request.ValidationResult) {
  695. requestDidValidateRequestResponseWithResult?(request, urlRequest, response, result)
  696. }
  697. open func request(_ request: UploadRequest, didCreateUploadable uploadable: UploadRequest.Uploadable) {
  698. requestDidCreateUploadable?(request, uploadable)
  699. }
  700. open func request(_ request: UploadRequest, didFailToCreateUploadableWithError error: AFError) {
  701. requestDidFailToCreateUploadableWithError?(request, error)
  702. }
  703. open func request(_ request: UploadRequest, didProvideInputStream stream: InputStream) {
  704. requestDidProvideInputStream?(request, stream)
  705. }
  706. open func request(_ request: DownloadRequest, didFinishDownloadingUsing task: URLSessionTask, with result: Result<URL, AFError>) {
  707. requestDidFinishDownloadingUsingTaskWithResult?(request, task, result)
  708. }
  709. open func request(_ request: DownloadRequest, didCreateDestinationURL url: URL) {
  710. requestDidCreateDestinationURL?(request, url)
  711. }
  712. open func request(_ request: DownloadRequest,
  713. didValidateRequest urlRequest: URLRequest?,
  714. response: HTTPURLResponse,
  715. fileURL: URL?,
  716. withResult result: Request.ValidationResult) {
  717. requestDidValidateRequestResponseFileURLWithResult?(request,
  718. urlRequest,
  719. response,
  720. fileURL,
  721. result)
  722. }
  723. open func request(_ request: DownloadRequest, didParseResponse response: DownloadResponse<URL?, AFError>) {
  724. requestDidParseDownloadResponse?(request, response)
  725. }
  726. }