Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Wai.Handler.Lambda

Synopsis

type RawResponse = (Status, ResponseHeaders, ByteString)
data Settings = Settings {
- timeoutValue :: Int
- handleTimeout :: ByteString -> IO RawResponse
- handleException :: ByteString -> SomeException -> IO RawResponse
}
run :: Application -> IO ()
runSettings :: Settings -> Application -> IO ()
setTimeoutSeconds :: Int -> Settings -> Settings
setHandleException :: (ByteString -> SomeException -> IO RawResponse) -> Settings -> Settings
setHandleTimeout :: (ByteString -> IO RawResponse) -> Settings -> Settings
defaultSettings :: Settings
defaultHandleException :: ByteString -> SomeException -> IO RawResponse
defaultTimeoutValue :: Int
defaultHandleTimeout :: ByteString -> IO RawResponse
handleRequest :: Settings -> Application -> ByteString -> IO ()
processRequest :: Application -> Request -> IO Response
decodeInput :: ByteString -> Either (JSONPath, String) (FilePath, IO Request)
data ApiGatewayRequestV2 = ApiGatewayRequestV2 {
- body :: !(Maybe Text)
- headers :: !(HashMap Text Text)
- rawQueryString :: !(Maybe Text)
- requestContext :: !RequestContext
- cookies :: !(Maybe [Text])
- isBase64Encoded :: !Bool
}
data RequestContext = RequestContext {
- accountId :: !Text
- apiId :: !Text
- domainName :: !Text
- http :: Http
- requestId :: !Text
}
data Http = Http {
- method :: !Text
- path :: !Text
- protocol :: !Text
- sourceIp :: !Text
}
parseRequest :: Object -> Parser (IO Request)
originalRequestKey :: Key Object
readResponse :: Response -> IO RawResponse
toJSONResponse :: Status -> ResponseHeaders -> ByteString -> Object
writeFileAtomic :: FilePath -> ByteString -> IO ()
xif :: b -> ((b -> c) -> b -> c) -> c
uncurry3 :: (a -> b -> c -> d) -> (a, b, c) -> d

Documentation

type RawResponse = (Status, ResponseHeaders, ByteString) Source #

The representation of the response sent back to API Gateway.

data Settings Source #

The settings for running an Application.

See also: * runSettings

For simplicity use the following setters with defaultSettings: * setTimeoutSeconds * setHandleTimeout * setHandleException

Constructors

Settings
Fields timeoutValue :: Int How many microseconds before we declare a timeout handleTimeout :: ByteString -> IO RawResponse How to handle a timeout handleException :: ByteString -> SomeException -> IO RawResponse How to handle an exception thrown by the `Application`

run :: Application -> IO () Source #

Run an Application.

Continuously reads requests from stdin. Each line should be a a JSON document as described in decodeInput.

All requests will be timed out after 2 seconds. If any exception is thrown while processing the request this will return an HTTP 500 Internal Server Error.

If you need more control use handleRequest directly.

runSettings :: Settings -> Application -> IO () Source #

setTimeoutSeconds :: Int -> Settings -> Settings Source #

setHandleException :: (ByteString -> SomeException -> IO RawResponse) -> Settings -> Settings Source #

setHandleTimeout :: (ByteString -> IO RawResponse) -> Settings -> Settings Source #

defaultSettings :: Settings Source #

defaultHandleException :: ByteString -> SomeException -> IO RawResponse Source #

defaultTimeoutValue :: Int Source #

Default request timeout. 2 seconds.

defaultHandleTimeout :: ByteString -> IO RawResponse Source #

handleRequest Source #

Arguments

:: Settings
-> Application
-> ByteString	The request (see `decodeInput`)
-> IO ()

Parse and handle the request.

Returns 504 if no response is available after the specified timeout.
Returns 500 if an exception occurs while processing the request.
Throws an exception if the input cannot be parsed.

processRequest :: Application -> Request -> IO Response Source #

Run the Request through the Application.

This function is completely dependent on the 'Application. Any exception thrown by the Application will be rethrown here. No timeout is implemented: if the Application never provides a Response then processRequest won't return.

decodeInput :: ByteString -> Either (JSONPath, String) (FilePath, IO Request) Source #

Decode a ByteString into (1) a Wai Request and (2) a filepath where the response should be written. The argument is JSON document with two fields: * request: the API Gateway request (see parseRequest) * reqsponseFile: Where to write the API Gateway response (see toJSONResponse)

data ApiGatewayRequestV2 Source #

Constructors

ApiGatewayRequestV2
Fields body :: !(Maybe Text) headers :: !(HashMap Text Text) rawQueryString :: !(Maybe Text) requestContext :: !RequestContext cookies :: !(Maybe [Text]) isBase64Encoded :: !Bool

Instances

Instances details

