File error delegate method now includes an optional file error

.swift-version

@@ -0,0 +1 @@
+6.2.0

README.md

@@ -39,33 +39,33 @@ You can conform to the `TUSClientDelegate` to receive updates from the `TUSClien
 
 ```swift
 extension MyClass: TUSClientDelegate {
-    func didStartUpload(id: UUID, client: TUSClient) {
+    func didStartUpload(id: UUID, context: [String: String]?, client: TUSClient) {
         print("TUSClient started upload, id is \(id)")
         print("TUSClient remaining is \(client.remainingUploads)")
     }
 
-    func didFinishUpload(id: UUID, url: URL, client: TUSClient) {
+    func didFinishUpload(id: UUID, url: URL, context: [String: String]?, client: TUSClient) {
         print("TUSClient finished upload, id is \(id) url is \(url)")
         print("TUSClient remaining is \(client.remainingUploads)")
         if client.remainingUploads == 0 {
             print("Finished uploading")
         }
     }
 
-    func uploadFailed(id: UUID, error: Error, client: TUSClient) {
+    func uploadFailed(id: UUID, error: Error, context: [String: String]?, client: TUSClient) {
         print("TUSClient upload failed for \(id) error \(error)")
     }
 
-    func fileError(error: TUSClientError, client: TUSClient) {
-        print("TUSClient File error \(error)")
+    func fileError(id: UUID?, error: TUSClientError, client: TUSClient) {
+        print("TUSClient File error \(error) for id \(id?.uuidString ?? "unknown")")
     }
 
 
     func totalProgress(bytesUploaded: Int, totalBytes: Int, client: TUSClient) {
     }
 
 
-    func progressFor(id: UUID, bytesUploaded: Int, totalBytes: Int, client: TUSClient) {
+    func progressFor(id: UUID, context: [String: String]?, bytesUploaded: Int, totalBytes: Int, client: TUSClient) {
 
     }
 

Sources/TUSKit/TUSClient.swift

@@ -22,6 +22,10 @@ public protocol TUSClientDelegate: AnyObject {
 
     /// Receive an error related to files. E.g. The `TUSClient` couldn't store a file or remove a file.
     func fileError(error: TUSClientError, client: TUSClient)
+    /// Receive an error related to files. E.g. The `TUSClient` couldn't store a file or remove a file.
+    /// - Parameters:
+    ///   - id: The upload identifier related to the error when available, otherwise nil.
+    func fileError(id: UUID?, error: TUSClientError, client: TUSClient)
 
     /// Get the progress of all ongoing uploads combined
     ///
@@ -40,6 +44,10 @@ public extension TUSClientDelegate {
     func progressFor(id: UUID, context: [String: String]?, progress: Float, client: TUSClient) {
         // Optional
     }
+
+    func fileError(id: UUID?, error: TUSClientError, client: TUSClient) {
+        fileError(error: error, client: client)
+    }
 }
 
 protocol ProgressDelegate: AnyObject {
@@ -499,7 +507,7 @@ public final class TUSClient {
         } catch let error {
             let tusError = TUSClientError.couldnotRemoveFinishedUploads(underlyingError: error)
             reportingQueue.async {
-                self.delegate?.fileError(error: tusError , client: self)
+                self.delegate?.fileError(id: nil, error: tusError , client: self)
             }
         }
     }
@@ -618,7 +626,7 @@ public final class TUSClient {
         } catch (let error) {
             let tusError = TUSClientError.couldNotLoadData(underlyingError: error)
             reportingQueue.async {
-                self.delegate?.fileError(error: tusError, client: self)
+                self.delegate?.fileError(id: nil, error: tusError, client: self)
             }
             return []
         }
@@ -672,7 +680,7 @@ extension TUSClient: SchedulerDelegate {
         } catch let error {
             let tusError = TUSClientError.couldNotDeleteFile(underlyingError: error)
             reportingQueue.async {
-                self.delegate?.fileError(error: tusError, client: self)
+                self.delegate?.fileError(id: uploadTask.metaData.id, error: tusError, client: self)
             }
         }
 
@@ -733,7 +741,7 @@ extension TUSClient: SchedulerDelegate {
         } catch let error {
             let tusError = TUSClientError.couldNotStoreFileMetadata(underlyingError: error)
             reportingQueue.async {
-                self.delegate?.fileError(error: tusError, client: self)
+                self.delegate?.fileError(id: metaData.id, error: tusError, client: self)
             }
         }
 
@@ -823,4 +831,3 @@ private extension URL {
         return "application/octet-stream"
     }
 }
-

TUSKitExample/TUSKitExample/Helpers/TUSWrapper.swift

@@ -123,7 +123,7 @@ extension TUSWrapper: TUSClientDelegate {
         }
     }
 
-    func fileError(error: TUSClientError, client: TUSClient) { }
+    func fileError(id: UUID?, error: TUSClientError, client: TUSClient) { }
     func totalProgress(bytesUploaded: Int, totalBytes: Int, client: TUSClient) {
         print("total progress: \(bytesUploaded) / \(totalBytes) => \(Int(Double(bytesUploaded) / Double(totalBytes) * 100))%")
     }

Tests/TUSKitTests/Mocks.swift

@@ -15,6 +15,7 @@ final class TUSMockDelegate: TUSClientDelegate {
     var startedUploads = [UUID]()
     var finishedUploads = [(UUID, URL)]()
     var failedUploads = [(UUID, Error)]()
+    var fileErrorsWithIds = [(UUID?, TUSClientError)]()
     var fileErrors = [TUSClientError]()
     var progressPerId = [UUID: Int]()
     var totalProgressReceived = [Int]()
@@ -49,6 +50,11 @@ final class TUSMockDelegate: TUSClientDelegate {
         fileErrorExpectation?.fulfill()
     }
 
+    func fileError(id: UUID?, error: TUSClientError, client: TUSClient) {
+        fileErrorsWithIds.append((id, error))
+        fileError(error: error, client: client)
+    }
+
     func uploadFailed(id: UUID, error: Error, context: [String : String]?, client: TUSClient) {
         failedUploads.append((id, error))
         uploadFailedExpectation?.fulfill()
@@ -142,4 +148,3 @@ final class MockURLProtocol: URLProtocol {
         // This is called if the request gets canceled or completed.
     }
 }
-

Tests/TUSKitTests/TUSClient/TUSClientInternalTests.swift

@@ -89,4 +89,38 @@ final class TUSClientInternalTests: XCTestCase {
         contents = try FileManager.default.contentsOfDirectory(at: fullStoragePath, includingPropertiesForKeys: nil)
         XCTAssertFalse(contents.isEmpty, "The client is expected to NOT remove finished uploads on startup")
     }
+
+    func testFileErrorIncludesIdWhenStoringMetadataFails() throws {
+        let failingId = UUID()
+        let missingFilePath = fullStoragePath.appendingPathComponent(failingId.uuidString)
+        try? FileManager.default.removeItem(at: missingFilePath)
+
+        let metaData = UploadMetadata(id: failingId,
+                                      filePath: missingFilePath,
+                                      uploadURL: URL(string: "https://tus.example.com/files")!,
+                                      size: 10,
+                                      customHeaders: [:],
+                                      mimeType: nil)
+        let creationTask = try CreationTask(metaData: metaData,
+                                            api: TUSAPI(session: URLSession(configuration: .ephemeral)),
+                                            files: files)
+
+        let scheduler = Scheduler()
+        let expectation = expectation(description: "delegate receives file error with id")
+        tusDelegate.fileErrorExpectation = expectation
+
+        client.onError(error: TUSClientError.couldNotStoreFileMetadata(underlyingError: FilesError.relatedFileNotFound),
+                       task: creationTask,
+                       scheduler: scheduler)
+
+        waitForExpectations(timeout: 1)
+
+        XCTAssertEqual(tusDelegate.fileErrorsWithIds.count, 1)
+        XCTAssertEqual(tusDelegate.fileErrorsWithIds.first?.0, failingId)
+        if case .couldNotStoreFileMetadata = tusDelegate.fileErrorsWithIds.first?.1 {
+            // Expected error
+        } else {
+            XCTFail("Expected a couldNotStoreFileMetadata error")
+        }
+    }
 }