@@ -1,16 +1,23 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE InstanceSigs #-}
7+{-# LANGUAGE InstanceSigs #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
6−{-# LANGUAGE OverloadedStrings #-}
9+{-# LANGUAGE OverloadedStrings #-}
7−{-# LANGUAGE PolyKinds #-}
10+{-# LANGUAGE PolyKinds #-}
11+{-# LANGUAGE Rank2Types #-}
8−{-# LANGUAGE ScopedTypeVariables #-}
12+{-# LANGUAGE ScopedTypeVariables #-}
9−{-# LANGUAGE TupleSections #-}
13+{-# LANGUAGE TupleSections #-}
10−{-# LANGUAGE TypeFamilies #-}
14+{-# LANGUAGE TypeFamilies #-}
11−{-# LANGUAGE TypeOperators #-}
15+{-# LANGUAGE TypeOperators #-}
12−{-# LANGUAGE UndecidableInstances #-}
16+{-# LANGUAGE UndecidableInstances #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
17+
18+#if MIN_VERSION_base(4,9,0)
19+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
15-- #include "overlapping-compat.h"
22-- #include "overlapping-compat.h"
16-- | This module provides 'client' which can automatically generate
23-- | This module provides 'client' which can automatically generate
@@ -18,23 +25,71 @@
19module Servant.Reflex
26module Servant.Reflex
21− , HasClient(..)
28+ , clientWithOpts
29+ , clientWithOptsAndResultHandler
31+ , clientWithRouteAndResultHandler
32+ , BuildHeaderKeysTo(..)
22 , module Servant.Common.Req
36 , module Servant.Common.Req
23 , module Servant.Common.BaseUrl
37 , module Servant.Common.BaseUrl
40+------------------------------------------------------------------------------
26import Control.Applicative
41import Control.Applicative
27−import Data.Proxy
42+import qualified Data.CaseInsensitive as CI
43+import Data.Functor.Identity
44+import qualified Data.Map as Map
28−import Data.String.Conversions
45+import Data.Monoid ((<>))
46+import Data.Proxy (Proxy (..))
47+import qualified Data.Set as Set
29−import Data.Text (Text)
48+import Data.Text (Text)
30−import qualified Data.Text as T
49+import qualified Data.Text as T
31−import Data.Text.Encoding
50+import qualified Data.Text.Encoding as E
51+import GHC.Exts (Constraint)
32−import GHC.TypeLits
52+import GHC.TypeLits (KnownSymbol, symbolVal)
33−import Servant.API
53+import Servant.API ((:<|>) (..), (:>), BasicAuth,
34−import Servant.Common.BaseUrl
54+ BasicAuthData, BuildHeadersTo (..),
55+ Capture, Header, Headers (..),
56+ HttpVersion, IsSecure,
57+ MimeRender (..), MimeUnrender,
58+ NoContent, QueryFlag, QueryParam,
59+ QueryParams, Raw, ReflectMethod (..),
61+ ToHttpApiData (..), Vault, Verb,
35−import Servant.Common.Req
63+import Servant.API.Description (Summary)
36−import Reflex
64+import qualified Servant.Auth as Auth
37−import Reflex.Dom
66+import Reflex.Dom.Core (Dynamic, Event, Reflex,
67+ XhrRequest (..), XhrResponse (..),
68+ XhrResponseHeaders (..),
69+ attachPromptlyDynWith, constDyn, ffor,
71+ performRequestsAsync)
72+------------------------------------------------------------------------------
73+import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
75+ SupportsServantReflex)
76+import Servant.Common.Req (ClientOptions(..),
77+ defaultClientOptions,
78+ Req, ReqResult(..), QParam(..),
79+ QueryPart(..), addHeader, authData,
80+ defReq, evalResponse, prependToPathParts,
83+ -- performRequestNoBody,
84+ performRequestsNoBody,
85+ performSomeRequestsAsync,
86+ qParamToQueryPart, reqBody,
87+ reqSuccess, reqFailure,
88+ reqMethod, respHeaders,
91+ qParams, withCredentials)
39-- * Accessing APIs as a Client
94-- * Accessing APIs as a Client
@@ -46,116 +101,191 @@ import Reflex.Dom
46-- > myApi :: Proxy MyApi
101-- > myApi :: Proxy MyApi
47-- > myApi = Proxy
102-- > myApi = Proxy
49−-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
104+-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
50−-- > postNewBook :: Dynamic t (Maybe Book) -> Event t ()
105+-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
51−-- -> m (Event t (Either XhrError (Book,Book)))
106+-- > -> m (Event t (l, ReqResult Book)))
52-- > (getAllBooks :<|> postNewBook) = client myApi host
107-- > (getAllBooks :<|> postNewBook) = client myApi host
53-- > where host = constDyn $ BaseUrl Http "localhost" 8080
108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
54−client :: (HasClient t m layout, MonadWidget t m)
110+ :: (HasClient t m layout tag)
114+ -> Dynamic t BaseUrl
115+ -> Client t m layout tag
116+client p q t baseurl = clientWithRoute p q t defReq baseurl defaultClientOptions
119+ :: (HasClient t m layout tag)
55− => Proxy layout -> Proxy m -> Dynamic t BaseUrl -> Client t m layout
123+ -> Dynamic t BaseUrl
125+ -> Client t m layout tag
56−client p q baseurl = clientWithRoute p q defReq baseurl
126+clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
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)
136+ -> Dynamic t BaseUrl
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
58-- | This class lets us define how each API combinator
143-- | This class lets us define how each API combinator
59-- influences the creation of an HTTP request. It's mostly
144-- influences the creation of an HTTP request. It's mostly
60-- an internal class, you can just use 'client'.
145-- an internal class, you can just use 'client'.
61−class HasClient t m layout where
146+class Monad m => HasClient t m layout (tag :: *) where
62− type Client t m layout :: *
147+ type Client t m layout tag :: *
63− clientWithRoute :: Proxy layout -> Proxy m -> Req t -> Dynamic t BaseUrl -> Client t m layout
148+ clientWithRoute
153+ -> Dynamic t BaseUrl
155+ -> Client t m layout tag
156+ clientWithRoute l m t r b o = clientWithRouteAndResultHandler l m t r b o return
158+ clientWithRouteAndResultHandler
163+ -> Dynamic t BaseUrl
165+ -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
166+ -> Client t m layout tag
169+instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
170+ type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
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
66−instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
67− type Client t m (a :<|> b) = Client t m a :<|> Client t m b
68− clientWithRoute Proxy q req baseurl =
69− clientWithRoute (Proxy :: Proxy a) q req baseurl :<|>
70− clientWithRoute (Proxy :: Proxy b) q req baseurl
72-- Capture. Example:
177-- Capture. Example:
73-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
75-- > myApi :: Proxy MyApi = Proxy
180-- > myApi :: Proxy MyApi = Proxy
77−-- > getBook :: MonadWidget t m
182+-- > getBook :: SupportsServantReflex t m
78-- => Dynamic t BaseUrl
183-- => Dynamic t BaseUrl
79-- -> Dynamic t (Maybe Text)
184-- -> Dynamic t (Maybe Text)
80−-- -> Event t ()
185+-- -> Event t l
81−-- -> m (Event t (Either XhrError (Text, Book)))
186+-- -> m (Event t (l, ReqResult Book))
82-- > getBook = client myApi (constDyn host)
187-- > getBook = client myApi (constDyn host)
83−instance (MonadWidget t m, KnownSymbol capture, ToHttpApiData a, HasClient t m sublayout)
84− => HasClient t m (Capture capture a :> sublayout) where
189+instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout tag)
86− type Client t m (Capture capture a :> sublayout) =
190+ => HasClient t m (Capture capture a :> sublayout) tag where
87− Dynamic t (Either Text a) -> Client t m sublayout
89− clientWithRoute Proxy q req baseurl val =
192+ type Client t m (Capture capture a :> sublayout) tag =
90− clientWithRoute (Proxy :: Proxy sublayout)
193+ Dynamic t (Either Text a) -> Client t m sublayout tag
92− (prependToPathParts p req)
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196+ clientWithRouteAndResultHandler
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
95 where p = (fmap . fmap) (toUrlPiece) val
198 where p = (fmap . fmap) (toUrlPiece) val
97-- VERB (Returning content) --
201-- VERB (Returning content) --
98instance {-# OVERLAPPABLE #-}
202instance {-# OVERLAPPABLE #-}
99 -- Note [Non-Empty Content Types]
203 -- Note [Non-Empty Content Types]
100− (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), MonadWidget t m
204+ (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
101− ) => HasClient t m (Verb method status cts' a) where
205+ ) => HasClient t m (Verb method status cts' a) tag where
102− type Client t m (Verb method status cts' a) =
206+ type Client t m (Verb method status cts' a) tag =
103− Event t () -> m (Event t (ReqResult a))
207+ Event t tag -> m (Event t (ReqResult tag a))
104 -- TODO how to access input types here?
208 -- TODO how to access input types here?
105 -- ExceptT ServantError IO a
209 -- ExceptT ServantError IO a
106− clientWithRoute Proxy _ req baseurl =
210+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
107− performRequestCT (Proxy :: Proxy ct) method req' baseurl
211+ wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
108− where method = decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
212+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
109 req' = req { reqMethod = method }
213 req' = req { reqMethod = method }
111-- -- VERB (No content) --
216-- -- VERB (No content) --
112instance {-# OVERLAPPING #-}
217instance {-# OVERLAPPING #-}
113− (ReflectMethod method, MonadWidget t m) =>
218+ (ReflectMethod method, SupportsServantReflex t m) =>
114− HasClient t m (Verb method status cts NoContent) where
219+ HasClient t m (Verb method status cts NoContent) tag where
115− type Client t m (Verb method status cts NoContent) =
220+ type Client t m (Verb method status cts NoContent) tag =
116− Event t () -> m (Event t (ReqResult NoContent))
221+ Event t tag -> m (Event t (ReqResult tag NoContent))
117 -- TODO: how to access input types here?
222 -- TODO: how to access input types here?
118 -- ExceptT ServantError IO NoContent
223 -- ExceptT ServantError IO NoContent
119− clientWithRoute Proxy _ req baseurl =
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
120− performRequestNoBody method req baseurl
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
121− where method = decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
226+ where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
123−-- -- HEADERS Verb (Content) --
228+
124−-- -- Headers combinator not treated in fully general case,
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
125−-- -- in order to deny instances for (Headers ls (Capture "id" Int)),
230+toHeaders r =
126−-- -- a combinator that wouldn't make sense
231+ let hdrs = maybe []
127−-- -- TODO Overlapping??
232+ (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
128−-- instance {-# OVERLAPPABLE #-}
233+ (Map.toList $ _xhrResponse_headers xhr))
129−-- -- Note [Non-Empty Content Types]
234+ (response r)
130−-- ( MimeUnrender ct a, BuildHeadersTo ls,
131−-- ReflectMethod method, cts' ~ (ct ': cts),
133−-- ) => HasClient t m (Verb method status cts' (Headers ls a)) where
134−-- type Client t m (Verb method status cts' (Headers ls a))
135−-- = Event t () -> m (Event t (Maybe a, XhrResponse))
136−-- -- ExceptT ServantError IO (Headers ls a)
137−-- clientWithRoute Proxy req baseurl = do
138−-- let method = reflectMethod (Proxy :: Proxy method)
139−-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) method req baseurl
140−-- return $ Headers { getResponse = resp
141−-- , getHeadersHList = buildHeadersTo hdrs
235+ in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
238+class BuildHeaderKeysTo hs where
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
241+instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242+ where buildHeaderKeysTo _ = []
244+instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
245+ => BuildHeaderKeysTo ((Header h v) ': xs) where
246+ buildHeaderKeysTo _ =
248+ thisKey = CI.mk $ T.pack (symbolVal (Proxy :: Proxy h))
249+ in thisKey : buildHeaderKeysTo (Proxy :: Proxy xs)
252+-- HEADERS Verb (Content) --
253+-- Headers combinator not treated in fully general case,
254+-- in order to deny instances for (Headers ls (Capture "id" Int)),
255+-- a combinator that wouldn't make sense
144-- TODO Overlapping??
256-- TODO Overlapping??
257+instance {-# OVERLAPPABLE #-}
258+ -- Note [Non-Empty Content Types]
259+ ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
260+ ReflectMethod method, cts' ~ (ct ': cts),
261+ SupportsServantReflex t m
262+ ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
263+ type Client t m (Verb method status cts' (Headers ls a)) tag =
264+ Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
265+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
266+ 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
269+ where req' = req { respHeaders =
270+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
145−-- -- HEADERS Verb (No content) --
274+-- HEADERS Verb (No content) --
146−-- instance {-# OVERLAPPABLE #-}
275+instance {-# OVERLAPPABLE #-}
147−-- ( BuildHeadersTo ls, ReflectMethod method,
276+ ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
148−-- MonadWidget t m
277+ SupportsServantReflex t m
149−-- ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
278+ ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
150−-- type Client t m (Verb method status cts (Headers ls NoContent))
279+ type Client t m (Verb method status cts (Headers ls NoContent)) tag
151−-- = Event t () -> m (Event t XhrResponse)
152−-- -- ExceptT ServantError IO (Headers ls NoContent)
280+ = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
153−-- clientWithRoute Proxy req baseurl = do
281+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
154−-- let method = reflectMethod (Proxy :: Proxy method)
282+ let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
155−-- hdrs <- performRequestNoBody method req baseurl
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
156−-- return $ Headers { getResponse = NoContent
284+ wrap $ toHeaders <$> resp
157−-- , getHeadersHList = buildHeadersTo hdrs
285+ where req' = req {respHeaders =
286+ OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
@@ -172,32 +302,45 @@ instance {-# OVERLAPPING #-}
172-- > -- then you can just use "viewRefer" to query that endpoint
302-- > -- then you can just use "viewRefer" to query that endpoint
173-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
174instance (KnownSymbol sym, ToHttpApiData a,
304instance (KnownSymbol sym, ToHttpApiData a,
175− HasClient t m sublayout, MonadWidget t m)
305+ HasClient t m sublayout tag, SupportsServantReflex t m)
176− => HasClient t m (Header sym a :> sublayout) where
306+ => HasClient t m (Header sym a :> sublayout) tag where
178− type Client t m (Header sym a :> sublayout) =
308+ type Client t m (Header sym a :> sublayout) tag =
179− Dynamic t (Either Text a) -> Client t m sublayout
309+ Dynamic t (Either Text a) -> Client t m sublayout tag
181− clientWithRoute Proxy q req baseurl _ =
311+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap eVal =
312+ clientWithRouteAndResultHandler
182− clientWithRoute (Proxy :: Proxy sublayout)
313+ (Proxy :: Proxy sublayout) q t
185− -- (maybe req -- TODO Need to pass the header in
186− -- (\value -> Servant.Common.Req.addHeader hname value req)
314+ (Servant.Common.Req.addHeader hname eVal req)
187− -- mval
315+ baseurl opts wrap
188− -- )
316+ where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
191-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
192-- functions.
322-- functions.
193−instance HasClient t m sublayout
323+instance HasClient t m sublayout tag
194− => HasClient t m (HttpVersion :> sublayout) where
324+ => HasClient t m (HttpVersion :> sublayout) tag where
326+ type Client t m (HttpVersion :> sublayout) tag =
327+ Client t m sublayout tag
329+ clientWithRouteAndResultHandler Proxy =
330+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
332+-- | Using a 'Summary' combinator in your API doesn't affect the client
334+instance (HasClient t m sublayout tag, KnownSymbol sym)
335+ => HasClient t m (Summary sym :> sublayout) tag where
337+ type Client t m (Summary sym :> sublayout) tag =
338+ Client t m sublayout tag
340+ clientWithRouteAndResultHandler Proxy =
341+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
196− type Client t m (HttpVersion :> sublayout) =
197− Client t m sublayout
199− clientWithRoute Proxy q =
200− clientWithRoute (Proxy :: Proxy sublayout) q
203-- | If you use a 'QueryParam' in one of your endpoints in your API,
346-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -226,17 +369,16 @@ instance HasClient t m sublayout
226-- > -- then you can just use "getBooksBy" to query that endpoint.
369-- > -- then you can just use "getBooksBy" to query that endpoint.
227-- > -- 'getBooksBy Nothing' for all books
370-- > -- 'getBooksBy Nothing' for all books
228-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
229−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
372+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
230− => HasClient t m (QueryParam sym a :> sublayout) where
373+ => HasClient t m (QueryParam sym a :> sublayout) tag where
232− type Client t m (QueryParam sym a :> sublayout) =
375+ type Client t m (QueryParam sym a :> sublayout) tag =
233− -- TODO (Maybe a), or (Maybe (Maybe a))? (should the user be able to send a Nothing)
234− Dynamic t (QParam a) -> Client t m sublayout
376+ Dynamic t (QParam a) -> Client t m sublayout tag
236 -- if mparam = Nothing, we don't add it to the query string
378 -- if mparam = Nothing, we don't add it to the query string
237− clientWithRoute Proxy q req baseurl mparam =
379+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
238− clientWithRoute (Proxy :: Proxy sublayout) q
380+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
239− (req {qParams = paramPair : qParams req}) baseurl
381+ (req {qParams = paramPair : qParams req}) baseurl opts wrap
241 where pname = symbolVal (Proxy :: Proxy sym)
383 where pname = symbolVal (Proxy :: Proxy sym)
242 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -244,6 +386,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
244 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
386 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
245 paramPair = (T.pack pname, p mparam)
387 paramPair = (T.pack pname, p mparam)
247-- | If you use a 'QueryParams' in one of your endpoints in your API,
391-- | If you use a 'QueryParams' in one of your endpoints in your API,
248-- the corresponding querying function will automatically take
392-- the corresponding querying function will automatically take
249-- an additional argument, a list of values of the type specified
393-- an additional argument, a list of values of the type specified
@@ -272,21 +416,22 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
272-- > -- 'getBooksBy []' for all books
416-- > -- 'getBooksBy []' for all books
273-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
274-- > -- to get all books by Asimov and Heinlein
418-- > -- to get all books by Asimov and Heinlein
275−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
419+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
276− => HasClient t m (QueryParams sym a :> sublayout) where
420+ => HasClient t m (QueryParams sym a :> sublayout) tag where
278− type Client t m (QueryParams sym a :> sublayout) =
422+ type Client t m (QueryParams sym a :> sublayout) tag =
279− Dynamic t [a] -> Client t m sublayout
423+ Dynamic t [a] -> Client t m sublayout tag
281− clientWithRoute Proxy q req baseurl paramlist =
425+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
282− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
426+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
284 where req' = req { qParams = (T.pack pname, params') : qParams req }
428 where req' = req { qParams = (T.pack pname, params') : qParams req }
285 pname = symbolVal (Proxy :: Proxy sym)
429 pname = symbolVal (Proxy :: Proxy sym)
286− params' = QueryPartParams $ (fmap . fmap) (toQueryParam)
430+ params' = QueryPartParams $ (fmap . fmap) toQueryParam
287 paramlist
431 paramlist
290-- | If you use a 'QueryFlag' in one of your endpoints in your API,
435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
291-- the corresponding querying function will automatically take
436-- the corresponding querying function will automatically take
292-- an additional 'Bool' argument.
437-- an additional 'Bool' argument.
@@ -311,49 +456,42 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
311-- > -- 'getBooksBy True' to only get _already published_ books
456-- > -- 'getBooksBy True' to only get _already published_ books
313-- TODO Bring back
458-- TODO Bring back
314−instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
459+instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
315− => HasClient t m (QueryFlag sym :> sublayout) where
460+ => HasClient t m (QueryFlag sym :> sublayout) tag where
317− type Client t m (QueryFlag sym :> sublayout) =
462+ type Client t m (QueryFlag sym :> sublayout) tag =
318− Dynamic t Bool -> Client t m sublayout
463+ Dynamic t Bool -> Client t m sublayout tag
320− clientWithRoute Proxy q req baseurl flag =
465+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
321− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
466+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
323 where req' = req { qParams = thisPair : qParams req }
468 where req' = req { qParams = thisPair : qParams req }
324 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
325 pName = symbolVal (Proxy :: Proxy sym)
470 pName = symbolVal (Proxy :: Proxy sym)
328−-- | Pick a 'Method' and specify where the server you want to query is. You get
473+
329−-- back the full `Response`.
474+-- | Send a raw 'XhrRequest ()' directly to 'baseurl'
331−instance (MonadWidget t m) => HasClient t m Raw where
475+instance SupportsServantReflex t m => HasClient t m Raw tag where
332− type Client t m Raw = Dynamic t (Either Text (XhrRequest ()))
476+ type Client t m Raw tag = Dynamic t (Either Text (XhrRequest ()))
333− -> Event t ()
477+ -> Event t tag
334− -> m (Event t (ReqResult ()))
478+ -> m (Event t (ReqResult tag ()))
336− -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
337− clientWithRoute _ _ _ baseurl xhrs triggers = do
480+ clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
338− let xhrs' = liftA2 (\x path -> case x of
482+ let xhrs' = liftA2 (\x path -> case x of
339− Left e -> Left e
483+ Left e -> Left e
340− Right jx -> Right $ jx {_xhrRequest_url = path
484+ Right jx -> Right $ jx { _xhrRequest_url = path <> _xhrRequest_url jx }
341− <> _xhrRequest_url jx})
343− (showBaseUrl <$> baseurl)
485+ ) xhrs (showBaseUrl <$> baseurl)
344− reqs = tagDyn xhrs' triggers
486+ xhrs'' = attachPromptlyDynWith (flip (,)) xhrs' triggers :: Event t (tag, Either Text (XhrRequest ()))
345− okReq = fmapMaybe hush reqs
487+ badReq = fmapMaybe (\(t,x) -> either (Just . (t,)) (const Nothing) x) xhrs'' :: Event t (tag, Text)
346− badReq = fmapMaybe tattle reqs
488+ okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
347− resps <- performRequestAsync okReq
489+
348− return $ leftmost [fmap (ResponseSuccess () ) resps
490+ resps <- performRequestsAsync okReq
349− ,fmap RequestFailure badReq]
491+ wrap $ leftmost [ uncurry RequestFailure <$> badReq
350−
492+ , evalResponse (const $ Right ()) <$> resps
352−hush :: Either e a -> Maybe a
494+
353−hush = either (const Nothing) Just
355−tattle :: Either e a -> Maybe e
356−tattle = either Just (const Nothing)
358-- | If you use a 'ReqBody' in one of your endpoints in your API,
496-- | If you use a 'ReqBody' in one of your endpoints in your API,
359-- the corresponding querying function will automatically take
497-- the corresponding querying function will automatically take
@@ -375,59 +513,64 @@ tattle = either Just (const Nothing)
375-- > where host = BaseUrl Http "localhost" 8080
513-- > where host = BaseUrl Http "localhost" 8080
376-- > -- then you can just use "addBook" to query that endpoint
514-- > -- then you can just use "addBook" to query that endpoint
378−instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
516+instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
379− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) where
517+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
381− type Client t m (ReqBody (ct ': cts) a :> sublayout) =
519+ type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
382− Dynamic t (Either Text a) -> Client t m sublayout
520+ Dynamic t (Either Text a) -> Client t m sublayout tag
384− clientWithRoute Proxy q req baseurl body =
522+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
385− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
523+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
386 where req' = req { reqBody = bodyBytesCT }
524 where req' = req { reqBody = bodyBytesCT }
387 ctProxy = Proxy :: Proxy ct
525 ctProxy = Proxy :: Proxy ct
388 ctString = T.pack $ show $ contentType ctProxy
526 ctString = T.pack $ show $ contentType ctProxy
389− --ctString = decodeUtf8 . CI.original . M.mainType $ contentType ctProxy
390 bodyBytesCT = Just $ (fmap . fmap)
527 bodyBytesCT = Just $ (fmap . fmap)
391 (\b -> (mimeRender ctProxy b, ctString))
528 (\b -> (mimeRender ctProxy b, ctString))
394-- | Make the querying function append @path@ to the request path.
533-- | Make the querying function append @path@ to the request path.
395−instance (KnownSymbol path, HasClient t m sublayout, Reflex t) => HasClient t m (path :> sublayout) where
534+instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
396− type Client t m (path :> sublayout) = Client t m sublayout
535+ type Client t m (path :> sublayout) tag = Client t m sublayout tag
398− clientWithRoute Proxy q req baseurl =
537+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap =
399− clientWithRoute (Proxy :: Proxy sublayout) q
538+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
400− (prependToPathParts (pure (Right $ T.pack p)) req)
539+ (prependToPathParts (pure (Right $ T.pack p)) req) baseurl opts wrap
403 where p = symbolVal (Proxy :: Proxy path)
541 where p = symbolVal (Proxy :: Proxy path)
405−instance HasClient t m api => HasClient t m (Vault :> api) where
406− type Client t m (Vault :> api) = Client t m api
408− clientWithRoute Proxy q req baseurl =
544+instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
409− clientWithRoute (Proxy :: Proxy api) q req baseurl
545+ type Client t m (Vault :> api) tag = Client t m api tag
547+ clientWithRouteAndResultHandler Proxy =
548+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
411−instance HasClient t m api => HasClient t m (RemoteHost :> api) where
551+instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
412− type Client t m (RemoteHost :> api) = Client t m api
552+ type Client t m (RemoteHost :> api) tag = Client t m api tag
414− clientWithRoute Proxy q req baseurl =
554+ clientWithRouteAndResultHandler Proxy =
415− clientWithRoute (Proxy :: Proxy api) q req baseurl
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
417−instance HasClient t m api => HasClient t m (IsSecure :> api) where
418− type Client t m (IsSecure :> api) = Client t m api
420− clientWithRoute Proxy q req baseurl =
421− clientWithRoute (Proxy :: Proxy api) q req baseurl
423−instance (HasClient t m api, Reflex t)
559+instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
424− => HasClient t m (BasicAuth realm usr :> api) where
560+ type Client t m (IsSecure :> api) tag = Client t m api tag
426− type Client t m (BasicAuth realm usr :> api) = Dynamic t (Maybe BasicAuthData)
562+ clientWithRouteAndResultHandler Proxy =
427− -> Client t m api
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
566+instance (HasClient t m api tag, Reflex t)
567+ => HasClient t m (BasicAuth realm usr :> api) tag where
569+ type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570+ -> Client t m api tag
429− clientWithRoute Proxy q req baseurl authdata =
572+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
430− clientWithRoute (Proxy :: Proxy api) q req' baseurl
573+ clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
432 req' = req { authData = Just authdata }
575 req' = req { authData = Just authdata }
@@ -453,3 +596,30 @@ non-empty lists, but is otherwise more specific, no instance will be overall
453more specific. This in turn generally means adding yet another instance (one
596more specific. This in turn generally means adding yet another instance (one
454for empty and one for non-empty lists).
597for empty and one for non-empty lists).
601+-- SUPPORT FOR servant-auth --
603+-- For JavaScript clients we should be sending/storing JSON web tokens in a
604+-- way that is inaccessible to JavaScript.
606+-- For @servant-auth@ this is done with HTTP-only cookies. In a Reflex-DOM
607+-- app this means the @servant-auth@ client should only verify that the API
608+-- supports Cookie-based authentication but do nothing with the token
611+-- @HasCookieAuth auths@ is nominally a redundant constraint, but ensures
612+-- we're not trying to rely on cookies when the API does not use them.
613+instance (HasCookieAuth auths, HasClient t m api tag) => HasClient t m (Auth.Auth auths a :> api) tag where
615+ type Client t m (Auth.Auth auths a :> api) tag = Client t m api tag
616+ clientWithRouteAndResultHandler Proxy = clientWithRouteAndResultHandler (Proxy :: Proxy api)
619+type family HasCookieAuth xs :: Constraint where
620+ HasCookieAuth (Auth.Cookie ': xs) = ()
621+ HasCookieAuth (x ': xs) = HasCookieAuth xs
622+ HasCookieAuth '[] = CookieAuthNotEnabled
624+class CookieAuthNotEnabled