FromJSON ApiGatewayRequestV2 Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods parseJSON :: Value -> Parser ApiGatewayRequestV2 # parseJSONList :: Value -> Parser [ApiGatewayRequestV2] #
ToJSON ApiGatewayRequestV2 Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods toJSON :: ApiGatewayRequestV2 -> Value # toEncoding :: ApiGatewayRequestV2 -> Encoding # toJSONList :: [ApiGatewayRequestV2] -> Value # toEncodingList :: [ApiGatewayRequestV2] -> Encoding #
Generic ApiGatewayRequestV2 Source #
Instance details Defined in Network.Wai.Handler.Lambda Associated Types type Rep ApiGatewayRequestV2 :: Type -> Type # Methods from :: ApiGatewayRequestV2 -> Rep ApiGatewayRequestV2 x # to :: Rep ApiGatewayRequestV2 x -> ApiGatewayRequestV2 #
Show ApiGatewayRequestV2 Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods showsPrec :: Int -> ApiGatewayRequestV2 -> ShowS # show :: ApiGatewayRequestV2 -> String # showList :: [ApiGatewayRequestV2] -> ShowS #
NFData ApiGatewayRequestV2 Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods rnf :: ApiGatewayRequestV2 -> () #
type Rep ApiGatewayRequestV2 Source #
Instance details Defined in Network.Wai.Handler.Lambda type Rep ApiGatewayRequestV2 = D1 ('MetaData "ApiGatewayRequestV2" "Network.Wai.Handler.Lambda" "wai-lambda-0.1.1.0-4kQWDCgzrvk3aqacUHRdqT" 'False) (C1 ('MetaCons "ApiGatewayRequestV2" 'PrefixI 'True) ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HashMap Text Text)) :: S1 ('MetaSel ('Just "rawQueryString") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "requestContext") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RequestContext) :: (S1 ('MetaSel ('Just "cookies") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "isBase64Encoded") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))))

data RequestContext Source #

Constructors

RequestContext
Fields accountId :: !Text apiId :: !Text domainName :: !Text http :: Http requestId :: !Text

Instances

Instances details

FromJSON RequestContext Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods parseJSON :: Value -> Parser RequestContext # parseJSONList :: Value -> Parser [RequestContext] #
ToJSON RequestContext Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods toJSON :: RequestContext -> Value # toEncoding :: RequestContext -> Encoding # toJSONList :: [RequestContext] -> Value # toEncodingList :: [RequestContext] -> Encoding #
Generic RequestContext Source #
Instance details Defined in Network.Wai.Handler.Lambda Associated Types type Rep RequestContext :: Type -> Type # Methods from :: RequestContext -> Rep RequestContext x # to :: Rep RequestContext x -> RequestContext #
Show RequestContext Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods showsPrec :: Int -> RequestContext -> ShowS # show :: RequestContext -> String # showList :: [RequestContext] -> ShowS #
NFData RequestContext Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods rnf :: RequestContext -> () #
type Rep RequestContext Source #
Instance details Defined in Network.Wai.Handler.Lambda type Rep RequestContext = D1 ('MetaData "RequestContext" "Network.Wai.Handler.Lambda" "wai-lambda-0.1.1.0-4kQWDCgzrvk3aqacUHRdqT" 'False) (C1 ('MetaCons "RequestContext" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "http") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Http) :: S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))))

data Http Source #

Constructors

Http
Fields method :: !Text path :: !Text protocol :: !Text sourceIp :: !Text

Instances

Instances details

FromJSON Http Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods parseJSON :: Value -> Parser Http # parseJSONList :: Value -> Parser [Http] #
ToJSON Http Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods toJSON :: Http -> Value # toEncoding :: Http -> Encoding # toJSONList :: [Http] -> Value # toEncodingList :: [Http] -> Encoding #
Generic Http Source #
Instance details Defined in Network.Wai.Handler.Lambda Associated Types type Rep Http :: Type -> Type # Methods from :: Http -> Rep Http x # to :: Rep Http x -> Http #
Show Http Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods showsPrec :: Int -> Http -> ShowS # show :: Http -> String # showList :: [Http] -> ShowS #
NFData Http Source #
Instance details Defined in Network.Wai.Handler.Lambda Methods rnf :: Http -> () #
type Rep Http Source #
Instance details Defined in Network.Wai.Handler.Lambda type Rep Http = D1 ('MetaData "Http" "Network.Wai.Handler.Lambda" "wai-lambda-0.1.1.0-4kQWDCgzrvk3aqacUHRdqT" 'False) (C1 ('MetaCons "Http" 'PrefixI 'True) ((S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sourceIp") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))))

parseRequest :: Object -> Parser (IO Request) Source #

Parser for a Request.

The input is an AWS API Gateway request event: https://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-api-gateway-request

originalRequestKey :: Key Object Source #

readResponse :: Response -> IO RawResponse Source #

Read the status, headers and body of a Response.

toJSONResponse :: Status -> ResponseHeaders -> ByteString -> Object Source #

Make an API Gateway response from status, headers and body. https://docs.aws.amazon.com/lambda/latest/dg/eventsources.html#eventsources-api-gateway-response

writeFileAtomic :: FilePath -> ByteString -> IO () Source #

Atomically write the ByteString to the file.

Uses rename(2).

xif :: b -> ((b -> c) -> b -> c) -> c Source #

flip fix

uncurry3 :: (a -> b -> c -> d) -> (a, b, c) -> d Source #