Change to use Foundation.Progress

Author: Econa77

Sources/APIKit/Concurrency/Concurrency.swift

@@ -23,7 +23,7 @@ public extension Session {
         return try await withTaskCancellationHandler(operation: {
             return try await withCheckedThrowingContinuation { continuation in
                 Task {
-                    let sessionTask = createSessionTask(request, callbackQueue: callbackQueue, progressHandler: { _, _, _ in }) { result in
+                    let sessionTask = createSessionTask(request, callbackQueue: callbackQueue, progressHandler: { _ in }) { result in
                         continuation.resume(with: result)
                     }
                     await cancellationHandler.register(with: sessionTask)

Sources/APIKit/Session.swift

@@ -36,7 +36,7 @@ open class Session {
     /// - parameter handler: The closure that receives result of the request.
     /// - returns: The new session task.
     @discardableResult
-    open class func send<Request: APIKit.Request>(_ request: Request, callbackQueue: CallbackQueue? = nil, progressHandler: @escaping (Int64, Int64, Int64) -> Void = { _, _, _ in }, completionHandler: @escaping (Result<Request.Response, SessionTaskError>) -> Void = { _ in }) -> SessionTask? {
+    open class func send<Request: APIKit.Request>(_ request: Request, callbackQueue: CallbackQueue? = nil, progressHandler: @escaping (Progress) -> Void = { _ in }, completionHandler: @escaping (Result<Request.Response, SessionTaskError>) -> Void = { _ in }) -> SessionTask? {
         return shared.send(request, callbackQueue: callbackQueue, progressHandler: progressHandler, completionHandler: completionHandler)
     }
 
@@ -54,7 +54,7 @@ open class Session {
     /// - parameter handler: The closure that receives result of the request.
     /// - returns: The new session task.
     @discardableResult
-    open func send<Request: APIKit.Request>(_ request: Request, callbackQueue: CallbackQueue? = nil, progressHandler: @escaping (Int64, Int64, Int64) -> Void = { _, _, _ in }, completionHandler: @escaping (Result<Request.Response, SessionTaskError>) -> Void = { _ in }) -> SessionTask? {
+    open func send<Request: APIKit.Request>(_ request: Request, callbackQueue: CallbackQueue? = nil, progressHandler: @escaping (Progress) -> Void = { _ in }, completionHandler: @escaping (Result<Request.Response, SessionTaskError>) -> Void = { _ in }) -> SessionTask? {
         let task = createSessionTask(request, callbackQueue: callbackQueue, progressHandler: progressHandler, completionHandler: completionHandler)
         task?.resume()
         return task
@@ -77,7 +77,7 @@ open class Session {
         }
     }
 
-    internal func createSessionTask<Request: APIKit.Request>(_ request: Request, callbackQueue: CallbackQueue?, progressHandler: @escaping (Int64, Int64, Int64) -> Void, completionHandler: @escaping (Result<Request.Response, SessionTaskError>) -> Void) -> SessionTask? {
+    internal func createSessionTask<Request: APIKit.Request>(_ request: Request, callbackQueue: CallbackQueue?, progressHandler: @escaping (Progress) -> Void, completionHandler: @escaping (Result<Request.Response, SessionTaskError>) -> Void) -> SessionTask? {
         let callbackQueue = callbackQueue ?? self.callbackQueue
         let urlRequest: URLRequest
         do {
@@ -90,8 +90,8 @@ open class Session {
         }
 
         let task = adapter.createTask(with: urlRequest,
-            progressHandler: { bytesSent, totalBytesSent, totalBytesExpectedToSend in
-                progressHandler(bytesSent, totalBytesSent, totalBytesExpectedToSend)
+            progressHandler: { progress in
+                progressHandler(progress)
             },
             completionHandler: { data, urlResponse, error in
                 let result: Result<Request.Response, SessionTaskError>

Sources/APIKit/SessionAdapter/SessionAdapter.swift

@@ -11,7 +11,7 @@ public protocol SessionTask: AnyObject {
 /// with `Session`.
 public protocol SessionAdapter {
     /// Returns instance that conforms to `SessionTask`. `handler` must be called after success or failure.
-    func createTask(with URLRequest: URLRequest, progressHandler: @escaping (Int64, Int64, Int64) -> Void, completionHandler: @escaping (Data?, URLResponse?, Error?) -> Void) -> SessionTask
+    func createTask(with URLRequest: URLRequest, progressHandler: @escaping (Progress) -> Void, completionHandler: @escaping (Data?, URLResponse?, Error?) -> Void) -> SessionTask
 
     /// Collects tasks from backend networking stack. `handler` must be called after collecting.
     func getTasks(with handler: @escaping ([SessionTask]) -> Void)

Sources/APIKit/SessionAdapter/URLSessionAdapter.swift

@@ -26,7 +26,7 @@ open class URLSessionAdapter: NSObject, SessionAdapter, URLSessionDelegate, URLS
     }
 
     /// Creates `URLSessionDataTask` instance using `dataTaskWithRequest(_:completionHandler:)`.
-    open func createTask(with URLRequest: URLRequest, progressHandler: @escaping (Int64, Int64, Int64) -> Void, completionHandler: @escaping (Data?, URLResponse?, Error?) -> Void) -> SessionTask {
+    open func createTask(with URLRequest: URLRequest, progressHandler: @escaping (Progress) -> Void, completionHandler: @escaping (Data?, URLResponse?, Error?) -> Void) -> SessionTask {
         let task = urlSession.dataTask(with: URLRequest)
 
         setBuffer(NSMutableData(), forTask: task)
@@ -60,13 +60,14 @@ open class URLSessionAdapter: NSObject, SessionAdapter, URLSessionDelegate, URLS
         return objc_getAssociatedObject(task, &taskAssociatedObjectCompletionHandlerKey) as? (Data?, URLResponse?, Error?) -> Void
     }
 
-    private func setProgressHandler(_ progressHandler: @escaping (Int64, Int64, Int64) -> Void, forTask task: URLSessionTask) {
+    private func setProgressHandler(_ progressHandler: @escaping (Progress) -> Void, forTask task: URLSessionTask) {
         objc_setAssociatedObject(task, &taskAssociatedObjectProgressHandlerKey, progressHandler as Any, .OBJC_ASSOCIATION_RETAIN_NONATOMIC)
     }
 
-    private func progressHandler(for task: URLSessionTask) -> ((Int64, Int64, Int64) -> Void)? {
-        return objc_getAssociatedObject(task, &taskAssociatedObjectProgressHandlerKey) as? (Int64, Int64, Int64) -> Void
+    private func progressHandler(for task: URLSessionTask) -> ((Progress) -> Void)? {
+        return objc_getAssociatedObject(task, &taskAssociatedObjectProgressHandlerKey) as? (Progress) -> Void
     }
+
     // MARK: URLSessionTaskDelegate
     open func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
         handler(for: task)?(buffer(for: task) as Data?, task.response, error)
@@ -79,6 +80,8 @@ open class URLSessionAdapter: NSObject, SessionAdapter, URLSessionDelegate, URLS
 
     // MARK: URLSessionDataDelegate
     open func urlSession(_ session: URLSession, task: URLSessionTask, didSendBodyData bytesSent: Int64, totalBytesSent: Int64, totalBytesExpectedToSend: Int64) {
-        progressHandler(for: task)?(bytesSent, totalBytesSent, totalBytesExpectedToSend)
+        let progress = Progress(totalUnitCount: totalBytesExpectedToSend)
+        progress.completedUnitCount = totalBytesSent
+        progressHandler(for: task)?(progress)
     }
 }

Tests/APIKitTests/SessionAdapterType/URLSessionAdapterSubclassTests.swift

@@ -64,7 +64,7 @@ class URLSessionAdapterSubclassTests: XCTestCase {
         let adapter = SessionAdapter(configuration: configuration)
         let session = Session(adapter: adapter)
 
-        session.send(request, progressHandler: { _, _, _ in
+        session.send(request, progressHandler: { _ in
             expectation.fulfill()
         })
 

Tests/APIKitTests/SessionTests.swift

@@ -225,10 +225,8 @@ class SessionTests: XCTestCase {
         let expectation = self.expectation(description: "wait for response")
         let request = TestRequest(method: .post)
 
-        session.send(request, progressHandler: { bytesSent, totalBytesSent, totalBytesExpectedToSend in
-            XCTAssertNotNil(bytesSent)
-            XCTAssertNotNil(totalBytesSent)
-            XCTAssertNotNil(totalBytesExpectedToSend)
+        session.send(request, progressHandler: { progress in
+            XCTAssertNotNil(progress)
             expectation.fulfill()
         })
 
@@ -250,7 +248,7 @@ class SessionTests: XCTestCase {
                 return testSesssion
             }
 
-            override func send<Request: APIKit.Request>(_ request: Request, callbackQueue: CallbackQueue?, progressHandler: @escaping (Int64, Int64, Int64) -> Void, completionHandler: @escaping (Result<Request.Response, SessionTaskError>) -> Void) -> SessionTask? {
+            override func send<Request: APIKit.Request>(_ request: Request, callbackQueue: CallbackQueue?, progressHandler: @escaping (Progress) -> Void, completionHandler: @escaping (Result<Request.Response, SessionTaskError>) -> Void) -> SessionTask? {
 
                 functionCallFlags[(#function)] = true
                 return super.send(request)

Tests/APIKitTests/TestComponents/TestSessionAdapter.swift

@@ -42,15 +42,15 @@ class TestSessionAdapter: SessionAdapter {
             if task.cancelled {
                 task.completionHandler(nil, nil, Error.cancelled)
             } else {
-                task.progressHandler(1, 1, 1)
+                task.progressHandler(Progress(totalUnitCount: 1))
                 task.completionHandler(data, urlResponse, error)
             }
         }
 
         tasks = []
     }
 
-    func createTask(with URLRequest: URLRequest, progressHandler: @escaping (Int64, Int64, Int64) -> Void, completionHandler: @escaping (Data?, URLResponse?, Swift.Error?) -> Void) -> SessionTask {
+    func createTask(with URLRequest: URLRequest, progressHandler: @escaping (Progress) -> Void, completionHandler: @escaping (Data?, URLResponse?, Swift.Error?) -> Void) -> SessionTask {
         let task = TestSessionTask(progressHandler: progressHandler, completionHandler: completionHandler)
         tasks.append(task)
 

Tests/APIKitTests/TestComponents/TestSessionTask.swift

@@ -4,10 +4,10 @@ import APIKit
 class TestSessionTask: SessionTask {
 
     var completionHandler: (Data?, URLResponse?, Error?) -> Void
-    var progressHandler: (Int64, Int64, Int64) -> Void
+    var progressHandler: (Progress) -> Void
     var cancelled = false
 
-    init(progressHandler: @escaping  (Int64, Int64, Int64) -> Void, completionHandler: @escaping (Data?, URLResponse?, Error?) -> Void) {
+    init(progressHandler: @escaping  (Progress) -> Void, completionHandler: @escaping (Data?, URLResponse?, Error?) -> Void) {
         self.completionHandler = completionHandler
         self.progressHandler = progressHandler
     }