Mig.Core.Class.Plugin

Plugins are useful to apply certain action to all routes in the server. For example we can add generic logger or authorization bazed on common query parameter or field of the body request that contains token of the session.

The downside is that we work on low level of Requesnce/Response as we have rendered all routes to ServerFun. But thw good part of it is that we can add generic action to every route.

Let's consider a simple example of adding logger to lall routes:

logRoutes :: Server IO -> Server IO
logRoutes = applyPlugin $ \(PathInfo path) -> prependServerAction $
   when (path /= ["favicon.ico"] && headMay path /= Just "static") $ do
     logRoute site (Text.intercalate "/" path)

-- | Logs the route info
logRoute :: Site -> Text -> IO ()
logRoute site route = do
  time <- getCurrentTime
  site.logInfo $ route <> " page visited at: " <> Text.pack (show time)

Here we use instance of ToPlugin for PathInfo to read full path for any route and we use this information in the logger.

We have various instances for everything that we can query from the request and we can use this information to transform the server functions inside the routes.

The instances work in the same manner as route handlers we can use as many arguments as we wish and we use typed wrappers to query specific part of the request. Thus we gain type-safety and get convenient interface to request the various parts of request.

class

class MonadIO (MonadOf f) => ToPlugin f where

Values that can represent a plugin. We use various newtype-wrappers to query type-safe info from request.

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: f -> ServerFun (MonadOf f) -> ServerFun (MonadOf f)

Instances

MonadIO m => ToPlugin (Plugin m)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: Plugin m -> ServerFun (MonadOf (Plugin m)) -> ServerFun (MonadOf (Plugin m))

MonadIO m => ToPlugin (PluginFun m)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: PluginFun m -> ServerFun (MonadOf (PluginFun m)) -> ServerFun (MonadOf (PluginFun m))

ToPlugin a => ToPlugin (RawResponse -> a)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (RawResponse -> a) -> ServerFun (MonadOf (RawResponse -> a)) -> ServerFun (MonadOf (RawResponse -> a))

(FromReqBody ty a, ToSchema a, ToPlugin b) => ToPlugin (Body ty a -> b)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (Body ty a -> b) -> ServerFun (MonadOf (Body ty a -> b)) -> ServerFun (MonadOf (Body ty a -> b))

(FromHttpApiData a, ToParamSchema a, ToPlugin b, KnownSymbol sym) => ToPlugin (Capture sym a -> b)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (Capture sym a -> b) -> ServerFun (MonadOf (Capture sym a -> b)) -> ServerFun (MonadOf (Capture sym a -> b))

(FromForm a, ToPlugin b) => ToPlugin (Cookie a -> b)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (Cookie a -> b) -> ServerFun (MonadOf (Cookie a -> b)) -> ServerFun (MonadOf (Cookie a -> b))

ToPlugin a => ToPlugin (FullPathInfo -> a)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (FullPathInfo -> a) -> ServerFun (MonadOf (FullPathInfo -> a)) -> ServerFun (MonadOf (FullPathInfo -> a))

(FromHttpApiData a, ToParamSchema a, ToPlugin b, KnownSymbol sym) => ToPlugin (Header sym a -> b)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (Header sym a -> b) -> ServerFun (MonadOf (Header sym a -> b)) -> ServerFun (MonadOf (Header sym a -> b))

ToPlugin a => ToPlugin (IsSecure -> a)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (IsSecure -> a) -> ServerFun (MonadOf (IsSecure -> a)) -> ServerFun (MonadOf (IsSecure -> a))

(FromHttpApiData a, ToParamSchema a, ToPlugin b, KnownSymbol sym) => ToPlugin (Optional sym a -> b)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (Optional sym a -> b) -> ServerFun (MonadOf (Optional sym a -> b)) -> ServerFun (MonadOf (Optional sym a -> b))

