Safe Haskell	None
Language	Haskell2010

Hasura.Eventing.HTTP

Description

Hasura.Eventing.HTTP

This module is an utility module providing HTTP utilities for Hasura.Eventing.EventTriggers and Hasura.Eventing.ScheduledTriggers.

The event triggers and scheduled triggers share the event delivery mechanism using the tryWebhook function defined in this module.

Synopsis

retryAfterHeader :: CI Text
data ExtraLogContext = ExtraLogContext {
- elEventId :: !EventId
- elEventName :: !(Maybe TriggerName)
}
data HTTPResp (a :: TriggerTypes) = HTTPResp {
- hrsStatus :: !Int
- hrsHeaders :: ![HeaderConf]
- hrsBody :: !SerializableBlob
- hrsSize :: !Int64
}
data HTTPErr (a :: TriggerTypes)
- = HClient !HttpException
- | HStatus !(HTTPResp a)
- | HOther !String
mkHTTPResp :: Response ByteString -> HTTPResp a
data RequestDetails = RequestDetails {
- _rdOriginalRequest :: Request
- _rdOriginalSize :: Int64
- _rdTransformedRequest :: Maybe Request
- _rdTransformedSize :: Maybe Int64
- _rdReqTransformCtx :: Maybe RequestTransformCtx
- _rdSessionVars :: Maybe SessionVariables
}
extractRequest :: RequestDetails -> Request
data HTTPRespExtra (a :: TriggerTypes) = HTTPRespExtra {
- _hreResponse :: !(Either (HTTPErr a) (HTTPResp a))
- _hreContext :: !ExtraLogContext
- _hreRequest :: !RequestDetails
- _hreWebhookVarName :: !Text
- _hreLogHeaders :: ![HeaderConf]
}
isNetworkError :: HTTPErr a -> Bool
isNetworkErrorHC :: HttpException -> Bool
anyBodyParser :: Response ByteString -> Either (HTTPErr a) (HTTPResp a)
data HTTPReq = HTTPReq {
- _hrqMethod :: !String
- _hrqUrl :: !String
- _hrqPayload :: !(Maybe Value)
- _hrqTry :: !Int
- _hrqDelay :: !(Maybe Int)
}
logHTTPForET :: (MonadReader r m, Has (Logger Hasura) r, MonadIO m) => Either (HTTPErr 'EventType) (HTTPResp 'EventType) -> ExtraLogContext -> RequestDetails -> Text -> [HeaderConf] -> m ()
logHTTPForST :: (MonadReader r m, Has (Logger Hasura) r, MonadIO m) => Either (HTTPErr 'ScheduledType) (HTTPResp 'ScheduledType) -> ExtraLogContext -> RequestDetails -> Text -> [HeaderConf] -> m ()
runHTTP :: MonadIO m => Manager -> Request -> m (Either (HTTPErr a) (HTTPResp a))
data TransformableRequestError a
- = HTTPError Value (HTTPErr a)
- | TransformationError Value TransformErrorBundle
mkRequest :: MonadError (TransformableRequestError a) m => [Header] -> ResponseTimeout -> ByteString -> Maybe RequestTransform -> ResolvedWebhook -> m RequestDetails
invokeRequest :: (MonadReader r m, MonadError (TransformableRequestError a) m, Has Manager r, Has (Logger Hasura) r, MonadIO m, MonadTrace m) => RequestDetails -> Maybe ResponseTransform -> Maybe SessionVariables -> (Either (HTTPErr a) (HTTPResp a) -> RequestDetails -> m ()) -> m (HTTPResp a)
mkResp :: Int -> SerializableBlob -> [HeaderConf] -> Response a
mkClientErr :: SerializableBlob -> Response a
mkWebhookReq :: Value -> [HeaderConf] -> InvocationVersion -> WebhookRequest
mkInvocationResp :: Maybe Int -> SerializableBlob -> [HeaderConf] -> Response a
isClientError :: Int -> Bool
encodeHeader :: EventHeaderInfo -> Header
decodeHeader :: [EventHeaderInfo] -> (HeaderName, ByteString) -> HeaderConf
prepareHeaders :: [EventHeaderInfo] -> ([Header], [HeaderConf])
getRetryAfterHeaderFromHTTPErr :: HTTPErr a -> Maybe Text
getRetryAfterHeaderFromResp :: HTTPResp a -> Maybe Text
parseRetryHeaderValue :: Text -> Maybe Int

