@@ -1,44 +1,65 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFunctor #-}
2+{-# LANGUAGE DeriveFunctor #-}
3+{-# LANGUAGE ExistentialQuantification #-}
3−{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleContexts #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE FunctionalDependencies #-}
4−{-# LANGUAGE GADTs #-}
7+{-# LANGUAGE GADTs #-}
8+{-# LANGUAGE LambdaCase #-}
9+{-# LANGUAGE MultiParamTypeClasses #-}
10+{-# LANGUAGE NamedFieldPuns #-}
5−{-# LANGUAGE OverloadedStrings #-}
11+{-# LANGUAGE OverloadedStrings #-}
6−{-# LANGUAGE LambdaCase #-}
7−{-# LANGUAGE RankNTypes #-}
12+{-# LANGUAGE RankNTypes #-}
8−{-# LANGUAGE ScopedTypeVariables #-}
13+{-# LANGUAGE ScopedTypeVariables #-}
9−{-# LANGUAGE TupleSections #-}
14+{-# LANGUAGE TupleSections #-}
15+{-# OPTIONS_GHC -fno-warn-orphans #-}
11module Servant.Common.Req where
17module Servant.Common.Req where
13-------------------------------------------------------------------------------
19-------------------------------------------------------------------------------
14−import Control.Applicative (liftA2, liftA3)
20+import Control.Applicative (liftA2, liftA3)
15import Control.Concurrent
21import Control.Concurrent
16−import Control.Monad (join)
22+import Control.Monad (join)
17−import Control.Monad.IO.Class (MonadIO, liftIO)
23+import Control.Monad.IO.Class (MonadIO, liftIO)
18−import Data.Bifunctor (first)
25+import Data.Bifunctor (first)
19−import qualified Data.ByteString.Builder as Builder
26+import qualified Data.ByteString as BS
27+import qualified Data.ByteString.Builder as BB
28+import Data.ByteString.Lazy (ByteString)
20−import qualified Data.ByteString.Lazy.Char8 as BL
29+import qualified Data.ByteString.Lazy.Char8 as BL
21−import qualified Data.Map as Map
22−import Data.Maybe (catMaybes, fromMaybe)
23import Data.Functor.Compose
30import Data.Functor.Compose
31+import qualified Data.JSString.Text as JS (lazyTextFromJSString)
32+import qualified Data.Map as Map
33+import Data.Maybe (catMaybes, fromMaybe)
24−import Data.Monoid ((<>))
34+import Data.Monoid ((<>))
25−import Data.Proxy (Proxy(..))
35+import Data.Proxy (Proxy (..))
26−import Data.Text (Text)
36+import Data.Text (Text)
27−import qualified Data.Text as T
37+import qualified Data.Text as T
28−import qualified Data.Text.Encoding as TE
38+import qualified Data.Text.Encoding as T
39+import qualified Data.Text.Lazy as TL
29−import Data.Traversable (forM)
40+import Data.Traversable (forM)
41+import qualified Language.Javascript.JSaddle as JS
30import Language.Javascript.JSaddle.Monad (JSM, MonadJSM, liftJSM)
42import Language.Javascript.JSaddle.Monad (JSM, MonadJSM, liftJSM)
31−import qualified Network.URI as N
43+import qualified Network.URI as N
32−import Reflex.Dom.Core hiding (tag)
44+import Reflex.Dom.Core hiding (tag)
33−import Servant.Common.BaseUrl (BaseUrl, showBaseUrl,
45+import Servant.API.ContentTypes (Accept, FormUrlEncoded,
34− SupportsServantReflex)
46+ JSON, NoContent (..),
35−import Servant.API.ContentTypes (MimeUnrender(..), NoContent(..))
47+ OctetStream, PlainText)
48+import Servant.Common.BaseUrl (BaseUrl,
49+ SupportsServantReflex,
51+import Web.FormUrlEncoded (FromForm, urlDecodeAsForm)
36−import Web.HttpApiData (ToHttpApiData(..))
52+import Web.HttpApiData (ToHttpApiData (..))
37-------------------------------------------------------------------------------
53-------------------------------------------------------------------------------
38import Servant.API.BasicAuth
54import Servant.API.BasicAuth
55+-------------------------------------------------------------------------------
58+-- jsonDecode :: JS.JSString -> Maybe a
59+-- jsonDecode = error "jsonDecode is only available in GHCJS"
41−------------------------------------------------------------------------------
62+-----------------------------------------------------------------------------
42-- | The result of a request event
63-- | The result of a request event
43data ReqResult tag a
64data ReqResult tag a
44 = ResponseSuccess tag a XhrResponse
65 = ResponseSuccess tag a XhrResponse
@@ -132,34 +153,35 @@ data QueryPart t = QueryPartParam (Dynamic t (Either Text (Maybe Text)))
132-------------------------------------------------------------------------------
153-------------------------------------------------------------------------------
133-- The data structure used to build up request information while traversing
154-- The data structure used to build up request information while traversing
134-- the shape of a servant API
155-- the shape of a servant API
135−data Req t = Req
156+data Req t = forall o. (IsXhrPayload o, Show o) => Req
136 { reqMethod :: Text
157 { reqMethod :: Text
137 , reqPathParts :: [Dynamic t (Either Text Text)]
158 , reqPathParts :: [Dynamic t (Either Text Text)]
138 , qParams :: [(Text, QueryPart t)]
159 , qParams :: [(Text, QueryPart t)]
139− , reqBody :: Maybe (Dynamic t (Either Text (BL.ByteString, Text)))
160+ , reqBody :: Maybe (Dynamic t (Either Text (o, Text)))
140 , headers :: [(Text, Dynamic t (Either Text Text))]
161 , headers :: [(Text, Dynamic t (Either Text Text))]
141 , respHeaders :: XhrResponseHeaders
162 , respHeaders :: XhrResponseHeaders
142 , authData :: Maybe (Dynamic t (Maybe BasicAuthData))
163 , authData :: Maybe (Dynamic t (Maybe BasicAuthData))
166+data SomeXhrRequest = forall o. (IsXhrPayload o, Show o) => SomeXhrRequest (XhrRequest (Maybe o))
145defReq :: Req t
168defReq :: Req t
146−defReq = Req "GET" [] [] Nothing [] def Nothing
169+defReq = Req "GET" [] [] (Nothing :: Maybe (Dynamic t (Either Text ((), Text)))) [] def Nothing
148prependToPathParts :: Dynamic t (Either Text Text) -> Req t -> Req t
171prependToPathParts :: Dynamic t (Either Text Text) -> Req t -> Req t
149prependToPathParts p req =
172prependToPathParts p req =
150 req { reqPathParts = p : reqPathParts req }
173 req { reqPathParts = p : reqPathParts req }
152addHeader :: (ToHttpApiData a, Reflex t) => Text -> Dynamic t (Either Text a) -> Req t -> Req t
175addHeader :: (ToHttpApiData a, Reflex t) => Text -> Dynamic t (Either Text a) -> Req t -> Req t
153−addHeader name val req = req { headers = (name, (fmap . fmap) (TE.decodeUtf8 . toHeader) val) : headers req }
176+addHeader name val req = req { headers = (name, (fmap . fmap) (T.decodeUtf8 . toHeader) val) : headers req }
156reqToReflexRequest
178reqToReflexRequest
157− :: forall t. Reflex t
179+ :: forall t. Reflex t
159− -> Dynamic t BaseUrl
181+ -> Dynamic t BaseUrl
160− -> Req t
182+ -> Req t
161− -> Dynamic t (Either Text (XhrRequest XhrPayload))
183+ -> Dynamic t (Either Text SomeXhrRequest)
162−reqToReflexRequest reqMeth reqHost req =
184+reqToReflexRequest reqMeth reqHost req@(Req _ _ _ (reqBody :: Maybe (Dynamic t (Either Text (o, Text)))) _ _ _) =
163 let t :: Dynamic t [Either Text Text]
185 let t :: Dynamic t [Either Text Text]
164 t = sequence $ reverse $ reqPathParts req
186 t = sequence $ reverse $ reqPathParts req
@@ -211,14 +233,14 @@ reqToReflexRequest reqMeth reqHost req =
211 fmap (fmap (\rightVal -> (headerName, rightVal))) dynam
233 fmap (fmap (\rightVal -> (headerName, rightVal))) dynam
213 mkConfigBody :: Either Text [(Text,Text)]
235 mkConfigBody :: Either Text [(Text,Text)]
214− -> (Either Text (BL.ByteString, Text))
236+ -> (Either Text (o, Text))
215− -> Either Text (XhrRequestConfig XhrPayload)
237+ -> Either Text (XhrRequestConfig (Maybe o))
216 mkConfigBody ehs rb = case (ehs, rb) of
238 mkConfigBody ehs rb = case (ehs, rb) of
217 (_, Left e) -> Left e
239 (_, Left e) -> Left e
218 (Left e, _) -> Left e
240 (Left e, _) -> Left e
219 (Right hs, Right (bBytes, bCT)) ->
241 (Right hs, Right (bBytes, bCT)) ->
220 Right $ XhrRequestConfig
242 Right $ XhrRequestConfig
221− { _xhrRequestConfig_sendData = bytesToPayload bBytes
243+ { _xhrRequestConfig_sendData = Just bBytes
222 , _xhrRequestConfig_headers =
244 , _xhrRequestConfig_headers =
223 Map.insert "Content-Type" bCT (Map.fromList hs)
245 Map.insert "Content-Type" bCT (Map.fromList hs)
224 , _xhrRequestConfig_user = Nothing
246 , _xhrRequestConfig_user = Nothing
@@ -228,16 +250,16 @@ reqToReflexRequest reqMeth reqHost req =
228 , _xhrRequestConfig_responseHeaders = def
250 , _xhrRequestConfig_responseHeaders = def
231− xhrOpts :: Dynamic t (Either Text (XhrRequestConfig XhrPayload))
253+ xhrOpts :: Dynamic t (Either Text (XhrRequestConfig (Maybe o)))
232− xhrOpts = case reqBody req of
254+ xhrOpts = case reqBody of
233 Nothing -> ffor xhrHeaders $ \case
255 Nothing -> ffor xhrHeaders $ \case
234 Left e -> Left e
256 Left e -> Left e
235 Right hs -> Right $ def { _xhrRequestConfig_headers = Map.fromList hs
257 Right hs -> Right $ def { _xhrRequestConfig_headers = Map.fromList hs
236 , _xhrRequestConfig_user = Nothing
258 , _xhrRequestConfig_user = Nothing
237 , _xhrRequestConfig_password = Nothing
259 , _xhrRequestConfig_password = Nothing
238 , _xhrRequestConfig_responseType = Nothing
260 , _xhrRequestConfig_responseType = Nothing
239− , _xhrRequestConfig_sendData = ""
240 , _xhrRequestConfig_withCredentials = False
261 , _xhrRequestConfig_withCredentials = False
262+ , _xhrRequestConfig_sendData = Nothing
242 Just rBody -> liftA2 mkConfigBody xhrHeaders rBody
264 Just rBody -> liftA2 mkConfigBody xhrHeaders rBody
@@ -245,16 +267,16 @@ reqToReflexRequest reqMeth reqHost req =
245 mkAuth _ (Left e) = Left e
267 mkAuth _ (Left e) = Left e
246 mkAuth Nothing r = r
268 mkAuth Nothing r = r
247 mkAuth (Just (BasicAuthData u p)) (Right config) = Right $ config
269 mkAuth (Just (BasicAuthData u p)) (Right config) = Right $ config
248− { _xhrRequestConfig_user = Just $ TE.decodeUtf8 u
270+ { _xhrRequestConfig_user = Just $ T.decodeUtf8 u
249− , _xhrRequestConfig_password = Just $ TE.decodeUtf8 p}
271+ , _xhrRequestConfig_password = Just $ T.decodeUtf8 p}
251 addAuth :: Dynamic t (Either Text (XhrRequestConfig x))
273 addAuth :: Dynamic t (Either Text (XhrRequestConfig x))
252 -> Dynamic t (Either Text (XhrRequestConfig x))
274 -> Dynamic t (Either Text (XhrRequestConfig x))
253 addAuth xhr = case authData req of
275 addAuth xhr = case authData req of
254− Nothing -> xhr
276+ Nothing -> xhr
255 Just auth -> liftA2 mkAuth auth xhr
277 Just auth -> liftA2 mkAuth auth xhr
257− xhrReq = (liftA2 . liftA2) (\p opt -> XhrRequest reqMeth p opt) xhrUrl (addAuth xhrOpts)
279+ xhrReq = (liftA2 . liftA2) (\p opt -> SomeXhrRequest $ XhrRequest reqMeth p opt) xhrUrl (addAuth xhrOpts)
259 in xhrReq
281 in xhrReq
@@ -263,8 +285,14 @@ reqToReflexRequest reqMeth reqHost req =
263displayHttpRequest :: Text -> Text
285displayHttpRequest :: Text -> Text
264displayHttpRequest httpmethod = "HTTP " <> httpmethod <> " request"
286displayHttpRequest httpmethod = "HTTP " <> httpmethod <> " request"
288+instance IsXhrPayload o => IsXhrPayload (Maybe o) where
289+ sendXhrPayload xhr = maybe (sendXhrPayload xhr ()) (sendXhrPayload xhr)
291+instance (IsXhrPayload o, IsXhrPayload o') => IsXhrPayload (Either o o') where
292+ sendXhrPayload xhr = either (sendXhrPayload xhr) (sendXhrPayload xhr)
266-- | This function performs the request
294-- | This function performs the request
267−performRequests :: forall t m f tag.(SupportsServantReflex t m, Traversable f)
295+performRequests :: forall t m f tag. (SupportsServantReflex t m, Traversable f)
269 -> Dynamic t (f (Req t))
297 -> Dynamic t (f (Req t))
270 -> Dynamic t BaseUrl
298 -> Dynamic t BaseUrl
@@ -277,6 +305,7 @@ performRequests reqMeth rs reqHost opts trigger = do
277 reqToReflexRequest reqMeth reqHost <$> fxhr) <$> rs
305 reqToReflexRequest reqMeth reqHost <$> fxhr) <$> rs
279 -- xhrReqs = fmap snd <$> xhrReqsAndDebugs
307 -- xhrReqs = fmap snd <$> xhrReqsAndDebugs
308+ reqs :: Event t (Compose ((,) tag) f (Either Text SomeXhrRequest))
280 reqs = attachPromptlyDynWith
309 reqs = attachPromptlyDynWith
281 (\fxhr t -> Compose (t, fxhr)) xhrReqs trigger
310 (\fxhr t -> Compose (t, fxhr)) xhrReqs trigger
@@ -292,32 +321,31 @@ performSomeRequestsAsync
292 HasWebView (Performable m),
321 HasWebView (Performable m),
293 PerformEvent t m,
322 PerformEvent t m,
294 TriggerEvent t m,
323 TriggerEvent t m,
295− Traversable f,
324+ Traversable f
299 => ClientOptions
326 => ClientOptions
300− -> Event t (f (Either Text (XhrRequest a)))
327+ -> Event t (f (Either Text SomeXhrRequest))
301 -> m (Event t (f (Either Text XhrResponse)))
328 -> m (Event t (f (Either Text XhrResponse)))
302−performSomeRequestsAsync opts =
329+performSomeRequestsAsync opts sxhr =
303− performSomeRequestsAsync' opts newXMLHttpRequest . fmap return
330+ performSomeRequestsAsync' opts newXMLHttpRequest $ return <$> sxhr
306------------------------------------------------------------------------------
333------------------------------------------------------------------------------
307-- | A modified version or Reflex.Dom.Xhr.performRequestsAsync
334-- | A modified version or Reflex.Dom.Xhr.performRequestsAsync
308-- that accepts 'f (Either e (XhrRequestb))' events
335-- that accepts 'f (Either e (XhrRequestb))' events
309performSomeRequestsAsync'
336performSomeRequestsAsync'
310− :: (MonadJSM (Performable m), PerformEvent t m, TriggerEvent t m, Traversable f, Show b)
337+ :: (MonadJSM (Performable m), PerformEvent t m, TriggerEvent t m, Traversable f)
311 => ClientOptions
338 => ClientOptions
312− -> (XhrRequest b -> (a -> JSM ()) -> Performable m XMLHttpRequest)
339+ -> (forall b. IsXhrPayload b => XhrRequest b -> (a -> JSM ()) -> Performable m XMLHttpRequest)
313− -> Event t (Performable m (f (Either Text (XhrRequest b)))) -> m (Event t (f (Either Text a)))
340+ -> Event t (Performable m (f (Either Text SomeXhrRequest)))
341+ -> m (Event t (f (Either Text a)))
314performSomeRequestsAsync' opts newXhr req = performEventAsync $ ffor req $ \hrs cb -> do
342performSomeRequestsAsync' opts newXhr req = performEventAsync $ ffor req $ \hrs cb -> do
315 rs <- hrs
343 rs <- hrs
316 resps <- forM rs $ \r -> case r of
344 resps <- forM rs $ \r -> case r of
317 Left e -> do
345 Left e -> do
318 resp <- liftIO $ newMVar (Left e)
346 resp <- liftIO $ newMVar (Left e)
319 return resp
347 return resp
320− Right r' -> do
348+ Right (SomeXhrRequest r') -> do
321 resp <- liftIO newEmptyMVar
349 resp <- liftIO newEmptyMVar
322 r'' <- liftJSM $ (optsRequestFixup opts) r'
350 r'' <- liftJSM $ (optsRequestFixup opts) r'
323 _ <- newXhr r'' $ liftIO . putMVar resp . Right
351 _ <- newXhr r'' $ liftIO . putMVar resp . Right
@@ -326,12 +354,6 @@ performSomeRequestsAsync' opts newXhr req = performEventAsync $ ffor req $ \hrs
326 return ()
354 return ()
330−type XhrPayload = T.Text
331−bytesToPayload :: BL.ByteString -> XhrPayload
332−bytesToPayload = TE.decodeUtf8 . BL.toStrict
335performRequestsCT
357performRequestsCT
336 :: (SupportsServantReflex t m,
358 :: (SupportsServantReflex t m,
337 MimeUnrender ct a, Traversable f)
359 MimeUnrender ct a, Traversable f)
@@ -344,11 +366,10 @@ performRequestsCT
344 -> m (Event t (f (ReqResult tag a)))
366 -> m (Event t (f (ReqResult tag a)))
345performRequestsCT ct reqMeth reqs reqHost opts trigger = do
367performRequestsCT ct reqMeth reqs reqHost opts trigger = do
346 resps <- performRequests reqMeth reqs reqHost opts trigger
368 resps <- performRequests reqMeth reqs reqHost opts trigger
347− let decodeResp x = first T.pack .
369+ let decodeResp x = first T.pack
348− mimeUnrender ct .
370+ . mimeUnrender ct
349− BL.fromStrict .
371+ . JS.textToJSString
350− TE.encodeUtf8 =<< note "No body text"
351− (_xhrResponse_responseText x)
372+ =<< note "No body text" (_xhrResponse_responseText x)
352 return $ fmap
373 return $ fmap
353 (\(t,rs) -> ffor rs $ \r -> case r of
374 (\(t,rs) -> ffor rs $ \r -> case r of
354 Left e -> RequestFailure t e
375 Left e -> RequestFailure t e
@@ -379,7 +400,7 @@ evalResponse
379 :: (XhrResponse -> Either Text a)
400 :: (XhrResponse -> Either Text a)
380 -> (tag, XhrResponse)
401 -> (tag, XhrResponse)
381 -> ReqResult tag a
402 -> ReqResult tag a
382−evalResponse decode (tag, xhr) =
403+evalResponse decodeRes (tag, xhr) =
383 let okStatus = _xhrResponse_status xhr < 400
404 let okStatus = _xhrResponse_status xhr < 400
384 errMsg = fromMaybe
405 errMsg = fromMaybe
385 ("Empty response with error code " <>
406 ("Empty response with error code " <>
@@ -389,20 +410,56 @@ evalResponse decode (tag, xhr) =
389 then either
410 then either
390 (\e -> ResponseFailure tag e xhr)
411 (\e -> ResponseFailure tag e xhr)
391 (\v -> ResponseSuccess tag v xhr)
412 (\v -> ResponseSuccess tag v xhr)
392− (decode xhr)
413+ (decodeRes xhr)
393 else ResponseFailure tag errMsg xhr
414 else ResponseFailure tag errMsg xhr
394 in respPayld
415 in respPayld
418+-- | Similar to 'Servant.API.ContentType.MimeUnrender' but with the differnce that
419+-- the second argument expects a JSString instead of ByteString.
420+-- This can lead to better performance ghcjs.
421+class Accept contentType => MimeUnrender contentType a where
422+ mimeUnrender :: Proxy contentType -> JS.JSString -> Either String a
424+instance FromJSON a => MimeUnrender JSON a where
425+ mimeUnrender _ = note "Failed to decode response" . jsonDecode
427+-- | @urlDecodeAsForm@
428+-- Note that the @mimeUnrender p (mimeRender p x) == Right x@ law only
429+-- holds if every element of x is non-null (i.e., not @("", "")@)
430+instance FromForm a => MimeUnrender FormUrlEncoded a where
431+ mimeUnrender _ = first T.unpack . urlDecodeAsForm . BB.toLazyByteString . T.encodeUtf8Builder . JS.textFromJSString
433+-- | @left show . TextL.decodeUtf8'@
434+instance MimeUnrender PlainText TL.Text where
435+ mimeUnrender _ = pure . JS.lazyTextFromJSString
437+-- | @left show . TextS.decodeUtf8' . toStrict@
438+instance MimeUnrender PlainText T.Text where
439+ mimeUnrender _ = pure . JS.textFromJSString
441+-- | @Right . BC.unpack@
442+instance MimeUnrender PlainText String where
443+ mimeUnrender _ = Right . T.unpack . JS.textFromJSString
446+instance MimeUnrender OctetStream ByteString where
447+ mimeUnrender _ = pure . BB.toLazyByteString . T.encodeUtf8Builder . JS.textFromJSString
449+-- | @Right . toStrict@
450+instance MimeUnrender OctetStream BS.ByteString where
451+ mimeUnrender _ = pure . T.encodeUtf8 . JS.textFromJSString
397note :: e -> Maybe a -> Either e a
453note :: e -> Maybe a -> Either e a
398−note e = maybe (Left e) Right
454+note e Nothing = Left e
455+note _ (Just a) = Right a
400fmapL :: (e -> e') -> Either e a -> Either e' a
457fmapL :: (e -> e') -> Either e a -> Either e' a
401fmapL _ (Right a) = Right a
458fmapL _ (Right a) = Right a
402fmapL f (Left e) = Left (f e)
459fmapL f (Left e) = Left (f e)
404−builderToText :: Builder.Builder -> T.Text
461+builderToText :: BB.Builder -> T.Text
405−builderToText = TE.decodeUtf8 . BL.toStrict . Builder.toLazyByteString
462+builderToText = T.decodeUtf8 . BL.toStrict . BB.toLazyByteString
407escape :: T.Text -> T.Text
464escape :: T.Text -> T.Text
408−escape = T.pack . N.escapeURIString (not . N.isReserved) . T.unpack . TE.decodeUtf8 . BL.toStrict . Builder.toLazyByteString . toEncodedUrlPiece
465+escape = T.pack . N.escapeURIString (not . N.isReserved) . T.unpack . T.decodeUtf8 . BL.toStrict . BB.toLazyByteString . toEncodedUrlPiece