Skip to content

Commit

Permalink
Improve text format error messages. (#148)
Browse files Browse the repository at this point in the history
- Include field names in type mismatch errors
- Quote field names in error messages

Example new output:
```
*** Exception: readMessageOrDie: Error parsing field "value": Type
mismatch: (BytesField,IntValue 3)
```
Compare to old output:
```
*** Exception: readMessageOrDie: Type mismatch: (BytesField,IntValue 3)
```
  • Loading branch information
judah authored and blackgnezdo committed Oct 1, 2017
1 parent 7f5dbeb commit 71025ad
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 11 deletions.
30 changes: 20 additions & 10 deletions proto-lens/src/Data/ProtoLens/TextFormat.hs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ module Data.ProtoLens.TextFormat(

import Lens.Family2 ((&),(^.),(.~), set, over, view)
import Control.Arrow (left)
import Data.Bifunctor (first)
import qualified Data.ByteString
import Data.Char (isPrint, isAscii, chr)
import Data.Foldable (foldlM, foldl')
Expand Down Expand Up @@ -237,10 +238,10 @@ buildMessageFromDescriptor
:: Message msg => Registry -> msg -> Parser.Message -> Either String msg
buildMessageFromDescriptor reg = foldlM (addField reg)

addField :: Message msg => Registry -> msg -> Parser.Field -> Either String msg
addField :: forall msg . Message msg => Registry -> msg -> Parser.Field -> Either String msg
addField reg msg (Parser.Field key rawValue) = do
FieldDescriptor _ typeDescriptor accessor <- getFieldDescriptor
value <- makeValue reg typeDescriptor rawValue
FieldDescriptor name typeDescriptor accessor <- getFieldDescriptor
value <- makeValue name reg typeDescriptor rawValue
return $ modifyField accessor value msg
where
getFieldDescriptor
Expand All @@ -259,13 +260,20 @@ modifyField (RepeatedField _ f) value = over f (value :)
modifyField (MapField key value f) mapElem
= over f (Map.insert (mapElem ^. key) (mapElem ^. value))

makeValue :: forall value. Registry -> FieldTypeDescriptor value -> Parser.Value -> Either String value
makeValue _ (ScalarField f) v = makeScalarValue f v
makeValue reg field@(MessageField MessageType) (Parser.MessageValue (Just typeUri) x)
makeValue
:: forall value
. String -- ^ name of field
-> Registry
-> FieldTypeDescriptor value
-> Parser.Value
-> Either String value
makeValue name _ (ScalarField f) v =
first (("Error parsing field " ++ show name ++ ": ") ++) $ makeScalarValue f v
makeValue name reg field@(MessageField MessageType) (Parser.MessageValue (Just typeUri) x)
| Just AnyMessageDescriptor { anyTypeUrlLens, anyValueLens } <- matchAnyMessage field =
case lookupRegistered typeUri reg of
Nothing -> Left $ "Could not decode google.protobuf.Any: "
++ "unregistered type URI "
Nothing -> Left $ "Could not decode google.protobuf.Any for field "
++ show name ++ ": unregistered type URI "
++ show typeUri
Just (SomeMessageType (Proxy :: Proxy value')) ->
case buildMessage reg x :: Either String value' of
Expand All @@ -275,8 +283,10 @@ makeValue reg field@(MessageField MessageType) (Parser.MessageValue (Just typeUr
| otherwise = Left ("Type mismatch parsing explicitly typed message. Expected " ++
show (messageName (Proxy @value)) ++
", got " ++ show typeUri)
makeValue reg (MessageField _) (Parser.MessageValue _ x) = buildMessage reg x
makeValue _ (MessageField _) val = Left $ "Type mismatch: expected message, found " ++ show val
makeValue _ reg (MessageField _) (Parser.MessageValue _ x) = buildMessage reg x
makeValue name _ (MessageField _) val =
Left $ "Type mismatch for field " ++ show name ++
": expected message, found " ++ show val

makeScalarValue :: ScalarField value -> Parser.Value -> Either String value
makeScalarValue Int32Field (Parser.IntValue x) = Right (fromInteger x)
Expand Down
3 changes: 2 additions & 1 deletion proto-lens/src/Data/ProtoLens/TextFormat/Parser.hs
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ data Value = IntValue Integer -- ^ An integer

instance Show Key
where
show (Key name) = name
show (Key name) = show name -- Quoting field names (i.e., `"field"` vs `field`
-- leads to nicer error messages.
show (UnknownKey k) = show k
show (ExtensionKey name) = "[" ++ intercalate "." name ++ "]"
show (UnknownExtensionKey k) = "[" ++ show k ++ "]"
Expand Down

0 comments on commit 71025ad

Please sign in to comment.