feat: Add invalid struct error (#238)

* new: allow for custom error codes from Parse Cloud

* Update APICommandTests.swift

* Update ParseError.swift

* fix lint

* Decode parse otherCode error and add tests

* Update Sources/ParseSwift/Types/ParseError.swift

Co-authored-by: Tom Fox <[email protected]>

* add guard

* Update Sources/ParseSwift/Types/ParseError.swift

Co-authored-by: Corey <[email protected]>

* Update Tests/ParseSwiftTests/ParseErrorTests.swift

Co-authored-by: Corey <[email protected]>

* Update CHANGELOG.md

* add invalid struct

* change line length

* Update URLSession+extensions.swift

* change line length

* Update ParseError.swift

* fix lint

* Revert "fix lint"

This reverts commit 889b3af.

* fix lint

* make changes

* remove invalid struct

* Update URLSession+extensions.swift

* Update ParseQueryTests.swift

* Update ParseQueryTests.swift

* revert changes

* Update ParseErrorTests.swift

* Update ParseQueryTests.swift

* update podspec and change log

* remove localized error

Co-authored-by: Corey <[email protected]>
Co-authored-by: Tom Fox <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -9,6 +9,7 @@
 
 __Improvements__
 - Added `operation` for `set` and `forceSet`, used for single key updates ([#248](https://github.com/parse-community/Parse-Swift/pull/248)), thanks to [Daniel Blyth](https://github.com/dblythy) and [Corey Baker](https://github.com/cbaker6).
+- Add more detail to invalid struct errors ([#238](https://github.com/parse-community/Parse-Swift/pull/238)), thanks to [Daniel Blyth](https://github.com/dblythy).
 
 ### 1.10.4
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.10.3...1.10.4)

ParseSwift.podtemplate

@@ -14,7 +14,7 @@ Pod::Spec.new do |s|
   s.osx.deployment_target = "10.13"
   s.tvos.deployment_target = "12.0"
   s.watchos.deployment_target = "5.0"
-  s.swift_versions = ['5.1', '5.2', '5.3', '5.4']
+  s.swift_versions = ['5.1', '5.2', '5.3', '5.4', '5.5']
   s.source_files = "Sources/ParseSwift/**/*.swift"
   s.license = {
     :type => "MIT",

Sources/ParseSwift/API/URLSession+extensions.swift

@@ -66,6 +66,11 @@ extension URLSession {
                           let json = try? JSONSerialization
                             .data(withJSONObject: responseData,
                               options: .prettyPrinted) else {
+                        let nsError = error as NSError
+                        if nsError.code == 4865,
+                          let description = nsError.userInfo["NSDebugDescription"] {
+                            return .failure(ParseError(code: .unknownError, message: "Invalid struct: \(description)"))
+                        }
                         return .failure(ParseError(code: .unknownError,
                                                    // swiftlint:disable:next line_length
                                                    message: "Error decoding parse-server response: \(response) with error: \(error.localizedDescription) Format: \(String(describing: String(data: responseData, encoding: .utf8)))"))

Sources/ParseSwift/Types/ParseError.swift

@@ -407,6 +407,13 @@ extension ParseError: CustomStringConvertible {
     }
 }
 
+// MARK: LocalizedError
+extension ParseError: LocalizedError {
+    public var errorDescription: String? {
+        debugDescription
+    }
+}
+
 // MARK: Compare Errors
 public extension Error {
 

Tests/ParseSwiftTests/ParseErrorTests.swift

@@ -46,6 +46,7 @@ class ParseErrorTests: XCTestCase {
         XCTAssertEqual(decoded.message, message)
         XCTAssertEqual(decoded.debugDescription, "ParseError code=\(code) error=\(message)")
         XCTAssertEqual(decoded.description, "ParseError code=\(code) error=\(message)")
+        XCTAssertEqual(decoded.errorDescription, "ParseError code=\(code) error=\(message)")
     }
 
     func testEncodeOther() throws {

Tests/ParseSwiftTests/ParseQueryTests.swift

@@ -726,6 +726,20 @@ class ParseQueryTests: XCTestCase { // swiftlint:disable:this type_body_length
         }
 
         let query = GameScore.query()
+        do {
+            _ = try query.first(options: [])
+            XCTFail("Should have thrown error")
+        } catch {
+            guard let error = error as? ParseError else {
+                XCTFail("Should have casted as ParseError")
+                return
+            }
+            #if !os(Linux) && !os(Android)
+            // swiftlint:disable:next line_length
+            XCTAssertEqual(error.message, "Invalid struct: No value associated with key CodingKeys(stringValue: \"score\", intValue: nil) (\"score\").")
+            XCTAssertEqual(error.code, .unknownError)
+            #endif
+        }
         XCTAssertThrowsError(try query.first(options: []))
     }