[v11] Storage Error Handling Consistency

[paulb777]

Fix #13071 Fix #10889

Storage Error handling was a mix of Swift error and NSError generation. With this PR, all errors are created as Swift errors and thanks to CustomNSError, NSError's are generated as needed from the Swift error enum.

• All Objective C/NSError handling should remain the same from a public API perspective
• Some of the Swift error enums have additional fields to have enough information to support the corresponding NSError and to provide useful information to Swift error enum users. This is most commonly information about underlying server errors.
• Additional error codes are added to provide NSError code mapping for errors that were introduced only in Swift after the Swift implementation transition.

Internal API review at go/storage-error-handling

[github-actions]

Apple API Diff Report

Commit: 25292a7
Last updated: Thu Jun 13 12:34 PDT 2024
View workflow logs & download artifacts

---

FirebaseStorage

Enumerations

[MODIFIED] StorageError

[MODIFIED] StorageError

Swift:
+  public enum StorageError : Error , CustomNSError
-  public enum StorageError : Error
+    case unauthenticated ( serverError : [ String : Any ])
+    case unauthorized ( bucket : String , object : String , serverError : [ String : Any ])
-    case objectNotFound ( String )
-    case bucketMismatch ( String )
-    case internalError ( String )
+    public var errorCode : Int { get }
+    case objectNotFound ( object : String , serverError : [ String : Any ])
+    case bucketMismatch ( message : String )
-    case bucketNotFound ( String )
-    case downloadSizeExceeded ( Int64 , Int64 )
+    public var errorUserInfo : [ String : Any ] { get }
-    case unauthorized ( String , String )
+    case downloadSizeExceeded ( total : Int64 , maxSize : Int64 )
-    case unknown ( String )
-    case invalidArgument ( String )
+    case quotaExceeded ( bucket : String , serverError : [ String : Any ])
+    case invalidArgument ( message : String )
+    case internalError ( message : String )
+    case unknown ( message : String , serverError : [ String : Any ])
+    case pathError ( message : String )
+    public static var errorDomain : String { get }
+    case bucketNotFound ( bucket : String )
-    case quotaExceeded ( String )
-    case pathError ( String )
+    case projectNotFound ( project : String )
-    case projectNotFound ( String )
-    case unauthenticated

StorageErrorCode

[ADDED] bucketMismatch

Swift:
+  case bucketMismatch = - 13051

[ADDED] internalError

Swift:
+  case internalError = - 13052

[ADDED] pathError

Swift:
+  case pathError = - 13053

---

[paulb777]

Going to merge it here - and will make any adjustments from the API review in later PRs