Skip to content

Better error message reporting for includes and add localizedDescription #85

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

Closed
mlomeli wants to merge 2 commits into from
Closed

Better error message reporting for includes and add localizedDescription #85

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
402bdee
Better error message reporting for includes and add localizedDescription
mlomeli Sep 19, 2020
9bdbf98
Merge branch 'master' into master
mlomeli Sep 19, 2020
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
21 changes: 15 additions & 6 deletions Sources/JSONAPI/Document/DocumentDecodingError.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
//
// Created by Mathew Polzin on 10/20/19.
//
import Foundation

public enum DocumentDecodingError: Swift.Error, Equatable {
case primaryResource(error: ResourceObjectDecodingError, idx: Int?)
case primaryResourceMissing
case primaryResourcesMissing

case includes(error: IncludesDecodingError)
case includes(error: IncludesDecodingError, idx: Int?)

case foundErrorDocumentWhenExpectingSuccess
case foundSuccessDocumentWhenExpectingError
Expand All @@ -24,7 +25,7 @@ public enum DocumentDecodingError: Swift.Error, Equatable {
}

init(_ decodingError: IncludesDecodingError) {
self = .includes(error: decodingError)
self = .includes(error: decodingError, idx: decodingError.idx)
}

init?(_ decodingError: DecodingError) {
Expand All @@ -50,7 +51,7 @@ public enum DocumentDecodingError: Swift.Error, Equatable {
}
}

extension DocumentDecodingError: CustomStringConvertible {
extension DocumentDecodingError: LocalizedError, CustomStringConvertible {
public var description: String {
switch self {
case .primaryResource(error: let error, idx: let idx):
Expand All @@ -60,14 +61,22 @@ extension DocumentDecodingError: CustomStringConvertible {
return "Primary Resource missing."
case .primaryResourcesMissing:
return "Primary Resources array missing."

case .includes(error: let error):
case .includes(error: let error, let idx):
if let index = idx,
let documentError = error.error as? IncludeDecodingError,
documentError.failures.indices.contains(index-1) {
let failure = documentError.failures[index-1]
return "Include Resource\(index) failed to parse because of \(failure)"
}
return "\(error)"

case .foundErrorDocumentWhenExpectingSuccess:
return "Expected a success document with a 'data' property but found an error document."
case .foundSuccessDocumentWhenExpectingError:
return "Expected an error document but found a success document with a 'data' property."
}
}
//No localization support. But matches the error description
public var errorDescription: String? {
return description
}
}