@@ -8,7 +8,6 @@
88{-# LANGUAGE MultiParamTypeClasses #-}
99{-# LANGUAGE OverloadedStrings #-}
1010{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE Rank2Types #-}
1211{-# LANGUAGE ScopedTypeVariables #-}
1312{-# LANGUAGE TupleSections #-}
1413{-# LANGUAGE TypeFamilies #-}
@@ -25,57 +24,48 @@
2524-- API.
2625module Servant.Reflex
2726 ( client
28− , clientWithOpts
29− , clientWithOptsAndResultHandler
30− , clientWithRoute
31− , clientWithRouteAndResultHandler
3227 , BuildHeaderKeysTo(..)
3328 , toHeaders
34− , HasClient
35− , Client
29+ , HasClient(..)
3630 , module Servant.Common.Req
3731 , module Servant.Common.BaseUrl
3832 ) where
3933
4034------------------------------------------------------------------------------
4135import Control.Applicative
42−import qualified Data.CaseInsensitive as CI
43−import Data.Functor.Identity
44−import qualified Data.Map as Map
4536import Data.Monoid ((<>))
46−import Data.Proxy (Proxy (..))
4737import qualified Data.Set as Set
38+import qualified Data.Text.Encoding as E
39+import Data.CaseInsensitive (mk)
40+import Data.Functor.Identity
41+import Data.Proxy (Proxy (..))
42+import qualified Data.Map as Map
4843import Data.Text (Text)
4944import qualified Data.Text as T
50−import qualified Data.Text.Encoding as E
5145import GHC.Exts (Constraint)
5246import GHC.TypeLits (KnownSymbol, symbolVal)
53−import Servant.API ((:<|>) (..), (:>), BasicAuth,
54− BasicAuthData, BuildHeadersTo (..),
55− Capture, Header, Headers (..),
56− HttpVersion, IsSecure,
57− MimeRender (..), MimeUnrender,
47+import Servant.API ((:<|>)(..),(:>), BasicAuth,
48+ BasicAuthData, BuildHeadersTo(..),
49+ Capture, contentType, Header,
50+ Headers(..), HttpVersion, IsSecure,
51+ MimeRender(..), MimeUnrender,
5852 NoContent, QueryFlag, QueryParam,
59− QueryParams, Raw, ReflectMethod (..),
53+ QueryParams, Raw, ReflectMethod(..),
6054 RemoteHost, ReqBody,
61− ToHttpApiData (..), Vault, Verb,
62− contentType)
63−import Servant.API.Description (Summary)
55+ ToHttpApiData(..), Vault, Verb)
6456import qualified Servant.Auth as Auth
6557
66−import Reflex.Dom.Core (Dynamic, Event, Reflex,
67− XhrRequest (..), XhrResponse (..),
68− XhrResponseHeaders (..),
69− attachPromptlyDynWith, constDyn, ffor,
70− fmapMaybe, leftmost,
71− performRequestsAsync)
58+import Reflex.Dom (Dynamic, Event, Reflex,
59+ XhrRequest(..),
60+ XhrResponseHeaders(..),
61+ XhrResponse(..), attachPromptlyDynWith, constDyn, ffor, fmapMaybe,
62+ leftmost, performRequestsAsync,
63+ )
7264------------------------------------------------------------------------------
7365import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
7466 showBaseUrl,
7567 SupportsServantReflex)
76−import Servant.Common.Req (ClientOptions(..),
77− defaultClientOptions,
78− Req, ReqResult(..), QParam(..),
68+import Servant.Common.Req (Req, ReqResult(..), QParam(..),
7969 QueryPart(..), addHeader, authData,
8070 defReq, evalResponse, prependToPathParts,
8171 -- performRequestCT,
@@ -85,10 +75,9 @@ import Servant.Common.Req (ClientOptions(..),
8575 performSomeRequestsAsync,
8676 qParamToQueryPart, reqBody,
8777 reqSuccess, reqFailure,
88− reqMethod, respHeaders,
89− response,
78+ reqMethod, respHeaders, response,
9079 reqTag,
91− qParams, withCredentials)
80+ qParams)
9281
9382
9483-- * Accessing APIs as a Client
@@ -103,75 +92,28 @@ import Servant.Common.Req (ClientOptions(..),
10392-- >
10493-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
10594-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
106−-- > -> m (Event t (l, ReqResult Book)))
95+-- -> m (Event t (l, ReqResult Book)))
10796-- > (getAllBooks :<|> postNewBook) = client myApi host
10897-- > where host = constDyn $ BaseUrl Http "localhost" 8080
109−client
110− :: (HasClient t m layout tag)
111− => Proxy layout
112− -> Proxy m
113− -> Proxy tag
114− -> Dynamic t BaseUrl
115− -> Client t m layout tag
116−client p q t baseurl = clientWithRoute p q t defReq baseurl defaultClientOptions
117−
118−clientWithOpts
119− :: (HasClient t m layout tag)
120− => Proxy layout
121− -> Proxy m
122− -> Proxy tag
123− -> Dynamic t BaseUrl
124− -> ClientOptions
125− -> Client t m layout tag
126−clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
127−
128−-- | Like 'clientWithOpts' but allows passing a function which will process the
129−-- result event in some way. This can be used to handle errors in a uniform way
130−-- across call sites.
131−clientWithOptsAndResultHandler
132− :: (HasClient t m layout tag)
133− => Proxy layout
134− -> Proxy m
135− -> Proxy tag
136− -> Dynamic t BaseUrl
137− -> ClientOptions
138− -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
139− -> Client t m layout tag
140−clientWithOptsAndResultHandler p q t = clientWithRouteAndResultHandler p q t defReq
98+client :: (HasClient t m layout tag)
99+ => Proxy layout -> Proxy m -> Proxy tag -> Dynamic t BaseUrl -> Client t m layout tag
100+client p q t baseurl = clientWithRoute p q t defReq baseurl
141101
142102
143103-- | This class lets us define how each API combinator
144104-- influences the creation of an HTTP request. It's mostly
145105-- an internal class, you can just use 'client'.
146−class Monad m => HasClient t m layout (tag :: *) where
106+class HasClient t m layout (tag :: *) where
147107 type Client t m layout tag :: *
148− clientWithRoute
149− :: Proxy layout
150− -> Proxy m
151− -> Proxy tag
152− -> Req t
153− -> Dynamic t BaseUrl
154− -> ClientOptions
155− -> Client t m layout tag
156− clientWithRoute l m t r b o = clientWithRouteAndResultHandler l m t r b o return
157−
158− clientWithRouteAndResultHandler
159− :: Proxy layout
160− -> Proxy m
161− -> Proxy tag
162− -> Req t
163− -> Dynamic t BaseUrl
164− -> ClientOptions
165− -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
166− -> Client t m layout tag
108+ clientWithRoute :: Proxy layout -> Proxy m -> Proxy tag -> Req t -> Dynamic t BaseUrl -> Client t m layout tag
167109
168110
169111instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
170112 type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
171113
172− clientWithRouteAndResultHandler Proxy q pTag req baseurl opts wrap =
173− clientWithRouteAndResultHandler (Proxy :: Proxy a) q pTag req baseurl opts wrap :<|>
174− clientWithRouteAndResultHandler (Proxy :: Proxy b) q pTag req baseurl opts wrap
114+ clientWithRoute Proxy q pTag req baseurl =
115+ clientWithRoute (Proxy :: Proxy a) q pTag req baseurl :<|>
116+ clientWithRoute (Proxy :: Proxy b) q pTag req baseurl
175117
176118
177119-- Capture. Example:
@@ -192,9 +134,11 @@ instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout ta
192134 type Client t m (Capture capture a :> sublayout) tag =
193135 Dynamic t (Either Text a) -> Client t m sublayout tag
194136
195− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196− clientWithRouteAndResultHandler
197− (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
137+ clientWithRoute Proxy q t req baseurl val =
138+ clientWithRoute (Proxy :: Proxy sublayout)
139+ q t
140+ (prependToPathParts p req)
141+ baseurl
198142 where p = (fmap . fmap) (toUrlPiece) val
199143
200144
@@ -207,8 +151,9 @@ instance {-# OVERLAPPABLE #-}
207151 Event t tag -> m (Event t (ReqResult tag a))
208152 -- TODO how to access input types here?
209153 -- ExceptT ServantError IO a
210− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
211− wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
154+ clientWithRoute Proxy _ _ req baseurl trigs =
155+ -- performRequestCT (Proxy :: Proxy ct) method req' baseurl trigs
156+ fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl trigs
212157 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
213158 req' = req { reqMethod = method }
214159
@@ -221,33 +166,29 @@ instance {-# OVERLAPPING #-}
221166 Event t tag -> m (Event t (ReqResult tag NoContent))
222167 -- TODO: how to access input types here?
223168 -- ExceptT ServantError IO NoContent
224− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225− wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
169+ clientWithRoute Proxy _ _ req baseurl =
170+ (fmap . fmap) runIdentity . performRequestsNoBody method (constDyn $ Identity req) baseurl
226171 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
227172
228173
229174toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
230175toHeaders r =
231− let hdrs = maybe []
232− (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
176+ let toBS = E.encodeUtf8
177+ hdrs = maybe []
178+ (\xhr -> fmap (\(h,v) -> (mk (toBS h), toBS v))
233179 (Map.toList $ _xhrResponse_headers xhr))
234180 (response r)
235181 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
236182
237−
238183class BuildHeaderKeysTo hs where
239− buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
184+ buildHeaderKeysTo :: Proxy hs -> [T.Text]
240185
241186instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242187 where buildHeaderKeysTo _ = []
243188
244189instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
245190 => BuildHeaderKeysTo ((Header h v) ': xs) where
246− buildHeaderKeysTo _ =
247− let
248− thisKey = CI.mk $ T.pack (symbolVal (Proxy :: Proxy h))
249− in thisKey : buildHeaderKeysTo (Proxy :: Proxy xs)
250−
191+ buildHeaderKeysTo _ = T.pack (symbolVal (Proxy :: Proxy h)) : buildHeaderKeysTo (Proxy :: Proxy xs)
251192
252193-- HEADERS Verb (Content) --
253194-- Headers combinator not treated in fully general case,
@@ -262,10 +203,10 @@ instance {-# OVERLAPPABLE #-}
262203 ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
263204 type Client t m (Verb method status cts' (Headers ls a)) tag =
264205 Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
265− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
206+ clientWithRoute Proxy _ _ req baseurl trigs = do
266207 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
267− resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268− wrap $ toHeaders <$> resp
208+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl trigs
209+ return $ toHeaders <$> resp
269210 where req' = req { respHeaders =
270211 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
271212 }
@@ -278,10 +219,10 @@ instance {-# OVERLAPPABLE #-}
278219 ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
279220 type Client t m (Verb method status cts (Headers ls NoContent)) tag
280221 = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
281− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
222+ clientWithRoute Proxy _ _ req baseurl trigs = do
282223 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
283− resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284− wrap $ toHeaders <$> resp
224+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl trigs
225+ return $ toHeaders <$> resp
285226 where req' = req {respHeaders =
286227 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
287228 }
@@ -308,11 +249,11 @@ instance (KnownSymbol sym, ToHttpApiData a,
308249 type Client t m (Header sym a :> sublayout) tag =
309250 Dynamic t (Either Text a) -> Client t m sublayout tag
310251
311− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap eVal =
312− clientWithRouteAndResultHandler
313− (Proxy :: Proxy sublayout) q t
314− (Servant.Common.Req.addHeader hname eVal req)
315− baseurl opts wrap
252+ clientWithRoute Proxy q t req baseurl eVal =
253+ clientWithRoute (Proxy :: Proxy sublayout)
254+ q t
255+ (Servant.Common.Req.addHeader hname eVal req)
256+ baseurl
316257 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
317258
318259
@@ -326,21 +267,8 @@ instance HasClient t m sublayout tag
326267 type Client t m (HttpVersion :> sublayout) tag =
327268 Client t m sublayout tag
328269
329− clientWithRouteAndResultHandler Proxy =
330− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
331−
332−-- | Using a 'Summary' combinator in your API doesn't affect the client
333−-- functions.
334−instance (HasClient t m sublayout tag, KnownSymbol sym)
335− => HasClient t m (Summary sym :> sublayout) tag where
336−
337− type Client t m (Summary sym :> sublayout) tag =
338− Client t m sublayout tag
339−
340− clientWithRouteAndResultHandler Proxy =
341− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
342−
343−
270+ clientWithRoute Proxy q t =
271+ clientWithRoute (Proxy :: Proxy sublayout) q t
344272
345273
346274-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -376,9 +304,9 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
376304 Dynamic t (QParam a) -> Client t m sublayout tag
377305
378306 -- if mparam = Nothing, we don't add it to the query string
379− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
380− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
381− (req {qParams = paramPair : qParams req}) baseurl opts wrap
307+ clientWithRoute Proxy q t req baseurl mparam =
308+ clientWithRoute (Proxy :: Proxy sublayout) q t
309+ (req {qParams = paramPair : qParams req}) baseurl
382310
383311 where pname = symbolVal (Proxy :: Proxy sym)
384312 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -422,8 +350,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
422350 type Client t m (QueryParams sym a :> sublayout) tag =
423351 Dynamic t [a] -> Client t m sublayout tag
424352
425− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
353+ clientWithRoute Proxy q t req baseurl paramlist =
354+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
427355
428356 where req' = req { qParams = (T.pack pname, params') : qParams req }
429357 pname = symbolVal (Proxy :: Proxy sym)
@@ -462,8 +390,8 @@ instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
462390 type Client t m (QueryFlag sym :> sublayout) tag =
463391 Dynamic t Bool -> Client t m sublayout tag
464392
465− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
393+ clientWithRoute Proxy q t req baseurl flag =
394+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
467395
468396 where req' = req { qParams = thisPair : qParams req }
469397 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
@@ -477,7 +405,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
477405 -> Event t tag
478406 -> m (Event t (ReqResult tag ()))
479407
480− clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
408+ clientWithRoute _ _ _ _ baseurl xhrs triggers = do
481409
482410 let xhrs' = liftA2 (\x path -> case x of
483411 Left e -> Left e
@@ -488,7 +416,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
488416 okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
489417
490418 resps <- performRequestsAsync okReq
491− wrap $ leftmost [ uncurry RequestFailure <$> badReq
419+ return $ leftmost [ uncurry RequestFailure <$> badReq
492420 , evalResponse (const $ Right ()) <$> resps
493421 ]
494422
@@ -519,8 +447,8 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
519447 type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520448 Dynamic t (Either Text a) -> Client t m sublayout tag
521449
522− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
450+ clientWithRoute Proxy q t req baseurl body =
451+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
524452 where req' = req { reqBody = bodyBytesCT }
525453 ctProxy = Proxy :: Proxy ct
526454 ctString = T.pack $ show $ contentType ctProxy
@@ -534,9 +462,9 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
534462instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
535463 type Client t m (path :> sublayout) tag = Client t m sublayout tag
536464
537− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap =
538− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
539− (prependToPathParts (pure (Right $ T.pack p)) req) baseurl opts wrap
465+ clientWithRoute Proxy q t req baseurl =
466+ clientWithRoute (Proxy :: Proxy sublayout) q t
467+ (prependToPathParts (pure (Right $ T.pack p)) req) baseurl
540468
541469 where p = symbolVal (Proxy :: Proxy path)
542470
@@ -544,23 +472,23 @@ instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient
544472instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
545473 type Client t m (Vault :> api) tag = Client t m api tag
546474
547− clientWithRouteAndResultHandler Proxy =
548− clientWithRouteAndResultHandler (Proxy :: Proxy api)
475+ clientWithRoute Proxy q t req baseurl =
476+ clientWithRoute (Proxy :: Proxy api) q t req baseurl
549477
550478
551479instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
552480 type Client t m (RemoteHost :> api) tag = Client t m api tag
553481
554− clientWithRouteAndResultHandler Proxy =
555− clientWithRouteAndResultHandler (Proxy :: Proxy api)
482+ clientWithRoute Proxy q t req baseurl =
483+ clientWithRoute (Proxy :: Proxy api) q t req baseurl
556484
557485
558486
559487instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
560488 type Client t m (IsSecure :> api) tag = Client t m api tag
561489
562− clientWithRouteAndResultHandler Proxy =
563− clientWithRouteAndResultHandler (Proxy :: Proxy api)
490+ clientWithRoute Proxy q t req baseurl =
491+ clientWithRoute (Proxy :: Proxy api) q t req baseurl
564492
565493
566494instance (HasClient t m api tag, Reflex t)
@@ -569,8 +497,8 @@ instance (HasClient t m api tag, Reflex t)
569497 type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570498 -> Client t m api tag
571499
572− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
573− clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
500+ clientWithRoute Proxy q t req baseurl authdata =
501+ clientWithRoute (Proxy :: Proxy api) q t req' baseurl
574502 where
575503 req' = req { authData = Just authdata }
576504
@@ -613,7 +541,7 @@ for empty and one for non-empty lists).
613541instance (HasCookieAuth auths, HasClient t m api tag) => HasClient t m (Auth.Auth auths a :> api) tag where
614542
615543 type Client t m (Auth.Auth auths a :> api) tag = Client t m api tag
616− clientWithRouteAndResultHandler Proxy = clientWithRouteAndResultHandler (Proxy :: Proxy api)
544+ clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy api)
617545
618546
619547type family HasCookieAuth xs :: Constraint where