servant-server-0.20: A family of combinators for defining webservices APIs and serving them

Safe Haskell | Safe-Inferred
Language | Haskell2010

Servant.Server.Internal.Delayed

Synopsis

- data Delayed env c where
  - Delayed :: {..} -> Delayed env c
- emptyDelayed :: RouteResult a -> Delayed env a
- addCapture :: Delayed env (a -> b) -> (captured -> DelayedIO a) -> Delayed (captured, env) b
- addParameterCheck :: Delayed env (a -> b) -> DelayedIO a -> Delayed env b
- addHeaderCheck :: Delayed env (a -> b) -> DelayedIO a -> Delayed env b
- addMethodCheck :: Delayed env a -> DelayedIO () -> Delayed env a
- addAuthCheck :: Delayed env (a -> b) -> DelayedIO a -> Delayed env b
- addBodyCheck :: Delayed env (a -> b) -> DelayedIO c -> (c -> DelayedIO a) -> Delayed env b
- addAcceptCheck :: Delayed env a -> DelayedIO () -> Delayed env a
- passToServer :: Delayed env (a -> b) -> (Request -> a) -> Delayed env b
- runDelayed :: Delayed env a -> env -> Request -> ResourceT IO (RouteResult a)
- runAction :: Delayed env (Handler a) -> env -> Request -> (RouteResult Response -> IO r) -> (a -> RouteResult Response) -> IO r

# Documentation

data Delayed env c where #

A `Delayed` is a representation of a handler with scheduled delayed checks that can trigger errors.

Why would we want to delay checks?

There are two reasons:

1. In a straight-forward implementation, the order in which we perform checks will determine the error we generate. This is because once an error occurs, we would abort and not perform any subsequent checks, but rather return the current error.

This is not a necessity: we could continue doing other checks, and choose the preferred error. However, that would in general mean more checking, which leads us to the other reason.

1. We really want to avoid doing certain checks too early. For example, captures involve parsing, and are much more costly than static route matches. In particular, if several paths contain the "same" capture, we'd like as much as possible to avoid trying the same parse many times. Also tricky is the request body. Again, this involves parsing, but also, WAI makes obtaining the request body a side-effecting operation. We could/can work around this by manually caching the request body, but we'd rather keep the number of times we actually try to decode the request body to an absolute minimum.

We prefer to have the following relative priorities of error codes:

    404
    405 (bad method)
    401 (unauthorized)
    415 (unsupported media type)
    406 (not acceptable)
    400 (bad request)

Therefore, while routing, we delay most checks so that they will ultimately occur in the right order.

A `Delayed` contains many delayed blocks of tests, and the actual handler:

1. Delayed captures. These can actually cause 404, and while they're costly, they should be done first among the delayed checks (at least as long as we do not decouple the check order from the error reporting, see above). Delayed captures can provide inputs to the actual handler.
2. Method check(s). This can cause a 405. On success, it does not provide an input for the handler. Method checks are comparatively cheap.
3. Authentication checks. This can cause 401.
4. Accept and content type header checks. These checks can cause 415 and 406 errors.
5. Query parameter checks. They require parsing and can cause 400 if the parsing fails. Query parameter checks provide inputs to the handler
6. Header Checks. They also require parsing and can cause 400 if parsing fails.
7. Body check. The request body check can cause 400.

Constructors

Delayed |

Fields

- :: { capturesD :: env -> DelayedIO captures
- , methodD :: DelayedIO ()
- , authD :: DelayedIO auth
- , acceptD :: DelayedIO ()
- , contentD :: DelayedIO contentType
- , paramsD :: DelayedIO params
- , headersD :: DelayedIO headers
- , bodyD :: contentType -> DelayedIO body
- , serverD :: captures -> params -> headers -> auth -> body -> Request -> RouteResult c
- } -> Delayed env c

#### Instances

Instances details

Functor (Delayed env) # |
Instance details Defined in Servant.Server.Internal.Delayed Methods fmap :: (a -> b) -> Delayed env a -> Delayed env b # (<$) :: a -> Delayed env b -> Delayed env a #

emptyDelayed :: RouteResult a -> Delayed env a #

A `Delayed` without any stored checks.

addCapture :: Delayed env (a -> b) -> (captured -> DelayedIO a) -> Delayed (captured, env) b #

Add a capture to the end of the capture block.

addParameterCheck :: Delayed env (a -> b) -> DelayedIO a -> Delayed env b #

Add a parameter check to the end of the params block

addHeaderCheck :: Delayed env (a -> b) -> DelayedIO a -> Delayed env b #

Add a parameter check to the end of the params block

addMethodCheck :: Delayed env a -> DelayedIO () -> Delayed env a #

Add a method check to the end of the method block.

addAuthCheck :: Delayed env (a -> b) -> DelayedIO a -> Delayed env b #

Add an auth check to the end of the auth block.

addBodyCheck #

Arguments

:: Delayed env (a -> b) |
-> DelayedIO c | content type check
-> (c -> DelayedIO a) | body check
-> Delayed env b |

Add a content type and body checks around parameter checks.

We'll report failed content type check (415), before trying to parse query parameters (400). Which, in turn, happens before request body parsing.

addAcceptCheck :: Delayed env a -> DelayedIO () -> Delayed env a #

Add an accept header check before handling parameters. In principle, we'd like to take a bad body (400) response take precedence over a failed accept check (406). BUT to allow streaming the body, we cannot run the body check and then still backtrack. We therefore do the accept check before the body check, when we can still backtrack. There are other solutions to this, but they'd be more complicated (such as delaying the body check further so that it can still be run in a situation where we'd otherwise report 406).

passToServer :: Delayed env (a -> b) -> (Request -> a) -> Delayed env b #

Many combinators extract information that is passed to the handler without the possibility of failure. In such a case, `passToServer` can be used.

runDelayed :: Delayed env a -> env -> Request -> ResourceT IO (RouteResult a) #

Run a delayed server. Performs all scheduled operations in order, and passes the results from the capture and body blocks on to the actual handler.

This should only be called once per request; otherwise the guarantees about effect and HTTP error ordering break down.

runAction :: Delayed env (Handler a) -> env -> Request -> (RouteResult Response -> IO r) -> (a -> RouteResult Response) -> IO r #

Runs a delayed server and the resulting action. Takes a continuation that lets us send a response. Also takes a continuation for how to turn the result of the delayed server into a response.