Better error handling

IntersectMBO · Mar 17, 2021 · fc0afd7 · fc0afd7
1 parent 1ed0c77
commit fc0afd7
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 13 deletions.
diff --git a/cardano-submit-api/cardano-submit-api.cabal b/cardano-submit-api/cardano-submit-api.cabal
@@ -36,7 +36,6 @@ common ouroboros-consensus-cardano  { build-depends: ouroboros-consensus-cardano
 common ouroboros-network            { build-depends: ouroboros-network                >= 0.1.0.0                  }
 common prometheus                   { build-depends: prometheus                       >= 2.2.2                    }
 common protolude                    { build-depends: protolude                        >= 0.3.0                    }
-common semigroupoids                { build-depends: semigroupoids                    >= 5.3.5                    }
 common servant                      { build-depends: servant                          >= 0.18.2                   }
 common servant-server               { build-depends: servant-server                   >= 0.18.2                   }
 common streaming-commons            { build-depends: streaming-commons                >= 0.2.2.1                  }
@@ -83,7 +82,6 @@ library
                       , ouroboros-network
                       , prometheus
                       , protolude
-                      , semigroupoids
                       , servant
                       , servant-server
                       , streaming-commons

diff --git a/cardano-submit-api/src/Cardano/TxSubmit/Types.hs b/cardano-submit-api/src/Cardano/TxSubmit/Types.hs
@@ -20,6 +20,7 @@ import           Cardano.Binary (DecoderError)
 import           Cardano.TxSubmit.Util (textShow)
 import           Data.Aeson (ToJSON (..), Value (..))
 import           Data.ByteString.Char8 (ByteString)
+import           Data.List.NonEmpty (NonEmpty)
 import           Data.Text (Text)
 import           Formatting (build, sformat)
 import           GHC.Generics (Generic)
@@ -30,16 +31,18 @@ import           Servant (Accept (..), JSON, MimeRender (..), MimeUnrender (..),
 import           Servant.API.Generic (ToServantApi, (:-))
 
 import qualified Data.ByteString.Lazy.Char8 as LBS
+import qualified Data.List as L
+import qualified Data.List.NonEmpty as NEL
 
 newtype TxSubmitPort = TxSubmitPort Int
 
--- | The errors that the pure 'TextEnvelope' parsing\/decoding functions can return.
+-- | The errors that the raw CBOR transaction parsing\/decoding functions can return.
 --
-newtype RawCborDecodeError = RawCborDecodeError DecoderError
+newtype RawCborDecodeError = RawCborDecodeError (NonEmpty DecoderError)
   deriving (Eq, Show)
 
 instance Error RawCborDecodeError where
-  displayError (RawCborDecodeError decErr) = "TextEnvelope decode error: " <> show decErr
+  displayError (RawCborDecodeError decodeErrors) = "RawCborDecodeError decode error: \n" <> L.intercalate "  \n" (fmap show (NEL.toList decodeErrors))
 
 -- | An error that can occur in the transaction submission web API.
 data TxSubmitWebApiError

diff --git a/cardano-submit-api/src/Cardano/TxSubmit/Web.hs b/cardano-submit-api/src/Cardano/TxSubmit/Web.hs
@@ -36,10 +36,10 @@ import           Control.Monad.IO.Class (liftIO)
 import           Control.Monad.Trans.Except.Extra (firstExceptT, handleIOExceptT, hoistEither,
                    hoistMaybe, left, newExceptT)
 import           Data.Aeson (ToJSON (..))
-import           Data.Bifunctor (first)
+import           Data.Bifunctor (first, second)
 import           Data.ByteString.Char8 (ByteString)
-import           Data.Either (rights)
-import           Data.Functor.Alt ((<!>))
+import           Data.Either (isRight, lefts, partitionEithers, rights)
+import           Data.Maybe (listToMaybe)
 import           Data.Proxy (Proxy (..))
 import           Data.Text (Text)
 import           Ouroboros.Consensus.Cardano.Block (EraMismatch (..))
@@ -55,6 +55,7 @@ import qualified Data.ByteString as BS
 import qualified Data.ByteString.Char8 as B8
 import qualified Data.Char as Char
 import qualified Data.List as L
+import qualified Data.List.NonEmpty as NEL
 import qualified Data.Text as T
 import qualified Data.Text.Encoding as T
 import qualified Data.Text.IO as T
@@ -104,17 +105,21 @@ readEnvSocketPath =
 deserialiseOne :: forall b. ()
   => FromSomeType SerialiseAsCBOR b
   -> ByteString
-  -> Either RawCborDecodeError b
-deserialiseOne (FromSomeType ttoken f) bs = first RawCborDecodeError $ f <$> deserialiseFromCBOR ttoken bs
+  -> Either DecoderError b
+deserialiseOne (FromSomeType ttoken f) bs = f <$> deserialiseFromCBOR ttoken bs
 
 deserialiseAnyOf :: forall b. ()
   => [FromSomeType SerialiseAsCBOR b]
   -> ByteString
   -> Either RawCborDecodeError b
-deserialiseAnyOf ts te = foldr (<!>) defaultError (fmap (`deserialiseOne` te) ts)
+deserialiseAnyOf ts te = let (es, as) = partitionEithers results in maybe (errors es) Right (listToMaybe as)
   where
-    defaultError :: Either RawCborDecodeError b
-    defaultError = Left (RawCborDecodeError DecoderErrorVoid)
+    results = fmap (`deserialiseOne` te) ts
+
+    errors :: [DecoderError] -> Either RawCborDecodeError b
+    errors es = case NEL.nonEmpty es of
+      Just fs -> Left (RawCborDecodeError fs)
+      Nothing -> Left (RawCborDecodeError (pure DecoderErrorVoid)) -- Should never hapen
 
 readByteStringTx :: ByteString -> ExceptT TxCmdError IO (InAnyCardanoEra Tx)
 readByteStringTx = firstExceptT TxCmdTxReadError . hoistEither . deserialiseAnyOf