(FromHttpApiData a, ToParamSchema a, ToPlugin b, KnownSymbol sym) => ToPlugin (OptionalHeader sym a -> b)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (OptionalHeader sym a -> b) -> ServerFun (MonadOf (OptionalHeader sym a -> b)) -> ServerFun (MonadOf (OptionalHeader sym a -> b))

ToPlugin a => ToPlugin (PathInfo -> a)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (PathInfo -> a) -> ServerFun (MonadOf (PathInfo -> a)) -> ServerFun (MonadOf (PathInfo -> a))

(FromHttpApiData a, ToParamSchema a, ToPlugin b, KnownSymbol sym) => ToPlugin (Query sym a -> b)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (Query sym a -> b) -> ServerFun (MonadOf (Query sym a -> b)) -> ServerFun (MonadOf (Query sym a -> b))

(ToPlugin b, KnownSymbol sym) => ToPlugin (QueryFlag sym -> b)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (QueryFlag sym -> b) -> ServerFun (MonadOf (QueryFlag sym -> b)) -> ServerFun (MonadOf (QueryFlag sym -> b))

ToPlugin a => ToPlugin (RawRequest -> a)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (RawRequest -> a) -> ServerFun (MonadOf (RawRequest -> a)) -> ServerFun (MonadOf (RawRequest -> a))

data Plugin m

Plugin can convert all routes of the server. It is wrapper on top of ServerFun m -> ServerFun m. We can apply plugins to servers with applyPlugin function also plugin has Monoid instance which is like Monoid.Endo or functional composition (.).

Constructors

Plugin

Fields

• info :: RouteInfo -> RouteInfo

  update api schema

• run :: PluginFun m

  run the plugin

Instances

Monoid (Plugin m)

Defined in Mig.Core.Class.Plugin

Methods

mempty :: Plugin m

mappend :: Plugin m -> Plugin m -> Plugin m

mconcat :: [Plugin m] -> Plugin m

Semigroup (Plugin m)

Defined in Mig.Core.Class.Plugin

Methods

(<>) :: Plugin m -> Plugin m -> Plugin m

sconcat :: NonEmpty (Plugin m) -> Plugin m

stimes :: Integral b => b -> Plugin m -> Plugin m

MonadIO m => ToPlugin (Plugin m)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: Plugin m -> ServerFun (MonadOf (Plugin m)) -> ServerFun (MonadOf (Plugin m))

type PluginFun m = ServerFun m -> ServerFun m

Low-level plugin function.

toPlugin :: forall f. ToPlugin f => f -> Plugin (MonadOf f)

Convert plugin-like value to plugin.

fromPluginFun :: MonadIO m => PluginFun m -> Plugin m

($:) :: forall f. ToPlugin f => f -> Server (MonadOf f) -> Server (MonadOf f)

Infix operator for applyPlugin

applyPlugin :: forall f. ToPlugin f => f -> Server (MonadOf f) -> Server (MonadOf f)

Applies plugin to all routes of the server.

newtype RawResponse

Read low-level response. Note that it does not affect the API schema

Constructors

RawResponse (Maybe Response)

Instances

ToPlugin a => ToPlugin (RawResponse -> a)

Defined in Mig.Core.Class.Plugin

Methods

toPluginInfo :: RouteInfo -> RouteInfo

toPluginFun :: (RawResponse -> a) -> ServerFun (MonadOf (RawResponse -> a)) -> ServerFun (MonadOf (RawResponse -> a))

specific plugins

prependServerAction :: forall m. MonadIO m => m () -> Plugin m

Prepends action to the server

appendServerAction :: forall m. MonadIO m => m () -> Plugin m

Post appends action to the server

processResponse :: forall m. MonadIO m => (m (Maybe Response) -> m (Maybe Response)) -> Plugin m

Applies transformation to the response

whenSecure :: forall m. MonadIO m => Plugin m

Execute request only if it is secure (made with SSL connection)

processNoResponse :: forall m a. (MonadIO m, IsResp a) => m a -> Plugin m

Sets default response if server response with Nothing. If it can not handle the request.