git.iko.soy/typeable/servant-reflex
on cb7bb12 help sign in
34 files changed+509−845
since splitsnapshots
unifiedsplit
.gitignore+1−2 .gitmodules+15 .travis.yml+57−12 README.md+33−70 build.sh+3 ChangeLog.md → changelog.md−28 default.nix−21 deps/http-api-data+1 deps/reflex+1 deps/reflex-dom+1 deps/servant+1 deps/servant-snap+1 exec/API.hs−1 exec/Example.hs+25−45 nix/nix.conf−3 nix/reflex-platform.nix−7 nix/servant-snap.nix−7 nix/testresults.nix−17 nix/testserver.nix−9 overrides-ghc.nix+19 overrides.nix+13 servant-reflex.cabal+19−28 shell.nix−1 src/Servant/Common/BaseUrl.hs+9−13 src/Servant/Common/Req.hs+91−107 src/Servant/Reflex.hs+115−223 src/Servant/Reflex/Multi.hs+53−82 testdriver/test/Servant/ReflexSpec.hs+1−2 testserver/API.hs+1−69 testserver/Main.hs+5−20 testserver/run-wd-tests.sh+5 testserver/testserver.cabal+7−8 testserver/tr.nix+32 travis.nix−70
.gitignore+1−2
@@ -6,6 +6,5 @@ log
66*.webapp
77*.stats
88out
9+reflex-platform
910/.stack-work/
10−TAGS
11−dist-newstyle
.gitmodules+15
@@ -0,0 +1,15 @@
1+[submodule "deps/reflex-dom"]
2+ path = deps/reflex-dom
3+ url = https://github.com/reflex-frp/reflex-dom.git
4+[submodule "deps/reflex"]
5+ path = deps/reflex
6+ url = https://github.com/reflex-frp/reflex.git
7+[submodule "deps/http-api-data"]
8+ path = deps/http-api-data
9+ url = https://github.com/fizruk/http-api-data
10+[submodule "deps/servant"]
11+ path = deps/servant
12+ url = https://github.com/haskell-servant/servant
13+[submodule "deps/servant-snap"]
14+ path = deps/servant-snap
15+ url = https://github.com/haskell-servant/servant-snap
.travis.yml+57−12
@@ -1,17 +1,62 @@
1−language: nix
2−nix: 2.3.6
3−sudo: require
1+sudo: required
2+
3+before_cache:
4+ - rm -fv $HOME/.cabal/packages/hackage.haskell.org/build-reports.log
5+ - rm -fv $HOME/.cabal/packages/hackage.haskell.org/00-index.tar
6+
7+addons:
8+ apt:
9+ - phantomjs
10+
11+matrix:
12+ include:
13+ - env: CABALVER=1.24 GHCVER=7.10.3
14+ compiler: ": #GHC 7.10.3"
15+ addons: {apt: {packages: [cabal-install-1.24,ghc-7.10.3], sources: [hvr-ghc]}}
16+ - env: CABALVER=1.24 GHCVER=8.0.1
17+ compiler: ": #GHC 8.0.1"
18+ addons: {apt: {packages: [cabal-install-1.24,ghc-8.0.1], sources: [hvr-ghc]}}
19+
20+
421
522before_install:
6− - sudo cp -rT $TRAVIS_BUILD_DIR/nix /etc/nix
23+ - unset CC
24+ - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH
25+ - git submodule update --init --recursive
726
8−before_script:
9− - sudo systemctl restart nix-daemon.service
10− - git config --global user.email "travis-ci@example.com"
11− - git config --global user.name "Travis-CI"
27+install:
28+ - cabal --version
29+ - BENCH=${BENCH---enable-benchmarks}
30+ - TEST=${TEST---enable-tests}
31+ - echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"
32+ - if [ -f $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz ];
33+ then
34+ zcat $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz >
35+ $HOME/.cabal/packages/hackage.haskell.org/00-index.tar;
36+ fi
37+ - travis_retry cabal update -v
38+ - git clone https://github.com/reflex-frp/reflex-platform
39+ - sed -i 's/^jobs:/-- jobs:/' ${HOME}/.cabal/config
40+ - reflex-platform/work-on ./overrides-ghc.nix ./testserver --command "cd testserver && cabal configure -fExample && cabal build"
41+ - reflex-platform/work-on ghc ./testdriver --command "cd testdriver && cabal configure && cabal build"
42+ - cd testserver && dist/build/back/back -p 8000 &
43+ - sleep 3
44+ - phantomjs --webdriver=127.0.0.1:4444 &
45+ - sleep 3
1246
1347script:
14− - nix-build travis.nix -A build
15− - nix-build travis.nix -A buildGhc
16− - nix-build travis.nix -A testserver
17− - nix-build travis.nix -A testresults
48+ - git config --global user.email "travis-ci@example.com"
49+ - git config --global user.name "Travis-CI"
50+ - ./build.sh
51+ # - testdriver/dist/build/spec/spec
52+
53+cache:
54+ directories:
55+ - /nix
56+ - $HOME/.cabal/packages
57+ - $HOME/.cabal/store
58+
59+env:
60+ global:
61+ - ENCRYPTION_LABEL: "3c89d919c82e"
62+ - COMMIT_AUTHOR_EMAIL: "imalsogreg@gmail.com"
README.md+33−70
@@ -4,19 +4,14 @@
44
55## `servant-reflex` lets you share your `servant` APIs with the frontend
66
7−Keeping your frontend in sync with your API server can be difficult - when the
8−API changes its input parameters or return type, XHR requests from the
9−frontend will fail at runtime. If your API is defined by
10−[servant](https://haskell-servant.readthedocs.io) combinators, you can use
11−`servant-reflex` to share the API between the server and frontend.
12−Syncronization between is checked at compile time, and rather than building XHR
13−requests by hand, API endpoints are available behind `reflex`'s FRP semantics.
7+Keeping your frontend in sync with your API server can be difficult - when the API changes its input parameters or return type, XHR requests from the frontend will fail at runtime. If your API is defined by [servant](haskell-servant.readthedocs.io) combinators, you can use `servant-reflex` to share the API between the server and frontend.
8+Syncronization between is checked at compile time, and rather than building XHR requests by hand, API endpoints are available behind `reflex`'s FRP semantics.
9+
1410
1511
1612## Example
1713
18−We have a webservice API defined in a module where both the server (compiled
19−with ghc) and the frontend (compiled with ghcjs) can see it:
14+We have a webservice API defined in a module where both the server (compiled with ghc) and the frontend (compiled with ghcjs) can see it:
2015
2116```haskell
2217type API = "getint" :> Get '[JSON] Int
@@ -29,8 +24,7 @@ type API = "getint" :> Get '[JSON] Int
2924 :<|> Raw
3025```
3126
32−`servant-reflex` then computes client functions that can query the API through
33−an `XhrRequest`.
27+`servant-reflex` then computes client functions that can query the API through an `XhrRequest`.
3428
3529```haskell
3630
@@ -43,16 +37,7 @@ an `XhrRequest`.
4337 (constDyn (BasePath "/"))
4438```
4539
46−These client functions are computed from your API type. They manage
47−serialization, `XhrRequest` generation, and deserialization for you. `a`
48−parameters used in URL captures become `Dynamic t (Either Text a)` parameters
49−in the client functions. `QueryFlag`, `QueryParams` and `QueryParam` API
50−parameters map to `Dynamic t Bool`, `Dynamic t [a]` and `Dynamic t (QParam a)`
51−respectively. These parameters to the client function are wrapped with failure
52−possibility to allow you to indicate at any time whether input validation for
53−that parameter has failed and no valid XHR request can be generated. The final
54−parameter is a trigger event for the XHR request. The return value
55−`Event t (ReqResult a)` contains responses from the API server.
40+These client functions are computed from your API type. They manage serialization, XhrRequest generation, and deserialization for you. `a` parameters used in URL captures become `Dynamic t (Either Text a)` parameters in the client functions. 'QueryFlag', 'QueryParams' and 'QueryParam' API parameters map to 'Dynamic t Bool', 'Dynamic t [a]' and 'Dynamic t (QParam a)' respectively. These parameters to the client function are wrapped with failure possibility to allow you to indicate at any time whether input validation for that parameter has failed and no valid XHR request can be generated. The final parameter is a trigger event for the XHR request. The return value `Event t (ReqResult a)` contains responses from the API server.
5641
5742```haskell
5843 -- No need to write these functions. servant-reflex creates them for you!
@@ -77,13 +62,7 @@ parameter is a trigger event for the XHR request. The return value
7762 -> m (Event t (ReqResult () Double))
7863```
7964
80−`ReqResult tag a` is defined in
81−[`Servant.Common.Req`](https://github.com/imalsogreg/servant-reflex/blob/6d866e338edb9bf6fd8f8d5083ff0187b4d8c0d2/src/Servant/Common/Req.hs#L40-L42)
82−and reports whether or not your request was sent (if validation fails, the
83−request won't be sent), and how decoding of the response went. You can pattern
84−match on these explicitly, but usually you'll want to use
85−`fmapMaybe :: (a -> Maybe b) -> Event t a -> Event t b` and one of the
86−elimination functions to filter the result type you care about, like this:
65+`ReqResult tag a` is defined in [`Servant.Common.Req`](https://github.com/imalsogreg/servant-reflex/blob/6d866e338edb9bf6fd8f8d5083ff0187b4d8c0d2/src/Servant/Common/Req.hs#L40-L42) and reports whether or not your request was sent (if validation fails, the request won't be sent), and how decoding of the response went. You can pattern match on these explicitly, but usually you'll want to use `fmapMaybe :: (a -> Maybe b) -> Event t a -> Event t b` and one of the elimination functions to filter the result type you care about, like this:
8766
8867```haskell
8968 -- ... continued ...
@@ -101,8 +80,7 @@ elimination functions to filter the result type you care about, like this:
10180 dynText =<< holdDyn "" (leftmost [errs, const "" <$> ys])
10281```
10382
104−This example builds some input fields to enter API parameters, buttons to
105−trigger the API calls, and text elements to show the results:
83+This example builds some input fields to enter API parameters, buttons to trigger the API calls, and text elements to show the results:
10684
10785```haskell
10886 elClass "div" "int-demo" $ do
@@ -125,53 +103,47 @@ trigger the API calls, and text elements to show the results:
125103 display =<< holdDyn Nothing outputDouble
126104```
127105
128−For a great introduction to recative DOM building, see the
129−[README](https://github.com/reflex-frp/reflex-platform) for the
130−`reflex-platform`. For more information about servant, see their
131−[documentation](http://haskell-servant.readthedocs.io/en/stable/). Thanks to
132−the respective authors of these fabulous libraries.
106+For a great introduction to recative DOM building, see the [README](https://github.com/reflex-frp/reflex-platform) for the `reflex-platform`. For more information about servant, see their [documentation](http://haskell-servant.readthedocs.io/en/stable/). Thanks to the respective authors of these fabulous libraries.
133107
134108
135109## Building the library and test server
136110
137−This repository comes with a small example of an API shared between a
138−ghcjs-compiled frontend
139−([exec/](https://github.com/imalsogreg/servant-reflex/tree/master/exec)) and a
140−ghc-compiled backend
141−([testserver/](https://github.com/imalsogreg/servant-reflex/tree/master/testserver).
142−To build these components, we will use the nix packages for the testserver. It
143−manages the frontend build as a dependency.
111+This repository comes with a small example of an API shared between a ghcjs-compiled frontend ([exec/](https://github.com/imalsogreg/servant-reflex/tree/master/exec)) and a ghc-compiled backend ([testserver/](https://github.com/imalsogreg/servant-reflex/tree/master/testserver). To build these components:
112+
113+
114+First build the library:
144115
145116```
146−nix build -f travis.nix testserver -o server
117+git submodule update --init --recursive
118+./build.sh
147119```
148120
149−Point it at the static directory and run it:
121+Then build the test server:
122+
123+```
124+deps/reflex-platform/work-on ./overrides-ghc.nix ./testserver --command "cd testserver && cabal build"
125+```
126+
127+
128+## Running the example site
129+
130+The server must be run from the directory where static assets live:
150131
151132```
152−STATIC_DIR=server/static server/back -p 8000
133+cd testserver
134+dist/build/back/back -p 8001
153135```
154136
155−Browse to [http://localhost:8000](http://localhost:8000) and click around.
156−Open the firefox or chrome developer tools and examine the XHR activity
157−under the Network tab.
137+And simply browse to `localhost:8001`
158138
159−**For a larger example of a project that shares types between backend and
160−frontend, see [hsnippet](https://github.com/mightybyte/hsnippet).**
139+**For a larger example of a project that shares types between backend and frontend, see [hsnippet](https://github.com/mightybyte/hsnippet).**
161140
162141
163142## Tagging requests
164143
165−The input and the return type of a client function like `getDouble` are both
166−event streams. The individual input events and responses occur at different
167−times and aren't automatically paired up, but you can recover the
168−relationship by tagging the requests.
144+The input and the return type of a client function like `getDouble` are both event streams. The individual input events and responses occur at different times and aren't automatically paired up, but you can recover the relationship by tagging the requests.
169145
170−So far we have used an `Event t ()` to trigger sending a request. If we choose
171−e.g. `Double` for the third `Proxy` argument to `client`, then `Event t Double`
172−will be used to trigger requests, and each `ReqResult` will carry the tag of
173−its request. Imagine we wanted to display not just the last "double" from
174−`doubleIt`, but a whole table of valid inputs and their doubled responses:
146+So far we have used an `Event t ()` to trigger sending a request. If we choose e.g. `Double` for the third `Proxy` argument to `client`, then `Event t Double` will be used to trigger requests, and each `ReqResult` will carry the tag of its request. Imagine we wanted to display not just the last "double" from `doubleIt`, but a whole table of valid inputs and their doubled responses:
175147
176148```haskell
177149 ...
@@ -201,10 +173,7 @@ its request. Imagine we wanted to display not just the last "double" from
201173
202174## Simultaneous requests
203175
204−`Servant.Reflex.Multi` provides an alternative client-generation function
205−called `clientA` (client applicative). Choose a container type that has both
206−`Applicative` and `Traversable` instances, and pass it to `clientA` through
207−another `Proxy`. Our `sayHi` client function will then have this type:
176+'Servant.Reflex.Multi' provides an alternative client-generation function called 'clientA' (client applicative). Choose a container type that has both `Applicative` and `Traversable` instances, and pass it to `clientA` through another 'Proxy'. Our `sayHi` client function will then have this type:
208177
209178```haskell
210179sayHi
@@ -215,10 +184,4 @@ sayHi
215184 -> m (Event t (f (ReqResult tag Text)))
216185```
217186
218−The dynamic params are each wrapped in `f`. For every firing of the trigger
219−event `tag`, all of these parameters will be combined according to `f`'s
220−`Applicative` instance (when `f` is `[]`, you will get all combinations of
221−all parameters taken together as a request; when `f` is `ZipList`, the Nth
222−elemens of each parameters list will be taken together as a request). Using
223−this interface, you can trigger many XHR's from a single event occurence, and
224−expect the responses to be structured the same way as the requests.
187+The dynamic params are each wrapped in `f`. For every firing of the trigger event `tag`, all of these parameters will be combined according to `f`'s applicative instance (when `f` is `[]`, you will get all combinations of all parameters taken together as a request; when `f` is 'ZipList', the Nth elemens of each parameters list will be taken together as a request). Using this interface, you can trigger many XHR's from a single event occurence, and expect the responses to be structured the same way as the requests.
build.shnew file+3
@@ -0,0 +1,3 @@
1+#!/usr/bin/env bash
2+
3+reflex-platform/work-on ./overrides.nix ./. --run "cabal configure --ghcjs && cabal build && exec/toSite.sh"
ChangeLog.md → changelog.mdrenamed−28
@@ -1,31 +1,3 @@
1−0.3.5
2−-----
3−
4− - Require reflex-dom-core >= 0.6 (for internal handling of case-insensitive headers)
5− - Require servant >= 0.16
6− - Eliminate use of deprecated widgets from reflex-dom-core
7− - Bump the version of reflex-platform used in nix-shell and test suite
8−
9−0.3.4
10−-----
11−
12−Add selenium-based test suite
13−
14−0.3.3
15−-----
16−
17−- Fix encoding issue: Explicitly escape reserved characters from path pieces and query parameters
18−
19−
20−0.3.2
21−-----
22−
23−- **Addition of 'Servant.Reflex.Common.Req.ClientOpts'** which
24−allows the users to apply a final adjustment to Requests before
25−thery are sent, such as setting the 'withCredentials' flag
26−or print the Request to the console for debugging
27−[PR #47](https://github.com/imalsogreg/servant-reflex/pull/47)
28−
2910.3
302---
313
default.nixdeleted−21
@@ -1,21 +0,0 @@
1−{ mkDerivation, base, bytestring, case-insensitive, containers
2−, data-default, exceptions, ghcjs-dom, http-api-data, http-media
3−, jsaddle, mtl, network-uri, reflex, reflex-dom, reflex-dom-core
4−, safe, servant, servant-auth, stdenv, string-conversions, text
5−, transformers
6−}:
7−mkDerivation {
8− pname = "servant-reflex";
9− version = "0.3.6";
10− src = ./.;
11− isLibrary = true;
12− isExecutable = true;
13− libraryHaskellDepends = [
14− base bytestring case-insensitive containers data-default exceptions
15− ghcjs-dom http-api-data http-media jsaddle mtl network-uri reflex
16− reflex-dom reflex-dom-core safe servant servant-auth string-conversions
17− text transformers
18− ];
19− description = "servant API generator for reflex apps";
20− license = stdenv.lib.licenses.bsd3;
21−}
deps/http-api-datanew file+1

Submodule changed.

deps/reflexnew file+1

Submodule changed.

deps/reflex-domnew file+1

Submodule changed.

deps/servantnew file+1

Submodule changed.

deps/servant-snapnew file+1

Submodule changed.

exec/API.hs−1
@@ -40,7 +40,6 @@ type API = "getunit" :> Get '[JSON] ()
4040 :<|> "a" :> "b" :> QueryFlag "gusto" :> Get '[JSON] Text
4141 :<|> "qna" :> ReqBody '[JSON] Question
4242 :> Post '[JSON] Answer
43− :<|> "secret" :> BasicAuth "realm" () :> Get '[JSON] Int
4443 :<|> Raw
4544
4645type GET = Get '[JSON] ()
exec/Example.hs+25−45
@@ -1,4 +1,3 @@
1−{-# LANGUAGE DataKinds #-}
21{-# LANGUAGE FlexibleContexts #-}
32{-# LANGUAGE GADTs #-}
43{-# LANGUAGE OverloadedStrings #-}
@@ -15,14 +14,12 @@ import Control.Monad.Fix (MonadFix)
1514import Data.Monoid (First(..), (<>))
1615import Data.Text (Text)
1716import qualified Data.Text as T
18−import qualified Data.Text.Encoding as T
1917import GHC.TypeLits
2018import Servant.API
2119import API
2220import Data.Proxy
2321import Text.Read (readMaybe)
24−import Reflex.Dom.Core hiding (run, mainWidget)
25−import Reflex.Dom (mainWidget)
22+import Reflex.Dom
2623------------------------------------------------------------------------------
2724import Servant.Reflex
2825import Servant.Reflex.Multi
@@ -33,6 +30,7 @@ api = Proxy
3330
3431main :: IO ()
3532main = mainWidget $ do
33+ el "h1" $ text "Wowzers!"
3634 divClass "example-base" run
3735 divClass "example-multi" runMulti
3836
@@ -46,7 +44,7 @@ runMulti :: forall t m. (SupportsServantReflex t m,
4644runMulti = do
4745 url <- baseUrlWidget
4846 el "br" blank
49− let (_ :<|> _ :<|> sayHi :<|> dbl :<|> _ :<|> _ :<|> _ :<|> _ ) =
47+ let (_ :<|> _ :<|> sayHi :<|> dbl :<|> _ :<|> _ ) =
5048 clientA api (Proxy :: Proxy m) (Proxy :: Proxy []) (Proxy :: Proxy Int) url
5149
5250 num :: Dynamic t (Either Text Double) <- fmap (note "No read" . readMaybe . T.unpack) . value <$> textInput def
@@ -67,14 +65,11 @@ runMulti = do
6765 grts <- fmap (fmap T.words . value) $ divClass "" $ do
6866 text "Greetings"
6967 textInput def
70− gust <- fmap (value) $ divClass "gusto-input" $ checkbox False def
68+ gust <- fmap value $ divClass "gusto-input" $ checkbox False def
7169 b <- button "Go"
72− r' <- sayHi (fmap QParamSome <$> nms) (fmap (:[]) $ grts)
73− (constDyn [True, False]) (1 <$ b)
74−
75− dynText =<< holdDyn "Waiting" (T.pack . show . catMaybes .
76− fmap reqSuccess <$> r')
70+ r' <- sayHi (fmap QParamSome <$> nms) (fmap (:[]) grts) (constDyn [True, False]) (1 <$ b)
7771
72+ dynText =<< holdDyn "Waiting" (T.pack . show . catMaybes . fmap reqSuccess <$> r')
7873
7974 return ()
8075
@@ -97,11 +92,8 @@ run = mdo
9792 el "br" (return ())
9893
9994 -- Name the computed API client functions
100− let tweakRequest = ClientOptions $ \r -> do
101− return $ r & withCredentials .~ True
102− let (getUnit :<|> getInt :<|> sayhi :<|> dbl
103− :<|> multi :<|> qna :<|> secret :<|> doRaw) =
104− clientWithOpts api (Proxy :: Proxy m) (Proxy :: Proxy Int) url tweakRequest
95+ let (getUnit :<|> getInt :<|> sayhi :<|> dbl :<|> multi :<|> qna :<|> doRaw) =
96+ client api (Proxy :: Proxy m) (Proxy :: Proxy Int) url
10597
10698 c2 = client (Proxy :: Proxy ComprehensiveAPI) (Proxy :: Proxy m) (Proxy :: Proxy ()) url -- Just make sure this compiles for now
10799
@@ -112,11 +104,11 @@ run = mdo
112104 unitResponse <- getUnit $ tag (current reqCount) unitBtn
113105 intResponse :: Event t (ReqResult Int Int) <- getInt $ tag (current reqCount) intBtn
114106
115− score <- foldDyn (+) 0 (fmapMaybe reqSuccess (intResponse))
107+ score <- foldDyn (+) 0 (fmapMaybe reqSuccess intResponse)
116108
117− r <- holdDyn "Waiting" $ fmap showXhrResponse $
118− leftmost [fmapMaybe response (unitResponse)
119− ,fmapMaybe response (intResponse)
109+ r <- holdDyn "Waiting" $ showXhrResponse <$>
110+ leftmost [fmapMaybe response unitResponse
111+ ,fmapMaybe response intResponse
120112 ]
121113 divClass "unit-int-response" $ el "p" $ dynText r >> el "br" (return ()) >> text "Total: " >> display score
122114 return (unitBtn, intBtn)
@@ -125,14 +117,14 @@ run = mdo
125117
126118 text "Name"
127119 el "br" $ return ()
128− inp :: Dynamic t Text <- fmap value $ divClass "name-input" $ (textInput def)
120+ inp :: Dynamic t Text <- fmap value $ divClass "name-input" $ textInput def
129121 let checkedName = fmap (\i -> bool (QParamSome i) (QParamInvalid "Need a name") (T.null i)) inp
130122 el "br" $ return ()
131123
132124 text "Greetings (space-separated)"
133125 el "br" $ return ()
134126 greetings <- fmap (fmap T.words . value) $
135− divClass "greetings-input" $ (textInput def)
127+ divClass "greetings-input" $ textInput def
136128
137129 el "br" $ return ()
138130
@@ -144,23 +136,23 @@ run = mdo
144136
145137 resp <- sayhi checkedName greetings gusto (tag (current reqCount) triggers)
146138 divClass "greeting-response" $ dynText =<<
147− holdDyn "No hi yet" (leftmost [ fmapMaybe reqSuccess (resp)
148− , fmapMaybe reqFailure (resp)])
139+ holdDyn "No hi yet" (leftmost [ fmapMaybe reqSuccess resp
140+ , fmapMaybe reqFailure resp])
149141 return sayHiClicks
150142
151143 dblBtn <- elClass "div" "demo-group" $ do
152144 text "A Double to double"
153145 el "br" $ return ()
154146 dblinp <- fmap value $ divClass "double-input" $ textInput def
155− (dblBtn) <- divClass "double-button" $ button "Double it"
156− dblResp <- dbl (fmap (note "read failure" . readMaybe . T.unpack) $
147+ dblBtn <- divClass "double-button" $ button "Double it"
148+ dblResp <- dbl ((note "read failure" . readMaybe . T.unpack) <$>
157149 dblinp) (tag (current reqCount) dblBtn)
158150 divClass "double-errors" $ dynText =<<
159− holdDyn "(no errors)" (fmapMaybe reqFailure (dblResp))
151+ holdDyn "(no errors)" (fmapMaybe reqFailure dblResp)
160152 el "br" (return ())
161153 divClass "double-result" $ el "p" $ dynText =<<
162− holdDyn "No number yet" (fmap tShow $
163− fmapMaybe reqSuccess (dblResp))
154+ holdDyn "No number yet" (tShow <$>
155+ fmapMaybe reqSuccess dblResp)
164156 return dblBtn
165157
166158 mpGo <- elClass "div" "demo-group" $ do
@@ -168,9 +160,9 @@ run = mdo
168160 b <- value <$> checkbox False def
169161 mpGo <- button "Test"
170162 multiResp <- multi b (tag (current reqCount) mpGo)
171− dynText =<< holdDyn "No res yet" (fmap tShow $
172− fmapMaybe reqSuccess $
173− (multiResp))
163+ dynText =<< holdDyn "No res yet" (tShow <$>
164+ fmapMaybe reqSuccess
165+ multiResp)
174166 return mpGo
175167
176168 return ()
@@ -180,24 +172,12 @@ run = mdo
180172 elClass "div" "demo-group" $ do
181173 text "JSON Unicode encoding test"
182174 txt <- value <$> textInput def
183− ev <- fmap (1 <$) $ button "Question"
175+ ev <- (1 <$) <$> button "Question"
184176 let dQ = Right . Question <$> traceDyn "will send: " txt
185177 rr <- qna dQ ev
186178 el "p" $
187179 dynText =<< holdDyn "No Answer" (unAnswer <$> fmapMaybe reqSuccess rr)
188180
189− divClass "demo-group" $ do
190− un <- fmap value $ text "Username" >> textArea def
191− pw <- fmap value $ text "Unhidden PW" >> textArea def
192− let ba :: Dynamic t (BasicAuthData ) = BasicAuthData
193− <$> fmap T.encodeUtf8 un
194− <*> fmap T.encodeUtf8 pw
195− b <- button "Get secret"
196− r <- secret (Just <$> ba) (0 <$ b)
197− res <- holdDyn Nothing (reqSuccess <$> r)
198− display res
199−
200−
201181showXhrResponse :: XhrResponse -> Text
202182showXhrResponse (XhrResponse stat stattxt rbmay rtmay respHeaders) =
203183 T.unlines ["stat: " <> tShow stat
nix/nix.confdeleted−3
@@ -1,3 +0,0 @@
1−substituters = https://cache.nixos.org/ https://nixcache.reflex-frp.org/
2−trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
3−trusted-users = travis
nix/reflex-platform.nixdeleted−7
@@ -1,7 +0,0 @@
1−let
2− rev = "1aba6f367982bd6dd78ec2fda75ab246a62d32c5" ;
3−in import (builtins.fetchTarball
4− {
5− url = "https://github.com/reflex-frp/reflex-platform/archive/${rev}.tar.gz";
6− sha256 = "137vg6i8yy4lp6rz4wbvvhfcc9d9qf7j1b3fnng3r7sj63k7j664" ;
7− }) {}
nix/servant-snap.nixdeleted−7
@@ -1,7 +0,0 @@
1−# Servant-snap is marked broken in nixpkgs
2−{ nixpkgs ? import <nixpkgs> {}}: self: super:
3−self.callCabal2nix "servant-snap" (nixpkgs.fetchgit {
4− url = "https://github.com/haskell-servant/servant-snap.git";
5− rev = "af5172a6de5bb2a07eb1bf4c85952075ec6ecdf3";
6− sha256 = "sha256-fzzQGwG8Ko72OO/kwLMG52eNZSt3F2dxhNgM9gaO4yQ=";
7−}) {}
nix/testresults.nixdeleted−17
@@ -1,17 +0,0 @@
1−{ curl, reflexPlatform, testdriver, testserver, phantomjs }:
2−
3−reflexPlatform.nixpkgs.pkgs.runCommand "runWebdriveTest.sh" {} ''
4− echo About to phantom
5− ${phantomjs}/bin/phantomjs --webdriver=127.0.0.1:4444 &
6− sleep 3
7− echo About to Server
8− STATIC_DIR=${testserver}/static ${testserver}/back -q --no-access-log --no-error-log -p 8000 &
9− sleep 3
10− ${curl}/bin/curl localhost:8000
11− ${curl}/bin/curl localhost:8000/runmain.js
12− echo About to testdrive
13− ${testdriver}/bin/spec > $out 2>&1
14− echo Done
15− trap "exit" INT TERM
16− trap "kill 0" EXIT
17− ''
nix/testserver.nixdeleted−9
@@ -1,9 +0,0 @@
1−servant-reflex: self: super:
2−
3−(self.callCabal2nix "testserver" ../testserver {}).overrideDerivation (drv: {
4− postInstall = ''
5− cp dist/build/back/back $out/back
6− mkdir $out/static
7− cp ${servant-reflex}/bin/example.jsexe/* $out/static/
8− '';
9−})
overrides-ghc.nixnew file+19
@@ -0,0 +1,19 @@
1+{ reflex-platform, ... }:
2+let
3+ dc = reflex-platform.lib.dontCheck;
4+ c2n = reflex-platform.cabal2nixResult;
5+in reflex-platform.ghc.override {
6+ overrides = self: super: {
7+ servant-snap = dc (self.callPackage (c2n deps/servant-snap) {});
8+ snap = dc (self.callPackage (c2n deps/servant-snap/deps/snap) {});
9+ snap-server = dc (self.callPackage (c2n deps/servant-snap/deps/snap/deps/snap-server) {});
10+ io-streams = dc (self.callPackage (c2n deps/servant-snap/deps/snap/deps/io-streams) {});
11+ io-streams-haproxy = dc (self.callPackage (c2n deps/servant-snap/deps/snap/deps/io-streams-haproxy) {});
12+ heist = dc (self.callPackage (c2n deps/servant-snap/deps/snap/deps/heist) {});
13+ xmlhtml = dc (self.callPackage (c2n deps/servant-snap/deps/snap/deps/xmlhtml) {});
14+ snap-core = dc (self.callPackage (c2n deps/servant-snap/deps/snap/deps/snap-core) {});
15+ servant = dc (self.callPackage (c2n deps/servant/servant) {});
16+ Glob = dc super.Glob;
17+ http-api-data = dc (self.callPackage (c2n deps/http-api-data) {});
18+ };
19+}
overrides.nixnew file+13
@@ -0,0 +1,13 @@
1+{ reflex-platform, ... }:
2+let
3+
4+ dc = reflex-platform.lib.dontCheck;
5+ c2n = reflex-platform.cabal2nixResult;
6+
7+in
8+reflex-platform.ghcjs.override {
9+ overrides = self: super: {
10+ servant = dc (self.callPackage (c2n deps/servant/servant) {});
11+ http-api-data = dc (self.callPackage (c2n deps/http-api-data) {});
12+ };
13+}
servant-reflex.cabal+19−28
@@ -1,8 +1,8 @@
11Name: servant-reflex
2−Version: 0.3.6
3−Synopsis: servant API generator for reflex apps
4−Description: Generate reflex-compatible client functions from servant API descriptions
5−License: BSD3
2+Version: 0.3
3+Synopsis: Servant reflex API generator
4+Description: Servant reflex API generator
5+License: AllRightsReserved
66License-file: LICENSE.md
77Author: Greg Hale, Doug Beardsley
88Maintainer: imalsogreg@gmail.com
@@ -17,35 +17,35 @@ Flag Example
1717
1818library
1919 exposed-modules:
20− Servant.Common.BaseUrl
21− Servant.Common.Req
2220 Servant.Reflex
2321 Servant.Reflex.Multi
2422
23+ other-modules:
24+ Servant.Common.BaseUrl
25+ Servant.Common.Req
26+
2527 hs-source-dirs: src
2628 build-depends:
27− base >= 4.8 && < 5,
29+ base >= 4.8 && < 4.10,
2830 bytestring >= 0.10 && < 0.11,
2931 case-insensitive >= 1.2.0.4 && < 1.3,
30− containers >= 0.5.6 && < 0.7,
32+ containers >= 0.5.6 && < 0.6,
3133 data-default >= 0.5 && < 0.8,
32− exceptions >= 0.8 && < 0.11,
33− ghcjs-dom >= 0.2 && < 0.10,
34− http-api-data >= 0.3.6 && < 0.5,
35− http-media >= 0.6 && < 0.9,
36− jsaddle >= 0.8 && < 0.10,
34+ exceptions >= 0.8 && < 0.9,
35+ ghcjs-dom >= 0.2 && < 0.3,
36+ http-api-data >= 0.2 && < 0.4,
37+ http-media >= 0.6 && < 0.7,
3738 mtl >= 2.2.1 && < 2.3,
3839 network-uri >= 2.6 && < 2.7,
39− reflex >= 0.5 && < 0.9,
40− reflex-dom-core >= 0.6 && < 0.8,
40+ reflex >= 0.5 && < 0.6,
41+ reflex-dom == 0.4 && < 0.5,
4142 safe >= 0.3.9 && < 0.4,
42− servant >= 0.16 && < 0.19,
43− servant-auth >= 0.2.1 && < 0.4,
43+ servant >= 0.8 && < 0.11,
4444 string-conversions >= 0.4 && < 0.5,
4545 text >= 1.2 && < 1.3,
4646 transformers >= 0.4 && < 0.6
4747
48− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields
48+ ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2
4949
5050 default-language: Haskell2010
5151
@@ -54,16 +54,7 @@ executable example
5454 buildable: True
5555 else
5656 buildable: False
57− build-depends:
58− aeson,
59− reflex,
60− servant-reflex,
61− base,
62− scientific,
63− servant,
64− reflex-dom,
65− reflex-dom-core,
66− text
57+ build-depends: aeson, reflex, servant-reflex, base, scientific, servant, reflex-dom, text
6758 default-language: Haskell2010
6859 main-is: Example.hs
6960 other-modules: API
shell.nixdeleted−1
@@ -1 +0,0 @@
1−(import ./travis.nix {nativeCompiler = "ghc";}).ghcPkgs.servant-reflex.env
src/Servant/Common/BaseUrl.hs+9−13
@@ -1,5 +1,4 @@
11{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE CPP #-}
32{-# LANGUAGE DeriveDataTypeable #-}
43{-# LANGUAGE DeriveGeneric #-}
54{-# LANGUAGE FlexibleContexts #-}
@@ -21,22 +20,18 @@ module Servant.Common.BaseUrl (
2120) where
2221
2322import Control.Monad (join)
24−-- import Control.Monad.IO.Class (MonadIO)
23+import Control.Monad.IO.Class (MonadIO)
2524import Control.Monad.Fix (MonadFix)
2625import Data.Monoid ((<>))
2726import Data.Text (Text)
2827import qualified Data.Text as T
2928import GHC.Generics
30−import Language.Javascript.JSaddle.Monad (MonadJSM)
3129import Reflex
32−import Reflex.Dom.Core
30+import Reflex.Dom
3331import Text.Read
3432
35−#if !MIN_VERSION_reflex_dom_core(0,7,0)
36−type SupportsServantReflex t m = (Reflex t, TriggerEvent t m, PerformEvent t m, HasWebView (Performable m), MonadJSM (Performable m))
37−#else
38−type SupportsServantReflex t m = (Reflex t, TriggerEvent t m, PerformEvent t m, MonadJSM (Performable m))
39−#endif
33+
34+type SupportsServantReflex t m = (Reflex t, TriggerEvent t m, PerformEvent t m, HasWebView (Performable m), MonadIO (Performable m))
4035
4136-- | URI scheme to use
4237data Scheme =
@@ -89,14 +84,15 @@ baseUrlWidget = elClass "div" "base-url" $ do
8984 where pathWidget :: m (Dynamic t BaseUrl)
9085 pathWidget = do
9186 text "Url base path"
92− t <- inputElement def
87+ t <- textInput (def {_textInputConfig_attributes =
88+ constDyn ("placeholder" =: "/a/b")})
9389 return $ BasePath <$> value t
9490 fullUrlWidget :: m (Dynamic t BaseUrl)
9591 fullUrlWidget = do
9692 schm <- dropdown Https (constDyn $ Https =: "https" <> Http =: "http") def
97− srv <- inputElement def
93+ srv <- textInput def {_textInputConfig_attributes = constDyn $ "placeholder" =: "example.com"}
9894 text ":"
99− prt <- inputElement def
95+ prt <- textInput def { _textInputConfig_attributes = constDyn $ "placeholder" =: "80"}
10096 port :: Dynamic t Int <- holdDyn 80 (fmapMaybe (readMaybe . T.unpack) $ updated (value prt))
101− path <- inputElement def
97+ path <- textInput def { _textInputConfig_attributes = constDyn $ "placeholder" =: "a/b" }
10298 return $ BaseFullUrl <$> value schm <*> value srv <*> port <*> value path
src/Servant/Common/Req.hs+91−107
@@ -4,22 +4,18 @@
44{-# LANGUAGE GADTs #-}
55{-# LANGUAGE OverloadedStrings #-}
66{-# LANGUAGE LambdaCase #-}
7−{-# LANGUAGE RankNTypes #-}
87{-# LANGUAGE ScopedTypeVariables #-}
98{-# LANGUAGE TupleSections #-}
109
1110module Servant.Common.Req where
1211
1312-------------------------------------------------------------------------------
14−import Control.Applicative (liftA2, liftA3)
15−import Control.Arrow ((&&&))
1613import Control.Concurrent
14+import Control.Applicative (liftA2, liftA3)
1715import Control.Monad (join)
1816import Control.Monad.IO.Class (MonadIO, liftIO)
1917import Data.Bifunctor (first)
20−import qualified Data.ByteString.Builder as Builder
2118import qualified Data.ByteString.Lazy.Char8 as BL
22−import Data.ByteString (ByteString)
2319import qualified Data.Map as Map
2420import Data.Maybe (catMaybes, fromMaybe)
2521import Data.Functor.Compose
@@ -29,9 +25,7 @@ import Data.Text (Text)
2925import qualified Data.Text as T
3026import qualified Data.Text.Encoding as TE
3127import Data.Traversable (forM)
32−import Language.Javascript.JSaddle.Monad (JSM, MonadJSM, liftJSM)
33−import qualified Network.URI as N
34−import Reflex.Dom.Core hiding (tag)
28+import Reflex.Dom hiding (tag)
3529import Servant.Common.BaseUrl (BaseUrl, showBaseUrl,
3630 SupportsServantReflex)
3731import Servant.API.ContentTypes (MimeUnrender(..), NoContent(..))
@@ -52,23 +46,6 @@ data ReqResult tag a
5246 -- ^ A failure to construct the request tagged with 'tag' at trigger time
5347 deriving (Functor)
5448
55−data ClientOptions = ClientOptions
56− { optsRequestFixup :: forall a. Show a => XhrRequest a -> JSM (XhrRequest a)
57− -- ^ Aribtrarily modify requests just before they are sent.
58− -- Warning: This escape hatch opens the possibility for your
59− -- requests to diverge from what the server expects, when the
60− -- server is also derived from a servant API
61− }
62−
63−defaultClientOptions :: ClientOptions
64−defaultClientOptions = ClientOptions { optsRequestFixup = return }
65−
66−-- withCredentials :: Lens' (XhrRequest a) Bool
67−withCredentials :: (Show a, Functor f) => (Bool -> f Bool) -> XhrRequest a -> f (XhrRequest a)
68−withCredentials inj r@(XhrRequest _ _ cfg) =
69− let cfg' = (\b -> cfg { _xhrRequestConfig_withCredentials = b}) <$>
70− inj (_xhrRequestConfig_withCredentials cfg)
71− in (\c' -> r {_xhrRequest_config = c' }) <$> cfg'
7249
7350------------------------------------------------------------------------------
7451-- | Simple filter/accessor for successful responses, when you want to
@@ -93,13 +70,6 @@ reqFailure (ResponseFailure _ s _) = Just s
9370reqFailure (RequestFailure _ s) = Just s
9471reqFailure _ = Nothing
9572
96−------------------------------------------------------------------------------
97−-- | Simple filter/accessor like 'reqFailure', but keeping the request tag
98−reqFailure' :: ReqResult tag a -> Maybe (tag,Text)
99−reqFailure' (ResponseFailure tag s _) = Just (tag,s)
100−reqFailure' (RequestFailure tag s) = Just (tag,s)
101−reqFailure' _ = Nothing
102−
10373
10474------------------------------------------------------------------------------
10575-- | Simple filter/accessor for the raw XHR response
@@ -167,7 +137,7 @@ reqToReflexRequest
167137 => Text
168138 -> Dynamic t BaseUrl
169139 -> Req t
170− -> Dynamic t (Either Text (XhrRequest XhrPayload))
140+ -> (Dynamic t (Either Text (XhrRequest XhrPayload)))
171141reqToReflexRequest reqMeth reqHost req =
172142 let t :: Dynamic t [Either Text Text]
173143 t = sequence $ reverse $ reqPathParts req
@@ -179,22 +149,18 @@ reqToReflexRequest reqMeth reqHost req =
179149 urlParts = fmap sequence t
180150
181151 urlPath :: Dynamic t (Either Text Text)
182− urlPath = (fmap.fmap)
183− (T.intercalate "/" . fmap escape)
184− urlParts
152+ urlPath = (fmap.fmap) (T.intercalate "/") urlParts
185153
186154 queryPartString :: (Text, QueryPart t) -> Dynamic t (Maybe (Either Text Text))
187155 queryPartString (pName, qp) = case qp of
188156 QueryPartParam p -> ffor p $ \case
189157 Left e -> Just (Left e)
190− Right (Just a) -> Just (Right $ pName <> "=" <> escape a)
158+ Right (Just a) -> Just (Right $ pName <> "=" <> a)
191159 Right Nothing -> Nothing
192160 QueryPartParams ps -> ffor ps $ \pStrings ->
193161 if null pStrings
194162 then Nothing
195− else Just . Right
196− . T.intercalate "&"
197− $ fmap (\p -> pName <> "=" <> escape p) pStrings
163+ else Just $ Right (T.intercalate "&" (fmap (\p -> pName <> "=" <> p) pStrings))
198164 QueryPartFlag fl -> ffor fl $ \case
199165 True -> Just $ Right pName
200166 False -> Nothing
@@ -229,10 +195,10 @@ reqToReflexRequest reqMeth reqHost req =
229195 Right $ XhrRequestConfig
230196 { _xhrRequestConfig_sendData = bytesToPayload bBytes
231197 , _xhrRequestConfig_headers =
232− Map.insert "Content-Type" bCT (Map.fromList hs)
198+ Map.insert "Content-Type" bCT (Map.fromList hs)
233199 , _xhrRequestConfig_user = Nothing
234200 , _xhrRequestConfig_password = Nothing
235− , _xhrRequestConfig_responseType = Just XhrResponseType_ArrayBuffer
201+ , _xhrRequestConfig_responseType = Nothing
236202 , _xhrRequestConfig_withCredentials = False
237203 , _xhrRequestConfig_responseHeaders = def
238204 }
@@ -244,8 +210,8 @@ reqToReflexRequest reqMeth reqHost req =
244210 Right hs -> Right $ def { _xhrRequestConfig_headers = Map.fromList hs
245211 , _xhrRequestConfig_user = Nothing
246212 , _xhrRequestConfig_password = Nothing
247− , _xhrRequestConfig_responseType = Just XhrResponseType_ArrayBuffer
248− , _xhrRequestConfig_sendData = mempty
213+ , _xhrRequestConfig_responseType = Nothing
214+ , _xhrRequestConfig_sendData = ""
249215 , _xhrRequestConfig_withCredentials = False
250216 }
251217 Just rBody -> liftA2 mkConfigBody xhrHeaders rBody
@@ -272,57 +238,41 @@ reqToReflexRequest reqMeth reqHost req =
272238displayHttpRequest :: Text -> Text
273239displayHttpRequest httpmethod = "HTTP " <> httpmethod <> " request"
274240
275−-- | This function performs the request
241+-- | This function actually performs the request.
276242performRequests :: forall t m f tag.(SupportsServantReflex t m, Traversable f)
277243 => Text
278244 -> Dynamic t (f (Req t))
279245 -> Dynamic t BaseUrl
280− -> ClientOptions
281246 -> Event t tag
282247 -> m (Event t (tag, f (Either Text XhrResponse)))
283−performRequests reqMeth rs reqHost opts trigger = do
284− let xhrReqs =
285− join $ (\(fxhr :: f (Req t)) -> sequence $
286− reqToReflexRequest reqMeth reqHost <$> fxhr) <$> rs
287−
288− -- xhrReqs = fmap snd <$> xhrReqsAndDebugs
289− reqs = attachPromptlyDynWith
290− (\fxhr t -> Compose (t, fxhr)) xhrReqs trigger
291−
292− resps <- performSomeRequestsAsync opts reqs
248+performRequests reqMeth rs reqHost trigger = do
249+ -- let xhrReqs = sequence $ (\r -> reqToReflexRequest reqMeth r reqHost) <$> rs :: Dynamic t (f (Either Text (XhrRequest XhrPayload)))
250+ let xhrReqs = join $ (\(fxhr :: f (Req t)) -> sequence $ reqToReflexRequest reqMeth reqHost <$> fxhr) <$> rs
251+ let reqs = attachPromptlyDynWith (\fxhr t -> Compose (t, fxhr)) xhrReqs trigger
252+ resps <- performSomeRequestsAsync reqs
293253 return $ getCompose <$> resps
294254
295−-- | Issues a collection of requests when the supplied Event fires.
296−-- When ALL requests from a given firing complete, the results are
297−-- collected and returned via the return Event.
255+-- | Issues a collection of requests when the supplied Event fires. When ALL requests from a given firing complete, the results are collected and returned via the return Event.
298256performSomeRequestsAsync
299257 :: (MonadIO (Performable m),
300− MonadJSM (Performable m),
301−#if !MIN_VERSION_reflex_dom_core(0,7,0)
302258 HasWebView (Performable m),
303−#endif
304259 PerformEvent t m,
305260 TriggerEvent t m,
306261 Traversable f,
307− IsXhrPayload a,
308− Show a
309− )
310− => ClientOptions
311− -> Event t (f (Either Text (XhrRequest a)))
262+ IsXhrPayload a)
263+ => Event t (f (Either Text (XhrRequest a)))
312264 -> m (Event t (f (Either Text XhrResponse)))
313−performSomeRequestsAsync opts =
314− performSomeRequestsAsync' opts newXMLHttpRequest . fmap return
265+performSomeRequestsAsync = performSomeRequestsAsync' newXMLHttpRequest . fmap return
315266
316267
317268------------------------------------------------------------------------------
318269-- | A modified version or Reflex.Dom.Xhr.performRequestsAsync
319270-- that accepts 'f (Either e (XhrRequestb))' events
320271performSomeRequestsAsync'
321− :: (MonadJSM (Performable m), PerformEvent t m, TriggerEvent t m, Traversable f, Show b)
322− => ClientOptions
323− -> (XhrRequest b -> (a -> JSM ()) -> Performable m XMLHttpRequest)
272+ :: (MonadIO (Performable m), PerformEvent t m, TriggerEvent t m, Traversable f)
273+ => (XhrRequest b -> (a -> IO ()) -> Performable m XMLHttpRequest)
324274 -> Event t (Performable m (f (Either Text (XhrRequest b)))) -> m (Event t (f (Either Text a)))
325−performSomeRequestsAsync' opts newXhr req = performEventAsync $ ffor req $ \hrs cb -> do
275+performSomeRequestsAsync' newXhr req = performEventAsync $ ffor req $ \hrs cb -> do
326276 rs <- hrs
327277 resps <- forM rs $ \r -> case r of
328278 Left e -> do
@@ -330,17 +280,70 @@ performSomeRequestsAsync' opts newXhr req = performEventAsync $ ffor req $ \hrs
330280 return resp
331281 Right r' -> do
332282 resp <- liftIO newEmptyMVar
333− r'' <- liftJSM $ (optsRequestFixup opts) r'
334− _ <- newXhr r'' $ liftIO . putMVar resp . Right
283+ _ <- newXhr r' $ liftIO . putMVar resp . Right
335284 return resp
336285 _ <- liftIO $ forkIO $ cb =<< forM resps takeMVar
337286 return ()
338287
339288
340289
341−type XhrPayload = ByteString
290+-- | This function actually performs the request.
291+performRequest :: forall t m tag .(SupportsServantReflex t m)
292+ => Text
293+ -> (Req t)
294+ -> Dynamic t BaseUrl
295+ -> Event t tag
296+ -> m (Event t (tag, XhrResponse), Event t (tag, Text))
297+performRequest reqMeth req reqHost trigger = do
298+
299+ let xhrReq = reqToReflexRequest reqMeth reqHost req
300+ let reqs = attachPromptlyDynWith (flip (,)) xhrReq trigger
301+ okReqs = fmapMaybe (\(t,e) -> either (const Nothing) (Just . (t,)) e) reqs
302+ badReqs = fmapMaybe (\(t,e) -> either (Just . (t,)) (const Nothing) e) reqs
303+
304+ resps <- performRequestsAsync okReqs
305+
306+ return (resps, badReqs)
307+
308+
309+type XhrPayload = T.Text
342310bytesToPayload :: BL.ByteString -> XhrPayload
343−bytesToPayload = BL.toStrict
311+bytesToPayload = TE.decodeUtf8 . BL.toStrict
312+
313+
314+-- performRequestNoBody :: forall t m tag.(SupportsServantReflex t m)
315+-- => Text
316+-- -> Req t
317+-- -> Dynamic t BaseUrl
318+-- -> Event t tag -> m (Event t (ReqResult tag NoContent))
319+-- performRequestNoBody reqMeth req reqHost trigger = do
320+-- (resp, badReq) <- performRequest reqMeth req reqHost trigger
321+-- let decodeResp = const $ Right NoContent
322+-- return $ leftmost [ fmap (evalResponse decodeResp) resp
323+-- , fmap (uncurry RequestFailure) badReq
324+-- ]
325+
326+
327+-- performRequestCT
328+-- :: (SupportsServantReflex t m,
329+-- MimeUnrender ct a)
330+-- => Proxy ct
331+-- -> Text
332+-- -> Req t
333+-- -> Dynamic t BaseUrl
334+-- -> Event t tag
335+-- -> m (Event t (ReqResult tag a))
336+-- performRequestCT ct reqMeth req reqHost trigger = do
337+-- (resp, badReq) <- performRequest reqMeth req reqHost trigger
338+-- let decodeResp x = first T.pack .
339+-- mimeUnrender ct .
340+-- BL.fromStrict .
341+-- TE.encodeUtf8 =<< note "No body text"
342+-- (_xhrResponse_responseText x)
343+
344+-- return $ leftmost [fmap (evalResponse decodeResp) resp
345+-- , fmap (uncurry RequestFailure) badReq
346+-- ]
344347
345348
346349performRequestsCT
@@ -350,20 +353,19 @@ performRequestsCT
350353 -> Text
351354 -> Dynamic t (f (Req t))
352355 -> Dynamic t BaseUrl
353− -> ClientOptions
354356 -> Event t tag
355357 -> m (Event t (f (ReqResult tag a)))
356−performRequestsCT ct reqMeth reqs reqHost opts trigger = do
357− resps <- performRequests reqMeth reqs reqHost opts trigger
358− let decodeResp (Just (XhrResponseBody_ArrayBuffer x)) =
359− first T.pack .
360− mimeUnrender ct $
361− BL.fromStrict x
362− decodeResp _ = Left "No body"
358+performRequestsCT ct reqMeth reqs reqHost trigger = do
359+ resps <- performRequests reqMeth reqs reqHost trigger
360+ let decodeResp x = first T.pack .
361+ mimeUnrender ct .
362+ BL.fromStrict .
363+ TE.encodeUtf8 =<< note "No body text"
364+ (_xhrResponse_responseText x)
363365 return $ fmap
364366 (\(t,rs) -> ffor rs $ \r -> case r of
365367 Left e -> RequestFailure t e
366− Right g -> evalResponse (decodeResp . _xhrResponse_response) (t,g)
368+ Right g -> evalResponse decodeResp (t,g)
367369 )
368370 resps
369371
@@ -374,11 +376,10 @@ performRequestsNoBody
374376 => Text
375377 -> Dynamic t (f (Req t))
376378 -> Dynamic t BaseUrl
377− -> ClientOptions
378379 -> Event t tag
379380 -> m (Event t (f (ReqResult tag NoContent)))
380−performRequestsNoBody reqMeth reqs reqHost opts trigger = do
381− resps <- performRequests reqMeth reqs reqHost opts trigger
381+performRequestsNoBody reqMeth reqs reqHost trigger = do
382+ resps <- performRequests reqMeth reqs reqHost trigger
382383 let decodeResp = const $ Right NoContent
383384 return $ ffor resps $ \(tag,rs) -> ffor rs $ \r -> case r of
384385 Left e -> RequestFailure tag e
@@ -391,8 +392,7 @@ evalResponse
391392 -> (tag, XhrResponse)
392393 -> ReqResult tag a
393394evalResponse decode (tag, xhr) =
394− let status = _xhrResponse_status xhr
395− okStatus = status >= 200 && status < 400
395+ let okStatus = _xhrResponse_status xhr < 400
396396 errMsg = fromMaybe
397397 ("Empty response with error code " <>
398398 T.pack (show $ _xhrResponse_status xhr))
@@ -405,17 +405,7 @@ evalResponse decode (tag, xhr) =
405405 else ResponseFailure tag errMsg xhr
406406 in respPayld
407407
408−------------------------------------------------------------------------------
409−-- | Utility for simultaneously accessing/filtering Success and Failure
410−-- response 'Event's,
411−fanReqResult :: Reflex t => Event t (ReqResult tag a) -> (Event t Text, Event t a)
412−fanReqResult = fmapMaybe reqFailure &&& fmapMaybe reqSuccess
413408
414−------------------------------------------------------------------------------
415−-- | Utility for simultaneously accessing/filtering Success and Failure
416−-- response 'Event's, but keeping the request tag
417−fanReqResult' :: Reflex t => Event t (ReqResult tag a) -> (Event t (tag, Text), Event t (tag, a))
418−fanReqResult' = fmapMaybe reqFailure' &&& fmapMaybe reqSuccess'
419409
420410
421411note :: e -> Maybe a -> Either e a
@@ -424,9 +414,3 @@ note e = maybe (Left e) Right
424414fmapL :: (e -> e') -> Either e a -> Either e' a
425415fmapL _ (Right a) = Right a
426416fmapL f (Left e) = Left (f e)
427−
428−builderToText :: Builder.Builder -> T.Text
429−builderToText = TE.decodeUtf8 . BL.toStrict . Builder.toLazyByteString
430−
431−escape :: T.Text -> T.Text
432−escape = T.pack . N.escapeURIString (not . N.isReserved) . T.unpack . TE.decodeUtf8 . BL.toStrict . Builder.toLazyByteString . toEncodedUrlPiece
src/Servant/Reflex.hs+115−223
@@ -1,23 +1,17 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7−{-# LANGUAGE InstanceSigs #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE OverloadedStrings #-}
10−{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE Rank2Types #-}
12−{-# LANGUAGE ScopedTypeVariables #-}
13−{-# LANGUAGE TupleSections #-}
14−{-# LANGUAGE TypeFamilies #-}
15−{-# LANGUAGE TypeOperators #-}
16−{-# LANGUAGE UndecidableInstances #-}
17−
18−#if MIN_VERSION_base(4,9,0)
19−{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
20−#endif
1+{-# LANGUAGE AllowAmbiguousTypes #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE DataKinds #-}
4+{-# LANGUAGE FlexibleContexts #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE InstanceSigs #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE OverloadedStrings #-}
9+{-# LANGUAGE PolyKinds #-}
10+{-# LANGUAGE ScopedTypeVariables #-}
11+{-# LANGUAGE TupleSections #-}
12+{-# LANGUAGE TypeFamilies #-}
13+{-# LANGUAGE TypeOperators #-}
14+{-# LANGUAGE UndecidableInstances #-}
2115
2216-- #include "overlapping-compat.h"
2317-- | This module provides 'client' which can automatically generate
@@ -25,70 +19,55 @@
2519-- API.
2620module Servant.Reflex
2721 ( client
28− , clientWithOpts
29− , clientWithOptsAndResultHandler
30− , clientWithRoute
31− , clientWithRouteAndResultHandler
3222 , BuildHeaderKeysTo(..)
3323 , toHeaders
34− , HasClient
35− , Client
24+ , HasClient(..)
3625 , module Servant.Common.Req
3726 , module Servant.Common.BaseUrl
3827 ) where
3928
4029------------------------------------------------------------------------------
4130import Control.Applicative
42−import qualified Data.CaseInsensitive as CI
31+import Data.CaseInsensitive (mk)
4332import Data.Functor.Identity
44−import qualified Data.Map as Map
45−import Data.Monoid ((<>))
46−import Data.Proxy (Proxy (..))
47−import qualified Data.Set as Set
48−import Data.Text (Text)
49−import qualified Data.Text as T
50−import qualified Data.Text.Encoding as E
51−import GHC.Exts (Constraint)
52−import GHC.TypeLits (KnownSymbol, symbolVal)
53−import Servant.API ((:<|>) (..), (:>), BasicAuth,
54− BasicAuthData, BuildHeadersTo (..),
55− Capture, Header, Headers (..),
56− HttpVersion, IsSecure,
57− MimeRender (..), MimeUnrender,
58− NoContent, QueryFlag, QueryParam',
59− QueryParams, Raw, ReflectMethod (..),
60− RemoteHost, ReqBody,
61− ToHttpApiData (..), Vault, Verb,
62− contentType)
63−import Servant.API.Description (Summary)
64−import qualified Servant.Auth as Auth
65−
66−import Reflex.Dom.Core (Dynamic, Event, Reflex,
67− XhrRequest (..), XhrResponse (..),
68− XhrResponseHeaders (..),
69− attachPromptlyDynWith, constDyn, ffor,
70− fmapMaybe, leftmost,
71− performRequestsAsync)
33+import qualified Data.Map as Map
34+import Data.Monoid ((<>))
35+import Data.Proxy (Proxy (..))
36+import qualified Data.Set as Set
37+import Data.Text (Text)
38+import qualified Data.Text as T
39+import qualified Data.Text.Encoding as E
40+import GHC.TypeLits (KnownSymbol, symbolVal)
41+import Servant.API ((:<|>) (..), (:>), BasicAuth,
42+ BasicAuthData, BuildHeadersTo (..),
43+ Capture, Header, Headers (..),
44+ HttpVersion, IsSecure, MimeRender (..),
45+ MimeUnrender, NoContent, QueryFlag,
46+ QueryParam, QueryParams, Raw,
47+ ReflectMethod (..), RemoteHost,
48+ ReqBody, ToHttpApiData (..), Vault,
49+ Verb, contentType)
50+
51+import Reflex.Dom (Dynamic, Event, Reflex,
52+ XhrRequest (..), XhrResponse (..),
53+ XhrResponseHeaders (..),
54+ attachPromptlyDynWith, constDyn, ffor,
55+ fmapMaybe, leftmost,
56+ performRequestsAsync)
7257------------------------------------------------------------------------------
73−import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
74− showBaseUrl,
75− SupportsServantReflex)
76−import Servant.Common.Req (ClientOptions(..),
77− defaultClientOptions,
78− Req, ReqResult(..), QParam(..),
79− QueryPart(..), addHeader, authData,
80− defReq, evalResponse, prependToPathParts,
81− -- performRequestCT,
82− performRequestsCT,
83− -- performRequestNoBody,
84− performRequestsNoBody,
85− performSomeRequestsAsync,
86− qParamToQueryPart, reqBody,
87− reqSuccess, reqFailure,
88− reqMethod, respHeaders,
89− response,
90− reqTag,
91− qParams, withCredentials)
58+import Servant.Common.BaseUrl (BaseUrl (..), Scheme (..),
59+ SupportsServantReflex, baseUrlWidget,
60+ showBaseUrl)
61+import Servant.Common.Req (QParam (..), QueryPart (..), Req,
62+ ReqResult (..), addHeader, authData,
63+ defReq, evalResponse,
64+ performRequestsCT,
65+ performRequestsNoBody,
66+ performSomeRequestsAsync,
67+ prependToPathParts, qParamToQueryPart,
68+ qParams, reqBody, reqFailure,
69+ reqMethod, reqSuccess, reqTag,
70+ respHeaders, response)
9271
9372
9473-- * Accessing APIs as a Client
@@ -103,75 +82,28 @@ import Servant.Common.Req (ClientOptions(..),
10382-- >
10483-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
10584-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
106−-- > -> m (Event t (l, ReqResult Book)))
85+-- -> m (Event t (l, ReqResult Book)))
10786-- > (getAllBooks :<|> postNewBook) = client myApi host
10887-- > 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
88+client :: (HasClient t m layout tag)
89+ => Proxy layout -> Proxy m -> Proxy tag -> Dynamic t BaseUrl -> Client t m layout tag
90+client p q t = clientWithRoute p q t defReq
14191
14292
14393-- | This class lets us define how each API combinator
14494-- influences the creation of an HTTP request. It's mostly
14595-- an internal class, you can just use 'client'.
146−class Monad m => HasClient t m layout (tag :: *) where
96+class HasClient t m layout (tag :: *) where
14797 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
98+ clientWithRoute :: Proxy layout -> Proxy m -> Proxy tag -> Req t -> Dynamic t BaseUrl -> Client t m layout tag
16799
168100
169101instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
170102 type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
171103
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
104+ clientWithRoute Proxy q pTag req baseurl =
105+ clientWithRoute (Proxy :: Proxy a) q pTag req baseurl :<|>
106+ clientWithRoute (Proxy :: Proxy b) q pTag req baseurl
175107
176108
177109-- Capture. Example:
@@ -192,10 +124,12 @@ instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout ta
192124 type Client t m (Capture capture a :> sublayout) tag =
193125 Dynamic t (Either Text a) -> Client t m sublayout tag
194126
195− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196− clientWithRouteAndResultHandler
197− (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
198− where p = (fmap . fmap) (toUrlPiece) val
127+ clientWithRoute Proxy q t req baseurl val =
128+ clientWithRoute (Proxy :: Proxy sublayout)
129+ q t
130+ (prependToPathParts p req)
131+ baseurl
132+ where p = (fmap . fmap) toUrlPiece val
199133
200134
201135-- VERB (Returning content) --
@@ -207,8 +141,9 @@ instance {-# OVERLAPPABLE #-}
207141 Event t tag -> m (Event t (ReqResult tag a))
208142 -- TODO how to access input types here?
209143 -- 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
144+ clientWithRoute Proxy _ _ req baseurl trigs =
145+ -- performRequestCT (Proxy :: Proxy ct) method req' baseurl trigs
146+ fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl trigs
212147 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
213148 req' = req { reqMethod = method }
214149
@@ -221,33 +156,29 @@ instance {-# OVERLAPPING #-}
221156 Event t tag -> m (Event t (ReqResult tag NoContent))
222157 -- TODO: how to access input types here?
223158 -- ExceptT ServantError IO NoContent
224− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225− wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
159+ clientWithRoute Proxy _ _ req baseurl =
160+ (fmap . fmap) runIdentity . performRequestsNoBody method (constDyn $ Identity req) baseurl
226161 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
227162
228163
229164toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
230165toHeaders r =
231− let hdrs = maybe []
232− (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
166+ let toBS = E.encodeUtf8
167+ hdrs = maybe []
168+ (\xhr -> fmap (\(h,v) -> (mk (toBS h), toBS v))
233169 (Map.toList $ _xhrResponse_headers xhr))
234170 (response r)
235171 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
236172
237−
238173class BuildHeaderKeysTo hs where
239− buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
174+ buildHeaderKeysTo :: Proxy hs -> [T.Text]
240175
241176instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242177 where buildHeaderKeysTo _ = []
243178
244179instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
245180 => 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−
181+ buildHeaderKeysTo _ = T.pack (symbolVal (Proxy :: Proxy h)) : buildHeaderKeysTo (Proxy :: Proxy xs)
251182
252183-- HEADERS Verb (Content) --
253184-- Headers combinator not treated in fully general case,
@@ -262,10 +193,10 @@ instance {-# OVERLAPPABLE #-}
262193 ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
263194 type Client t m (Verb method status cts' (Headers ls a)) tag =
264195 Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
265− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
196+ clientWithRoute Proxy _ _ req baseurl trigs = do
266197 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
198+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl trigs
199+ return $ toHeaders <$> resp
269200 where req' = req { respHeaders =
270201 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
271202 }
@@ -278,10 +209,10 @@ instance {-# OVERLAPPABLE #-}
278209 ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
279210 type Client t m (Verb method status cts (Headers ls NoContent)) tag
280211 = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
281− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
212+ clientWithRoute Proxy _ _ req baseurl trigs = do
282213 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
283− resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284− wrap $ toHeaders <$> resp
214+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl trigs
215+ return $ toHeaders <$> resp
285216 where req' = req {respHeaders =
286217 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
287218 }
@@ -308,11 +239,11 @@ instance (KnownSymbol sym, ToHttpApiData a,
308239 type Client t m (Header sym a :> sublayout) tag =
309240 Dynamic t (Either Text a) -> Client t m sublayout tag
310241
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
242+ clientWithRoute Proxy q t req baseurl eVal =
243+ clientWithRoute (Proxy :: Proxy sublayout)
244+ q t
245+ (Servant.Common.Req.addHeader hname eVal req)
246+ baseurl
316247 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
317248
318249
@@ -326,21 +257,8 @@ instance HasClient t m sublayout tag
326257 type Client t m (HttpVersion :> sublayout) tag =
327258 Client t m sublayout tag
328259
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−
260+ clientWithRoute Proxy =
261+ clientWithRoute (Proxy :: Proxy sublayout)
344262
345263
346264-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -370,15 +288,15 @@ instance (HasClient t m sublayout tag, KnownSymbol sym)
370288-- > -- 'getBooksBy Nothing' for all books
371289-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
372290instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
373− => HasClient t m (QueryParam' mods sym a :> sublayout) tag where
291+ => HasClient t m (QueryParam sym a :> sublayout) tag where
374292
375− type Client t m (QueryParam' mods sym a :> sublayout) tag =
293+ type Client t m (QueryParam sym a :> sublayout) tag =
376294 Dynamic t (QParam a) -> Client t m sublayout tag
377295
378296 -- 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
297+ clientWithRoute Proxy q t req baseurl mparam =
298+ clientWithRoute (Proxy :: Proxy sublayout) q t
299+ (req {qParams = paramPair : qParams req}) baseurl
382300
383301 where pname = symbolVal (Proxy :: Proxy sym)
384302 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -422,8 +340,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
422340 type Client t m (QueryParams sym a :> sublayout) tag =
423341 Dynamic t [a] -> Client t m sublayout tag
424342
425− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
343+ clientWithRoute Proxy q t req baseurl paramlist =
344+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
427345
428346 where req' = req { qParams = (T.pack pname, params') : qParams req }
429347 pname = symbolVal (Proxy :: Proxy sym)
@@ -462,8 +380,8 @@ instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
462380 type Client t m (QueryFlag sym :> sublayout) tag =
463381 Dynamic t Bool -> Client t m sublayout tag
464382
465− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
383+ clientWithRoute Proxy q t req baseurl flag =
384+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
467385
468386 where req' = req { qParams = thisPair : qParams req }
469387 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
@@ -477,7 +395,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
477395 -> Event t tag
478396 -> m (Event t (ReqResult tag ()))
479397
480− clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
398+ clientWithRoute _ _ _ _ baseurl xhrs triggers = do
481399
482400 let xhrs' = liftA2 (\x path -> case x of
483401 Left e -> Left e
@@ -488,7 +406,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
488406 okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
489407
490408 resps <- performRequestsAsync okReq
491− wrap $ leftmost [ uncurry RequestFailure <$> badReq
409+ return $ leftmost [ uncurry RequestFailure <$> badReq
492410 , evalResponse (const $ Right ()) <$> resps
493411 ]
494412
@@ -519,8 +437,8 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
519437 type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520438 Dynamic t (Either Text a) -> Client t m sublayout tag
521439
522− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
440+ clientWithRoute Proxy q t req baseurl body =
441+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
524442 where req' = req { reqBody = bodyBytesCT }
525443 ctProxy = Proxy :: Proxy ct
526444 ctString = T.pack $ show $ contentType ctProxy
@@ -534,9 +452,9 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
534452instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
535453 type Client t m (path :> sublayout) tag = Client t m sublayout tag
536454
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
455+ clientWithRoute Proxy q t req =
456+ clientWithRoute (Proxy :: Proxy sublayout) q t
457+ (prependToPathParts (pure (Right $ T.pack p)) req)
540458
541459 where p = symbolVal (Proxy :: Proxy path)
542460
@@ -544,23 +462,23 @@ instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient
544462instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
545463 type Client t m (Vault :> api) tag = Client t m api tag
546464
547− clientWithRouteAndResultHandler Proxy =
548− clientWithRouteAndResultHandler (Proxy :: Proxy api)
465+ clientWithRoute Proxy =
466+ clientWithRoute (Proxy :: Proxy api)
549467
550468
551469instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
552470 type Client t m (RemoteHost :> api) tag = Client t m api tag
553471
554− clientWithRouteAndResultHandler Proxy =
555− clientWithRouteAndResultHandler (Proxy :: Proxy api)
472+ clientWithRoute Proxy =
473+ clientWithRoute (Proxy :: Proxy api)
556474
557475
558476
559477instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
560478 type Client t m (IsSecure :> api) tag = Client t m api tag
561479
562− clientWithRouteAndResultHandler Proxy =
563− clientWithRouteAndResultHandler (Proxy :: Proxy api)
480+ clientWithRoute Proxy =
481+ clientWithRoute (Proxy :: Proxy api)
564482
565483
566484instance (HasClient t m api tag, Reflex t)
@@ -569,8 +487,8 @@ instance (HasClient t m api tag, Reflex t)
569487 type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570488 -> Client t m api tag
571489
572− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
573− clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
490+ clientWithRoute Proxy q t req baseurl authdata =
491+ clientWithRoute (Proxy :: Proxy api) q t req' baseurl
574492 where
575493 req' = req { authData = Just authdata }
576494
@@ -596,29 +514,3 @@ non-empty lists, but is otherwise more specific, no instance will be overall
596514more specific. This in turn generally means adding yet another instance (one
597515for empty and one for non-empty lists).
598516-}
599−
600−
601−-- SUPPORT FOR servant-auth --
602−
603−-- For JavaScript clients we should be sending/storing JSON web tokens in a
604−-- way that is inaccessible to JavaScript.
605−--
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
609−-- directly.
610−
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
614−
615− type Client t m (Auth.Auth auths a :> api) tag = Client t m api tag
616− clientWithRouteAndResultHandler Proxy = clientWithRouteAndResultHandler (Proxy :: Proxy api)
617−
618−
619−type family HasCookieAuth xs :: Constraint where
620− HasCookieAuth (Auth.Cookie ': xs) = ()
621− HasCookieAuth (x ': xs) = HasCookieAuth xs
622− HasCookieAuth '[] = CookieAuthNotEnabled
623−
624−class CookieAuthNotEnabled
src/Servant/Reflex/Multi.hs+53−82
@@ -16,15 +16,12 @@
1616module Servant.Reflex.Multi (
1717 -- * Compute servant client functions
1818 clientA
19− , clientWithOptsA
2019 , BaseUrl(..)
2120 , Scheme(..)
2221
2322 -- * Build QueryParam arguments
2423 , QParam(..)
2524
26− -- * Access response data
27− , withCredentials
2825
2926 -- * Access response data
3027 , ReqResult(..)
@@ -37,45 +34,40 @@ module Servant.Reflex.Multi (
3734 ) where
3835
3936------------------------------------------------------------------------------
40−import Control.Applicative (liftA2)
41−import Data.Functor.Compose (Compose (..), getCompose)
42−import Data.Proxy (Proxy (..))
43−import qualified Data.Set as Set
44−import Data.Text (Text)
45−import qualified Data.Text as T
46−import qualified Data.Text.Encoding as E
47−import GHC.TypeLits (KnownSymbol, symbolVal)
48−import Servant.API ((:<|>) (..), (:>), BasicAuth,
49− BasicAuthData, BuildHeadersTo (..),
50− Capture, Header, Headers (..),
51− HttpVersion, IsSecure,
52− MimeRender (..), MimeUnrender,
53− NoContent, QueryFlag, QueryParam,
54− QueryParams, Raw, ReflectMethod (..),
55− RemoteHost, ReqBody,
56− ToHttpApiData (..), Vault, Verb,
57− contentType)
58−import Servant.API.Description (Summary)
59−
60−import Reflex.Dom.Core (Dynamic, Event, Reflex,
61− XhrRequest (..),
62− XhrResponseHeaders (..),
63− attachPromptlyDynWith, constDyn)
37+import Control.Applicative (liftA2)
38+import Data.Functor.Compose (Compose (..), getCompose)
39+import Data.Proxy (Proxy (..))
40+import qualified Data.Set as Set
41+import Data.Text (Text)
42+import qualified Data.Text as T
43+import qualified Data.Text.Encoding as E
44+import GHC.TypeLits (KnownSymbol, symbolVal)
45+import Servant.API ((:<|>) (..), (:>), BasicAuth,
46+ BasicAuthData, BuildHeadersTo (..),
47+ Capture, Header, Headers (..),
48+ HttpVersion, IsSecure, MimeRender (..),
49+ MimeUnrender, NoContent, QueryFlag,
50+ QueryParam, QueryParams, Raw,
51+ ReflectMethod (..), RemoteHost,
52+ ReqBody, ToHttpApiData (..), Vault,
53+ Verb, contentType)
54+
55+import Reflex.Dom (Dynamic, Event, Reflex,
56+ XhrRequest (..),
57+ XhrResponseHeaders (..),
58+ attachPromptlyDynWith, constDyn)
6459------------------------------------------------------------------------------
6560import Servant.Common.BaseUrl (BaseUrl (..), Scheme (..),
6661 SupportsServantReflex)
67−import Servant.Common.Req (ClientOptions,
68− QParam (..), QueryPart (..), Req,
62+import Servant.Common.Req (QParam (..), QueryPart (..), Req,
6963 ReqResult (..), addHeader, authData,
70− defReq,
71− defaultClientOptions,
72− performRequestsCT,
64+ defReq, performRequestsCT,
7365 performRequestsNoBody,
7466 performSomeRequestsAsync,
7567 prependToPathParts, qParamToQueryPart,
7668 qParams, reqBody, reqFailure,
7769 reqMethod, reqSuccess, reqSuccess',
78− respHeaders, response, withCredentials)
70+ respHeaders, response)
7971import Servant.Reflex (BuildHeaderKeysTo (..), toHeaders)
8072
8173
@@ -85,24 +77,14 @@ clientA :: (HasClientMulti t m layout f tag, Applicative f, Reflex t)
8577 -> Dynamic t BaseUrl -> ClientMulti t m layout f tag
8678clientA p q f tag baseurl =
8779 clientWithRouteMulti p q f tag (constDyn (pure defReq)) baseurl
88− defaultClientOptions
89−
9080
91−-- | A version of @client@ that sets the withCredentials flag
92−-- on requests. Use this function for clients of CORS API's
93−clientWithOptsA :: (HasClientMulti t m layout f tag, Applicative f, Reflex t)
94− => Proxy layout -> Proxy m -> Proxy f -> Proxy tag
95− -> Dynamic t BaseUrl -> ClientOptions -> ClientMulti t m layout f tag
96−clientWithOptsA p q f tag baseurl opts =
97− clientWithRouteMulti p q f tag
98− (constDyn (pure defReq)) baseurl opts
9981
10082------------------------------------------------------------------------------
10183class HasClientMulti t m layout f (tag :: *) where
10284 type ClientMulti t m layout f tag :: *
10385 clientWithRouteMulti :: Proxy layout -> Proxy m -> Proxy f -> Proxy tag
10486 -> Dynamic t (f (Req t)) -> Dynamic t BaseUrl
105− -> ClientOptions -> ClientMulti t m layout f tag
87+ -> ClientMulti t m layout f tag
10688
10789
10890------------------------------------------------------------------------------
@@ -110,9 +92,9 @@ instance (HasClientMulti t m a f tag, HasClientMulti t m b f tag) =>
11092 HasClientMulti t m (a :<|> b) f tag where
11193 type ClientMulti t m (a :<|> b) f tag = ClientMulti t m a f tag :<|>
11294 ClientMulti t m b f tag
113− clientWithRouteMulti Proxy q f tag reqs baseurl opts =
114− clientWithRouteMulti (Proxy :: Proxy a) q f tag reqs baseurl opts :<|>
115− clientWithRouteMulti (Proxy :: Proxy b) q f tag reqs baseurl opts
95+ clientWithRouteMulti Proxy q f tag reqs baseurl =
96+ clientWithRouteMulti (Proxy :: Proxy a) q f tag reqs baseurl :<|>
97+ clientWithRouteMulti (Proxy :: Proxy b) q f tag reqs baseurl
11698
11799
118100------------------------------------------------------------------------------
@@ -125,8 +107,8 @@ instance (SupportsServantReflex t m,
125107 type ClientMulti t m (Capture capture a :> sublayout) f tag =
126108 f (Dynamic t (Either Text a)) -> ClientMulti t m sublayout f tag
127109
128− clientWithRouteMulti _ q f tag reqs baseurl opts vals =
129− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag reqs' baseurl opts
110+ clientWithRouteMulti _ q f tag reqs baseurl vals =
111+ clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag reqs' baseurl
130112 where
131113 reqs' = (prependToPathParts <$> ps <*>) <$> reqs
132114 ps = (fmap . fmap . fmap) toUrlPiece vals
@@ -146,8 +128,8 @@ instance {-# OVERLAPPABLE #-}
146128 type ClientMulti t m (Verb method status cts' a) f tag =
147129 Event t tag -> m (Event t (f (ReqResult tag a)))
148130
149− clientWithRouteMulti _ _ _ _ reqs baseurl opts =
150− performRequestsCT (Proxy :: Proxy ct) method reqs' baseurl opts
131+ clientWithRouteMulti _ _ _ _ reqs baseurl =
132+ performRequestsCT (Proxy :: Proxy ct) method reqs' baseurl
151133 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
152134 reqs' = fmap (\r -> r { reqMethod = method }) <$> reqs
153135
@@ -161,8 +143,8 @@ instance {-# OVERLAPPING #-}
161143 Event t tag -> m (Event t (f (ReqResult tag NoContent)))
162144 -- TODO: how to access input types here?
163145 -- ExceptT ServantError IO NoContent
164− clientWithRouteMulti Proxy _ _ _ req baseurl opts =
165− performRequestsNoBody method req baseurl opts
146+ clientWithRouteMulti Proxy _ _ _ req baseurl =
147+ performRequestsNoBody method req baseurl
166148 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
167149
168150
@@ -176,9 +158,9 @@ instance {-# OVERLAPPABLE #-}
176158 ) => HasClientMulti t m (Verb method status cts' (Headers ls a)) f tag where
177159 type ClientMulti t m (Verb method status cts' (Headers ls a)) f tag =
178160 Event t tag -> m (Event t (f (ReqResult tag (Headers ls a))))
179− clientWithRouteMulti Proxy _ _ _ reqs baseurl opts triggers = do
161+ clientWithRouteMulti Proxy _ _ _ reqs baseurl triggers = do
180162 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
181− resp <- performRequestsCT (Proxy :: Proxy ct) method reqs' baseurl opts triggers :: m (Event t (f (ReqResult tag a)))
163+ resp <- performRequestsCT (Proxy :: Proxy ct) method reqs' baseurl triggers :: m (Event t (f (ReqResult tag a)))
182164 return $ fmap toHeaders <$> resp
183165 where
184166 reqs' = fmap (\r ->
@@ -199,9 +181,9 @@ instance {-# OVERLAPPABLE #-}
199181 cts (Headers ls NoContent)) f tag where
200182 type ClientMulti t m (Verb method status cts (Headers ls NoContent)) f tag
201183 = Event t tag -> m (Event t (f (ReqResult tag (Headers ls NoContent))))
202− clientWithRouteMulti Proxy _ _ _ reqs baseurl opts triggers = do
184+ clientWithRouteMulti Proxy _ _ _ reqs baseurl triggers = do
203185 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
204− resp <- performRequestsNoBody method reqs' baseurl opts triggers
186+ resp <- performRequestsNoBody method reqs' baseurl triggers
205187 return $ fmap toHeaders <$> resp
206188 where reqs' = fmap (\req ->
207189 req {respHeaders = OnlyHeaders (Set.fromList
@@ -221,11 +203,11 @@ instance (KnownSymbol sym,
221203 type ClientMulti t m (Header sym a :> sublayout) f tag =
222204 f (Dynamic t (Either Text a)) -> ClientMulti t m sublayout f tag
223205
224− clientWithRouteMulti Proxy f q tag reqs baseurl opts eVals =
206+ clientWithRouteMulti Proxy f q tag reqs baseurl eVals =
225207 clientWithRouteMulti (Proxy :: Proxy sublayout) f
226208 q tag
227209 reqs'
228− baseurl opts
210+ baseurl
229211 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
230212 reqs' = ((\eVal req -> Servant.Common.Req.addHeader hname eVal req)
231213 <$> eVals <*>) <$> reqs
@@ -242,17 +224,6 @@ instance HasClientMulti t m sublayout f tag
242224 clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag
243225
244226
245−------------------------------------------------------------------------------
246−instance (HasClientMulti t m sublayout f tag, KnownSymbol sym)
247− => HasClientMulti t m (Summary sym :> sublayout) f tag where
248−
249− type ClientMulti t m (Summary sym :> sublayout) f tag =
250− ClientMulti t m sublayout f tag
251−
252− clientWithRouteMulti Proxy q f tag =
253− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag
254−
255−
256227------------------------------------------------------------------------------
257228instance (KnownSymbol sym,
258229 ToHttpApiData a,
@@ -266,9 +237,9 @@ instance (KnownSymbol sym,
266237
267238 -- if mparam = Nothing, we don't add it to the query string
268239 -- TODO: Check the above comment
269− clientWithRouteMulti Proxy q f tag reqs baseurl opts mparams =
240+ clientWithRouteMulti Proxy q f tag reqs baseurl mparams =
270241 clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag
271− reqs' baseurl opts
242+ reqs' baseurl
272243
273244 where pname = symbolVal (Proxy :: Proxy sym)
274245 p prm = QueryPartParam $ fmap qParamToQueryPart prm
@@ -289,8 +260,8 @@ instance (KnownSymbol sym,
289260 type ClientMulti t m (QueryParams sym a :> sublayout) f tag =
290261 Dynamic t (f [a]) -> ClientMulti t m sublayout f tag
291262
292− clientWithRouteMulti Proxy q f tag reqs baseurl opts paramlists =
293− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag reqs' baseurl opts
263+ clientWithRouteMulti Proxy q f tag reqs baseurl paramlists =
264+ clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag reqs' baseurl
294265
295266 where req' l r = r { qParams = (T.pack pname, params' (constDyn l)) : qParams r }
296267 pname = symbolVal (Proxy :: Proxy sym)
@@ -308,8 +279,8 @@ instance (KnownSymbol sym,
308279 type ClientMulti t m (QueryFlag sym :> sublayout) f tag =
309280 Dynamic t (f Bool) -> ClientMulti t m sublayout f tag
310281
311− clientWithRouteMulti Proxy q f' tag reqs baseurl opts flags =
312− clientWithRouteMulti (Proxy :: Proxy sublayout) q f' tag reqs' baseurl opts
282+ clientWithRouteMulti Proxy q f' tag reqs baseurl flags =
283+ clientWithRouteMulti (Proxy :: Proxy sublayout) q f' tag reqs' baseurl
313284
314285 where req' f req = req { qParams = thisPair (constDyn f) : qParams req }
315286 thisPair f = (T.pack pName, QueryPartFlag f) :: (Text, QueryPart t)
@@ -323,10 +294,10 @@ instance (SupportsServantReflex t m,
323294 -> Event t tag
324295 -> m (Event t (f (ReqResult tag ())))
325296
326− clientWithRouteMulti _ _ _ _ _ _ opts rawReqs triggers = do
297+ clientWithRouteMulti _ _ _ _ _ _ rawReqs triggers = do
327298 let rawReqs' = sequence rawReqs :: Dynamic t (f (Either Text (XhrRequest ())))
328299 rawReqs'' = attachPromptlyDynWith (\fxhr t -> Compose (t, fxhr)) rawReqs' triggers
329− resps <- fmap (fmap aux . sequenceA . getCompose) <$> performSomeRequestsAsync opts rawReqs''
300+ resps <- fmap (fmap aux . sequenceA . getCompose) <$> performSomeRequestsAsync rawReqs''
330301 return resps
331302 where
332303 aux (tag, Right r) = ResponseSuccess tag () r
@@ -342,8 +313,8 @@ instance (MimeRender ct a,
342313 type ClientMulti t m (ReqBody (ct ': cts) a :> sublayout) f tag =
343314 Dynamic t (f (Either Text a)) -> ClientMulti t m sublayout f tag
344315
345− clientWithRouteMulti Proxy q f tag reqs baseurl opts bodies =
346− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag reqs' baseurl opts
316+ clientWithRouteMulti Proxy q f tag reqs baseurl bodies =
317+ clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag reqs' baseurl
347318 where req' b r = r { reqBody = bodyBytesCT (constDyn b) }
348319 ctProxy = Proxy :: Proxy ct
349320 ctString = T.pack $ show $ contentType ctProxy
@@ -394,8 +365,8 @@ instance (HasClientMulti t m api f tag, Reflex t, Applicative f)
394365 type ClientMulti t m (BasicAuth realm usr :> api) f tag = Dynamic t (f (Maybe BasicAuthData))
395366 -> ClientMulti t m api f tag
396367
397− clientWithRouteMulti Proxy q f tag reqs baseurl opts authdatas =
398− clientWithRouteMulti (Proxy :: Proxy api) q f tag reqs' baseurl opts
368+ clientWithRouteMulti Proxy q f tag reqs baseurl authdatas =
369+ clientWithRouteMulti (Proxy :: Proxy api) q f tag reqs' baseurl
399370 where
400371 req' a r = r { authData = Just (constDyn a) }
401372 reqs' = liftA2 req' <$> authdatas <*> reqs
testdriver/test/Servant/ReflexSpec.hs+1−2
@@ -9,7 +9,6 @@ import qualified Data.Text as T
99import Data.Foldable
1010import Test.WebDriver.Commands.Wait
1111import Test.Hspec.WebDriver
12−import Test.Hspec.WebDriver (chromeCaps)
1312
1413
1514clickingShouldCause :: Selector -> Selector -> Double -> (Element -> Element -> WD Bool) -> WD ()
@@ -29,7 +28,7 @@ spec :: Spec
2928spec = do
3029 describe "servant-reflex tests" $ do
3130
32− session "test page" $ using [chromeCaps] $ do
31+ session "test page" $ using Chrome $ do
3332
3433 it "opens the page" $ runWD $
3534 openPage "http://localhost:8000"
testserver/API.hsmode 100644 → 120000+1−69
@@ -1,69 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE TypeOperators #-}
4−
5−module API where
6−
7−import Data.Aeson
8−import Data.Aeson.Types (typeMismatch)
9−import Data.Text (Text)
10−import Servant.API
11−
12−newtype Question = Question { unQuestion :: Text } deriving (Show)
13−
14−instance ToJSON Question where
15− toJSON (Question txt) = object ["question" .= txt]
16−
17−instance FromJSON Question where
18− parseJSON (Object v) = Question <$> v .: "question"
19− parseJSON x = typeMismatch "Couldn't find key 'question'" x
20−
21−newtype Answer = Answer { unAnswer :: Text } deriving (Show)
22−
23−instance ToJSON Answer where
24− toJSON (Answer txt) = object ["answer" .= txt]
25−
26−instance FromJSON Answer where
27− parseJSON (Object v) = Answer <$> v .: "answer"
28− parseJSON x = typeMismatch "Couldn't find key 'answer'" x
29−
30−
31−-- | API spec for server, client, and docs
32−type API = "getunit" :> Get '[JSON] ()
33− :<|> "getint" :> Get '[JSON] Int
34− :<|> "sayhi" :> QueryParam "username" Text
35− :> QueryParams "greetings" Text
36− :> QueryFlag "gusto"
37− :> Get '[JSON] Text
38− :<|> "double" :> ReqBody '[JSON] Double
39− :> Post '[JSON] Double
40− :<|> "a" :> "b" :> QueryFlag "gusto" :> Get '[JSON] Text
41− :<|> "qna" :> ReqBody '[JSON] Question
42− :> Post '[JSON] Answer
43− :<|> "secret" :> BasicAuth "realm" () :> Get '[JSON] Int
44− :<|> Raw
45−
46−type GET = Get '[JSON] ()
47−
48−-- Imported the comprehensive API example for testing.
49−-- https://github.com/haskell-servant/servant/blob/master/servant/src/Servant/API/Internal/Test/ComprehensiveAPI.hs
50−type ComprehensiveAPI =
51− GET :<|>
52− Get '[JSON] Int :<|>
53− Capture "foo" Int :> GET :<|>
54− Header "foo" Int :> GET :<|>
55− HttpVersion :> GET :<|>
56− IsSecure :> GET :<|>
57− QueryParam "foo" Int :> GET :<|>
58− QueryParams "foo" Int :> GET :<|>
59− QueryFlag "foo" :> GET :<|>
60−-- Raw :<|>
61− RemoteHost :> GET :<|>
62− ReqBody '[JSON] Int :> GET :<|>
63− Get '[JSON] (Headers '[Header "foo" Int] ()) :<|>
64− "foo" :> GET :<|>
65− Vault :> GET :<|>
66− Verb 'POST 204 '[JSON] () :<|>
67− Verb 'POST 204 '[JSON] Int
68−-- This one isn't in scope
69−-- :<|> WithNamedContext "foo" '[] GET
@@ -0,0 +1 @@
1+../exec/API.hs
testserver/Main.hs+5−20
@@ -2,17 +2,14 @@
22{-# LANGUAGE DeriveGeneric #-}
33{-# LANGUAGE OverloadedStrings #-}
44{-# LANGUAGE PolyKinds #-}
5−{-# LANGUAGE TypeApplications #-}
65{-# LANGUAGE TypeFamilies #-}
76{-# LANGUAGE TypeOperators #-}
87
98import Control.Monad.IO.Class (liftIO)
10−import Control.Monad.Reader (reader)
119import Data.Aeson
1210import Data.Bool
1311import Data.Char (toUpper)
1412import qualified Data.List as L
15−import Data.Maybe (fromMaybe)
1613import Data.Monoid
1714import Data.Proxy
1815import Data.Text hiding (head, length, map,
@@ -27,7 +24,6 @@ import Snap.Http.Server
2724import Servant
2825import Servant.Server
2926-- import Snap.Util.FileServe
30−import System.Environment (lookupEnv)
3127import API
3228import Snap
3329
@@ -43,7 +39,7 @@ instance ToJSON Greet
4339testApi :: Proxy API
4440testApi = Proxy
4541
46−data App = App { appStaticDir :: String }
42+data App = App
4743
4844-- Server-side handlers.
4945--
@@ -51,10 +47,8 @@ data App = App { appStaticDir :: String }
5147-- that represents the API, are glued together using :<|>.
5248--
5349-- Each handler runs in the 'ExceptT ServantErr IO' monad.
54−server :: Server API '[BasicAuthCheck (Handler App App) ()] (Handler App App)
55−server = return () :<|> return 100 :<|> sayhi :<|> dbl
56− :<|> multi :<|> qna :<|> serveSecret
57− :<|> statics
50+server :: Server API (Handler App App)
51+server = return () :<|> return 100 :<|> sayhi :<|> dbl :<|> multi :<|> qna :<|> serveDirectory "static"
5852 where sayhi :: Maybe Text -> [Text] -> Bool -> Handler App App Text
5953 sayhi nm greetings withGusto = case nm of
6054 Nothing -> return ("Sorry, who are you?" :: Text)
@@ -75,27 +69,18 @@ server = return () :<|> return 100 :<|> sayhi :<|> dbl
7569 putStrLn $ "qna got: " ++ show q
7670 T.putStrLn $ unQuestion q
7771 return $ Answer $ unQuestion q
78− serveSecret _ = do
79− req <- getRequest
80− liftIO $ putStrLn (show req)
81− return 101
82− statics = do
83− staticDir <- reader appStaticDir
84− serveDirectory staticDir
8572
8673-- Turn the server into a WAI app. 'serve' is provided by servant,
8774-- more precisely by the Servant.Server module.
8875test :: Handler App App ()
89−test = serveSnapWithContext testApi
90− (BasicAuthCheck (\_ -> return @(Handler App App) (Authorized ())) :. EmptyContext) server
76+test = serveSnap testApi server
9177
9278initApp :: SnapletInit App App
9379initApp = makeSnaplet "myapp" "example" Nothing $ do
94− staticDir <- fromMaybe "static" <$> liftIO (lookupEnv "STATIC_DIR")
9580 addRoutes [("", test)
9681 ,("", serveDirectory "static")
9782 ]
98− return (App staticDir)
83+ return App
9984
10085-- Put this all to work!
10186main :: IO ()
testserver/run-wd-tests.shnew file+5
@@ -0,0 +1,5 @@
1+#!/usr/bin/env bash
2+
3+dist/build/back/back -p 8000 &
4+phantomjs --webdriver=127.0.0.1:4444 &
5+dist/build/spec/spec
testserver/testserver.cabal+7−8
@@ -19,14 +19,13 @@ executable back
1919 main-is: Main.hs
2020 -- other-modules:
2121 -- other-extensions:
22− build-depends: aeson >= 0.9 && < 1.5
23− , base >=4.8 && < 5
24− , mtl
25− , snap >= 1.0 && < 1.2
26− , snap-server >= 1.0 && < 1.2
22+ build-depends: aeson >= 0.9 && < 1.1
23+ , base >=4.8 && <4.10
24+ , snap >= 1.0 && < 1.1
25+ , snap-server >= 1.0 && < 1.1
2726 , snap-core >= 1.0 && < 1.1
28− , servant >= 0.16 && < 0.18
29− , servant-snap >= 0.8 && < 0.9
30− , text >= 1.0 && < 1.3
27+ , servant >= 0.8 && < 0.11
28+ , servant-snap >= 0.7.2 && < 0.8
29+ , text >= 1.2 && < 1.3
3130 -- hs-source-dirs:
3231 default-language: Haskell2010
testserver/tr.nixnew file+32
@@ -0,0 +1,32 @@
1+{ reflex-platform, ... }:
2+let
3+
4+ dontCheck = (import <nixpkgs> {}).pkgs.haskell.lib.dontCheck;
5+ cabal2nixResult = reflex-platform.cabal2nixResult;
6+ nixpkgs = (import <nixpkgs> {});
7+in
8+reflex-platform.ghc.override {
9+ overrides = self: super: {
10+ servant-snap = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap) {});
11+ snap = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap) {});
12+ io-streams = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/io-streams) {});
13+ io-streams-haproxy = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/io-streams-haproxy) {});
14+ heist = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/heist) {});
15+ xmlhtml = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/xmlhtml) {});
16+ snap-core = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/snap-core) {});
17+ snap-server = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/snap-server) {});
18+ snap-loader-static = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap-loader-static) {});
19+ snap-loader-dynamic = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap-loader-dynamic) {});
20+ hspec-snap = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/hspec-snap) {});
21+
22+ # servant-foreign = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-foreign) {});
23+ # servant-js = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-js) {});
24+ # servant-docs = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-docs) {});
25+ # servant-client = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-client) {});
26+ # servant-blaze = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-blaze) {});
27+ # servant-lucid = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-lucid) {});
28+ # servant-server = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-server) {});
29+ # servant = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant) {});
30+
31+ };
32+}
travis.nixdeleted−70
@@ -1,70 +0,0 @@
1−{
2− nativeCompiler ? "ghc",
3− # ^ Choose a GHC for compiling backend components (web server, selenium)
4− # (ghc, ghc8_0, ghc8_2, ghc8_4 or ghcHEAD)
5−
6− jsCompiler ? "ghcjs"
7− # ^ Choose a GHCJS for compiling the frontend
8− # (ghcjs, ghcjs8_0, ghcjs8_2 or ghcjs8_4)
9−
10−}:
11−
12−let
13−
14− reflexPlatform = import ./nix/reflex-platform.nix;
15−
16− lib = reflexPlatform.nixpkgs.haskell.lib;
17− do = funs: pkg: builtins.foldl' (a: b: b a) pkg funs;
18−
19− ghcjsPkgs = with lib; reflexPlatform.${jsCompiler}.override {
20− overrides = self: super: {
21− http-media = dontCheck super.http-media;
22− servant = dontCheck super.servant;
23− lens-aeson = dontCheck super.lens-aeson;
24− servant-reflex = lib.appendConfigureFlag
25− (self.callPackage ./default.nix {}) "-fExample";
26− };
27− };
28−
29− ghcPkgs = with lib; reflexPlatform.${nativeCompiler}.override {
30− overrides = self: super: {
31− servant-snap = dontCheck ((import ./nix/servant-snap.nix {}) self super);
32− testdriver = self.callCabal2nix "testdriver" ./testdriver {};
33− testserver = import nix/testserver.nix ghcjsPkgs.servant-reflex self super;
34− servant-reflex = self.callPackage ./default.nix {};
35− };
36− };
37−
38− testresults = import ./nix/testresults.nix
39− { inherit reflexPlatform;
40− inherit (ghcPkgs) testserver testdriver;
41− inherit (reflexPlatform.nixpkgs) curl;
42− phantomjs = reflexPlatform.nixpkgs.phantomjs2;
43− };
44−
45−in
46− rec {
47−
48− inherit reflexPlatform ghcPkgs ghcjsPkgs;
49−
50− build = ghcjsPkgs.servant-reflex;
51− buildGhc = ghcPkgs.servant-reflex;
52− testserver = ghcPkgs.testserver;
53− testdriver = ghcPkgs.testdriver;
54− inherit testresults;
55−
56− cabalBuild = reflexPlatform.${jsCompiler}.shellFor {
57− name = "servant-reflex-cabal-builder";
58−
59− packages = p: [
60− build
61− ];
62−
63− shellHook = ''
64− cabal configure --ghcjs -f Example
65− cabal build
66− exec/toSite.sh
67− exit $?
68− '';
69− };
70− }