Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add additional debugging info when JSON decoding fails #21

Closed
wants to merge 1 commit into from
Closed

Add additional debugging info when JSON decoding fails #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 47 additions & 10 deletions Sources/GraphQLMap.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,34 +19,54 @@ public struct GraphQLMap {
}

public func value<T>(forKey key: String, decoder: JSONDecoder<T>) throws -> T {
return try decoder(jsonValue(forKey: key))
do {
return try decoder(jsonValue(forKey: key))
} catch let error as JSONDecodingError {
throw GraphQLMapDecodingError(error: error, key: key, localizedJson: jsonObject)
}
}

public func value<T: JSONDecodable>(forKey key: String) throws -> T {
return try value(forKey: key, decoder: T.init(jsonValue:))
do {
return try value(forKey: key, decoder: T.init(jsonValue:))
} catch let error as JSONDecodingError {
throw GraphQLMapDecodingError(error: error, key: key, localizedJson: jsonObject)
}
}

public func optionalValue<T: JSONDecodable>(forKey key: String) throws -> T? {
guard let jsonValue = optionalJSONValue(forKey: key) else { return nil }
return try Optional<T>.init(jsonValue: jsonValue)
do {
return try Optional<T>.init(jsonValue: jsonValue)
} catch let error as JSONDecodingError {
throw GraphQLMapDecodingError(error: error, key: key, localizedJson: jsonObject)
}
}

