aboutsummaryrefslogtreecommitdiff
path: root/src/Language/GraphQL/Error.hs
diff options
context:
space:
mode:
Diffstat (limited to 'src/Language/GraphQL/Error.hs')
-rw-r--r--src/Language/GraphQL/Error.hs105
1 files changed, 71 insertions, 34 deletions
diff --git a/src/Language/GraphQL/Error.hs b/src/Language/GraphQL/Error.hs
index 59719b0..9df69de 100644
--- a/src/Language/GraphQL/Error.hs
+++ b/src/Language/GraphQL/Error.hs
@@ -1,3 +1,5 @@
+{-# LANGUAGE DuplicateRecordFields #-}
+{-# LANGUAGE ExistentialQuantification #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
@@ -5,20 +7,29 @@
module Language.GraphQL.Error
( parseError
, CollectErrsT
+ , Error(..)
, Resolution(..)
+ , ResolverException(..)
+ , Response(..)
+ , ResponseEventStream
, addErr
, addErrMsg
, runCollectErrs
, singleError
) where
+import Conduit
+import Control.Exception (Exception(..))
import Control.Monad.Trans.State (StateT, modify, runStateT)
-import qualified Data.Aeson as Aeson
import Data.HashMap.Strict (HashMap)
+import Data.Sequence (Seq(..), (|>))
+import qualified Data.Sequence as Seq
import Data.Text (Text)
-import Data.Void (Void)
-import Language.GraphQL.AST.Document (Name)
+import qualified Data.Text as Text
+import Language.GraphQL.AST (Location(..), Name)
+import Language.GraphQL.Execute.Coerce
import Language.GraphQL.Type.Schema
+import Prelude hiding (null)
import Text.Megaparsec
( ParseErrorBundle(..)
, PosState(..)
@@ -31,59 +42,85 @@ import Text.Megaparsec
-- | Executor context.
data Resolution m = Resolution
- { errors :: [Aeson.Value]
+ { errors :: Seq Error
, types :: HashMap Name (Type m)
}
-- | Wraps a parse error into a list of errors.
-parseError :: Applicative f => ParseErrorBundle Text Void -> f Aeson.Value
+parseError :: (Applicative f, Serialize a)
+ => ParseErrorBundle Text Void
+ -> f (Response a)
parseError ParseErrorBundle{..} =
- pure $ Aeson.object [("errors", Aeson.toJSON $ fst $ foldl go ([], bundlePosState) bundleErrors)]
+ pure $ Response null $ fst
+ $ foldl go (Seq.empty, bundlePosState) bundleErrors
where
- errorObject s SourcePos{..} = Aeson.object
- [ ("message", Aeson.toJSON $ init $ parseErrorTextPretty s)
- , ("line", Aeson.toJSON $ unPos sourceLine)
- , ("column", Aeson.toJSON $ unPos sourceColumn)
- ]
+ errorObject s SourcePos{..} = Error
+ { message = Text.pack $ init $ parseErrorTextPretty s
+ , locations = [Location (unPos' sourceLine) (unPos' sourceColumn)]
+ }
+ unPos' = fromIntegral . unPos
go (result, state) x =
let (_, newState) = reachOffset (errorOffset x) state
sourcePosition = pstateSourcePos newState
- in (errorObject x sourcePosition : result, newState)
+ in (result |> errorObject x sourcePosition, newState)
-- | A wrapper to pass error messages around.
type CollectErrsT m = StateT (Resolution m) m
-- | Adds an error to the list of errors.
-addErr :: Monad m => Aeson.Value -> CollectErrsT m ()
+addErr :: Monad m => Error -> CollectErrsT m ()
addErr v = modify appender
where
- appender resolution@Resolution{..} = resolution{ errors = v : errors }
+ appender :: Monad m => Resolution m -> Resolution m
+ appender resolution@Resolution{..} = resolution{ errors = errors |> v }
-makeErrorMessage :: Text -> Aeson.Value
-makeErrorMessage s = Aeson.object [("message", Aeson.toJSON s)]
+makeErrorMessage :: Text -> Error
+makeErrorMessage s = Error s []
-- | Constructs a response object containing only the error with the given
--- message.
-singleError :: Text -> Aeson.Value
-singleError message = Aeson.object
- [ ("errors", Aeson.toJSON [makeErrorMessage message])
- ]
+-- message.
+singleError :: Serialize a => Text -> Response a
+singleError message = Response null $ Seq.singleton $ makeErrorMessage message
-- | Convenience function for just wrapping an error message.
-addErrMsg :: Monad m => Text -> CollectErrsT m ()
-addErrMsg = addErr . makeErrorMessage
+addErrMsg :: (Monad m, Serialize a) => Text -> CollectErrsT m a
+addErrMsg errorMessage = (addErr . makeErrorMessage) errorMessage >> pure null
+
+-- | @GraphQL@ error.
+data Error = Error
+ { message :: Text
+ , locations :: [Location]
+ } deriving (Eq, Show)
+
+-- | The server\'s response describes the result of executing the requested
+-- operation if successful, and describes any errors encountered during the
+-- request.
+data Response a = Response
+ { data' :: a
+ , errors :: Seq Error
+ } deriving (Eq, Show)
+
+-- | Each event in the underlying Source Stream triggers execution of the
+-- subscription selection set. The results of the execution generate a Response
+-- Stream.
+type ResponseEventStream m a = ConduitT () (Response a) m ()
+
+-- | Only exceptions that inherit from 'ResolverException' a cought by the
+-- executor.
+data ResolverException = forall e. Exception e => ResolverException e
+
+instance Show ResolverException where
+ show (ResolverException e) = show e
+
+instance Exception ResolverException
-- | Runs the given query computation, but collects the errors into an error
--- list, which is then sent back with the data.
-runCollectErrs :: Monad m
+-- list, which is then sent back with the data.
+runCollectErrs :: (Monad m, Serialize a)
=> HashMap Name (Type m)
- -> CollectErrsT m Aeson.Value
- -> m Aeson.Value
+ -> CollectErrsT m a
+ -> m (Response a)
runCollectErrs types' res = do
- (dat, Resolution{..}) <- runStateT res $ Resolution{ errors = [], types = types' }
- if null errors
- then return $ Aeson.object [("data", dat)]
- else return $ Aeson.object
- [ ("data", dat)
- , ("errors", Aeson.toJSON $ reverse errors)
- ]
+ (dat, Resolution{..}) <- runStateT res
+ $ Resolution{ errors = Seq.empty, types = types' }
+ pure $ Response dat errors