@@ -1,29 +1,29 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
1+{-# LANGUAGE CPP #-}
2{-# LANGUAGE ConstraintKinds #-}
2{-# LANGUAGE ConstraintKinds #-}
3{-# LANGUAGE DataKinds #-}
3{-# LANGUAGE DataKinds #-}
4{-# LANGUAGE DeriveDataTypeable #-}
4{-# LANGUAGE DeriveDataTypeable #-}
5{-# LANGUAGE FlexibleContexts #-}
5{-# LANGUAGE FlexibleContexts #-}
6{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FlexibleInstances #-}
7−{-# LANGUAGE InstanceSigs #-}
8{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE MultiParamTypeClasses #-}
9{-# LANGUAGE OverloadedStrings #-}
8{-# LANGUAGE OverloadedStrings #-}
10{-# LANGUAGE PolyKinds #-}
9{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE QuantifiedConstraints #-}
12{-# LANGUAGE RankNTypes #-}
10{-# LANGUAGE RankNTypes #-}
13{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE ScopedTypeVariables #-}
14{-# LANGUAGE TupleSections #-}
12{-# LANGUAGE TupleSections #-}
15−{-# LANGUAGE TypeApplications #-}
16{-# LANGUAGE TypeFamilies #-}
13{-# LANGUAGE TypeFamilies #-}
17{-# LANGUAGE TypeOperators #-}
14{-# LANGUAGE TypeOperators #-}
18{-# LANGUAGE UndecidableInstances #-}
15{-# LANGUAGE UndecidableInstances #-}
17+#if MIN_VERSION_base(4,9,0) && __GLASGOW_HASKELL__ >= 802
18+#define HAS_TYPE_ERROR
20module Servant.Server.Internal
21module Servant.Server.Internal
21 ( module Servant.Server.Internal
22 ( module Servant.Server.Internal
22 , module Servant.Server.Internal.BasicAuth
23 , module Servant.Server.Internal.BasicAuth
23 , module Servant.Server.Internal.Context
24 , module Servant.Server.Internal.Context
24 , module Servant.Server.Internal.Delayed
25 , module Servant.Server.Internal.Delayed
25 , module Servant.Server.Internal.DelayedIO
26 , module Servant.Server.Internal.DelayedIO
26− , module Servant.Server.Internal.ErrorFormatter
27 , module Servant.Server.Internal.Handler
27 , module Servant.Server.Internal.Handler
28 , module Servant.Server.Internal.Router
28 , module Servant.Server.Internal.Router
29 , module Servant.Server.Internal.RouteResult
29 , module Servant.Server.Internal.RouteResult
@@ -41,11 +41,12 @@ import qualified Data.ByteString as B
41import qualified Data.ByteString.Builder as BB
41import qualified Data.ByteString.Builder as BB
42import qualified Data.ByteString.Char8 as BC8
42import qualified Data.ByteString.Char8 as BC8
43import qualified Data.ByteString.Lazy as BL
43import qualified Data.ByteString.Lazy as BL
44−import Data.Constraint (Constraint, Dict(..))
45import Data.Either
44import Data.Either
46 (partitionEithers)
45 (partitionEithers)
47import Data.Maybe
46import Data.Maybe
48 (fromMaybe, isNothing, mapMaybe, maybeToList)
47 (fromMaybe, isNothing, mapMaybe, maybeToList)
49import Data.String
50import Data.String
50 (IsString (..))
51 (IsString (..))
51import Data.String.Conversions
52import Data.String.Conversions
@@ -54,9 +55,8 @@ import Data.Tagged
54 (Tagged (..), retag, untag)
55 (Tagged (..), retag, untag)
55import qualified Data.Text as T
56import qualified Data.Text as T
56import Data.Typeable
57import Data.Typeable
58import GHC.TypeLits
58import GHC.TypeLits
59− (KnownNat, KnownSymbol, TypeError, symbolVal)
59+ (KnownNat, KnownSymbol, natVal, symbolVal)
60import qualified Network.HTTP.Media as NHM
60import qualified Network.HTTP.Media as NHM
61import Network.HTTP.Types hiding
61import Network.HTTP.Types hiding
62 (Header, ResponseHeaders)
62 (Header, ResponseHeaders)
@@ -64,52 +64,45 @@ import Network.Socket
64 (SockAddr)
64 (SockAddr)
65import Network.Wai
65import Network.Wai
66 (Application, Request, httpVersion, isSecure, lazyRequestBody,
66 (Application, Request, httpVersion, isSecure, lazyRequestBody,
67− queryString, remoteHost, getRequestBodyChunk, requestHeaders,
67+ rawQueryString, remoteHost, requestBody, requestHeaders,
68 requestMethod, responseLBS, responseStream, vault)
68 requestMethod, responseLBS, responseStream, vault)
69import Prelude ()
69import Prelude ()
70import Prelude.Compat
70import Prelude.Compat
71import Servant.API
71import Servant.API
72 ((:<|>) (..), (:>), Accept (..), BasicAuth, Capture',
72 ((:<|>) (..), (:>), Accept (..), BasicAuth, Capture',
73− CaptureAll, Description, EmptyAPI, Fragment,
73+ CaptureAll, Description, EmptyAPI, FramingRender (..),
74− FramingRender (..), FramingUnrender (..), FromSourceIO (..),
74+ FramingUnrender (..), FromSourceIO (..), Header', If,
75− Header', If, IsSecure (..), NoContentVerb, QueryFlag,
75+ IsSecure (..), QueryFlag, QueryParam', QueryParams, Raw,
76− QueryParam', QueryParams, Raw, ReflectMethod (reflectMethod),
76+ ReflectMethod (reflectMethod), RemoteHost, ReqBody',
77− RemoteHost, ReqBody', SBool (..), SBoolI (..), SourceIO,
77+ SBool (..), SBoolI (..), SourceIO, Stream, StreamBody',
78− Stream, StreamBody', Summary, ToSourceIO (..), Vault, Verb,
78+ Summary, ToSourceIO (..), Vault, Verb, WithNamedContext)
79− WithNamedContext, NamedRoutes)
80−import Servant.API.Generic (GenericMode(..), ToServant, ToServantApi, GServantProduct, toServant, fromServant)
81import Servant.API.ContentTypes
79import Servant.API.ContentTypes
82 (AcceptHeader (..), AllCTRender (..), AllCTUnrender (..),
80 (AcceptHeader (..), AllCTRender (..), AllCTUnrender (..),
83− AllMime, MimeRender (..), MimeUnrender (..), NoContent,
81+ AllMime, MimeRender (..), MimeUnrender (..), canHandleAcceptH)
85import Servant.API.Modifiers
82import Servant.API.Modifiers
86 (FoldLenient, FoldRequired, RequestArgument,
83 (FoldLenient, FoldRequired, RequestArgument,
87 unfoldRequestArgument)
84 unfoldRequestArgument)
88import Servant.API.ResponseHeaders
85import Servant.API.ResponseHeaders
89 (GetHeaders, Headers, getHeaders, getResponse)
86 (GetHeaders, Headers, getHeaders, getResponse)
90−import Servant.API.Status
92import qualified Servant.Types.SourceT as S
87import qualified Servant.Types.SourceT as S
93−import Servant.API.TypeErrors
94import Web.HttpApiData
88import Web.HttpApiData
95− (FromHttpApiData, parseHeader, parseQueryParam, parseUrlPiece,
89+ (FromHttpApiData, parseHeader, parseQueryParam,
96− parseUrlPieces)
90+ parseUrlPieceMaybe, parseUrlPieces)
98import Servant.Server.Internal.BasicAuth
92import Servant.Server.Internal.BasicAuth
99import Servant.Server.Internal.Context
93import Servant.Server.Internal.Context
100import Servant.Server.Internal.Delayed
94import Servant.Server.Internal.Delayed
101import Servant.Server.Internal.DelayedIO
95import Servant.Server.Internal.DelayedIO
102−import Servant.Server.Internal.ErrorFormatter
103import Servant.Server.Internal.Handler
96import Servant.Server.Internal.Handler
104import Servant.Server.Internal.Router
97import Servant.Server.Internal.Router
105import Servant.Server.Internal.RouteResult
98import Servant.Server.Internal.RouteResult
106import Servant.Server.Internal.RoutingApplication
99import Servant.Server.Internal.RoutingApplication
107import Servant.Server.Internal.ServerError
100import Servant.Server.Internal.ServerError
102+#ifdef HAS_TYPE_ERROR
109import GHC.TypeLits
103import GHC.TypeLits
110 (ErrorMessage (..), TypeError)
104 (ErrorMessage (..), TypeError)
111−import Servant.API.TypeLevel
105+#endif
112− (AtLeastOneFragment, FragmentUnique)
114class HasServer api context where
107class HasServer api context where
115 type ServerT api (m :: * -> *) :: *
108 type ServerT api (m :: * -> *) :: *
@@ -173,31 +166,22 @@ instance (HasServer a context, HasServer b context) => HasServer (a :<|> b) cont
173-- > server = getBook
166-- > server = getBook
174-- > where getBook :: Text -> Handler Book
167-- > where getBook :: Text -> Handler Book
175-- > getBook isbn = ...
168-- > getBook isbn = ...
176−instance (KnownSymbol capture, FromHttpApiData a, Typeable a
169+instance (KnownSymbol capture, FromHttpApiData a, HasServer api context)
177− , HasServer api context, SBoolI (FoldLenient mods)
178− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
180 => HasServer (Capture' mods capture a :> api) context where
170 => HasServer (Capture' mods capture a :> api) context where
182 type ServerT (Capture' mods capture a :> api) m =
172 type ServerT (Capture' mods capture a :> api) m =
183− If (FoldLenient mods) (Either String a) a -> ServerT api m
173+ a -> ServerT api m
185 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
175 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
187 route Proxy context d =
177 route Proxy context d =
188− CaptureRouter [hint] $
178+ CaptureRouter $
189 route (Proxy :: Proxy api)
179 route (Proxy :: Proxy api)
191− (addCapture d $ \ txt -> withRequest $ \ request ->
181+ (addCapture d $ \ txt -> case parseUrlPieceMaybe txt of
192− case ( sbool :: SBool (FoldLenient mods)
182+ Nothing -> delayedFail err400
193− , parseUrlPiece txt :: Either T.Text a) of
194− (SFalse, Left e) -> delayedFail $ formatError rep request $ cs e
195− (SFalse, Right v) -> return v
183+ Just v -> return v
196− (STrue, piece) -> return $ (either (Left . cs) Right) piece)
184+ )
198− rep = typeRep (Proxy :: Proxy Capture')
199− formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
200− hint = CaptureHint (T.pack $ symbolVal $ Proxy @capture) (typeRep (Proxy :: Proxy a))
202-- | If you use 'CaptureAll' in one of the endpoints for your API,
186-- | If you use 'CaptureAll' in one of the endpoints for your API,
203-- this automatically requires your server-side handler to be a
187-- this automatically requires your server-side handler to be a
@@ -216,10 +200,7 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a
216-- > server = getSourceFile
200-- > server = getSourceFile
217-- > where getSourceFile :: [Text] -> Handler Book
201-- > where getSourceFile :: [Text] -> Handler Book
218-- > getSourceFile pathSegments = ...
202-- > getSourceFile pathSegments = ...
219−instance (KnownSymbol capture, FromHttpApiData a, Typeable a
203+instance (KnownSymbol capture, FromHttpApiData a, HasServer api context)
220− , HasServer api context
221− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
223 => HasServer (CaptureAll capture a :> api) context where
204 => HasServer (CaptureAll capture a :> api) context where
225 type ServerT (CaptureAll capture a :> api) m =
206 type ServerT (CaptureAll capture a :> api) m =
@@ -228,18 +209,14 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a
228 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
209 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
230 route Proxy context d =
211 route Proxy context d =
231− CaptureAllRouter [hint] $
212+ CaptureAllRouter $
232 route (Proxy :: Proxy api)
213 route (Proxy :: Proxy api)
234− (addCapture d $ \ txts -> withRequest $ \ request ->
235− case parseUrlPieces txts of
215+ (addCapture d $ \ txts -> case parseUrlPieces txts of
236− Left e -> delayedFail $ formatError rep request $ cs e
216+ Left _ -> delayedFail err400
237− Right v -> return v
217+ Right v -> return v
240− rep = typeRep (Proxy :: Proxy CaptureAll)
241− formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
242− hint = CaptureHint (T.pack $ symbolVal $ Proxy @capture) (typeRep (Proxy :: Proxy [a]))
244allowedMethodHead :: Method -> Request -> Bool
221allowedMethodHead :: Method -> Request -> Bool
245allowedMethodHead method request = method == methodGet && requestMethod request == methodHead
222allowedMethodHead method request = method == methodGet && requestMethod request == methodHead
@@ -259,10 +236,10 @@ methodCheck method request
259-- body check is no longer an option. However, we now run the accept
236-- body check is no longer an option. However, we now run the accept
260-- check before the body check and can therefore afford to make it
237-- check before the body check and can therefore afford to make it
261-- recoverable.
238-- recoverable.
262−acceptCheck :: (AllMime list) => Proxy list -> AcceptHeader -> DelayedIO ()
239+acceptCheck :: (AllMime list) => Proxy list -> B.ByteString -> DelayedIO ()
263acceptCheck proxy accH
240acceptCheck proxy accH
264− | canHandleAcceptH proxy accH = return ()
241+ | canHandleAcceptH proxy (AcceptHeader accH) = return ()
265− | otherwise = delayedFail err406
242+ | otherwise = delayedFail err406
267methodRouter :: (AllCTRender ctypes a)
244methodRouter :: (AllCTRender ctypes a)
268 => (b -> ([(HeaderName, B.ByteString)], a))
245 => (b -> ([(HeaderName, B.ByteString)], a))
@@ -272,28 +249,17 @@ methodRouter :: (AllCTRender ctypes a)
272methodRouter splitHeaders method proxy status action = leafRouter route'
249methodRouter splitHeaders method proxy status action = leafRouter route'
274 route' env request respond =
251 route' env request respond =
275− let accH = getAcceptHeader request
252+ let accH = fromMaybe ct_wildcard $ lookup hAccept $ requestHeaders request
276 in runAction (action `addMethodCheck` methodCheck method request
253 in runAction (action `addMethodCheck` methodCheck method request
277 `addAcceptCheck` acceptCheck proxy accH
254 `addAcceptCheck` acceptCheck proxy accH
278 ) env request respond $ \ output -> do
255 ) env request respond $ \ output -> do
279 let (headers, b) = splitHeaders output
256 let (headers, b) = splitHeaders output
280− case handleAcceptH proxy accH b of
257+ case handleAcceptH proxy (AcceptHeader accH) b of
281 Nothing -> FailFatal err406 -- this should not happen (checked before), so we make it fatal if it does
258 Nothing -> FailFatal err406 -- this should not happen (checked before), so we make it fatal if it does
282 Just (contentT, body) ->
259 Just (contentT, body) ->
283 let bdy = if allowedMethodHead method request then "" else body
260 let bdy = if allowedMethodHead method request then "" else body
284 in Route $ responseLBS status ((hContentType, cs contentT) : headers) bdy
261 in Route $ responseLBS status ((hContentType, cs contentT) : headers) bdy
286−noContentRouter :: Method
288− -> Delayed env (Handler b)
290−noContentRouter method status action = leafRouter route'
292− route' env request respond =
293− runAction (action `addMethodCheck` methodCheck method request)
294− env request respond $ \ _output ->
295− Route $ responseLBS status [] ""
297instance {-# OVERLAPPABLE #-}
263instance {-# OVERLAPPABLE #-}
298 ( AllCTRender ctypes a, ReflectMethod method, KnownNat status
264 ( AllCTRender ctypes a, ReflectMethod method, KnownNat status
299 ) => HasServer (Verb method status ctypes a) context where
265 ) => HasServer (Verb method status ctypes a) context where
@@ -303,7 +269,7 @@ instance {-# OVERLAPPABLE #-}
304 route Proxy _ = methodRouter ([],) method (Proxy :: Proxy ctypes) status
270 route Proxy _ = methodRouter ([],) method (Proxy :: Proxy ctypes) status
305 where method = reflectMethod (Proxy :: Proxy method)
271 where method = reflectMethod (Proxy :: Proxy method)
306− status = statusFromNat (Proxy :: Proxy status)
272+ status = toEnum . fromInteger $ natVal (Proxy :: Proxy status)
308instance {-# OVERLAPPING #-}
274instance {-# OVERLAPPING #-}
309 ( AllCTRender ctypes a, ReflectMethod method, KnownNat status
275 ( AllCTRender ctypes a, ReflectMethod method, KnownNat status
@@ -315,16 +281,8 @@ instance {-# OVERLAPPING #-}
316 route Proxy _ = methodRouter (\x -> (getHeaders x, getResponse x)) method (Proxy :: Proxy ctypes) status
282 route Proxy _ = methodRouter (\x -> (getHeaders x, getResponse x)) method (Proxy :: Proxy ctypes) status
317 where method = reflectMethod (Proxy :: Proxy method)
283 where method = reflectMethod (Proxy :: Proxy method)
318− status = statusFromNat (Proxy :: Proxy status)
284+ status = toEnum . fromInteger $ natVal (Proxy :: Proxy status)
320−instance (ReflectMethod method) =>
321− HasServer (NoContentVerb method) context where
323− type ServerT (NoContentVerb method) m = m NoContent
324− hoistServerWithContext _ _ nt s = nt s
326− route Proxy _ = noContentRouter method status204
327− where method = reflectMethod (Proxy :: Proxy method)
329instance {-# OVERLAPPABLE #-}
287instance {-# OVERLAPPABLE #-}
330 ( MimeRender ctype chunk, ReflectMethod method, KnownNat status,
288 ( MimeRender ctype chunk, ReflectMethod method, KnownNat status,
@@ -336,7 +294,7 @@ instance {-# OVERLAPPABLE #-}
337 route Proxy _ = streamRouter ([],) method status (Proxy :: Proxy framing) (Proxy :: Proxy ctype)
295 route Proxy _ = streamRouter ([],) method status (Proxy :: Proxy framing) (Proxy :: Proxy ctype)
338 where method = reflectMethod (Proxy :: Proxy method)
296 where method = reflectMethod (Proxy :: Proxy method)
339− status = statusFromNat (Proxy :: Proxy status)
297+ status = toEnum . fromInteger $ natVal (Proxy :: Proxy status)
342instance {-# OVERLAPPING #-}
300instance {-# OVERLAPPING #-}
@@ -350,7 +308,7 @@ instance {-# OVERLAPPING #-}
351 route Proxy _ = streamRouter (\x -> (getHeaders x, getResponse x)) method status (Proxy :: Proxy framing) (Proxy :: Proxy ctype)
309 route Proxy _ = streamRouter (\x -> (getHeaders x, getResponse x)) method status (Proxy :: Proxy framing) (Proxy :: Proxy ctype)
352 where method = reflectMethod (Proxy :: Proxy method)
310 where method = reflectMethod (Proxy :: Proxy method)
353− status = statusFromNat (Proxy :: Proxy status)
311+ status = toEnum . fromInteger $ natVal (Proxy :: Proxy status)
356streamRouter :: forall ctype a c chunk env framing. (MimeRender ctype chunk, FramingRender framing, ToSourceIO chunk a) =>
314streamRouter :: forall ctype a c chunk env framing. (MimeRender ctype chunk, FramingRender framing, ToSourceIO chunk a) =>
@@ -362,7 +320,7 @@ streamRouter :: forall ctype a c chunk env framing. (MimeRender ctype chunk, Fra
362 -> Delayed env (Handler c)
320 -> Delayed env (Handler c)
363 -> Router env
321 -> Router env
364streamRouter splitHeaders method status framingproxy ctypeproxy action = leafRouter $ \env request respond ->
322streamRouter splitHeaders method status framingproxy ctypeproxy action = leafRouter $ \env request respond ->
365− let AcceptHeader accH = getAcceptHeader request
323+ let accH = fromMaybe ct_wildcard $ lookup hAccept $ requestHeaders request
366 cmediatype = NHM.matchAccept [contentType ctypeproxy] accH
324 cmediatype = NHM.matchAccept [contentType ctypeproxy] accH
367 accCheck = when (isNothing cmediatype) $ delayedFail err406
325 accCheck = when (isNothing cmediatype) $ delayedFail err406
368 contentHeader = (hContentType, NHM.renderHeader . maybeToList $ cmediatype)
326 contentHeader = (hContentType, NHM.renderHeader . maybeToList $ cmediatype)
@@ -407,7 +365,6 @@ streamRouter splitHeaders method status framingproxy ctypeproxy action = leafRou
408 (KnownSymbol sym, FromHttpApiData a, HasServer api context
366 (KnownSymbol sym, FromHttpApiData a, HasServer api context
409 , SBoolI (FoldRequired mods), SBoolI (FoldLenient mods)
367 , SBoolI (FoldRequired mods), SBoolI (FoldLenient mods)
410− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
412 => HasServer (Header' mods sym a :> api) context where
369 => HasServer (Header' mods sym a :> api) context where
@@ -419,9 +376,6 @@ instance
419 route Proxy context subserver = route (Proxy :: Proxy api) context $
376 route Proxy context subserver = route (Proxy :: Proxy api) context $
420 subserver `addHeaderCheck` withRequest headerCheck
377 subserver `addHeaderCheck` withRequest headerCheck
422− rep = typeRep (Proxy :: Proxy Header')
423− formatError = headerParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
425 headerName :: IsString n => n
379 headerName :: IsString n => n
426 headerName = fromString $ symbolVal (Proxy :: Proxy sym)
380 headerName = fromString $ symbolVal (Proxy :: Proxy sym)
@@ -432,13 +386,15 @@ instance
432 mev :: Maybe (Either T.Text a)
386 mev :: Maybe (Either T.Text a)
433 mev = fmap parseHeader $ lookup headerName (requestHeaders req)
387 mev = fmap parseHeader $ lookup headerName (requestHeaders req)
435− errReq = delayedFailFatal $ formatError rep req
389+ errReq = delayedFailFatal err400
436− $ "Header " <> headerName <> " is required"
390+ { errBody = "Header " <> headerName <> " is required"
438− errSt e = delayedFailFatal $ formatError rep req
393+ errSt e = delayedFailFatal err400
439− $ cs $ "Error parsing header "
394+ { errBody = cs $ "Error parsing header "
440− <> headerName
395+ <> headerName
441− <> " failed: " <> e
396+ <> " failed: " <> e
443-- | If you use @'QueryParam' "author" Text@ in one of the endpoints for your API,
399-- | If you use @'QueryParam' "author" Text@ in one of the endpoints for your API,
444-- this automatically requires your server-side handler to be a function
400-- this automatically requires your server-side handler to be a function
@@ -464,7 +420,6 @@ instance
465 ( KnownSymbol sym, FromHttpApiData a, HasServer api context
421 ( KnownSymbol sym, FromHttpApiData a, HasServer api context
466 , SBoolI (FoldRequired mods), SBoolI (FoldLenient mods)
422 , SBoolI (FoldRequired mods), SBoolI (FoldLenient mods)
467− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
469 => HasServer (QueryParam' mods sym a :> api) context where
424 => HasServer (QueryParam' mods sym a :> api) context where
@@ -474,12 +429,9 @@ instance
474 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
429 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
476 route Proxy context subserver =
431 route Proxy context subserver =
477− let querytext = queryToQueryText . queryString
432+ let querytext req = parseQueryText $ rawQueryString req
478 paramname = cs $ symbolVal (Proxy :: Proxy sym)
433 paramname = cs $ symbolVal (Proxy :: Proxy sym)
480− rep = typeRep (Proxy :: Proxy QueryParam')
481− formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
483 parseParam :: Request -> DelayedIO (RequestArgument mods a)
435 parseParam :: Request -> DelayedIO (RequestArgument mods a)
484 parseParam req =
436 parseParam req =
485 unfoldRequestArgument (Proxy :: Proxy mods) errReq errSt mev
437 unfoldRequestArgument (Proxy :: Proxy mods) errReq errSt mev
@@ -487,12 +439,14 @@ instance
487 mev :: Maybe (Either T.Text a)
439 mev :: Maybe (Either T.Text a)
488 mev = fmap parseQueryParam $ join $ lookup paramname $ querytext req
440 mev = fmap parseQueryParam $ join $ lookup paramname $ querytext req
490− errReq = delayedFailFatal $ formatError rep req
442+ errReq = delayedFailFatal err400
491− $ cs $ "Query parameter " <> paramname <> " is required"
443+ { errBody = cs $ "Query parameter " <> paramname <> " is required"
493− errSt e = delayedFailFatal $ formatError rep req
446+ errSt e = delayedFailFatal err400
494− $ cs $ "Error parsing query parameter "
447+ { errBody = cs $ "Error parsing query parameter "
495− <> paramname <> " failed: " <> e
448+ <> paramname <> " failed: " <> e
497 delayed = addParameterCheck subserver . withRequest $ \req ->
451 delayed = addParameterCheck subserver . withRequest $ \req ->
498 parseParam req
452 parseParam req
@@ -518,8 +472,7 @@ instance
518-- > server = getBooksBy
472-- > server = getBooksBy
519-- > where getBooksBy :: [Text] -> Handler [Book]
473-- > where getBooksBy :: [Text] -> Handler [Book]
520-- > getBooksBy authors = ...return all books by these authors...
474-- > getBooksBy authors = ...return all books by these authors...
521−instance (KnownSymbol sym, FromHttpApiData a, HasServer api context
475+instance (KnownSymbol sym, FromHttpApiData a, HasServer api context)
522− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters)
523 => HasServer (QueryParams sym a :> api) context where
476 => HasServer (QueryParams sym a :> api) context where
525 type ServerT (QueryParams sym a :> api) m =
478 type ServerT (QueryParams sym a :> api) m =
@@ -530,23 +483,21 @@ instance (KnownSymbol sym, FromHttpApiData a, HasServer api context
530 route Proxy context subserver = route (Proxy :: Proxy api) context $
483 route Proxy context subserver = route (Proxy :: Proxy api) context $
531 subserver `addParameterCheck` withRequest paramsCheck
484 subserver `addParameterCheck` withRequest paramsCheck
533− rep = typeRep (Proxy :: Proxy QueryParams)
534− formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
536 paramname = cs $ symbolVal (Proxy :: Proxy sym)
486 paramname = cs $ symbolVal (Proxy :: Proxy sym)
537 paramsCheck req =
487 paramsCheck req =
538 case partitionEithers $ fmap parseQueryParam params of
488 case partitionEithers $ fmap parseQueryParam params of
539 ([], parsed) -> return parsed
489 ([], parsed) -> return parsed
540− (errs, _) -> delayedFailFatal $ formatError rep req
490+ (errs, _) -> delayedFailFatal err400
541− $ cs $ "Error parsing query parameter(s) "
491+ { errBody = cs $ "Error parsing query parameter(s) "
542− <> paramname <> " failed: "
492+ <> paramname <> " failed: "
543− <> T.intercalate ", " errs
493+ <> T.intercalate ", " errs
545 params :: [T.Text]
496 params :: [T.Text]
546 params = mapMaybe snd
497 params = mapMaybe snd
547 . filter (looksLikeParam . fst)
498 . filter (looksLikeParam . fst)
548− . queryToQueryText
499+ . parseQueryText
549− . queryString
500+ . rawQueryString
552 looksLikeParam name = name == paramname || name == (paramname <> "[]")
503 looksLikeParam name = name == paramname || name == (paramname <> "[]")
@@ -572,7 +523,7 @@ instance (KnownSymbol sym, HasServer api context)
572 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
523 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
574 route Proxy context subserver =
525 route Proxy context subserver =
575− let querytext = queryToQueryText . queryString
526+ let querytext r = parseQueryText $ rawQueryString r
576 param r = case lookup paramname (querytext r) of
527 param r = case lookup paramname (querytext r) of
577 Just Nothing -> True -- param is there, with no value
528 Just Nothing -> True -- param is there, with no value
578 Just (Just v) -> examine v -- param with a value
529 Just (Just v) -> examine v -- param with a value
@@ -614,7 +565,7 @@ instance HasServer Raw context where
614-- The @Content-Type@ header is inspected, and the list provided is used to
565-- The @Content-Type@ header is inspected, and the list provided is used to
615-- attempt deserialization. If the request does not have a @Content-Type@
566-- attempt deserialization. If the request does not have a @Content-Type@
616-- header, it is treated as @application/octet-stream@ (as specified in
567-- header, it is treated as @application/octet-stream@ (as specified in
617−-- [RFC 7231 section 3.1.1.5](http://tools.ietf.org/html/rfc7231#section-3.1.1.5)).
568+-- <http://tools.ietf.org/html/rfc7231#section-3.1.1.5 RFC7231>.
618-- This lets servant worry about extracting it from the request and turning
569-- This lets servant worry about extracting it from the request and turning
619-- it into a value of the type you specify.
570-- it into a value of the type you specify.
@@ -630,7 +581,6 @@ instance HasServer Raw context where
630-- > where postBook :: Book -> Handler Book
581-- > where postBook :: Book -> Handler Book
631-- > postBook book = ...insert into your db...
582-- > postBook book = ...insert into your db...
632instance ( AllCTUnrender list a, HasServer api context, SBoolI (FoldLenient mods)
583instance ( AllCTUnrender list a, HasServer api context, SBoolI (FoldLenient mods)
633− , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
634 ) => HasServer (ReqBody' mods list a :> api) context where
584 ) => HasServer (ReqBody' mods list a :> api) context where
636 type ServerT (ReqBody' mods list a :> api) m =
586 type ServerT (ReqBody' mods list a :> api) m =
@@ -642,9 +592,6 @@ instance ( AllCTUnrender list a, HasServer api context, SBoolI (FoldLenient mods
642 = route (Proxy :: Proxy api) context $
592 = route (Proxy :: Proxy api) context $
643 addBodyCheck subserver ctCheck bodyCheck
593 addBodyCheck subserver ctCheck bodyCheck
645− rep = typeRep (Proxy :: Proxy ReqBody')
646− formatError = bodyParserErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
648 -- Content-Type check, we only lookup we can try to parse the request body
595 -- Content-Type check, we only lookup we can try to parse the request body
649 ctCheck = withRequest $ \ request -> do
596 ctCheck = withRequest $ \ request -> do
650 -- See HTTP RFC 2616, section 7.2.1
597 -- See HTTP RFC 2616, section 7.2.1
@@ -663,7 +610,7 @@ instance ( AllCTUnrender list a, HasServer api context, SBoolI (FoldLenient mods
663 case sbool :: SBool (FoldLenient mods) of
610 case sbool :: SBool (FoldLenient mods) of
664 STrue -> return mrqbody
611 STrue -> return mrqbody
665 SFalse -> case mrqbody of
612 SFalse -> case mrqbody of
666− Left e -> delayedFailFatal $ formatError rep request e
613+ Left e -> delayedFailFatal err400 { errBody = cs e }
667 Right v -> return v
614 Right v -> return v
@@ -686,7 +633,7 @@ instance
686 bodyCheck fromRS = withRequest $ \req -> do
633 bodyCheck fromRS = withRequest $ \req -> do
687 let mimeUnrender' = mimeUnrender (Proxy :: Proxy ctype) :: BL.ByteString -> Either String chunk
634 let mimeUnrender' = mimeUnrender (Proxy :: Proxy ctype) :: BL.ByteString -> Either String chunk
688 let framingUnrender' = framingUnrender (Proxy :: Proxy framing) mimeUnrender' :: SourceIO B.ByteString -> SourceIO chunk
635 let framingUnrender' = framingUnrender (Proxy :: Proxy framing) mimeUnrender' :: SourceIO B.ByteString -> SourceIO chunk
689− let body = getRequestBodyChunk req
636+ let body = requestBody req
690 let rs = S.fromAction B.null body
637 let rs = S.fromAction B.null body
691 let rs' = fromRS $ framingUnrender' rs
638 let rs' = fromRS $ framingUnrender' rs
692 return rs'
639 return rs'
@@ -755,12 +702,12 @@ data EmptyServer = EmptyServer deriving (Typeable, Eq, Show, Bounded, Enum)
755emptyServer :: ServerT EmptyAPI m
702emptyServer :: ServerT EmptyAPI m
756emptyServer = Tagged EmptyServer
703emptyServer = Tagged EmptyServer
758−-- | The server for an `EmptyAPI` is `emptyServer`.
705+-- | The server for an `EmptyAPI` is `emptyAPIServer`.
760-- > type MyApi = "nothing" :> EmptyApi
707-- > type MyApi = "nothing" :> EmptyApi
762-- > server :: Server MyApi
709-- > server :: Server MyApi
763−-- > server = emptyServer
710+-- > server = emptyAPIServer
764instance HasServer EmptyAPI context where
711instance HasServer EmptyAPI context where
765 type ServerT EmptyAPI m = Tagged m EmptyServer
712 type ServerT EmptyAPI m = Tagged m EmptyServer
@@ -789,10 +736,7 @@ instance ( KnownSymbol realm
789-- * helpers
736-- * helpers
791ct_wildcard :: B.ByteString
738ct_wildcard :: B.ByteString
792−ct_wildcard = "*" <> "/" <> "*"
739+ct_wildcard = "*" <> "/" <> "*" -- Because CPP
794−getAcceptHeader :: Request -> AcceptHeader
795−getAcceptHeader = AcceptHeader . fromMaybe ct_wildcard . lookup hAccept . requestHeaders
797-- * General Authentication
741-- * General Authentication
@@ -817,15 +761,39 @@ instance (HasContextEntry context (NamedContext name subContext), HasServer subA
817 hoistServerWithContext _ _ nt s = hoistServerWithContext (Proxy :: Proxy subApi) (Proxy :: Proxy subContext) nt s
761 hoistServerWithContext _ _ nt s = hoistServerWithContext (Proxy :: Proxy subApi) (Proxy :: Proxy subContext) nt s
819-------------------------------------------------------------------------------
763-------------------------------------------------------------------------------
820−-- Custom type errors
764+-- TypeError helpers
821-------------------------------------------------------------------------------
765-------------------------------------------------------------------------------
823−-- Erroring instance for 'HasServer' when a combinator is not fully applied
767+#ifdef HAS_TYPE_ERROR
768+-- | This instance catches mistakes when there are non-saturated
769+-- type applications on LHS of ':>'.
771+-- >>> serve (Proxy :: Proxy (Capture "foo" :> Get '[JSON] Int)) (error "...")
773+-- ...Expected something of kind Symbol or *, got: k -> l on the LHS of ':>'.
774+-- ...Maybe you haven't applied enough arguments to
775+-- ...Capture' '[] "foo"
778+-- >>> undefined :: Server (Capture "foo" :> Get '[JSON] Int)
780+-- ...Expected something of kind Symbol or *, got: k -> l on the LHS of ':>'.
781+-- ...Maybe you haven't applied enough arguments to
782+-- ...Capture' '[] "foo"
824−instance TypeError (PartialApplication HasServer arr) => HasServer ((arr :: a -> b) :> sub) context
785+instance TypeError (HasServerArrowKindError arr) => HasServer ((arr :: k -> l) :> api) context
826− type ServerT (arr :> sub) _ = TypeError (PartialApplication (HasServer :: * -> [*] -> Constraint) arr)
787+ type ServerT (arr :> api) m = TypeError (HasServerArrowKindError arr)
827− route = error "unreachable"
788+ -- it doens't really matter what sub route we peak
789+ route _ _ _ = error "servant-server panic: impossible happened in HasServer (arr :> api)"
828− hoistServerWithContext _ _ _ _ = error "unreachable"
790+ hoistServerWithContext _ _ _ = id
792+-- Cannot have TypeError here, otherwise use of this symbol will error :)
793+type HasServerArrowKindError arr =
794+ 'Text "Expected something of kind Symbol or *, got: k -> l on the LHS of ':>'."
795+ ':$$: 'Text "Maybe you haven't applied enough arguments to"
830-- | This instance prevents from accidentally using '->' instead of ':>'
798-- | This instance prevents from accidentally using '->' instead of ':>'
@@ -859,103 +827,7 @@ type HasServerArrowTypeError a b =
859 ':$$: 'ShowType a
827 ':$$: 'ShowType a
860 ':$$: 'Text "and"
828 ':$$: 'Text "and"
861 ':$$: 'ShowType b
829 ':$$: 'ShowType b
863−-- Erroring instances for 'HasServer' for unknown API combinators
865−-- XXX: This omits the @context@ parameter, e.g.:
867−-- "There is no instance for HasServer (Bool :> …)". Do we care ?
868−instance {-# OVERLAPPABLE #-} TypeError (NoInstanceForSub HasServer ty) => HasServer (ty :> sub) context
870−instance {-# OVERLAPPABLE #-} TypeError (NoInstanceFor (HasServer api context)) => HasServer api context
872−-- | Ignore @'Fragment'@ in server handlers.
873−-- See <https://ietf.org/rfc/rfc2616.html#section-15.1.3> for more details.
877−-- > type MyApi = "books" :> Fragment Text :> Get '[JSON] [Book]
879−-- > server :: Server MyApi
880−-- > server = getBooks
881−-- > where getBooks :: Handler [Book]
882−-- > getBooks = ...return all books...
883−instance (AtLeastOneFragment api, FragmentUnique (Fragment a1 :> api), HasServer api context)
884− => HasServer (Fragment a1 :> api) context where
885− type ServerT (Fragment a1 :> api) m = ServerT api m
887− route _ = route (Proxy :: Proxy api)
889− hoistServerWithContext _ = hoistServerWithContext (Proxy :: Proxy api)
892-- >>> import Servant
833-- >>> import Servant
894−-- | A type that specifies that an API record contains a server implementation.
895−data AsServerT (m :: * -> *)
896−instance GenericMode (AsServerT m) where
897− type AsServerT m :- api = ServerT api m
899−type AsServer = AsServerT Handler
902−-- | Set of constraints required to convert to / from vanilla server types.
903−type GServerConstraints api m =
904− ( ToServant api (AsServerT m) ~ ServerT (ToServantApi api) m
905− , GServantProduct (Rep (api (AsServerT m)))
908−-- | This class is a necessary evil: in the implementation of 'HasServer' for
909−-- @'NamedRoutes' api@, we essentially need the quantified constraint @forall
910−-- m. 'GServerConstraints' m@ to hold.
912−-- We cannot require do that directly as the definition of 'GServerConstraints'
913−-- contains type family applications ('Rep' and 'ServerT'). The trick is to hide
914−-- those type family applications behind a typeclass providing evidence for
915−-- @'GServerConstraints' api m@ in the form of a dictionary, and require that
916−-- @forall m. 'GServer' api m@ instead.
918−-- Users shouldn't have to worry about this class, as the only possible instance
919−-- is provided in this module for all record APIs.
921−class GServer (api :: * -> *) (m :: * -> *) where
922− gServerProof :: Dict (GServerConstraints api m)
925− ( ToServant api (AsServerT m) ~ ServerT (ToServantApi api) m
926− , GServantProduct (Rep (api (AsServerT m)))
927− ) => GServer api m where
931− ( HasServer (ToServantApi api) context
932− , forall m. Generic (api (AsServerT m))
933− , forall m. GServer api m
934− ) => HasServer (NamedRoutes api) context where
936− type ServerT (NamedRoutes api) m = api (AsServerT m)
939− :: Proxy (NamedRoutes api)
941− -> Delayed env (api (AsServerT Handler))
943− route _ ctx delayed =
944− case gServerProof @api @Handler of
945− Dict -> route (Proxy @(ToServantApi api)) ctx (toServant <$> delayed)
947− hoistServerWithContext
948− :: forall m n. Proxy (NamedRoutes api)
950− -> (forall x. m x -> n x)
951− -> api (AsServerT m)
952− -> api (AsServerT n)
953− hoistServerWithContext _ pctx nat server =
954− case (gServerProof @api @m, gServerProof @api @n) of
956− fromServant servantSrvN
958− servantSrvM :: ServerT (ToServantApi api) m =
960− servantSrvN :: ServerT (ToServantApi api) n =
961− hoistServerWithContext (Proxy @(ToServantApi api)) pctx nat servantSrvM