使用EitherT累积错误

时间:2014-05-12 11:00:00

标签: haskell error-handling either

我有一个Web API的小型示例应用程序,它采用了一个巨大的JSON文档,并且应该将其解析并报告每个部分的错误消息。

以下代码是使用EitherT(和错误包)的一个工作示例。但是,问题是EitherT在遇到的第一个Left上打破计算,只返回第一个"错误"它看到了。我想要的是一个错误消息列表,所有可能产生的消息。例如,如果runEitherT中的第一行失败,则无法完成任何其他操作。但是如果第二行失败,那么我们仍然可以尝试运行后续行,因为它们对第二行没有数据依赖性。因此,我们理论上可以一次性生成 more (不一定是所有)错误消息。

是否可以懒惰地运行所有计算并返回我们可以找到的所有错误消息?

{-# LANGUAGE OverloadedStrings #-}

module Main where

import Data.ByteString.Lazy.Char8 (pack)
import Web.Scotty as S
import Network.Wai.Middleware.RequestLogger
import Data.Aeson
import Data.Aeson.Types
import Control.Lens hiding ((.=), (??))
import Data.Aeson.Lens
import qualified Data.Text as T
import Control.Error
import Control.Applicative
import qualified Data.HashMap.Strict as H
import Network.HTTP.Types

data TypeOne = TypeOne T.Text TypeTwo TypeThree
  deriving (Show)

data TypeTwo = TypeTwo Double
  deriving (Show)

data TypeThree = TypeThree Double
  deriving (Show)

main :: IO ()
main = scotty 3000 $ do
  middleware logStdoutDev

  post "/pdor" $ do
    api_key <- param "api_key"
    input   <- param "input"

    typeOne <- runEitherT $ do
      result       <- (decode (pack input) :: Maybe Value) ?? "Could not parse. Input JSON document is malformed"
      typeTwoObj   <- (result ^? key "typeTwo")            ?? "Could not find key typeTwo in JSON document."
      typeThreeObj <- (result ^? key "typeThree")          ?? "Could not find key typeThree in JSON document."
      name         <- (result ^? key "name" . _String)     ?? "Could not find key name in JSON document."
      typeTwo      <- hoistEither $ prependLeft "Error when parsing TypeTwo: " $ parseEither jsonTypeTwo typeTwoObj
      typeThree    <- hoistEither $ prependLeft "Error when parsing TypeThree: " $ parseEither jsonTypeThree typeThreeObj

      return $ TypeOne name typeTwo typeThree

    case typeOne of
      Left errorMsg -> do
        _ <- status badRequest400
        S.json $ object ["error" .= errorMsg]
      Right _ ->
        -- do something with the parsed Haskell type
        S.json $ object ["api_key" .= (api_key :: String), "message" .= ("success" :: String)]

prependLeft :: String -> Either String a -> Either String a
prependLeft msg (Left s) = Left (msg ++ s)
prependLeft _ x = x

jsonTypeTwo :: Value -> Parser TypeTwo
jsonTypeTwo (Object v) = TypeTwo <$> v .: "val"
jsonTypeTwo _ = fail $ "no data present for TypeTwo"

jsonTypeThree :: Value -> Parser TypeThree
jsonTypeThree (Object v) = TypeThree <$> v .: "val"
jsonTypeThree _ = fail $ "no data present for TypeThree"

如果有人有一些建议,也可以接受重构建议。

2 个答案:

答案 0 :(得分:8)

正如我在评论中提到的,您至少有两种累积错误的方法。下面我详细说明这些。我们需要这些进口产品:

import Control.Applicative
import Data.Monoid
import Data.These

TheseT monad transformer

免责声明: TheseTChronicleT中被称为these package

看一下These data type的定义:

data These a b = This a | That b | These a b

此处ThisThat对应Left数据类型的RightEitherThese数据构造函数可以为Monad实例提供累积功能:它包含结果(类型b)和先前错误的集合(类型a的集合)。

利用已有的These数据类型定义,我们可以轻松创建ErrorT - 就像monad变换器一样:

newtype TheseT e m a = TheseT {
  runTheseT :: m (These e a)
}

TheseT是以下列方式Monad的实例:

instance Functor m => Functor (TheseT e m) where
  fmap f (TheseT m) = TheseT (fmap (fmap f) m)

instance (Monoid e, Applicative m) => Applicative (TheseT e m) where
  pure x = TheseT (pure (pure x))
  TheseT f <*> TheseT x = TheseT (liftA2 (<*>) f x)

instance (Monoid e, Monad m) => Monad (TheseT e m) where
  return x = TheseT (return (return x))
  m >>= f = TheseT $ do
    t <- runTheseT m
    case t of
      This  e   -> return (This e)
      That    x -> runTheseT (f x)
      These _ x -> do
        t' <- runTheseT (f x)
        return (t >> t')  -- this is where errors get concatenated

Applicative累积ErrorT

免责声明:由于您已经在m (Either e a) newtype包装器中工作,因此这种方法更容易适应,但它仅适用于Applicative设置。

如果实际代码仅使用Applicative界面,我们可以通过ErrorT更改其Applicative实例来解决问题。

让我们从一个非变压器版本开始:

data Accum e a = ALeft e | ARight a

instance Functor (Accum e) where
  fmap f (ARight x) = ARight (f x)
  fmap _ (ALeft e)  = ALeft e

instance Monoid e => Applicative (Accum e) where
  pure = ARight
  ARight f <*> ARight x = ARight (f x)
  ALeft e  <*> ALeft e' = ALeft (e <> e')
  ALeft e  <*> _        = ALeft e
  _        <*> ALeft e  = ALeft e

请注意,在定义<*>时,我们知道,如果双方都是ALeft,那么可以执行<>。如果我们尝试定义相应的Monad实例,我们就会失败:

instance Monoid e => Monad (Accum e) where
  return = ARight
  ALeft e >>= f = -- we can't apply f

因此我们可能拥有的唯一Monad实例是Either。但是ap<*>不一样:

Left a <*>  Left b  ≡  Left (a <> b)
Left a `ap` Left b  ≡  Left a

因此,我们只能将Accum用作Applicative

现在我们可以根据Applicative

定义Accum变换器
newtype AccErrorT e m a = AccErrorT {
  runAccErrorT :: m (Accum e a)
}

instance (Functor m) => Functor (AccErrorT e m) where
  fmap f (AccErrorT m) = AccErrorT (fmap (fmap f) m)

instance (Monoid e, Applicative m) => Applicative (AccErrorT e m) where
  pure x = AccErrorT (pure (pure x))
  AccErrorT f <*> AccErrorT x = AccErrorT (liftA2 (<*>) f x)

请注意,AccErrorT e m基本上是Compose m (Accum e)


修改

{p> AccErrorAccValidation中被称为validation package

答案 1 :(得分:0)

我们实际上可以将其编码为箭头(Kleisli变换器)。

newtype EitherAT x m a b = EitherAT { runEitherAT :: a -> m (Either x b) }

instance Monad m => Category EitherAT x m where
  id = EitherAT $ return . Right
  EitherAT a . EitherAT b
       = EitherAT $ \x -> do
              ax <- a x
              case ax of Right y -> b y
                         Left e  -> return $ Left e

instance (Monad m, Semigroup x) => Arrow EitherAT x m where
  arr f = EitherAT $ return . Right . f
  EitherAT a *** EitherAT b = EitherAT $ \(x,y) -> do
      ax <- a x
      by <- b y
      return $ case (ax,by) of
        (Right x',Right y') -> Right (x',y')
        (Left e  , Left f ) -> Left $ e <> f
        (Left e  , _      ) -> Left e
        (  _     , Left f ) ->        Left f
  first = (***id)

只是,这会违反箭头规则(您无法在不丢失a *** b错误信息的情况下将first a >>> second b重写为a。但是,如果您基本上将所有Left视为调试设备,您可能会认为它没问题。