@@ -1,12 +1,10 @@
11{-# LANGUAGE AllowAmbiguousTypes #-}
22{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE CPP #-}
43{-# LANGUAGE DataKinds #-}
54{-# LANGUAGE DeriveDataTypeable #-}
65{-# LANGUAGE FlexibleContexts #-}
76{-# LANGUAGE FlexibleInstances #-}
87{-# LANGUAGE InstanceSigs #-}
9−{-# LANGUAGE LambdaCase #-}
108{-# LANGUAGE MultiParamTypeClasses #-}
119{-# LANGUAGE OverloadedStrings #-}
1210{-# LANGUAGE PolyKinds #-}
@@ -36,10 +34,9 @@ module Servant.Server.Internal
3634import Control.Monad
3735 (join, when)
3836import Control.Monad.Trans
39− (liftIO, lift)
37+ (liftIO)
4038import Control.Monad.Trans.Resource
41− (runResourceT, ReleaseKey)
42−import Data.Acquire
39+ (runResourceT)
4340import qualified Data.ByteString as B
4441import qualified Data.ByteString.Builder as BB
4542import qualified Data.ByteString.Char8 as BC8
@@ -66,7 +63,7 @@ import Network.HTTP.Types hiding
6663import Network.Socket
6764 (SockAddr)
6865import Network.Wai
69− (Application, Request, Response, ResponseReceived, httpVersion, isSecure, lazyRequestBody,
66+ (Application, Request, httpVersion, isSecure, lazyRequestBody,
7067 queryString, remoteHost, getRequestBodyChunk, requestHeaders,
7168 requestMethod, responseLBS, responseStream, vault)
7269import Prelude ()
@@ -76,10 +73,10 @@ import Servant.API
7673 CaptureAll, Description, EmptyAPI, Fragment,
7774 FramingRender (..), FramingUnrender (..), FromSourceIO (..),
7875 Header', If, IsSecure (..), NoContentVerb, QueryFlag,
79− QueryParam', QueryParams, Raw, RawM, ReflectMethod (reflectMethod),
76+ QueryParam', QueryParams, Raw, ReflectMethod (reflectMethod),
8077 RemoteHost, ReqBody', SBool (..), SBoolI (..), SourceIO,
8178 Stream, StreamBody', Summary, ToSourceIO (..), Vault, Verb,
82− WithNamedContext, WithResource, NamedRoutes)
79+ WithNamedContext, NamedRoutes)
8380import Servant.API.Generic (GenericMode(..), ToServant, ToServantApi, GServantProduct, toServant, fromServant)
8481import Servant.API.ContentTypes
8582 (AcceptHeader (..), AllCTRender (..), AllCTUnrender (..),
@@ -97,8 +94,6 @@ import Servant.API.TypeErrors
9794import Web.HttpApiData
9895 (FromHttpApiData, parseHeader, parseQueryParam, parseUrlPiece,
9996 parseUrlPieces)
100−import Data.Kind
101− (Type)
10297
10398import Servant.Server.Internal.BasicAuth
10499import Servant.Server.Internal.Context
@@ -117,10 +112,6 @@ import Servant.API.TypeLevel
117112 (AtLeastOneFragment, FragmentUnique)
118113
119114class HasServer api context where
120− -- | The type of a server for this API, given a monad to run effects in.
121− --
122− -- Note that the result kind is @*@, so it is /not/ a monad transformer, unlike
123− -- what the @T@ in the name might suggest.
124115 type ServerT api (m :: * -> *) :: *
125116
126117 route ::
@@ -250,42 +241,6 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a
250241 formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
251242 hint = CaptureHint (T.pack $ symbolVal $ Proxy @capture) (typeRep (Proxy :: Proxy [a]))
252243
253−-- | If you use 'WithResource' in one of the endpoints for your API Servant
254−-- will provide the handler for this endpoint an argument of the specified type.
255−-- The lifespan of this resource will be automatically managed by Servant. This
256−-- resource will be created before the handler starts and it will be destoyed
257−-- after it ends. A new resource is created for each request to the endpoint.
258−
259−-- The creation and destruction are done using a 'Data.Acquire.Acquire'
260−-- provided via server 'Context'.
261−--
262−-- Example
263−--
264−-- > type MyApi = WithResource Handle :> "writeToFile" :> Post '[JSON] NoContent
265−-- >
266−-- > server :: Server MyApi
267−-- > server = writeToFile
268−-- > where writeToFile :: (ReleaseKey, Handle) -> Handler NoContent
269−-- > writeToFile (_, h) = hPutStrLn h "message"
270−--
271−-- In addition to the resource, the handler will also receive a 'ReleaseKey'
272−-- which can be used to deallocate the resource before the end of the request
273−-- if desired.
274−
275−instance (HasServer api ctx, HasContextEntry ctx (Acquire a))
276− => HasServer (WithResource a :> api) ctx where
277−
278− type ServerT (WithResource a :> api) m = (ReleaseKey, a) -> ServerT api m
279−
280− hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy @api) pc nt . s
281−
282− route Proxy context d = route (Proxy @api) context (d `addParameterCheck` allocateResource)
283− where
284− allocateResource :: DelayedIO (ReleaseKey, a)
285− allocateResource = DelayedIO $ lift $ allocateAcquire (getContextEntry context)
286−
287−
288−
289244allowedMethodHead :: Method -> Request -> Bool
290245allowedMethodHead method request = method == methodGet && requestMethod request == methodHead
291246
@@ -653,35 +608,6 @@ instance HasServer Raw context where
653608 Fail a -> respond $ Fail a
654609 FailFatal e -> respond $ FailFatal e
655610
656−-- | Just pass the request to the underlying application and serve its response.
657−--
658−-- Example:
659−--
660−-- > type MyApi = "images" :> Raw
661−-- >
662−-- > server :: Server MyApi
663−-- > server = serveDirectory "/var/www/images"
664−instance HasServer RawM context where
665− type ServerT RawM m = Request -> (Response -> IO ResponseReceived) -> m ResponseReceived
666−
667− route
668− :: Proxy RawM
669− -> Context context
670− -> Delayed env (Request -> (Response -> IO ResponseReceived) -> Handler ResponseReceived) -> Router env
671− route _ _ handleDelayed = RawRouter $ \env request respond -> runResourceT $ do
672− routeResult <- runDelayed handleDelayed env request
673− let respond' = liftIO . respond
674− liftIO $ case routeResult of
675− Route handler -> runHandler (handler request (respond . Route)) >>=
676− \case
677− Left e -> respond' $ FailFatal e
678− Right a -> pure a
679− Fail e -> respond' $ Fail e
680− FailFatal e -> respond' $ FailFatal e
681−
682− hoistServerWithContext _ _ f srvM = \req respond -> f (srvM req respond)
683−
684−
685611-- | If you use 'ReqBody' in one of the endpoints for your API,
686612-- this automatically requires your server-side handler to be a function
687613-- that takes an argument of the type specified by 'ReqBody'.
@@ -895,11 +821,7 @@ instance (HasContextEntry context (NamedContext name subContext), HasServer subA
895821-------------------------------------------------------------------------------
896822
897823-- Erroring instance for 'HasServer' when a combinator is not fully applied
898−instance TypeError (PartialApplication
899−#if __GLASGOW_HASKELL__ >= 904
900− @(Type -> [Type] -> Constraint)
901−#endif
902− HasServer arr) => HasServer ((arr :: a -> b) :> sub) context
824+instance TypeError (PartialApplication HasServer arr) => HasServer ((arr :: a -> b) :> sub) context
903825 where
904826 type ServerT (arr :> sub) _ = TypeError (PartialApplication (HasServer :: * -> [*] -> Constraint) arr)
905827 route = error "unreachable"
@@ -943,11 +865,7 @@ type HasServerArrowTypeError a b =
943865-- XXX: This omits the @context@ parameter, e.g.:
944866--
945867-- "There is no instance for HasServer (Bool :> …)". Do we care ?
946−instance {-# OVERLAPPABLE #-} TypeError (NoInstanceForSub
947−#if __GLASGOW_HASKELL__ >= 904
948− @(Type -> [Type] -> Constraint)
949−#endif
950− HasServer ty) => HasServer (ty :> sub) context
868+instance {-# OVERLAPPABLE #-} TypeError (NoInstanceForSub HasServer ty) => HasServer (ty :> sub) context
951869
952870instance {-# OVERLAPPABLE #-} TypeError (NoInstanceFor (HasServer api context)) => HasServer api context
953871