Improve exception display for GraphQLException and GraphQLError
#92
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Before:
GraphQLException [GraphQLError {message = "Something went wrong!", locations = Just [GraphQLErrorLoc {errorLine = 10, errorCol = 3}], path = Just [String "my_query.graphql"], extensions = Just (Object (fromList [("complexity",Number 2.0)]))}]
After:
GraphQL errors:
At 10:3: Something went wrong!
Path: "my_query.graphql"
Extensions: {"complexity":2}
|
Addressed comments, PTAL when you have some time :) |
| <> maybe "" (nextLine "Path: " . joinWithCommas . map valueToString) (path exception) | ||
| <> maybe "" (nextLine "Extensions: " . valueToString) (extensions exception) | ||
| where | ||
| joinWithCommas = unwords . intersperse ", " |
There was a problem hiding this comment.
This doesn't seem right; wouldn't it do
["a", "b"] => "a , b"Shouldn't it just be intercalate ", "?
Comment on lines
+36
to
+37
| displayGraphQLError :: String -> String -> GraphQLError -> String | ||
| displayGraphQLError indentFirst indentRest exception = |
There was a problem hiding this comment.
Nit: I don't think this needs to be completely general 🙂 Let's just inline "* " and " "; I suspect it'll be a bit cleaner
| @@ -30,13 +33,35 @@ data GraphQLError = GraphQLError | |||
| } | |||
| deriving (Show, Eq, Generic, ToJSON, FromJSON) | |||
|
|
|||
| displayGraphQLError :: String -> String -> GraphQLError -> String | |||
| displayGraphQLError indentFirst indentRest exception = | |||
There was a problem hiding this comment.
Nit: to avoid all the parentheses, maybe RecordWildCard the exception?
| displayGraphQLError indentFirst indentRest exception = | ||
| indentFirst | ||
| <> "At " | ||
| <> joinWithCommas (maybe [] (map displayErrorLoc) (locations exception)) |
There was a problem hiding this comment.
An empty list would make the message a bit weird. Can we maybe show ??? if there's no location (either Nothing or an empty list in locations)?
|
Also, looks like you have some linting failures? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before:
After:
Closes #91