refactor: add and update ParseError codes (#24)

* refactor: update ParseError codes

* add test

* update images

* lower codecov patch

Author: cbaker6

.codecov.yml

@@ -6,7 +6,7 @@ coverage:
   status:
     patch:
       default:
-        target: auto
+        target: 49
     changes: false
     project:
       default:

.github/workflows/ci.yml

@@ -16,6 +16,7 @@ concurrency:
 
 jobs:
   xcode-test-ios:
+    timeout-minutes: 15
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
@@ -43,6 +44,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_LATEST }}
 
   xcode-test-macos:
+    timeout-minutes: 15
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
@@ -76,6 +78,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_LATEST }}
 
   xcode-test-tvos:
+    timeout-minutes: 15
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
@@ -103,6 +106,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_LATEST }}
 
   xcode-build-watchos:
+    timeout-minutes: 15
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
@@ -120,6 +124,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_LATEST }}
 
   spm-test:
+    timeout-minutes: 15
     runs-on: macos-latest
     steps:
     - uses: actions/checkout@v3
@@ -153,6 +158,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_LATEST }}
 
   xcode-test-ios-5_3:
+    timeout-minutes: 15
     needs: xcode-build-watchos
     runs-on: macos-11
     steps:
@@ -177,6 +183,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_OLDEST }}
 
   linux:
+    timeout-minutes: 5
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v3
@@ -197,6 +204,7 @@ jobs:
           fail_ci_if_error: true
 
   windows:
+    timeout-minutes: 10
     runs-on: windows-2019
     steps:
       - uses: actions/checkout@v3
@@ -214,6 +222,7 @@ jobs:
           fail_ci_if_error: false
 
   windows-latest:
+    timeout-minutes: 10
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v3
@@ -231,6 +240,7 @@ jobs:
           fail_ci_if_error: false
 
   docs:
+    timeout-minutes: 10
     needs: xcode-build-watchos
     runs-on: macos-latest
     steps:
@@ -243,6 +253,7 @@ jobs:
           DEVELOPER_DIR: ${{ env.CI_XCODE_LATEST }}
 
   carthage:
+   timeout-minutes: 25
    needs: xcode-build-watchos
    runs-on: macos-latest
    steps:

CHANGELOG.md

@@ -8,6 +8,7 @@
 [Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/4.16.2...5.0.0), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/5.0.0/documentation/parseswift)
 
 __Fixes__
