git.iko.soy/typeable/servant
on master help sign in
Merge pull request #1114 from phadej/bgamari-request-in-failureresponse

Bgamari request in failureresponse

commitfdd1c7392bfc21ecbf0a29c79e8df90d556f99c0 authorOleg Grenrus <oleg.grenrus@iki.fi> dateTue 5 Feb 2019, 12:25 (8 years ago) parent46afc9b388f8f0
7 files changed+91−29
servant-client-core/servant-client-core.cabal+5−1 servant-client-core/src/Servant/Client/Core/Internal/BaseUrl.hs+5 servant-client-core/src/Servant/Client/Core/Internal/Request.hs+50−17 servant-client/servant-client.cabal+4 servant-client/src/Servant/Client/Internal/HttpClient.hs+9−1 servant-client/src/Servant/Client/Internal/HttpClient/Streaming.hs+4−3 servant-client/test/Servant/ClientSpec.hs+14−7
servant-client-core/servant-client-core.cabal+5−1
@@ -58,9 +58,13 @@ library
5858 , transformers >= 0.5.2.0 && < 0.6
5959 , template-haskell >= 2.11.1.0 && < 2.15
6060
61+ if !impl(ghc >= 8.2)
62+ build-depends:
63+ bifunctors >= 5.5.3 && < 5.6
64+
6165 -- Servant dependencies
6266 build-depends:
63− servant >= 0.15 && <0.16
67+ servant >= 0.15 && <0.16
6468
6569 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
6670 -- Here can be exceptions if we really need features from the newer versions.
servant-client-core/src/Servant/Client/Core/Internal/BaseUrl.hs+5
@@ -4,6 +4,8 @@
44{-# LANGUAGE ViewPatterns #-}
55module Servant.Client.Core.Internal.BaseUrl where
66
7+import Control.DeepSeq
8+ (NFData (..))
79import Control.Monad.Catch
810 (Exception, MonadThrow, throwM)
911import Data.Aeson
@@ -39,6 +41,9 @@ data BaseUrl = BaseUrl
3941 } deriving (Show, Ord, Generic, Lift, Data)
4042-- TODO: Ord is more precise than Eq
4143-- TODO: Add Hashable instance?
44+--
45+instance NFData BaseUrl where
46+ rnf (BaseUrl a b c d) = a `seq` rnf b `seq` rnf c `seq` rnf d
4247
4348instance Eq BaseUrl where
4449 BaseUrl a b c path == BaseUrl a' b' c' path'
servant-client-core/src/Servant/Client/Core/Internal/Request.hs+50−17
@@ -19,14 +19,20 @@ import Control.DeepSeq
1919 (NFData (..))
2020import Control.Monad.Catch
2121 (Exception)
22−import qualified Data.ByteString as BS
23−import qualified Data.ByteString.Builder as Builder
24−import qualified Data.ByteString.Lazy as LBS
22+import Data.Bifoldable
23+ (Bifoldable (..))
24+import Data.Bifunctor
25+ (Bifunctor (..))
26+import Data.Bitraversable
27+ (Bitraversable (..), bifoldMapDefault, bimapDefault)
28+import qualified Data.ByteString as BS
29+import qualified Data.ByteString.Builder as Builder
30+import qualified Data.ByteString.Lazy as LBS
2531import Data.Int
2632 (Int64)
2733import Data.Semigroup
2834 ((<>))
29−import qualified Data.Sequence as Seq
35+import qualified Data.Sequence as Seq
3036import Data.Text
3137 (Text)
3238import Data.Text.Encoding
@@ -42,13 +48,17 @@ import Network.HTTP.Types
4248 Status (..), http11, methodGet)
4349import Servant.API
4450 (ToHttpApiData, toEncodedUrlPiece, toHeader)
51+import Servant.Client.Core.Internal.BaseUrl
52+ (BaseUrl)
4553
4654-- | A type representing possible errors in a request
4755--
4856-- Note that this type substantially changed in 0.12.
4957data ServantError =
50− -- | The server returned an error response
51− FailureResponse Response
58+ -- | The server returned an error response including the
59+ -- failing request. 'requestPath' includes the 'BaseUrl' and the
60+ -- path of the request.
61+ FailureResponse (RequestF () (BaseUrl, BS.ByteString)) Response
5262 -- | The body could not be decoded at the expected type
5363 | DecodeFailure Text Response
5464 -- | The content-type of the response is not supported
@@ -62,30 +72,53 @@ data ServantError =
6272instance Exception ServantError
6373
6474instance NFData ServantError where
65− rnf (FailureResponse res) = rnf res
75+ rnf (FailureResponse req res) = rnf req `seq` rnf res
6676 rnf (DecodeFailure err res) = rnf err `seq` rnf res
6777 rnf (UnsupportedContentType mt' res) =
6878 mediaTypeRnf mt' `seq`
6979 rnf res
70− where
71− mediaTypeRnf mt =
72− rnf (mainType mt) `seq`
73− rnf (subType mt) `seq`
74− rnf (parameters mt)
7580 rnf (InvalidContentTypeHeader res) = rnf res
7681 rnf (ConnectionError err) = rnf err
7782
78−data RequestF a = Request
79− { requestPath :: a
83+mediaTypeRnf :: MediaType -> ()
84+mediaTypeRnf mt =
85+ rnf (mainType mt) `seq`
86+ rnf (subType mt) `seq`
87+ rnf (parameters mt)
88+
89+data RequestF body path = Request
90+ { requestPath :: path
8091 , requestQueryString :: Seq.Seq QueryItem
81− , requestBody :: Maybe (RequestBody, MediaType)
92+ , requestBody :: Maybe (body, MediaType)
8293 , requestAccept :: Seq.Seq MediaType
8394 , requestHeaders :: Seq.Seq Header
8495 , requestHttpVersion :: HttpVersion
8596 , requestMethod :: Method
86− } deriving (Generic, Typeable)
97+ } deriving (Generic, Typeable, Eq, Show, Functor, Foldable, Traversable)
98+
99+instance Bifunctor RequestF where bimap = bimapDefault
100+instance Bifoldable RequestF where bifoldMap = bifoldMapDefault
101+instance Bitraversable RequestF where
102+ bitraverse f g r = mk
103+ <$> traverse (bitraverse f pure) (requestBody r)
104+ <*> g (requestPath r)
105+ where
106+ mk b p = r { requestBody = b, requestPath = p }
107+
108+instance (NFData path, NFData body) => NFData (RequestF body path) where
109+ rnf r =
110+ rnf (requestPath r)
111+ `seq` rnf (requestQueryString r)
112+ `seq` rnfB (requestBody r)
113+ `seq` rnf (fmap mediaTypeRnf (requestAccept r))
114+ `seq` rnf (requestHeaders r)
115+ `seq` requestHttpVersion r
116+ `seq` rnf (requestMethod r)
117+ where
118+ rnfB Nothing = ()
119+ rnfB (Just (b, mt)) = rnf b `seq` mediaTypeRnf mt
87120
88−type Request = RequestF Builder.Builder
121+type Request = RequestF RequestBody Builder.Builder
89122
90123-- | The request body. A replica of the @http-client@ @RequestBody@.
91124data RequestBody
servant-client/servant-client.cabal+4
@@ -55,6 +55,10 @@ library
5555 , time >= 1.6.0.1 && < 1.9
5656 , transformers >= 0.5.2.0 && < 0.6
5757
58+ if !impl(ghc >= 8.2)
59+ build-depends:
60+ bifunctors >= 5.5.3 && < 5.6
61+
5862 -- Servant dependencies.
5963 -- Strict dependency on `servant-client-core` as we re-export things.
6064 build-depends:
servant-client/src/Servant/Client/Internal/HttpClient.hs+9−1
@@ -31,6 +31,8 @@ import Control.Monad.STM
3131import Control.Monad.Trans.Control
3232 (MonadBaseControl (..))
3333import Control.Monad.Trans.Except
34+import Data.Bifunctor
35+ (bimap)
3436import Data.ByteString.Builder
3537 (toLazyByteString)
3638import qualified Data.ByteString.Lazy as BSL
@@ -167,7 +169,7 @@ performRequest req = do
167169 status_code = statusCode status
168170 ourResponse = clientResponseToResponse response
169171 unless (status_code >= 200 && status_code < 300) $
170− throwError $ FailureResponse ourResponse
172+ throwError $ mkFailureResponse burl req ourResponse
171173 return ourResponse
172174 where
173175 requestWithoutCookieJar :: Client.Manager -> Client.Request -> ClientM (Client.Response BSL.ByteString)
@@ -195,6 +197,12 @@ performRequest req = do
195197 fReq = Client.hrFinalRequest responses
196198 fRes = Client.hrFinalResponse responses
197199
200+mkFailureResponse :: BaseUrl -> Request -> GenResponse BSL.ByteString -> ServantError
201+mkFailureResponse burl request =
202+ FailureResponse (bimap (const ()) f request)
203+ where
204+ f b = (burl, BSL.toStrict $ toLazyByteString b)
205+
198206clientResponseToResponse :: Client.Response a -> GenResponse a
199207clientResponseToResponse r = Response
200208 { responseStatusCode = Client.responseStatus r
servant-client/src/Servant/Client/Internal/HttpClient/Streaming.hs+4−3
@@ -53,7 +53,8 @@ import qualified Network.HTTP.Client as Client
5353import Servant.Client.Core
5454import Servant.Client.Internal.HttpClient
5555 (ClientEnv (..), catchConnectionError,
56− clientResponseToResponse, mkClientEnv, requestToClientRequest)
56+ clientResponseToResponse, mkClientEnv, requestToClientRequest,
57+ mkFailureResponse)
5758
5859
5960-- | Generates a set of client functions for an API.
@@ -166,7 +167,7 @@ performRequest req = do
166167 status_code = statusCode status
167168 ourResponse = clientResponseToResponse response
168169 unless (status_code >= 200 && status_code < 300) $
169− throwError $ FailureResponse ourResponse
170+ throwError $ mkFailureResponse burl req ourResponse
170171 return ourResponse
171172
172173performWithStreamingRequest :: Request -> (StreamingResponse -> IO a) -> ClientM a
@@ -182,7 +183,7 @@ performWithStreamingRequest req k = do
182183 -- we throw FailureResponse in IO :(
183184 unless (status_code >= 200 && status_code < 300) $ do
184185 b <- BSL.fromChunks <$> Client.brConsume (Client.responseBody res)
185− throwIO $ FailureResponse $ clientResponseToResponse res { Client.responseBody = b }
186+ throwIO $ mkFailureResponse burl req (clientResponseToResponse res { Client.responseBody = b })
186187
187188 x <- k (clientResponseToResponse res)
188189 k1 x
servant-client/test/Servant/ClientSpec.hs+14−7
@@ -40,7 +40,7 @@ import Data.Aeson
4040import Data.Char
4141 (chr, isPrint)
4242import Data.Foldable
43− (forM_)
43+ (forM_, toList)
4444import Data.Maybe
4545 (listToMaybe)
4646import Data.Monoid ()
@@ -336,9 +336,16 @@ sucessSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do
336336 let p = Person "Clara" 42
337337 left show <$> runClient (getBody p) baseUrl `shouldReturn` Right p
338338
339+ it "Servant.API FailureResponse" $ \(_, baseUrl) -> do
340+ left show <$> runClient (getQueryParam (Just "alice")) baseUrl `shouldReturn` Right alice
341+ Left (FailureResponse req _) <- runClient (getQueryParam (Just "bob")) baseUrl
342+ Req.requestPath req `shouldBe` (baseUrl, "/param")
343+ toList (Req.requestQueryString req) `shouldBe` [("name", Just "bob")]
344+ Req.requestMethod req `shouldBe` HTTP.methodGet
345+
339346 it "Servant.API.QueryParam" $ \(_, baseUrl) -> do
340347 left show <$> runClient (getQueryParam (Just "alice")) baseUrl `shouldReturn` Right alice
341− Left (FailureResponse r) <- runClient (getQueryParam (Just "bob")) baseUrl
348+ Left (FailureResponse _ r) <- runClient (getQueryParam (Just "bob")) baseUrl
342349 responseStatusCode r `shouldBe` HTTP.Status 400 "bob not found"
343350
344351 it "Servant.API.QueryParam.QueryParams" $ \(_, baseUrl) -> do
@@ -362,7 +369,7 @@ sucessSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do
362369 res <- runClient (getRawFailure HTTP.methodGet) baseUrl
363370 case res of
364371 Right _ -> assertFailure "expected Left, but got Right"
365− Left (FailureResponse r) -> do
372+ Left (FailureResponse _ r) -> do
366373 responseStatusCode r `shouldBe` HTTP.status400
367374 responseBody r `shouldBe` "rawFailure"
368375 Left e -> assertFailure $ "expected FailureResponse, but got " ++ show e
@@ -399,7 +406,7 @@ wrappedApiSpec = describe "error status codes" $ do
399406 it desc $ bracket (startWaiApp $ serveW api) endWaiApp $ \(_, baseUrl) -> do
400407 let getResponse :: ClientM ()
401408 getResponse = client api
402− Left (FailureResponse r) <- runClient getResponse baseUrl
409+ Left (FailureResponse _ r) <- runClient getResponse baseUrl
403410 responseStatusCode r `shouldBe` (HTTP.Status 500 "error message")
404411 in mapM_ test $
405412 (WrappedApi (Proxy :: Proxy (Delete '[JSON] ())), "Delete") :
@@ -416,7 +423,7 @@ failSpec = beforeAll (startWaiApp failServer) $ afterAll endWaiApp $ do
416423 let (_ :<|> _ :<|> getDeleteEmpty :<|> _) = client api
417424 Left res <- runClient getDeleteEmpty baseUrl
418425 case res of
419− FailureResponse r | responseStatusCode r == HTTP.status404 -> return ()
426+ FailureResponse _ r | responseStatusCode r == HTTP.status404 -> return ()
420427 _ -> fail $ "expected 404 response, but got " <> show res
421428
422429 it "reports DecodeFailure" $ \(_, baseUrl) -> do
@@ -466,7 +473,7 @@ basicAuthSpec = beforeAll (startWaiApp basicAuthServer) $ afterAll endWaiApp $ d
466473 it "Authenticates a BasicAuth protected server appropriately" $ \(_,baseUrl) -> do
467474 let getBasic = client basicAuthAPI
468475 let basicAuthData = BasicAuthData "not" "password"
469− Left (FailureResponse r) <- runClient (getBasic basicAuthData) baseUrl
476+ Left (FailureResponse _ r) <- runClient (getBasic basicAuthData) baseUrl
470477 responseStatusCode r `shouldBe` HTTP.Status 403 "Forbidden"
471478
472479genAuthSpec :: Spec
@@ -483,7 +490,7 @@ genAuthSpec = beforeAll (startWaiApp genAuthServer) $ afterAll endWaiApp $ do
483490 it "Authenticates a AuthProtect protected server appropriately" $ \(_, baseUrl) -> do
484491 let getProtected = client genAuthAPI
485492 let authRequest = Auth.mkAuthenticatedRequest () (\_ req -> Req.addHeader "Wrong" ("header" :: String) req)
486− Left (FailureResponse r) <- runClient (getProtected authRequest) baseUrl
493+ Left (FailureResponse _ r) <- runClient (getProtected authRequest) baseUrl
487494 responseStatusCode r `shouldBe` (HTTP.Status 401 "Unauthorized")
488495
489496genericClientSpec :: Spec