Documentation

retryAfterHeader :: CI Text Source #

data ExtraLogContext Source #

Constructors

ExtraLogContext
Fields elEventId :: !EventId elEventName :: !(Maybe TriggerName)

Instances

Instances details

Eq ExtraLogContext Source #
Instance details Defined in Hasura.Eventing.HTTP Methods (==) :: ExtraLogContext -> ExtraLogContext -> Bool # (/=) :: ExtraLogContext -> ExtraLogContext -> Bool #
Show ExtraLogContext Source #
Instance details Defined in Hasura.Eventing.HTTP Methods showsPrec :: Int -> ExtraLogContext -> ShowS # show :: ExtraLogContext -> String # showList :: [ExtraLogContext] -> ShowS #

data HTTPResp (a :: TriggerTypes) Source #

Constructors

HTTPResp
Fields hrsStatus :: !Int hrsHeaders :: ![HeaderConf] hrsBody :: !SerializableBlob hrsSize :: !Int64

Instances

Instances details

Show (HTTPResp a) Source #
Instance details Defined in Hasura.Eventing.HTTP Methods showsPrec :: Int -> HTTPResp a -> ShowS # show :: HTTPResp a -> String # showList :: [HTTPResp a] -> ShowS #
ToJSON (HTTPResp a) Source #
Instance details Defined in Hasura.Eventing.HTTP Methods toJSON :: HTTPResp a -> Value toEncoding :: HTTPResp a -> Encoding toJSONList :: [HTTPResp a] -> Value toEncodingList :: [HTTPResp a] -> Encoding
ToEngineLog (HTTPResp 'EventType) Hasura Source #
Instance details Defined in Hasura.Eventing.HTTP Methods toEngineLog :: HTTPResp 'EventType -> (LogLevel, EngineLogType Hasura, Value) Source #
ToEngineLog (HTTPResp 'ScheduledType) Hasura Source #
Instance details Defined in Hasura.Eventing.HTTP Methods toEngineLog :: HTTPResp 'ScheduledType -> (LogLevel, EngineLogType Hasura, Value) Source #

data HTTPErr (a :: TriggerTypes) Source #

Constructors

HClient !HttpException
HStatus !(HTTPResp a)
HOther !String

Instances

Instances details

Show (HTTPErr a) Source #
Instance details Defined in Hasura.Eventing.HTTP Methods showsPrec :: Int -> HTTPErr a -> ShowS # show :: HTTPErr a -> String # showList :: [HTTPErr a] -> ShowS #
ToJSON (HTTPErr a) Source #
Instance details Defined in Hasura.Eventing.HTTP Methods toJSON :: HTTPErr a -> Value toEncoding :: HTTPErr a -> Encoding toJSONList :: [HTTPErr a] -> Value toEncodingList :: [HTTPErr a] -> Encoding
ToEngineLog (HTTPErr 'EventType) Hasura Source #
Instance details Defined in Hasura.Eventing.HTTP Methods toEngineLog :: HTTPErr 'EventType -> (LogLevel, EngineLogType Hasura, Value) Source #
ToEngineLog (HTTPErr 'ScheduledType) Hasura Source #
Instance details Defined in Hasura.Eventing.HTTP Methods toEngineLog :: HTTPErr 'ScheduledType -> (LogLevel, EngineLogType Hasura, Value) Source #

mkHTTPResp :: Response ByteString -> HTTPResp a Source #

data RequestDetails Source #

Constructors

RequestDetails
Fields _rdOriginalRequest :: Request _rdOriginalSize :: Int64 _rdTransformedRequest :: Maybe Request _rdTransformedSize :: Maybe Int64 _rdReqTransformCtx :: Maybe RequestTransformCtx _rdSessionVars :: Maybe SessionVariables

Instances

Instances details

ToJSON RequestDetails Source #
Instance details Defined in Hasura.Eventing.HTTP Methods toJSON :: RequestDetails -> Value toEncoding :: RequestDetails -> Encoding toJSONList :: [RequestDetails] -> Value toEncodingList :: [RequestDetails] -> Encoding

extractRequest :: RequestDetails -> Request Source #

data HTTPRespExtra (a :: TriggerTypes) Source #

Constructors

HTTPRespExtra
Fields _hreResponse :: !(Either (HTTPErr a) (HTTPResp a)) _hreContext :: !ExtraLogContext _hreRequest :: !RequestDetails _hreWebhookVarName :: !Text _hreLogHeaders :: ![HeaderConf]

isNetworkError :: HTTPErr a -> Bool Source #

isNetworkErrorHC :: HttpException -> Bool Source #

anyBodyParser :: Response ByteString -> Either (HTTPErr a) (HTTPResp a) Source #

data HTTPReq Source #

Constructors

HTTPReq
Fields _hrqMethod :: !String _hrqUrl :: !String _hrqPayload :: !(Maybe Value) _hrqTry :: !Int _hrqDelay :: !(Maybe Int)

logHTTPForET :: (MonadReader r m, Has (Logger Hasura) r, MonadIO m) => Either (HTTPErr 'EventType) (HTTPResp 'EventType) -> ExtraLogContext -> RequestDetails -> Text -> [HeaderConf] -> m () Source #

logHTTPForST :: (MonadReader r m, Has (Logger Hasura) r, MonadIO m) => Either (HTTPErr 'ScheduledType) (HTTPResp 'ScheduledType) -> ExtraLogContext -> RequestDetails -> Text -> [HeaderConf] -> m () Source #

runHTTP :: MonadIO m => Manager -> Request -> m (Either (HTTPErr a) (HTTPResp a)) Source #

data TransformableRequestError a Source #

Constructors

HTTPError Value (HTTPErr a)
TransformationError Value TransformErrorBundle

Instances

Instances details

Show (TransformableRequestError a) Source #
Instance details Defined in Hasura.Eventing.HTTP Methods showsPrec :: Int -> TransformableRequestError a -> ShowS # show :: TransformableRequestError a -> String # showList :: [TransformableRequestError a] -> ShowS #

mkRequest Source #

Arguments

:: MonadError (TransformableRequestError a) m
=> [Header]
-> ResponseTimeout
-> ByteString	the request body. It is passed as a `Bytestring` because we need to log the request size. As the logging happens outside the function, we pass it the final request body, instead of `Value`
-> Maybe RequestTransform
-> ResolvedWebhook
-> m RequestDetails

invokeRequest :: (MonadReader r m, MonadError (TransformableRequestError a) m, Has Manager r, Has (Logger Hasura) r, MonadIO m, MonadTrace m) => RequestDetails -> Maybe ResponseTransform -> Maybe SessionVariables -> (Either (HTTPErr a) (HTTPResp a) -> RequestDetails -> m ()) -> m (HTTPResp a) Source #

mkResp :: Int -> SerializableBlob -> [HeaderConf] -> Response a Source #

mkClientErr :: SerializableBlob -> Response a Source #

mkWebhookReq :: Value -> [HeaderConf] -> InvocationVersion -> WebhookRequest Source #

mkInvocationResp :: Maybe Int -> SerializableBlob -> [HeaderConf] -> Response a Source #

isClientError :: Int -> Bool Source #

encodeHeader :: EventHeaderInfo -> Header Source #

decodeHeader :: [EventHeaderInfo] -> (HeaderName, ByteString) -> HeaderConf Source #

prepareHeaders :: [EventHeaderInfo] -> ([Header], [HeaderConf]) Source #

Encodes given request headers along with our defaultHeaders and returns them along with the re-decoded set of headers (for logging purposes).

getRetryAfterHeaderFromHTTPErr :: HTTPErr a -> Maybe Text Source #

getRetryAfterHeaderFromResp :: HTTPResp a -> Maybe Text Source #

parseRetryHeaderValue :: Text -> Maybe Int Source #