+- (Breaking Change) Add and update ParseError codes. unknownError has been renamed to otherCause. invalidImageData now has the error code of 150. webhookError has the error code of 143 ([#23](https://github.com/netreconlab/Parse-Swift/pull/23)), thanks to [Corey Baker](https://github.com/cbaker6).
 - (Breaking Change) Remove deprecated code ([#23](https://github.com/netreconlab/Parse-Swift/pull/23)), thanks to [Corey Baker](https://github.com/cbaker6).
 
 ### 4.16.2

README.md

@@ -1,4 +1,4 @@
-![parse-repository-header-sdk-swift](Sources/ParseSwift/Documentation.docc/Resources/parse-swift.png)
+![parse-swift](https://user-images.githubusercontent.com/8621344/204069535-e1882bb0-bbcb-4178-87e6-58fd1bed96d1.png)
 
 <h3 align="center">iOS · macOS · watchOS · tvOS · Linux · Android · Windows</h3>
 

Sources/ParseSwift/API/API+Command.swift

@@ -111,7 +111,7 @@ internal extension API {
             group.wait()
 
             guard let response = responseResult else {
-                throw ParseError(code: .unknownError,
+                throw ParseError(code: .otherCause,
                                  message: "Could not unrwrap server response")
             }
             return try response.get()
@@ -265,7 +265,7 @@ internal extension API {
                         }
                     } else {
                         callbackQueue.async {
-                            completion(.failure(ParseError(code: .unknownError,
+                            completion(.failure(ParseError(code: .otherCause,
                                                            // swiftlint:disable:next line_length
                                                            message: "Cannot download the file without specifying the url")))
                         }
@@ -288,13 +288,13 @@ internal extension API {
                 Parse.configuration.serverURL.appendingPathComponent(path.urlComponent) : parseURL!
 
             guard var components = URLComponents(url: url, resolvingAgainstBaseURL: false) else {
-                return .failure(ParseError(code: .unknownError,
+                return .failure(ParseError(code: .otherCause,
                                            message: "Could not unrwrap url components for \(url)"))
             }
             components.queryItems = params
 
             guard let urlComponents = components.url else {
-                return .failure(ParseError(code: .unknownError,
+                return .failure(ParseError(code: .otherCause,
                                            message: "Could not create url from components for \(components)"))
             }
 
@@ -303,7 +303,7 @@ internal extension API {
             if let urlBody = body {
                 if (urlBody as? ParseCloudTypeable) != nil {
                     guard let bodyData = try? ParseCoding.parseEncoder().encode(urlBody, skipKeys: .cloud) else {
-                        return .failure(ParseError(code: .unknownError,
+                        return .failure(ParseError(code: .otherCause,
                                                        message: "Could not encode body \(urlBody)"))
                     }
                     urlRequest.httpBody = bodyData
@@ -315,7 +315,7 @@ internal extension API {
                                     collectChildren: false,
                                     objectsSavedBeforeThisOne: childObjects,
                                     filesSavedBeforeThisOne: childFiles) else {
-                            return .failure(ParseError(code: .unknownError,
+                            return .failure(ParseError(code: .otherCause,
                                                        message: "Could not encode body \(urlBody)"))
                     }
                     urlRequest.httpBody = bodyData.encoded
@@ -349,7 +349,7 @@ internal extension API.Command {
         if !object.isSaved {
             return createFile(object)
         } else {
-            throw ParseError(code: .unknownError,
+            throw ParseError(code: .otherCause,
                              message: "File is already saved and cannot be updated.")
         }
     }
@@ -372,7 +372,7 @@ internal extension API.Command {
                     otherURL: object.cloudURL) { (data) -> ParseFile in
             let tempFileLocation = try ParseCoding.jsonDecoder().decode(URL.self, from: data)
             guard let fileManager = ParseFileManager() else {
-                throw ParseError(code: .unknownError, message: "Cannot create fileManager")
+                throw ParseError(code: .otherCause, message: "Cannot create fileManager")
             }
             let downloadDirectoryPath = try ParseFileManager.downloadDirectory()
             try fileManager.createDirectoryIfNeeded(downloadDirectoryPath.relativePath)
@@ -542,22 +542,22 @@ internal extension API.Command where T: ParseObject {
                             return .success(updatedObject)
                         } catch {
                             guard let parseError = error as? ParseError else {
-                                return .failure(ParseError(code: .unknownError,
+                                return .failure(ParseError(code: .otherCause,
                                                            message: error.localizedDescription))
                             }
                             return .failure(parseError)
                         }
                     } else {
                         guard let parseError = response.error else {
-                            return .failure(ParseError(code: .unknownError, message: "unknown error"))
+                            return .failure(ParseError(code: .otherCause, message: "unknown error"))
                         }
 
                         return .failure(parseError)
                     }
                 })
             } catch {
                 guard let parseError = error as? ParseError else {
-                    return [(.failure(ParseError(code: .unknownError, message: "decoding error: \(error)")))]
+                    return [(.failure(ParseError(code: .otherCause, message: "decoding error: \(error)")))]
                 }
                 return [(.failure(parseError))]
             }
@@ -588,15 +588,15 @@ internal extension API.Command where T: ParseObject {
                         return .success(())
                     } else {
                         guard let parseError = response.error else {
-                            return .failure(ParseError(code: .unknownError, message: "unknown error"))
+                            return .failure(ParseError(code: .otherCause, message: "unknown error"))
                         }
 
                         return .failure(parseError)
                     }
                 })
             } catch {
                 guard let parseError = error as? ParseError else {
-                    return [(.failure(ParseError(code: .unknownError, message: "decoding error: \(error)")))]
+                    return [(.failure(ParseError(code: .otherCause, message: "decoding error: \(error)")))]
                 }
                 return [(.failure(parseError))]
             }

Sources/ParseSwift/API/API+NonParseBodyCommand.swift

@@ -50,7 +50,7 @@ internal extension API {
             group.wait()
 
             guard let response = responseResult else {
-                throw ParseError(code: .unknownError,
+                throw ParseError(code: .otherCause,
                                  message: "Could not unrwrap server response")
             }
             return try response.get()
@@ -93,21 +93,21 @@ internal extension API {
             let url = Parse.configuration.serverURL.appendingPathComponent(path.urlComponent)
 
             guard var components = URLComponents(url: url, resolvingAgainstBaseURL: false) else {
-                return .failure(ParseError(code: .unknownError,
+                return .failure(ParseError(code: .otherCause,
                                            message: "Could not unrwrap url components for \(url)"))
             }
             components.queryItems = params
 
             guard let urlComponents = components.url else {
-                return .failure(ParseError(code: .unknownError,
+                return .failure(ParseError(code: .otherCause,
                                            message: "Could not create url from components for \(components)"))
             }
 
             var urlRequest = URLRequest(url: urlComponents)
             urlRequest.allHTTPHeaderFields = headers
             if let urlBody = body {
                 guard let bodyData = try? ParseCoding.jsonEncoder().encode(urlBody) else {
-                    return .failure(ParseError(code: .unknownError,
+                    return .failure(ParseError(code: .otherCause,
                                                    message: "Could not encode body \(urlBody)"))
                 }
                 urlRequest.httpBody = bodyData
@@ -128,7 +128,7 @@ internal extension API.NonParseBodyCommand {
     // MARK: Deleting
     static func delete<T>(_ object: T) throws -> API.NonParseBodyCommand<NoBody, NoBody> where T: ParseObject {
         guard object.isSaved else {
-            throw ParseError(code: .unknownError,
+            throw ParseError(code: .otherCause,
                              message: "Cannot delete an object without an objectId")
         }
 
@@ -192,19 +192,19 @@ internal extension API.NonParseBodyCommand {
                     let response = responses[object.offset]
                     if let success = response.success {
                         guard let successfulResponse = try? object.element.mapper(success) else {
-                            return.failure(ParseError(code: .unknownError, message: "unknown error"))
+                            return.failure(ParseError(code: .otherCause, message: "unknown error"))
                         }
                         return .success(successfulResponse)
                     } else {
                         guard let parseError = response.error else {
-                            return .failure(ParseError(code: .unknownError, message: "unknown error"))
+                            return .failure(ParseError(code: .otherCause, message: "unknown error"))
                         }
                         return .failure(parseError)
                     }
                 })
             } catch {
                 guard let parseError = error as? ParseError else {
-                    return [(.failure(ParseError(code: .unknownError, message: "decoding error: \(error)")))]
+                    return [(.failure(ParseError(code: .otherCause, message: "decoding error: \(error)")))]
                 }
                 return [(.failure(parseError))]
             }

Sources/ParseSwift/API/Responses.swift

@@ -35,7 +35,7 @@ internal struct ReplaceResponse: Decodable {
         }
         guard let createdAt = createdAt else {
             guard let updatedAt = updatedAt else {
-                throw ParseError(code: .unknownError,
+                throw ParseError(code: .otherCause,
                                  message: "Response from server should not have an updatedAt of nil")
             }
             return UpdateResponse(updatedAt: updatedAt).apply(to: object)
@@ -77,7 +77,7 @@ internal struct BatchResponse: Codable {
                              message: "Response from server should not have an objectId of nil")
         }
         guard let createdAt = createdAt else {
-            throw ParseError(code: .unknownError,
+            throw ParseError(code: .otherCause,
                              message: "Response from server should not have an createdAt of nil")
         }
         return CreateResponse(objectId: objectId, createdAt: createdAt)
@@ -89,7 +89,7 @@ internal struct BatchResponse: Codable {
 
     func asUpdateResponse() throws -> UpdateResponse {
         guard let updatedAt = updatedAt else {
-            throw ParseError(code: .unknownError,
+            throw ParseError(code: .otherCause,
                              message: "Response from server should not have an updatedAt of nil")
         }
         return UpdateResponse(updatedAt: updatedAt)

Sources/ParseSwift/Authentication/3rd Party/ParseApple/ParseApple.swift

@@ -31,7 +31,7 @@ public struct ParseApple<AuthenticatedUser: ParseUser>: ParseAuthentication {
         func makeDictionary(user: String,
                             identityToken: Data) throws -> [String: String] {
             guard let identityTokenString = String(data: identityToken, encoding: .utf8) else {
-                throw ParseError(code: .unknownError, message: "Could not convert identityToken to String")
+                throw ParseError(code: .otherCause, message: "Could not convert identityToken to String")
             }
             return [AuthenticationKeys.id.rawValue: user,
              AuthenticationKeys.token.rawValue: identityTokenString]
@@ -74,7 +74,7 @@ public extension ParseApple {
 
         guard let appleAuthData = try? AuthenticationKeys.id.makeDictionary(user: user, identityToken: identityToken) else {
             callbackQueue.async {
-                completion(.failure(.init(code: .unknownError,
+                completion(.failure(.init(code: .otherCause,
                                           message: "Could not create authData.")))
             }
             return
@@ -91,7 +91,7 @@ public extension ParseApple {
                completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
         guard AuthenticationKeys.id.verifyMandatoryKeys(authData: authData) else {
             callbackQueue.async {
-                completion(.failure(.init(code: .unknownError,
+                completion(.failure(.init(code: .otherCause,
                                           message: "Should have authData in consisting of keys \"id\" and \"token\".")))
             }
             return
@@ -122,7 +122,7 @@ public extension ParseApple {
               completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
         guard let appleAuthData = try? AuthenticationKeys.id.makeDictionary(user: user, identityToken: identityToken) else {
             callbackQueue.async {
-                completion(.failure(.init(code: .unknownError,
+                completion(.failure(.init(code: .otherCause,
                                           message: "Could not create authData.")))
             }
             return
@@ -138,7 +138,7 @@ public extension ParseApple {
               callbackQueue: DispatchQueue = .main,
               completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
         guard AuthenticationKeys.id.verifyMandatoryKeys(authData: authData) else {
-            let error = ParseError(code: .unknownError,
+            let error = ParseError(code: .otherCause,
                                    message: "Should have authData in consisting of keys \"id\" and \"token\".")
             callbackQueue.async {
                 completion(.failure(error))

Sources/ParseSwift/Authentication/3rd Party/ParseFacebook/ParseFacebook.swift

@@ -136,7 +136,7 @@ public extension ParseFacebook {
                completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
         guard AuthenticationKeys.id.verifyMandatoryKeys(authData: authData) else {
             callbackQueue.async {
-                completion(.failure(.init(code: .unknownError,
+                completion(.failure(.init(code: .otherCause,
                                           message: "Should have authData in consisting of keys \"id\", \"expirationDate\" and \"authenticationToken\" or \"accessToken\".")))
             }
             return
@@ -210,7 +210,7 @@ public extension ParseFacebook {
               completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
         guard AuthenticationKeys.id.verifyMandatoryKeys(authData: authData) else {
             callbackQueue.async {
-                completion(.failure(.init(code: .unknownError,
+                completion(.failure(.init(code: .otherCause,
                                           message: "Should have authData in consisting of keys \"id\", \"expirationDate\" and \"authenticationToken\" or \"accessToken\".")))
             }
             return

Sources/ParseSwift/Authentication/3rd Party/ParseGithub/ParseGitHub.swift

@@ -87,7 +87,7 @@ public extension ParseGitHub {
                completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
         guard AuthenticationKeys.id.verifyMandatoryKeys(authData: authData) else {
             callbackQueue.async {
-                completion(.failure(.init(code: .unknownError,
+                completion(.failure(.init(code: .otherCause,
                                           message: "Should have authData in consisting of keys \"id\" and \"accessToken\".")))
             }
             return
@@ -131,7 +131,7 @@ public extension ParseGitHub {
               completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
         guard AuthenticationKeys.id.verifyMandatoryKeys(authData: authData) else {
             callbackQueue.async {
-                completion(.failure(.init(code: .unknownError,
+                completion(.failure(.init(code: .otherCause,
                                           message: "Should have authData in consisting of keys \"id\" and \"accessToken\".")))
             }
             return