public func list<T>(forKey key: String, decoder: JSONDecoder<T>) throws -> [T] {
let value = try jsonValue(forKey: key)
guard let array = value as? JSONArray else {
throw JSONDecodingError.couldNotConvert(value: value, to: JSONArray.self)
do {
let value = try jsonValue(forKey: key)
guard let array = value as? JSONArray else {
throw JSONDecodingError.couldNotConvert(value: value, to: JSONArray.self)
}
return try array.map { try decoder($0) }
} catch let error as JSONDecodingError {
throw GraphQLMapDecodingError(error: error, key: key, localizedJson: jsonObject)
}
return try array.map { try decoder($0) }
}

public func optionalList<T>(forKey key: String, decoder: JSONDecoder<T>) throws -> [T]? {
guard let value = optionalJSONValue(forKey: key) else { return nil }
if value is NSNull { return nil }

guard let array = value as? JSONArray else {
throw JSONDecodingError.couldNotConvert(value: value, to: JSONArray.self)
do {
guard let array = value as? JSONArray else {
throw JSONDecodingError.couldNotConvert(value: value, to: JSONArray.self)
}
return try array.map { try decoder($0) }
} catch let error as JSONDecodingError {
throw GraphQLMapDecodingError(error: error, key: key, localizedJson: jsonObject)
}
return try array.map { try decoder($0) }
}

public func list<T: JSONDecodable>(forKey key: String) throws -> [T] {
Expand Down Expand Up @@ -146,3 +166,20 @@ public extension GraphQLMapEncodable {
return graphQLMap.jsonValue
}
}

public struct GraphQLMapDecodingError: Error, LocalizedError {

public let jsonDecodingError: JSONDecodingError
public let localizedJson: JSONObject
public let key: String

init(error: JSONDecodingError, key: String, localizedJson: JSONObject) {
self.jsonDecodingError = error
self.localizedJson = localizedJson
self.key = key
}

public var errorDescription: String? {
return jsonDecodingError.errorDescription
}
}
30 changes: 20 additions & 10 deletions Tests/ApolloTests/GraphQLMapDecodingTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ class GraphQLMapDecodingTests: XCTestCase {
let map = GraphQLMap(jsonObject: [:])

XCTAssertThrowsError(try with(returnType: String.self, map.value(forKey: "name"))) { (error) in
if case JSONDecodingError.missingValue(let key) = error {
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.missingValue(let key) = error.jsonDecodingError {
XCTAssertEqual(key, "name")
} else {
XCTFail("Unexpected error: \(error)")
Expand All @@ -55,7 +56,8 @@ class GraphQLMapDecodingTests: XCTestCase {
let map = GraphQLMap(jsonObject: ["name": NSNull()])

XCTAssertThrowsError(try with(returnType: String.self, map.value(forKey: "name"))) { (error) in
if case JSONDecodingError.couldNotConvert(let value, let expectedType) = error {
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.couldNotConvert(let value, let expectedType) = error.jsonDecodingError {
XCTAssertEqual(value as? NSNull, NSNull())
XCTAssertTrue(expectedType == String.self)
} else {
Expand All @@ -68,7 +70,8 @@ class GraphQLMapDecodingTests: XCTestCase {
let map = GraphQLMap(jsonObject: ["name": 10])

XCTAssertThrowsError(try with(returnType: String.self, map.value(forKey: "name"))) { (error) in
if case JSONDecodingError.couldNotConvert(let value, let expectedType) = error {
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.couldNotConvert(let value, let expectedType) = error.jsonDecodingError {
XCTAssertEqual(value as? Int, 10)
XCTAssertTrue(expectedType == String.self)
} else {
Expand Down Expand Up @@ -99,7 +102,8 @@ class GraphQLMapDecodingTests: XCTestCase {
let map = GraphQLMap(jsonObject: ["name": 10])

XCTAssertThrowsError(try with(returnType: Optional<String>.self, map.optionalValue(forKey: "name"))) { (error) in
if case JSONDecodingError.couldNotConvert(let value, let expectedType) = error {
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.couldNotConvert(let value, let expectedType) = error.jsonDecodingError {
XCTAssertEqual(value as? Int, 10)
XCTAssertTrue(expectedType == String.self)
} else {
Expand All @@ -118,7 +122,8 @@ class GraphQLMapDecodingTests: XCTestCase {
let map = GraphQLMap(jsonObject: [:])

XCTAssertThrowsError(try with(returnType: Array<Episode>.self, map.list(forKey: "appearsIn"))) { (error) in
if case JSONDecodingError.missingValue(let key) = error {
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.missingValue(let key) = error.jsonDecodingError {
XCTAssertEqual(key, "appearsIn")
} else {
XCTFail("Unexpected error: \(error)")
Expand All @@ -130,7 +135,8 @@ class GraphQLMapDecodingTests: XCTestCase {
let map = GraphQLMap(jsonObject: ["appearsIn": NSNull()])

XCTAssertThrowsError(try with(returnType: Array<Episode>.self, map.list(forKey: "appearsIn"))) { (error) in
if case JSONDecodingError.couldNotConvert(let value, _) = error {
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.couldNotConvert(let value, _) = error.jsonDecodingError {
XCTAssertEqual(value as? NSNull, NSNull())
} else {
XCTFail("Unexpected error: \(error)")
Expand All @@ -142,9 +148,11 @@ class GraphQLMapDecodingTests: XCTestCase {
let map = GraphQLMap(jsonObject: ["appearsIn": [4, 5, 6]])

XCTAssertThrowsError(try with(returnType: Array<Episode>.self, map.list(forKey: "appearsIn"))) { (error) in
guard case JSONDecodingError.couldNotConvert = error else {
XCTFail("Unexpected error: \(error)")
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.couldNotConvert = error.jsonDecodingError {
return
} else {
XCTFail("Unexpected error: \(error)")
}
}
}
Expand All @@ -171,9 +179,11 @@ class GraphQLMapDecodingTests: XCTestCase {
let map = GraphQLMap(jsonObject: ["appearsIn": [4, 5, 6]])

XCTAssertThrowsError(try with(returnType: Optional<Array<Episode>>.self, map.list(forKey: "appearsIn"))) { (error) in
guard case JSONDecodingError.couldNotConvert = error else {
XCTFail("Unexpected error: \(error)")
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.couldNotConvert = error.jsonDecodingError {
return
} else {
XCTFail("Unexpected error: \(error)")
}
}
}
Expand Down
9 changes: 6 additions & 3 deletions Tests/ApolloTests/ParseQueryResultDataTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ class ParseQueryResultDataTests: XCTestCase {
let query = HeroNameQuery()

XCTAssertThrowsError(try query.parse(data: data)) { error in
if case JSONDecodingError.missingValue(let key) = error {
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.missingValue(let key) = error.jsonDecodingError {
XCTAssertEqual(key, "name")
} else {
XCTFail("Unexpected error: \(error)")
Expand All @@ -53,7 +54,8 @@ class ParseQueryResultDataTests: XCTestCase {
let query = HeroNameQuery()

XCTAssertThrowsError(try query.parse(data: data)) { error in
if case JSONDecodingError.couldNotConvert(let value, let expectedType) = error {
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.couldNotConvert(let value, let expectedType) = error.jsonDecodingError {
XCTAssertEqual(value as? Int, 10)
XCTAssertTrue(expectedType == String.self)
} else {
Expand Down Expand Up @@ -145,7 +147,8 @@ class ParseQueryResultDataTests: XCTestCase {
let query = HeroDetailsQuery(episode: .empire)

XCTAssertThrowsError(try query.parse(data: data)) { error in
if case JSONDecodingError.missingValue(let key) = error {
if let error = error as? GraphQLMapDecodingError,
case JSONDecodingError.missingValue(let key) = error.jsonDecodingError {
XCTAssertEqual(key, "__typename")
} else {
XCTFail("Unexpected error: \(error)")
Expand Down