on bdc4dc3 help sign in
34 files changed+502−847
since splitsnapshots
unifiedsplit
.gitignore+1−2 .gitmodules+15 .travis.yml+57−12 README.md+28−114 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+6−27 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+35 servant-reflex.cabal+19−28 shell.nix−1 src/Servant/Common/BaseUrl.hs+8−8 src/Servant/Common/Req.hs+99−109 src/Servant/Reflex.hs+103−202 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+28−114
@@ -2,21 +2,16 @@
22
33[![Build Status](https://travis-ci.org/imalsogreg/servant-reflex.svg?branch=master)](https://travis-ci.org/imalsogreg/servant-reflex)
44
5−## `servant-reflex` lets you share your `servant` APIs with the frontend
5+## The problem `servant-reflex` solves
6+
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.
69
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.
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
@@ -39,26 +33,16 @@ an `XhrRequest`.
3933 -- servant-reflex computes FRP functions for each API endpoint
4034 let (getint :<|> sayhi :<|> doubleit :<|> _) = client (Proxy :: Proxy API)
4135 (Proxy :: Proxy m)
42− (Proxy :: Proxy ())
4336 (constDyn (BasePath "/"))
4437```
4538
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.
39+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.
5640
5741```haskell
5842 -- No need to write these functions. servant-reflex creates them for you!
5943 getint :: MonadWidget t m
6044 => Event t () -- ^ Trigger the XHR Request
61− -> m (Event t (ReqResult () Int)) -- ^ Consume the answer
45+ -> m (Event t (ReqResult Int)) -- ^ Consume the answer
6246
6347 sayhi :: MonadWidget t m
6448 => Dynamic t (QParam Text)
@@ -69,21 +53,15 @@ parameter is a trigger event for the XHR request. The return value
6953 -- ^ Flag for capitalizing the response
7054 -> Event t ()
7155 -- ^ Trigger the XHR Request
72− -> m (Event t (ReqResult () Text))
56+ -> m (Event t (ReqResult Text))
7357
7458 doubleit :: MonadWidget t m
7559 => Dynamic t (Either Text Double)
7660 -> Event t ()
77− -> m (Event t (ReqResult () Double))
61+ -> m (Event t (ReqResult Double))
7862```
7963
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:
64+`ReqResult 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:
8765
8866```haskell
8967 -- ... continued ...
@@ -101,8 +79,7 @@ elimination functions to filter the result type you care about, like this:
10179 dynText =<< holdDyn "" (leftmost [errs, const "" <$> ys])
10280```
10381
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:
82+This example builds some input fields to enter API parameters, buttons to trigger the API calls, and text elements to show the results:
10683
10784```haskell
10885 elClass "div" "int-demo" $ do
@@ -125,100 +102,37 @@ trigger the API calls, and text elements to show the results:
125102 display =<< holdDyn Nothing outputDouble
126103```
127104
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.
105+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.
133106
134107
135108## Building the library and test server
136109
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.
110+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:
144111
145−```
146−nix build -f travis.nix testserver -o server
147−```
148112
149−Point it at the static directory and run it:
113+First build the library:
150114
151115```
152−STATIC_DIR=server/static server/back -p 8000
116+git submodule update --init --recursive
117+./build.sh
153118```
154119
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.
158−
159−**For a larger example of a project that shares types between backend and
160−frontend, see [hsnippet](https://github.com/mightybyte/hsnippet).**
120+Then build the test server:
161121
122+```
123+deps/reflex-platform/work-on ./overrides-ghc.nix ./testserver --command "cd testserver && cabal build"
124+```
162125
163−## Tagging requests
164126
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.
127+## Running the example site
169128
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:
129+The server must be run from the directory where static assets live:
175130
176−```haskell
177− ...
178− inp <- textInput def
179−
180− -- Convert the raw text into an `Either Text Double`
181− let inpNum = maybe (Left "No Parse") Right . readMaybe . T.unpack <$> value inp
182− go <- button "Double It"
183−
184− -- Call 'doubleIt' with triggers that coincide with good input parses
185− rs <- doubleIt inpNum (fforMaybe (tagPromptlyDyn inpNum go) $ \case
186− Left _ -> Nothing
187− Right a -> Just a
188− )
189−
190− -- Accumulate good responses in a map
191− doubleTable <- foldDyn (<>) mempty $ ffor rs $ \case
192− ResponseSuccess tag v _ -> tag =: v
193− _ -> mempty
194−
195− el "table" $ do
196− listWithKey doubleTable $ \k dv -> el "tr" $ do
197− el "td" $ text (T.pack $ show k)
198− el "td" $ dynText (T.pack . show <$> dv)
199− ...
200131```
201−
202−## Simultaneous requests
203−
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:
208−
209−```haskell
210−sayHi
211− :: Dynamic t (f (QParam Text))
212− -> Dynamic t (f [Text])
213− -> Dynamic t (f Bool)
214− -> Event t tag
215− -> m (Event t (f (ReqResult tag Text)))
132+cd testserver
133+dist/build/back/back -p 8001
216134```
217135
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.
136+And simply browse to `localhost:8001`
137+
138+**For a larger example of a project that shares types between backend and frontend, see [hsnippet](https://github.com/mightybyte/hsnippet).**
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+6−27
@@ -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
@@ -46,7 +43,7 @@ runMulti :: forall t m. (SupportsServantReflex t m,
4643runMulti = do
4744 url <- baseUrlWidget
4845 el "br" blank
49− let (_ :<|> _ :<|> sayHi :<|> dbl :<|> _ :<|> _ :<|> _ :<|> _ ) =
46+ let (_ :<|> _ :<|> sayHi :<|> dbl :<|> _ :<|> _ ) =
5047 clientA api (Proxy :: Proxy m) (Proxy :: Proxy []) (Proxy :: Proxy Int) url
5148
5249 num :: Dynamic t (Either Text Double) <- fmap (note "No read" . readMaybe . T.unpack) . value <$> textInput def
@@ -69,12 +66,9 @@ runMulti = do
6966 textInput def
7067 gust <- fmap (value) $ divClass "gusto-input" $ checkbox False def
7168 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')
69+ r' <- sayHi (fmap QParamSome <$> nms) (fmap (:[]) $ grts) (constDyn [True, False]) (1 <$ b)
7770
71+ dynText =<< holdDyn "Waiting" (T.pack . show . catMaybes . fmap reqSuccess <$> r')
7872
7973 return ()
8074
@@ -97,11 +91,8 @@ run = mdo
9791 el "br" (return ())
9892
9993 -- 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
94+ let (getUnit :<|> getInt :<|> sayhi :<|> dbl :<|> multi :<|> qna :<|> doRaw) =
95+ client api (Proxy :: Proxy m) (Proxy :: Proxy Int) url
10596
10697 c2 = client (Proxy :: Proxy ComprehensiveAPI) (Proxy :: Proxy m) (Proxy :: Proxy ()) url -- Just make sure this compiles for now
10798
@@ -186,18 +177,6 @@ run = mdo
186177 el "p" $
187178 dynText =<< holdDyn "No Answer" (unAnswer <$> fmapMaybe reqSuccess rr)
188179
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−
201180showXhrResponse :: XhrResponse -> Text
202181showXhrResponse (XhrResponse stat stattxt rbmay rtmay respHeaders) =
203182 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+ pkgs = import <nixpkgs> {};
4+ c2n = reflex-platform.cabal2nixResult;
5+in reflex-platform.ghc.override {
6+ overrides = self: super: {
7+ servant-snap = pkgs.haskell.lib.dontCheck (self.callPackage (c2n deps/servant-snap) {});
8+ snap = pkgs.haskell.lib.dontCheck (self.callPackage (c2n deps/servant-snap/deps/snap) {});
9+ snap-server = pkgs.haskell.lib.dontCheck (self.callPackage (c2n deps/servant-snap/deps/snap/deps/snap-server) {});
10+ io-streams = pkgs.haskell.lib.dontCheck (self.callPackage (c2n deps/servant-snap/deps/snap/deps/io-streams) {});
11+ io-streams-haproxy = pkgs.haskell.lib.dontCheck (self.callPackage (c2n deps/servant-snap/deps/snap/deps/io-streams-haproxy) {});
12+ heist = pkgs.haskell.lib.dontCheck (self.callPackage (c2n deps/servant-snap/deps/snap/deps/heist) {});
13+ xmlhtml = pkgs.haskell.lib.dontCheck (self.callPackage (c2n deps/servant-snap/deps/snap/deps/xmlhtml) {});
14+ snap-core = pkgs.haskell.lib.dontCheck (self.callPackage (c2n deps/servant-snap/deps/snap/deps/snap-core) {});
15+ servant = pkgs.haskell.lib.dontCheck (self.callPackage (c2n deps/servant/servant) {});
16+ Glob = pkgs.haskell.lib.dontCheck super.Glob;
17+ http-api-data = pkgs.haskell.lib.dontCheck (self.callPackage (c2n deps/http-api-data) {});
18+ };
19+}
overrides.nixnew file+35
@@ -0,0 +1,35 @@
1+{ reflex-platform, ... }:
2+let
3+
4+ nixpkgs = (import <nixpkgs> {});
5+ dontCheck = nixpkgs.pkgs.haskell.lib.dontCheck;
6+ cabal2nixResult = reflex-platform.cabal2nixResult;
7+
8+in
9+reflex-platform.ghcjs.override {
10+ overrides = self: super: {
11+ servant = dontCheck (self.callPackage (cabal2nixResult deps/servant/servant) {});
12+ http-api-data = dontCheck (self.callPackage (cabal2nixResult deps/http-api-data) {});
13+ natural-transformation = self.callPackage (
14+ { mkDerivation, base, containers, fetchgit, quickcheck-instances
15+ , stdenv, tasty, tasty-quickcheck
16+ }:
17+ mkDerivation {
18+ pname = "natural-transformation";
19+ version = "0.4";
20+ src = fetchgit {
21+ url = "https://github.com/ku-fpg/natural-transformation";
22+ sha256 = "0xbnnxbf5ydszbhf7h5ra3mrqy4mcyqc3zb2k8bwm1zyqrz6v0fs";
23+ rev = "b1200c09dcafd034e32846413913b74735c8ba56";
24+ };
25+ libraryHaskellDepends = [ base ];
26+ testHaskellDepends = [
27+ base containers quickcheck-instances tasty tasty-quickcheck
28+ ];
29+ homepage = "https://github.com/ku-fpg/natural-transformation";
30+ description = "A natural transformation package";
31+ license = stdenv.lib.licenses.bsd3;
32+ }
33+ ) {};
34+ };
35+}
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.7,
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.18,
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+8−8
@@ -20,19 +20,18 @@ module Servant.Common.BaseUrl (
2020) where
2121
2222import Control.Monad (join)
23−-- import Control.Monad.IO.Class (MonadIO)
23+import Control.Monad.IO.Class (MonadIO)
2424import Control.Monad.Fix (MonadFix)
2525import Data.Monoid ((<>))
2626import Data.Text (Text)
2727import qualified Data.Text as T
2828import GHC.Generics
29−import Language.Javascript.JSaddle.Monad (MonadJSM)
3029import Reflex
31−import Reflex.Dom.Core
30+import Reflex.Dom
3231import Text.Read
3332
3433
35−type SupportsServantReflex t m = (Reflex t, TriggerEvent t m, PerformEvent t m, HasWebView (Performable m), MonadJSM (Performable m))
34+type SupportsServantReflex t m = (Reflex t, TriggerEvent t m, PerformEvent t m, HasWebView (Performable m), MonadIO (Performable m))
3635
3736-- | URI scheme to use
3837data Scheme =
@@ -85,14 +84,15 @@ baseUrlWidget = elClass "div" "base-url" $ do
8584 where pathWidget :: m (Dynamic t BaseUrl)
8685 pathWidget = do
8786 text "Url base path"
88− t <- inputElement def
87+ t <- textInput (def {_textInputConfig_attributes =
88+ constDyn ("placeholder" =: "/a/b")})
8989 return $ BasePath <$> value t
9090 fullUrlWidget :: m (Dynamic t BaseUrl)
9191 fullUrlWidget = do
9292 schm <- dropdown Https (constDyn $ Https =: "https" <> Http =: "http") def
93− srv <- inputElement def
93+ srv <- textInput def {_textInputConfig_attributes = constDyn $ "placeholder" =: "example.com"}
9494 text ":"
95− prt <- inputElement def
95+ prt <- textInput def { _textInputConfig_attributes = constDyn $ "placeholder" =: "80"}
9696 port :: Dynamic t Int <- holdDyn 80 (fmapMaybe (readMaybe . T.unpack) $ updated (value prt))
97− path <- inputElement def
97+ path <- textInput def { _textInputConfig_attributes = constDyn $ "placeholder" =: "a/b" }
9898 return $ BaseFullUrl <$> value schm <*> value srv <*> port <*> value path
src/Servant/Common/Req.hs+99−109
@@ -1,25 +1,20 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFunctor #-}
32{-# LANGUAGE FlexibleContexts #-}
43{-# LANGUAGE GADTs #-}
54{-# LANGUAGE OverloadedStrings #-}
65{-# LANGUAGE LambdaCase #-}
7−{-# LANGUAGE RankNTypes #-}
86{-# LANGUAGE ScopedTypeVariables #-}
97{-# LANGUAGE TupleSections #-}
108
119module Servant.Common.Req where
1210
1311-------------------------------------------------------------------------------
14−import Control.Applicative (liftA2, liftA3)
15−import Control.Arrow ((&&&))
1612import Control.Concurrent
13+import Control.Applicative (liftA2, liftA3)
1714import Control.Monad (join)
1815import Control.Monad.IO.Class (MonadIO, liftIO)
1916import Data.Bifunctor (first)
20−import qualified Data.ByteString.Builder as Builder
2117import qualified Data.ByteString.Lazy.Char8 as BL
22−import Data.ByteString (ByteString)
2318import qualified Data.Map as Map
2419import Data.Maybe (catMaybes, fromMaybe)
2520import Data.Functor.Compose
@@ -29,9 +24,7 @@ import Data.Text (Text)
2924import qualified Data.Text as T
3025import qualified Data.Text.Encoding as TE
3126import 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)
27+import Reflex.Dom hiding (tag)
3528import Servant.Common.BaseUrl (BaseUrl, showBaseUrl,
3629 SupportsServantReflex)
3730import Servant.API.ContentTypes (MimeUnrender(..), NoContent(..))
@@ -50,25 +43,7 @@ data ReqResult tag a
5043 -- a non-successful response code
5144 | RequestFailure tag Text
5245 -- ^ A failure to construct the request tagged with 'tag' at trigger time
53− deriving (Functor)
54−
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'
46+
7247
7348------------------------------------------------------------------------------
7449-- | Simple filter/accessor for successful responses, when you want to
@@ -93,13 +68,6 @@ reqFailure (ResponseFailure _ s _) = Just s
9368reqFailure (RequestFailure _ s) = Just s
9469reqFailure _ = Nothing
9570
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−
10371
10472------------------------------------------------------------------------------
10573-- | Simple filter/accessor for the raw XHR response
@@ -115,6 +83,13 @@ reqTag (ResponseSuccess tag _ _) = tag
11583reqTag (ResponseFailure tag _ _) = tag
11684reqTag (RequestFailure tag _ ) = tag
11785
86+------------------------------------------------------------------------------
87+instance Functor (ReqResult tag) where
88+ fmap f (ResponseSuccess tag a xhr) = ResponseSuccess tag (f a) xhr
89+ fmap _ (ResponseFailure tag r x) = ResponseFailure tag r x
90+ fmap _ (RequestFailure tag r) = RequestFailure tag r
91+
92+
11893-------------------------------------------------------------------------------
11994-- | You must wrap the parameter of a QueryParam endpoint with 'QParam' to
12095-- indicate whether the parameter is valid and present, validly absent, or
@@ -167,7 +142,7 @@ reqToReflexRequest
167142 => Text
168143 -> Dynamic t BaseUrl
169144 -> Req t
170− -> Dynamic t (Either Text (XhrRequest XhrPayload))
145+ -> (Dynamic t (Either Text (XhrRequest XhrPayload)))
171146reqToReflexRequest reqMeth reqHost req =
172147 let t :: Dynamic t [Either Text Text]
173148 t = sequence $ reverse $ reqPathParts req
@@ -179,22 +154,18 @@ reqToReflexRequest reqMeth reqHost req =
179154 urlParts = fmap sequence t
180155
181156 urlPath :: Dynamic t (Either Text Text)
182− urlPath = (fmap.fmap)
183− (T.intercalate "/" . fmap escape)
184− urlParts
157+ urlPath = (fmap.fmap) (T.intercalate "/") urlParts
185158
186159 queryPartString :: (Text, QueryPart t) -> Dynamic t (Maybe (Either Text Text))
187160 queryPartString (pName, qp) = case qp of
188161 QueryPartParam p -> ffor p $ \case
189162 Left e -> Just (Left e)
190− Right (Just a) -> Just (Right $ pName <> "=" <> escape a)
163+ Right (Just a) -> Just (Right $ pName <> "=" <> a)
191164 Right Nothing -> Nothing
192165 QueryPartParams ps -> ffor ps $ \pStrings ->
193166 if null pStrings
194167 then Nothing
195− else Just . Right
196− . T.intercalate "&"
197− $ fmap (\p -> pName <> "=" <> escape p) pStrings
168+ else Just $ Right (T.intercalate "&" (fmap (\p -> pName <> "=" <> p) pStrings))
198169 QueryPartFlag fl -> ffor fl $ \case
199170 True -> Just $ Right pName
200171 False -> Nothing
@@ -229,10 +200,10 @@ reqToReflexRequest reqMeth reqHost req =
229200 Right $ XhrRequestConfig
230201 { _xhrRequestConfig_sendData = bytesToPayload bBytes
231202 , _xhrRequestConfig_headers =
232− Map.insert "Content-Type" bCT (Map.fromList hs)
203+ Map.insert "Content-Type" bCT (Map.fromList hs)
233204 , _xhrRequestConfig_user = Nothing
234205 , _xhrRequestConfig_password = Nothing
235− , _xhrRequestConfig_responseType = Just XhrResponseType_ArrayBuffer
206+ , _xhrRequestConfig_responseType = Nothing
236207 , _xhrRequestConfig_withCredentials = False
237208 , _xhrRequestConfig_responseHeaders = def
238209 }
@@ -244,8 +215,8 @@ reqToReflexRequest reqMeth reqHost req =
244215 Right hs -> Right $ def { _xhrRequestConfig_headers = Map.fromList hs
245216 , _xhrRequestConfig_user = Nothing
246217 , _xhrRequestConfig_password = Nothing
247− , _xhrRequestConfig_responseType = Just XhrResponseType_ArrayBuffer
248− , _xhrRequestConfig_sendData = mempty
218+ , _xhrRequestConfig_responseType = Nothing
219+ , _xhrRequestConfig_sendData = ""
249220 , _xhrRequestConfig_withCredentials = False
250221 }
251222 Just rBody -> liftA2 mkConfigBody xhrHeaders rBody
@@ -272,55 +243,41 @@ reqToReflexRequest reqMeth reqHost req =
272243displayHttpRequest :: Text -> Text
273244displayHttpRequest httpmethod = "HTTP " <> httpmethod <> " request"
274245
275−-- | This function performs the request
246+-- | This function actually performs the request.
276247performRequests :: forall t m f tag.(SupportsServantReflex t m, Traversable f)
277248 => Text
278249 -> Dynamic t (f (Req t))
279250 -> Dynamic t BaseUrl
280− -> ClientOptions
281251 -> Event t tag
282252 -> 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
253+performRequests reqMeth rs reqHost trigger = do
254+ -- let xhrReqs = sequence $ (\r -> reqToReflexRequest reqMeth r reqHost) <$> rs :: Dynamic t (f (Either Text (XhrRequest XhrPayload)))
255+ let xhrReqs = join $ (\(fxhr :: f (Req t)) -> sequence $ reqToReflexRequest reqMeth reqHost <$> fxhr) <$> rs
256+ let reqs = attachPromptlyDynWith (\fxhr t -> Compose (t, fxhr)) xhrReqs trigger
257+ resps <- performSomeRequestsAsync reqs
293258 return $ getCompose <$> resps
294259
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.
260+-- | 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.
298261performSomeRequestsAsync
299262 :: (MonadIO (Performable m),
300− MonadJSM (Performable m),
301263 HasWebView (Performable m),
302264 PerformEvent t m,
303265 TriggerEvent t m,
304266 Traversable f,
305− IsXhrPayload a,
306− Show a
307− )
308− => ClientOptions
309− -> Event t (f (Either Text (XhrRequest a)))
267+ IsXhrPayload a)
268+ => Event t (f (Either Text (XhrRequest a)))
310269 -> m (Event t (f (Either Text XhrResponse)))
311−performSomeRequestsAsync opts =
312− performSomeRequestsAsync' opts newXMLHttpRequest . fmap return
270+performSomeRequestsAsync = performSomeRequestsAsync' newXMLHttpRequest . fmap return
313271
314272
315273------------------------------------------------------------------------------
316274-- | A modified version or Reflex.Dom.Xhr.performRequestsAsync
317275-- that accepts 'f (Either e (XhrRequestb))' events
318276performSomeRequestsAsync'
319− :: (MonadJSM (Performable m), PerformEvent t m, TriggerEvent t m, Traversable f, Show b)
320− => ClientOptions
321− -> (XhrRequest b -> (a -> JSM ()) -> Performable m XMLHttpRequest)
277+ :: (MonadIO (Performable m), PerformEvent t m, TriggerEvent t m, Traversable f)
278+ => (XhrRequest b -> (a -> IO ()) -> Performable m XMLHttpRequest)
322279 -> Event t (Performable m (f (Either Text (XhrRequest b)))) -> m (Event t (f (Either Text a)))
323−performSomeRequestsAsync' opts newXhr req = performEventAsync $ ffor req $ \hrs cb -> do
280+performSomeRequestsAsync' newXhr req = performEventAsync $ ffor req $ \hrs cb -> do
324281 rs <- hrs
325282 resps <- forM rs $ \r -> case r of
326283 Left e -> do
@@ -328,17 +285,70 @@ performSomeRequestsAsync' opts newXhr req = performEventAsync $ ffor req $ \hrs
328285 return resp
329286 Right r' -> do
330287 resp <- liftIO newEmptyMVar
331− r'' <- liftJSM $ (optsRequestFixup opts) r'
332− _ <- newXhr r'' $ liftIO . putMVar resp . Right
288+ _ <- newXhr r' $ liftIO . putMVar resp . Right
333289 return resp
334290 _ <- liftIO $ forkIO $ cb =<< forM resps takeMVar
335291 return ()
336292
337293
338294
339−type XhrPayload = ByteString
295+-- | This function actually performs the request.
296+performRequest :: forall t m tag .(SupportsServantReflex t m)
297+ => Text
298+ -> (Req t)
299+ -> Dynamic t BaseUrl
300+ -> Event t tag
301+ -> m (Event t (tag, XhrResponse), Event t (tag, Text))
302+performRequest reqMeth req reqHost trigger = do
303+
304+ let xhrReq = reqToReflexRequest reqMeth reqHost req
305+ let reqs = attachPromptlyDynWith (flip (,)) xhrReq trigger
306+ okReqs = fmapMaybe (\(t,e) -> either (const Nothing) (Just . (t,)) e) reqs
307+ badReqs = fmapMaybe (\(t,e) -> either (Just . (t,)) (const Nothing) e) reqs
308+
309+ resps <- performRequestsAsync okReqs
310+
311+ return (resps, badReqs)
312+
313+
314+type XhrPayload = T.Text
340315bytesToPayload :: BL.ByteString -> XhrPayload
341−bytesToPayload = BL.toStrict
316+bytesToPayload = TE.decodeUtf8 . BL.toStrict
317+
318+
319+-- performRequestNoBody :: forall t m tag.(SupportsServantReflex t m)
320+-- => Text
321+-- -> Req t
322+-- -> Dynamic t BaseUrl
323+-- -> Event t tag -> m (Event t (ReqResult tag NoContent))
324+-- performRequestNoBody reqMeth req reqHost trigger = do
325+-- (resp, badReq) <- performRequest reqMeth req reqHost trigger
326+-- let decodeResp = const $ Right NoContent
327+-- return $ leftmost [ fmap (evalResponse decodeResp) resp
328+-- , fmap (uncurry RequestFailure) badReq
329+-- ]
330+
331+
332+-- performRequestCT
333+-- :: (SupportsServantReflex t m,
334+-- MimeUnrender ct a)
335+-- => Proxy ct
336+-- -> Text
337+-- -> Req t
338+-- -> Dynamic t BaseUrl
339+-- -> Event t tag
340+-- -> m (Event t (ReqResult tag a))
341+-- performRequestCT ct reqMeth req reqHost trigger = do
342+-- (resp, badReq) <- performRequest reqMeth req reqHost trigger
343+-- let decodeResp x = first T.pack .
344+-- mimeUnrender ct .
345+-- BL.fromStrict .
346+-- TE.encodeUtf8 =<< note "No body text"
347+-- (_xhrResponse_responseText x)
348+
349+-- return $ leftmost [fmap (evalResponse decodeResp) resp
350+-- , fmap (uncurry RequestFailure) badReq
351+-- ]
342352
343353
344354performRequestsCT
@@ -348,20 +358,19 @@ performRequestsCT
348358 -> Text
349359 -> Dynamic t (f (Req t))
350360 -> Dynamic t BaseUrl
351− -> ClientOptions
352361 -> Event t tag
353362 -> m (Event t (f (ReqResult tag a)))
354−performRequestsCT ct reqMeth reqs reqHost opts trigger = do
355− resps <- performRequests reqMeth reqs reqHost opts trigger
356− let decodeResp (Just (XhrResponseBody_ArrayBuffer x)) =
357− first T.pack .
358− mimeUnrender ct $
359− BL.fromStrict x
360− decodeResp _ = Left "No body"
363+performRequestsCT ct reqMeth reqs reqHost trigger = do
364+ resps <- performRequests reqMeth reqs reqHost trigger
365+ let decodeResp x = first T.pack .
366+ mimeUnrender ct .
367+ BL.fromStrict .
368+ TE.encodeUtf8 =<< note "No body text"
369+ (_xhrResponse_responseText x)
361370 return $ fmap
362371 (\(t,rs) -> ffor rs $ \r -> case r of
363372 Left e -> RequestFailure t e
364− Right g -> evalResponse (decodeResp . _xhrResponse_response) (t,g)
373+ Right g -> evalResponse decodeResp (t,g)
365374 )
366375 resps
367376
@@ -372,11 +381,10 @@ performRequestsNoBody
372381 => Text
373382 -> Dynamic t (f (Req t))
374383 -> Dynamic t BaseUrl
375− -> ClientOptions
376384 -> Event t tag
377385 -> m (Event t (f (ReqResult tag NoContent)))
378−performRequestsNoBody reqMeth reqs reqHost opts trigger = do
379− resps <- performRequests reqMeth reqs reqHost opts trigger
386+performRequestsNoBody reqMeth reqs reqHost trigger = do
387+ resps <- performRequests reqMeth reqs reqHost trigger
380388 let decodeResp = const $ Right NoContent
381389 return $ ffor resps $ \(tag,rs) -> ffor rs $ \r -> case r of
382390 Left e -> RequestFailure tag e
@@ -389,8 +397,7 @@ evalResponse
389397 -> (tag, XhrResponse)
390398 -> ReqResult tag a
391399evalResponse decode (tag, xhr) =
392− let status = _xhrResponse_status xhr
393− okStatus = status >= 200 && status < 400
400+ let okStatus = _xhrResponse_status xhr < 400
394401 errMsg = fromMaybe
395402 ("Empty response with error code " <>
396403 T.pack (show $ _xhrResponse_status xhr))
@@ -403,17 +410,7 @@ evalResponse decode (tag, xhr) =
403410 else ResponseFailure tag errMsg xhr
404411 in respPayld
405412
406−------------------------------------------------------------------------------
407−-- | Utility for simultaneously accessing/filtering Success and Failure
408−-- response 'Event's,
409−fanReqResult :: Reflex t => Event t (ReqResult tag a) -> (Event t Text, Event t a)
410−fanReqResult = fmapMaybe reqFailure &&& fmapMaybe reqSuccess
411413
412−------------------------------------------------------------------------------
413−-- | Utility for simultaneously accessing/filtering Success and Failure
414−-- response 'Event's, but keeping the request tag
415−fanReqResult' :: Reflex t => Event t (ReqResult tag a) -> (Event t (tag, Text), Event t (tag, a))
416−fanReqResult' = fmapMaybe reqFailure' &&& fmapMaybe reqSuccess'
417414
418415
419416note :: e -> Maybe a -> Either e a
@@ -422,10 +419,3 @@ note e = maybe (Left e) Right
422419fmapL :: (e -> e') -> Either e a -> Either e' a
423420fmapL _ (Right a) = Right a
424421fmapL f (Left e) = Left (f e)
425−
426−builderToText :: Builder.Builder -> T.Text
427−builderToText = TE.decodeUtf8 . BL.toStrict . Builder.toLazyByteString
428−
429−escape :: T.Text -> T.Text
430−escape = T.pack . N.escapeURIString (not . N.isReserved) . T.unpack . TE.decodeUtf8 . BL.toStrict . Builder.toLazyByteString . toEncodedUrlPiece
431−
src/Servant/Reflex.hs+103−202
@@ -1,23 +1,24 @@
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 OverloadedStrings #-}
8+{-# LANGUAGE PolyKinds #-}
9+{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TupleSections #-}
11+{-# LANGUAGE TypeFamilies #-}
12+{-# LANGUAGE TypeOperators #-}
13+{-# LANGUAGE UndecidableInstances #-}
14+{-# LANGUAGE MultiParamTypeClasses #-}
15+{-# LANGUAGE OverloadedStrings #-}
16+{-# LANGUAGE PolyKinds #-}
17+{-# LANGUAGE ScopedTypeVariables #-}
18+{-# LANGUAGE TupleSections #-}
19+{-# LANGUAGE TypeFamilies #-}
20+{-# LANGUAGE TypeOperators #-}
21+{-# LANGUAGE UndecidableInstances #-}
2122
2223-- #include "overlapping-compat.h"
2324-- | This module provides 'client' which can automatically generate
@@ -25,57 +26,46 @@
2526-- API.
2627module Servant.Reflex
2728 ( client
28− , clientWithOpts
29− , clientWithOptsAndResultHandler
30− , clientWithRoute
31− , clientWithRouteAndResultHandler
3229 , BuildHeaderKeysTo(..)
3330 , toHeaders
34− , HasClient
35− , Client
31+ , HasClient(..)
3632 , module Servant.Common.Req
3733 , module Servant.Common.BaseUrl
3834 ) where
3935
4036------------------------------------------------------------------------------
4137import Control.Applicative
42−import qualified Data.CaseInsensitive as CI
43−import Data.Functor.Identity
44−import qualified Data.Map as Map
4538import Data.Monoid ((<>))
46−import Data.Proxy (Proxy (..))
4739import qualified Data.Set as Set
40+import qualified Data.Text.Encoding as E
41+import Data.CaseInsensitive (mk)
42+import Data.Functor.Identity
43+import Data.Proxy (Proxy (..))
44+import qualified Data.Map as Map
4845import Data.Text (Text)
4946import qualified Data.Text as T
50−import qualified Data.Text.Encoding as E
51−import GHC.Exts (Constraint)
5247import GHC.TypeLits (KnownSymbol, symbolVal)
53−import Servant.API ((:<|>) (..), (:>), BasicAuth,
54− BasicAuthData, BuildHeadersTo (..),
55− Capture, Header, Headers (..),
56− HttpVersion, IsSecure,
57− MimeRender (..), MimeUnrender,
48+import Servant.API ((:<|>)(..),(:>), BasicAuth,
49+ BasicAuthData, BuildHeadersTo(..),
50+ Capture, contentType, Header,
51+ Headers(..), HttpVersion, IsSecure,
52+ MimeRender(..), MimeUnrender,
5853 NoContent, QueryFlag, QueryParam,
59− QueryParams, Raw, ReflectMethod (..),
54+ QueryParams, Raw, ReflectMethod(..),
6055 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)
56+ ToHttpApiData(..), Vault, Verb)
57+
58+import Reflex.Dom (Dynamic, Event, Reflex,
59+ XhrRequest(..),
60+ XhrResponseHeaders(..),
61+ XhrResponse(..), attachPromptlyDynWith, constDyn, ffor, fmapMaybe,
62+ leftmost, performRequestsAsync,
63+ )
7264------------------------------------------------------------------------------
7365import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
7466 showBaseUrl,
7567 SupportsServantReflex)
76−import Servant.Common.Req (ClientOptions(..),
77− defaultClientOptions,
78− Req, ReqResult(..), QParam(..),
68+import Servant.Common.Req (Req, ReqResult(..), QParam(..),
7969 QueryPart(..), addHeader, authData,
8070 defReq, evalResponse, prependToPathParts,
8171 -- performRequestCT,
@@ -85,10 +75,9 @@ import Servant.Common.Req (ClientOptions(..),
8575 performSomeRequestsAsync,
8676 qParamToQueryPart, reqBody,
8777 reqSuccess, reqFailure,
88− reqMethod, respHeaders,
89− response,
78+ reqMethod, respHeaders, response,
9079 reqTag,
91− qParams, withCredentials)
80+ qParams)
9281
9382
9483-- * Accessing APIs as a Client
@@ -103,75 +92,28 @@ import Servant.Common.Req (ClientOptions(..),
10392-- >
10493-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
10594-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
106−-- > -> m (Event t (l, ReqResult Book)))
95+-- -> m (Event t (l, ReqResult Book)))
10796-- > (getAllBooks :<|> postNewBook) = client myApi host
10897-- > where host = constDyn $ BaseUrl Http "localhost" 8080
109−client
110− :: (HasClient t m layout tag)
111− => Proxy layout
112− -> Proxy m
113− -> Proxy tag
114− -> Dynamic t BaseUrl
115− -> Client t m layout tag
116−client p q t baseurl = clientWithRoute p q t defReq baseurl defaultClientOptions
117−
118−clientWithOpts
119− :: (HasClient t m layout tag)
120− => Proxy layout
121− -> Proxy m
122− -> Proxy tag
123− -> Dynamic t BaseUrl
124− -> ClientOptions
125− -> Client t m layout tag
126−clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
127−
128−-- | Like 'clientWithOpts' but allows passing a function which will process the
129−-- result event in some way. This can be used to handle errors in a uniform way
130−-- across call sites.
131−clientWithOptsAndResultHandler
132− :: (HasClient t m layout tag)
133− => Proxy layout
134− -> Proxy m
135− -> Proxy tag
136− -> Dynamic t BaseUrl
137− -> ClientOptions
138− -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
139− -> Client t m layout tag
140−clientWithOptsAndResultHandler p q t = clientWithRouteAndResultHandler p q t defReq
98+client :: (HasClient t m layout tag)
99+ => Proxy layout -> Proxy m -> Proxy tag -> Dynamic t BaseUrl -> Client t m layout tag
100+client p q t baseurl = clientWithRoute p q t defReq baseurl
141101
142102
143103-- | This class lets us define how each API combinator
144104-- influences the creation of an HTTP request. It's mostly
145105-- an internal class, you can just use 'client'.
146−class Monad m => HasClient t m layout (tag :: *) where
106+class HasClient t m layout (tag :: *) where
147107 type Client t m layout tag :: *
148− clientWithRoute
149− :: Proxy layout
150− -> Proxy m
151− -> Proxy tag
152− -> Req t
153− -> Dynamic t BaseUrl
154− -> ClientOptions
155− -> Client t m layout tag
156− clientWithRoute l m t r b o = clientWithRouteAndResultHandler l m t r b o return
157−
158− clientWithRouteAndResultHandler
159− :: Proxy layout
160− -> Proxy m
161− -> Proxy tag
162− -> Req t
163− -> Dynamic t BaseUrl
164− -> ClientOptions
165− -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
166− -> Client t m layout tag
108+ clientWithRoute :: Proxy layout -> Proxy m -> Proxy tag -> Req t -> Dynamic t BaseUrl -> Client t m layout tag
167109
168110
169111instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
170112 type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
171113
172− clientWithRouteAndResultHandler Proxy q pTag req baseurl opts wrap =
173− clientWithRouteAndResultHandler (Proxy :: Proxy a) q pTag req baseurl opts wrap :<|>
174− clientWithRouteAndResultHandler (Proxy :: Proxy b) q pTag req baseurl opts wrap
114+ clientWithRoute Proxy q pTag req baseurl =
115+ clientWithRoute (Proxy :: Proxy a) q pTag req baseurl :<|>
116+ clientWithRoute (Proxy :: Proxy b) q pTag req baseurl
175117
176118
177119-- Capture. Example:
@@ -192,9 +134,11 @@ instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout ta
192134 type Client t m (Capture capture a :> sublayout) tag =
193135 Dynamic t (Either Text a) -> Client t m sublayout tag
194136
195− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196− clientWithRouteAndResultHandler
197− (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
137+ clientWithRoute Proxy q t req baseurl val =
138+ clientWithRoute (Proxy :: Proxy sublayout)
139+ q t
140+ (prependToPathParts p req)
141+ baseurl
198142 where p = (fmap . fmap) (toUrlPiece) val
199143
200144
@@ -207,8 +151,9 @@ instance {-# OVERLAPPABLE #-}
207151 Event t tag -> m (Event t (ReqResult tag a))
208152 -- TODO how to access input types here?
209153 -- ExceptT ServantError IO a
210− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
211− wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
154+ clientWithRoute Proxy _ _ req baseurl trigs =
155+ -- performRequestCT (Proxy :: Proxy ct) method req' baseurl trigs
156+ fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl trigs
212157 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
213158 req' = req { reqMethod = method }
214159
@@ -221,33 +166,29 @@ instance {-# OVERLAPPING #-}
221166 Event t tag -> m (Event t (ReqResult tag NoContent))
222167 -- TODO: how to access input types here?
223168 -- ExceptT ServantError IO NoContent
224− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225− wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
169+ clientWithRoute Proxy _ _ req baseurl =
170+ (fmap . fmap) runIdentity . performRequestsNoBody method (constDyn $ Identity req) baseurl
226171 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
227172
228173
229174toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
230175toHeaders r =
231− let hdrs = maybe []
232− (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
176+ let toBS = E.encodeUtf8
177+ hdrs = maybe []
178+ (\xhr -> fmap (\(h,v) -> (mk (toBS h), toBS v))
233179 (Map.toList $ _xhrResponse_headers xhr))
234180 (response r)
235181 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
236182
237−
238183class BuildHeaderKeysTo hs where
239− buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
184+ buildHeaderKeysTo :: Proxy hs -> [T.Text]
240185
241186instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242187 where buildHeaderKeysTo _ = []
243188
244189instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
245190 => BuildHeaderKeysTo ((Header h v) ': xs) where
246− buildHeaderKeysTo _ =
247− let
248− thisKey = CI.mk $ T.pack (symbolVal (Proxy :: Proxy h))
249− in thisKey : buildHeaderKeysTo (Proxy :: Proxy xs)
250−
191+ buildHeaderKeysTo _ = T.pack (symbolVal (Proxy :: Proxy h)) : buildHeaderKeysTo (Proxy :: Proxy xs)
251192
252193-- HEADERS Verb (Content) --
253194-- Headers combinator not treated in fully general case,
@@ -262,10 +203,10 @@ instance {-# OVERLAPPABLE #-}
262203 ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
263204 type Client t m (Verb method status cts' (Headers ls a)) tag =
264205 Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
265− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
206+ clientWithRoute Proxy _ _ req baseurl trigs = do
266207 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
267− resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268− wrap $ toHeaders <$> resp
208+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl trigs
209+ return $ toHeaders <$> resp
269210 where req' = req { respHeaders =
270211 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
271212 }
@@ -278,10 +219,10 @@ instance {-# OVERLAPPABLE #-}
278219 ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
279220 type Client t m (Verb method status cts (Headers ls NoContent)) tag
280221 = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
281− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
222+ clientWithRoute Proxy _ _ req baseurl trigs = do
282223 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
283− resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284− wrap $ toHeaders <$> resp
224+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl trigs
225+ return $ toHeaders <$> resp
285226 where req' = req {respHeaders =
286227 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
287228 }
@@ -308,11 +249,11 @@ instance (KnownSymbol sym, ToHttpApiData a,
308249 type Client t m (Header sym a :> sublayout) tag =
309250 Dynamic t (Either Text a) -> Client t m sublayout tag
310251
311− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap eVal =
312− clientWithRouteAndResultHandler
313− (Proxy :: Proxy sublayout) q t
314− (Servant.Common.Req.addHeader hname eVal req)
315− baseurl opts wrap
252+ clientWithRoute Proxy q t req baseurl eVal =
253+ clientWithRoute (Proxy :: Proxy sublayout)
254+ q t
255+ (Servant.Common.Req.addHeader hname eVal req)
256+ baseurl
316257 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
317258
318259
@@ -326,21 +267,8 @@ instance HasClient t m sublayout tag
326267 type Client t m (HttpVersion :> sublayout) tag =
327268 Client t m sublayout tag
328269
329− clientWithRouteAndResultHandler Proxy =
330− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
331−
332−-- | Using a 'Summary' combinator in your API doesn't affect the client
333−-- functions.
334−instance (HasClient t m sublayout tag, KnownSymbol sym)
335− => HasClient t m (Summary sym :> sublayout) tag where
336−
337− type Client t m (Summary sym :> sublayout) tag =
338− Client t m sublayout tag
339−
340− clientWithRouteAndResultHandler Proxy =
341− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
342−
343−
270+ clientWithRoute Proxy q t =
271+ clientWithRoute (Proxy :: Proxy sublayout) q t
344272
345273
346274-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -376,9 +304,9 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
376304 Dynamic t (QParam a) -> Client t m sublayout tag
377305
378306 -- if mparam = Nothing, we don't add it to the query string
379− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
380− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
381− (req {qParams = paramPair : qParams req}) baseurl opts wrap
307+ clientWithRoute Proxy q t req baseurl mparam =
308+ clientWithRoute (Proxy :: Proxy sublayout) q t
309+ (req {qParams = paramPair : qParams req}) baseurl
382310
383311 where pname = symbolVal (Proxy :: Proxy sym)
384312 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -422,8 +350,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
422350 type Client t m (QueryParams sym a :> sublayout) tag =
423351 Dynamic t [a] -> Client t m sublayout tag
424352
425− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
353+ clientWithRoute Proxy q t req baseurl paramlist =
354+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
427355
428356 where req' = req { qParams = (T.pack pname, params') : qParams req }
429357 pname = symbolVal (Proxy :: Proxy sym)
@@ -462,8 +390,8 @@ instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
462390 type Client t m (QueryFlag sym :> sublayout) tag =
463391 Dynamic t Bool -> Client t m sublayout tag
464392
465− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
393+ clientWithRoute Proxy q t req baseurl flag =
394+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
467395
468396 where req' = req { qParams = thisPair : qParams req }
469397 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
@@ -477,7 +405,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
477405 -> Event t tag
478406 -> m (Event t (ReqResult tag ()))
479407
480− clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
408+ clientWithRoute _ _ _ _ baseurl xhrs triggers = do
481409
482410 let xhrs' = liftA2 (\x path -> case x of
483411 Left e -> Left e
@@ -488,7 +416,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
488416 okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
489417
490418 resps <- performRequestsAsync okReq
491− wrap $ leftmost [ uncurry RequestFailure <$> badReq
419+ return $ leftmost [ uncurry RequestFailure <$> badReq
492420 , evalResponse (const $ Right ()) <$> resps
493421 ]
494422
@@ -519,8 +447,8 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
519447 type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520448 Dynamic t (Either Text a) -> Client t m sublayout tag
521449
522− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
450+ clientWithRoute Proxy q t req baseurl body =
451+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
524452 where req' = req { reqBody = bodyBytesCT }
525453 ctProxy = Proxy :: Proxy ct
526454 ctString = T.pack $ show $ contentType ctProxy
@@ -534,9 +462,9 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
534462instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
535463 type Client t m (path :> sublayout) tag = Client t m sublayout tag
536464
537− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap =
538− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
539− (prependToPathParts (pure (Right $ T.pack p)) req) baseurl opts wrap
465+ clientWithRoute Proxy q t req baseurl =
466+ clientWithRoute (Proxy :: Proxy sublayout) q t
467+ (prependToPathParts (pure (Right $ T.pack p)) req) baseurl
540468
541469 where p = symbolVal (Proxy :: Proxy path)
542470
@@ -544,23 +472,23 @@ instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient
544472instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
545473 type Client t m (Vault :> api) tag = Client t m api tag
546474
547− clientWithRouteAndResultHandler Proxy =
548− clientWithRouteAndResultHandler (Proxy :: Proxy api)
475+ clientWithRoute Proxy q t req baseurl =
476+ clientWithRoute (Proxy :: Proxy api) q t req baseurl
549477
550478
551479instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
552480 type Client t m (RemoteHost :> api) tag = Client t m api tag
553481
554− clientWithRouteAndResultHandler Proxy =
555− clientWithRouteAndResultHandler (Proxy :: Proxy api)
482+ clientWithRoute Proxy q t req baseurl =
483+ clientWithRoute (Proxy :: Proxy api) q t req baseurl
556484
557485
558486
559487instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
560488 type Client t m (IsSecure :> api) tag = Client t m api tag
561489
562− clientWithRouteAndResultHandler Proxy =
563− clientWithRouteAndResultHandler (Proxy :: Proxy api)
490+ clientWithRoute Proxy q t req baseurl =
491+ clientWithRoute (Proxy :: Proxy api) q t req baseurl
564492
565493
566494instance (HasClient t m api tag, Reflex t)
@@ -569,8 +497,8 @@ instance (HasClient t m api tag, Reflex t)
569497 type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570498 -> Client t m api tag
571499
572− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
573− clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
500+ clientWithRoute Proxy q t req baseurl authdata =
501+ clientWithRoute (Proxy :: Proxy api) q t req' baseurl
574502 where
575503 req' = req { authData = Just authdata }
576504
@@ -596,30 +524,3 @@ non-empty lists, but is otherwise more specific, no instance will be overall
596524more specific. This in turn generally means adding yet another instance (one
597525for empty and one for non-empty lists).
598526-}
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
625−
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− }