git.iko.soy/typeable/servant-reflex
on 4272de9 help sign in
45 files changed+693−2015
since splitsnapshots
unifiedsplit
.gitignore−3 .gitmodules+21 .travis.yml+47−12 ChangeLog.md−60 README.md+80−139 build.sh+3 default.nix+12−16 testdriver/deploy-code-coverage.sh → deploy.sh deps/ghcjs-dom+1 deps/reflex+1 deps/reflex-dom+1 deps/reflex-dom-contrib+1 deps/reflex-platform+1 deps/servant+1 deps/servant-snap+1 exec/API.hs+4−29 exec/Example.hs+40−148 init-sandbox.sh+40 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+10 overrides.nix+8 testdriver/runTestsAndCoverage.sh → runTestsAndCoverage.sh servant-reflex.cabal+31−36 shell.nix−1 shell.sh+3 src/Servant/Common/BaseUrl.hs+20−35 src/Servant/Common/Req.hs+101−316 src/Servant/Reflex.hs+197−370 src/Servant/Reflex/Multi.hs−401 stack.yaml−56 test/Tests.hs+4 testdriver/LICENSE.md−30 testdriver/test/Servant/ReflexSpec.hs−94 testdriver/test/Spec.hs−1 testdriver/testdriver.cabal−26 testserver/API.hs+1−69 testserver/Main.hs+16−41 testserver/testserver.cabal+16−17 testserver/tr.nix+32 exec/toSite.sh → toSite.sh−2 travis.nix−70
.gitignore−3
@@ -6,6 +6,3 @@ log
66*.webapp
77*.stats
88out
9−/.stack-work/
10−TAGS
11−dist-newstyle
.gitmodules+21
@@ -0,0 +1,21 @@
1+[submodule "deps/servant-snap"]
2+ path = deps/servant-snap
3+ url = https://github.com/haskell-servant/servant-snap
4+[submodule "deps/reflex-dom"]
5+ path = deps/reflex-dom
6+ url = https://github.com/ryantrinkle/reflex-dom
7+[submodule "deps/reflex"]
8+ path = deps/reflex
9+ url = https://github.com/ryantrinkle/reflex
10+[submodule "deps/reflex-platform"]
11+ path = deps/reflex-platform
12+ url = https://github.com/reflex-frp/reflex-platform.git
13+[submodule "deps/servant"]
14+ path = deps/servant
15+ url = https://github.com/haskell-servant/servant
16+[submodule "deps/reflex-dom-contrib"]
17+ path = deps/reflex-dom-contrib
18+ url = https://github.com/reflex-frp/reflex-dom-contrib
19+[submodule "deps/ghcjs-dom"]
20+ path = deps/ghcjs-dom
21+ url = https://github.com/ghcjs/ghcjs-dom
.travis.yml+47−12
@@ -1,17 +1,52 @@
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+matrix:
8+ include:
9+ - env: CABALVER=1.24 GHCVER=7.10.3
10+ compiler: ": #GHC 7.10.3"
11+ addons: {apt: {packages: [cabal-install-1.24,ghc-7.10.3], sources: [hvr-ghc]}}
12+ - env: CABALVER=1.24 GHCVER=8.0.1
13+ compiler: ": #GHC 8.0.1"
14+ addons: {apt: {packages: [cabal-install-1.24,ghc-8.0.1], sources: [hvr-ghc]}}
15+
16+
417
518before_install:
6− - sudo cp -rT $TRAVIS_BUILD_DIR/nix /etc/nix
19+ - openssl aes-256-cbc -K $encrypted_3c89d919c82e_key -iv $encrypted_3c89d919c82e_iv -in deploy_key.enc -out deploy_key -d
20+ - unset CC
21+ - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH
722
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"
23+install:
24+ - cabal --version
25+ - BENCH=${BENCH---enable-benchmarks}
26+ - TEST=${TEST---enable-tests}
27+ - echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"
28+ - if [ -f $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz ];
29+ then
30+ zcat $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz >
31+ $HOME/.cabal/packages/hackage.haskell.org/00-index.tar;
32+ fi
33+ - travis_retry cabal update -v
34+ - sed -i 's/^jobs:/-- jobs:/' ${HOME}/.cabal/config
1235
1336script:
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
37+- git config --global user.email "travis-ci@example.com"
38+- git config --global user.name "Travis-CI"
39+- git submodule update --init --recursive
40+- deps/reflex-platform/work-on ghc ./. --command "cabal configure --enable-tests && cabal build"
41+- bash ./deploy.sh
42+
43+cache:
44+ directories:
45+ - /nix
46+ - $HOME/.cabal/packages
47+ - $HOME/.cabal/store
48+
49+env:
50+ global:
51+ - ENCRYPTION_LABEL: "3c89d919c82e"
52+ - COMMIT_AUTHOR_EMAIL: "imalsogreg@gmail.com"
ChangeLog.mddeleted−60
@@ -1,60 +0,0 @@
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−
29−0.3
30−---
31−
32−- **Addition of the 'Servant.Reflex.Multi' module** which allows the user
33−to choose some '(Applicative f, Traversable f) => f' for collecting
34−endpoint parameters. The traversable instance is used for passing
35−multiple 'XhrRequest's in response to a single event trigger. The
36−Applicative instance is used to combine parameters. For example,
37−'Capture "id" Name :> QueryParam "greeting" Text :> Get '[JSON] Text'
38−will generate a client function:
39−`Dynamic t (f Name) -> Dynamic t (f greeting) -> Event t tag ->
40− m (Event t (f (ReqResult tag Text)))`
41−Calling that function with 'f' chosen to be list ('[]'), this call
42−`clientFun
43−(constDyn ["Greg", "Bernie"])
44−(constDyn ["Greetings", "Hey"])
45−trigger`
46−would produce four XhrRequests per 'trigger' event, one for each
47−combination of possible parameters, and one response event
48−would carry a list of the four responses.
49−A 'zip-wise' combination of the parameters can be chosen with
50−a different applicative wrapper: 'ZipList'
51−
52−- **Event tags**. A new type parameter lets users choose a payload
53−value to attach to outgoing requests at the point of triggering,
54−and which is embedded in the response, allowing individual
55−request-response pairs to be followed. The response's tag has been
56−added to each constructor `ReqResult tag a` type.
57−
58−- **Improved Unicode support** Thanks to Schell Scivally
59−(https://github.com/schell) for identifying and fixing a UTF-8
60−encoding bug!
README.md+80−139
@@ -1,36 +1,82 @@
1+Note: work in progress.
2+
13# servant-reflex
24
3−[![Build Status](https://travis-ci.org/imalsogreg/servant-reflex.svg?branch=master)](https://travis-ci.org/imalsogreg/servant-reflex)
5+[![Build Status](https://travis-ci.org/imalsogreg/servant-reflex.svg?branch=dynamic)](https://travis-ci.org/imalsogreg/servant-reflex)
6+
7+
8+This library lets you automatically derive [`reflex-dom`](https://github.com/reflex-frp/reflex-dom) clients that query each endpoint of a [`servant`](htps://github.com/haskell-servant/servant) webservice.
9+
10+## Building the library and test server
11+
12+### With `reflex-platform`:
13+
14+First build the library:
15+
16+```
17+git clone https://github.com/imalsogreg/servant-reflex
18+cd servant-reflex
19+git submodule update --init --recursive
20+./build.sh
21+./toSite.sh
22+```
23+
24+(the `toSite.sh` script copies the generated javascript to the server's static assets directory)
25+
26+
27+Then build the test server (not in a nix-shell):
28+
29+```
30+./init-sandbox.sh
31+cd testserver && cabal install --only-dep && cabal build && cd ..
32+
33+```
434
5−## `servant-reflex` lets you share your `servant` APIs with the frontend
635
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.
36+### Or, with a system-wide ghcjs
37+
38+You will need a recent [GHCJS installation](https://github.com/ghcjs/ghcjs), or use the [reflex-platform](https://github.com/reflex-frp/reflex-platform). A [snap](https://github.com/snapframework) server using [servant-snap](https://github.com/haskell-servant/servant-snap) is provided for serving the api. `Snap 1.0` is not yet on Hackage (and servant-snap is still experimental), but we bundle the sources as a git submodule. To install everything with cabal:
39+
40+```
41+git clone https://github.com/imalsogreg/servant-reflex
42+cd servant-reflex
43+git submodule update --init --recursive
44+./init-sandbox.sh
45+cd testserver && cabal install --only-dep && cabal build && cd ..
46+cabal install --only-dep
47+cabal build
48+./toSite
49+```
50+
51+The `toSite.hs` script copies the ghcjs-generated files into the server's static directory.
52+
53+## Running the example site
54+
55+The server must be run from the directory where static assets live:
56+
57+```
58+cd testserver
59+dist/build/back/back -p 8001
60+```
1461
62+And simply browse to `localhost:8001`
1563
1664## Example
1765
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:
66+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:
2067
2168```haskell
2269type API = "getint" :> Get '[JSON] Int
23− :<|> "sayhi" :> QueryParam "username" Text
24− :> QueryParams "greetings" Text
70+ :<|> "sayhi" :> QueryParam "username" String
71+ :> QueryParams "greetings" String
2572 :> QueryFlag "gusto"
26− :> Get '[JSON] Text
73+ :> Get '[JSON] String
2774 :<|> "double" :> ReqBody '[JSON] Double
2875 :> Post '[JSON] Double
2976 :<|> Raw
3077```
3178
32−`servant-reflex` then computes client functions that can query the API through
33−an `XhrRequest`.
79+`servant-reflex` then computes functions that can query the API through an `XhrRequest`.
3480
3581```haskell
3682
@@ -39,51 +85,37 @@ an `XhrRequest`.
3985 -- servant-reflex computes FRP functions for each API endpoint
4086 let (getint :<|> sayhi :<|> doubleit :<|> _) = client (Proxy :: Proxy API)
4187 (Proxy :: Proxy m)
42− (Proxy :: Proxy ())
4388 (constDyn (BasePath "/"))
4489```
4590
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.
91+These client functions are computed from the API and manage serialization, XhrRequest generation, and deserialization for you. `a` parameters become `Dynamic t (Either String a)` values. You provide a trigger event and receive an `Event t (ReqResult a)`, with responses from the API server (which you would write with `servant-server`).
5692
5793```haskell
5894 -- No need to write these functions. servant-reflex creates them for you!
5995 getint :: MonadWidget t m
6096 => Event t () -- ^ Trigger the XHR Request
61− -> m (Event t (ReqResult () Int)) -- ^ Consume the answer
97+ -> m (Event t (ReqResult Int)) -- ^ Consume the answer
6298
6399 sayhi :: MonadWidget t m
64− => Dynamic t (QParam Text)
65− -- ^ One input parameter - the 'name', wrapped in 'QParam'
66− -> Dynamic t [Text]
100+ => Dynamic t (Either String String)
101+ -- ^ One input parameter - the 'name'
102+ -> Dynamic t [String]
67103 -- ^ Another input: list of preferred greetings
68104 -> Dynamic t Bool
69105 -- ^ Flag for capitalizing the response
70106 -> Event t ()
71107 -- ^ Trigger the XHR Request
72− -> m (Event t (ReqResult () Text))
108+ -> m (Event t (ReqResult String))
73109
74110 doubleit :: MonadWidget t m
75− => Dynamic t (Either Text Double)
111+ => Dynamic t (Either String Double)
76112 -> Event t ()
77− -> m (Event t (ReqResult () Double))
113+ -> m (Event t (ReqResult Double))
78114```
79115
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:
116+Plug any of these functions into your reflex frontend to consume backend servant services. *Isomorphic!*
117+
118+`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:
87119
88120```haskell
89121 -- ... continued ...
@@ -101,8 +133,7 @@ elimination functions to filter the result type you care about, like this:
101133 dynText =<< holdDyn "" (leftmost [errs, const "" <$> ys])
102134```
103135
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:
136+This example builds some input fields to enter API parameters, buttons to trigger the API calls, and text elements to show the results:
106137
107138```haskell
108139 elClass "div" "int-demo" $ do
@@ -111,7 +142,7 @@ trigger the API calls, and text elements to show the results:
111142 display =<< holdDyn (Just 0) serverInts
112143
113144 elClass "div" "hello-demo" $ do
114− nameText <- QParamSome . value <$> textInput def
145+ nameText <- value <$> textInput def
115146 greetings <- (fmap words . value) <$> textInput def
116147 withGusto <- checkbox def
117148 helloButton <- button "Say hi"
@@ -125,100 +156,10 @@ trigger the API calls, and text elements to show the results:
125156 display =<< holdDyn Nothing outputDouble
126157```
127158
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.
133−
134−
135−## Building the library and test server
136−
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.
144−
145−```
146−nix build -f travis.nix testserver -o server
147−```
148−
149−Point it at the static directory and run it:
150−
151−```
152−STATIC_DIR=server/static server/back -p 8000
153−```
154−
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).**
161−
162−
163−## Tagging requests
159+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.
164160
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.
169−
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:
175−
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− ...
200−```
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)))
216−```
161+## TODOs
217162
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.
163+ - Request Headers
164+ - Tests
165+ - Code cleanup
build.shnew file+3
@@ -0,0 +1,3 @@
1+#!/bin/sh
2+
3+deps/reflex-platform/work-on ./overrides.nix ./. --run "cabal configure --ghcjs && cabal build"
default.nix+12−16
@@ -1,21 +1,17 @@
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−}:
1+{ mkDerivation, exceptions, http-types, reflex, reflex-dom, servant }:
2+
73mkDerivation {
84 pname = "servant-reflex";
9− version = "0.3.6";
10− src = ./.;
11− isLibrary = true;
5+ version = "0.1";
6+ src = builtins.filterSource (path: type: baseNameOf path != ".git") ./.;
127 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
8+ isLibrary = true;
9+ buildDepends = [
10+ exceptions
11+ http-types
12+ reflex
13+ reflex-dom
14+ servant
1815 ];
19− description = "servant API generator for reflex apps";
20− license = stdenv.lib.licenses.bsd3;
16+ license = null;
2117}
testdriver/deploy-code-coverage.sh → deploy.shrenamed

The content is the same.

deps/ghcjs-domnew file+1

Submodule changed.

deps/reflexnew file+1

Submodule changed.

deps/reflex-domnew file+1

Submodule changed.

deps/reflex-dom-contribnew file+1

Submodule changed.

deps/reflex-platformnew file+1

Submodule changed.

deps/servantnew file+1

Submodule changed.

deps/servant-snapnew file+1

Submodule changed.

exec/API.hs+4−29
@@ -1,32 +1,10 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE TypeOperators #-}
1+{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE TypeOperators #-}
43
54module API where
65
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−
6+import Data.Text (Text)
7+import Servant.API
308
319-- | API spec for server, client, and docs
3210type API = "getunit" :> Get '[JSON] ()
@@ -38,9 +16,6 @@ type API = "getunit" :> Get '[JSON] ()
3816 :<|> "double" :> ReqBody '[JSON] Double
3917 :> Post '[JSON] Double
4018 :<|> "a" :> "b" :> QueryFlag "gusto" :> Get '[JSON] Text
41− :<|> "qna" :> ReqBody '[JSON] Question
42− :> Post '[JSON] Answer
43− :<|> "secret" :> BasicAuth "realm" () :> Get '[JSON] Int
4419 :<|> Raw
4520
4621type GET = Get '[JSON] ()
exec/Example.hs+40−148
@@ -1,210 +1,105 @@
1−{-# LANGUAGE DataKinds #-}
21{-# LANGUAGE FlexibleContexts #-}
32{-# LANGUAGE GADTs #-}
43{-# LANGUAGE OverloadedStrings #-}
54{-# LANGUAGE RankNTypes #-}
6−{-# LANGUAGE RecursiveDo #-}
75{-# LANGUAGE ScopedTypeVariables #-}
86
97module Main where
108
11−------------------------------------------------------------------------------
129import Data.Bool
1310import Data.Maybe
14−import Control.Monad.Fix (MonadFix)
15−import Data.Monoid (First(..), (<>))
11+import Data.Monoid
1612import Data.Text (Text)
1713import qualified Data.Text as T
18−import qualified Data.Text.Encoding as T
19−import GHC.TypeLits
2014import Servant.API
15+import Servant.Reflex
2116import API
2217import Data.Proxy
2318import Text.Read (readMaybe)
24−import Reflex.Dom.Core hiding (run, mainWidget)
25−import Reflex.Dom (mainWidget)
26−------------------------------------------------------------------------------
27−import Servant.Reflex
28−import Servant.Reflex.Multi
29−
19+import Reflex.Dom
3020
3121api :: Proxy API
3222api = Proxy
3323
3424main :: IO ()
35−main = mainWidget $ do
36− divClass "example-base" run
37− divClass "example-multi" runMulti
38−
39−
40−runMulti :: forall t m. (SupportsServantReflex t m,
41− DomBuilder t m,
42− DomBuilderSpace m ~ GhcjsDomSpace,
43− MonadFix m,
44− PostBuild t m,
45− MonadHold t m) => m ()
46−runMulti = do
47− url <- baseUrlWidget
48− el "br" blank
49− let (_ :<|> _ :<|> sayHi :<|> dbl :<|> _ :<|> _ :<|> _ :<|> _ ) =
50− clientA api (Proxy :: Proxy m) (Proxy :: Proxy []) (Proxy :: Proxy Int) url
51−
52− num :: Dynamic t (Either Text Double) <- fmap (note "No read" . readMaybe . T.unpack) . value <$> textInput def
53− num2 :: Dynamic t (Either Text Double) <- fmap (note "No read" . readMaybe . T.unpack) . value <$> textInput def
54−
55− b <- button "Run dbl multi"
56− reqCount :: Dynamic t Int <- count b
57− r <- dbl ((\x y -> [x,y]) <$> num <*> num2) (tag (current reqCount) b)
58− dynText =<< holdDyn "Waiting" (T.pack . show . fmap reqSuccess <$> r)
59−
60− lastInd <- holdDyn [] $ fmap reqTag <$> r
61− display lastInd
62−
63− divClass "demo-group" $ do
64− nms <- fmap (fmap T.words . value) $ divClass "" $ do
65− text "Names"
66− textInput def
67− grts <- fmap (fmap T.words . value) $ divClass "" $ do
68− text "Greetings"
69− textInput def
70− gust <- fmap (value) $ divClass "gusto-input" $ checkbox False def
71− 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')
77−
78−
79− return ()
80−
81−run :: forall t m. (SupportsServantReflex t m,
82− DomBuilder t m,
83− DomBuilderSpace m ~ GhcjsDomSpace,
84− MonadFix m,
85− PostBuild t m,
86− MonadHold t m) => m ()
87−run = mdo
88−
89− reqCount <- count $ leftmost
90− [() <$ unitBtn, () <$ intBtn, () <$ sayHiClicks, () <$ dblBtn, () <$ mpGo]
25+main = mainWidget run
26+
27+
28+run :: forall t m. MonadWidget t m => m ()
29+run = do
30+
9131 -- Allow user to choose the url target for the request
9232 -- (alternatively we could just `let url = constDyn (BasePath "/")`)
9333 url <- baseUrlWidget
9434 el "br" (return ())
95− dynText $ showBaseUrl <$> url
96−
35+ dynText =<< mapDyn showBaseUrl url
9736 el "br" (return ())
9837
9938 -- 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
39+ let (getUnit :<|> getInt :<|> sayhi :<|> dbl :<|> multi :<|> doRaw) =
40+ client api (Proxy :: Proxy m) url
10541
106− c2 = client (Proxy :: Proxy ComprehensiveAPI) (Proxy :: Proxy m) (Proxy :: Proxy ()) url -- Just make sure this compiles for now
107−
108− (unitBtn, intBtn) <- elClass "div" "demo-group" $ do
109− unitBtn <- divClass "unit-button" $ button "Get unit"
110− intBtn <- divClass "int-button" $ button "Get int"
42+ elClass "div" "demo-group" $ do
43+ unitBtn <- button "Get unit"
44+ intBtn <- button "Get int"
11145
112− unitResponse <- getUnit $ tag (current reqCount) unitBtn
113− intResponse :: Event t (ReqResult Int Int) <- getInt $ tag (current reqCount) intBtn
46+ unitResponse <- getUnit unitBtn
47+ intResponse :: Event t (ReqResult Int) <- getInt intBtn
11448
115− score <- foldDyn (+) 0 (fmapMaybe reqSuccess (intResponse))
49+ score <- foldDyn (+) 0 (fmapMaybe reqSuccess intResponse)
11650
11751 r <- holdDyn "Waiting" $ fmap showXhrResponse $
118− leftmost [fmapMaybe response (unitResponse)
119− ,fmapMaybe response (intResponse)
52+ leftmost [fmapMaybe response unitResponse
53+ ,fmapMaybe response intResponse
12054 ]
121− divClass "unit-int-response" $ el "p" $ dynText r >> el "br" (return ()) >> text "Total: " >> display score
122− return (unitBtn, intBtn)
55+ dynText r >> el "br" (return ()) >> text "Total: " >> display score
12356
124− sayHiClicks <- elClass "div" "demo-group" $ do
57+ elClass "div" "demo-group" $ do
12558
12659 text "Name"
12760 el "br" $ return ()
128− inp :: Dynamic t Text <- fmap value $ divClass "name-input" $ (textInput def)
61+ inp :: Dynamic t Text <- fmap value (textInput def)
12962 let checkedName = fmap (\i -> bool (QParamSome i) (QParamInvalid "Need a name") (T.null i)) inp
13063 el "br" $ return ()
13164
13265 text "Greetings (space-separated)"
13366 el "br" $ return ()
134− greetings <- fmap (fmap T.words . value) $
135− divClass "greetings-input" $ (textInput def)
67+ greetings <- fmap (fmap T.words . value) (textInput def)
13668
13769 el "br" $ return ()
13870
139− gusto <- fmap value $ divClass "gusto-input" $ checkbox False def
71+ gusto <- value <$> checkbox False def
14072
14173 el "br" $ return ()
142− sayHiClicks :: Event t () <- divClass "hi-button" $ button "Say hi"
143− let triggers = leftmost [sayHiClicks, () <$ updated inp]
74+ sayhiClicks :: Event t () <- button "Say hi"
75+ let triggers = leftmost [sayhiClicks, () <$ updated inp]
14476
145− resp <- sayhi checkedName greetings gusto (tag (current reqCount) triggers)
146− divClass "greeting-response" $ dynText =<<
147− holdDyn "No hi yet" (leftmost [ fmapMaybe reqSuccess (resp)
148− , fmapMaybe reqFailure (resp)])
149− return sayHiClicks
77+ resp <- sayhi checkedName greetings gusto triggers
78+ dynText =<< holdDyn "No hi yet" (leftmost [fmapMaybe reqSuccess resp, fmapMaybe reqFailure resp])
15079
151− dblBtn <- elClass "div" "demo-group" $ do
80+ elClass "div" "demo-group" $ do
15281 text "A Double to double"
15382 el "br" $ return ()
154− 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) $
157− dblinp) (tag (current reqCount) dblBtn)
158− divClass "double-errors" $ dynText =<<
159− holdDyn "(no errors)" (fmapMaybe reqFailure (dblResp))
83+ dblinp <- value <$> textInput def
84+ dblBtn <- button "Double it"
85+ dblResp <- dbl (fmap (note "read failure" . readMaybe . T.unpack) $ dblinp) dblBtn
86+ dynText =<< holdDyn "(no errors)" (fmapMaybe reqFailure dblResp)
16087 el "br" (return ())
161− divClass "double-result" $ el "p" $ dynText =<<
162− holdDyn "No number yet" (fmap tShow $
163− fmapMaybe reqSuccess (dblResp))
164− return dblBtn
88+ display =<< holdDyn "No number yet" (fmap tShow $ fmapMaybe reqSuccess dblResp)
16589
166− mpGo <- elClass "div" "demo-group" $ do
90+ elClass "div" "demo-group" $ do
16791 text "Multi-part path"
16892 b <- value <$> checkbox False def
16993 mpGo <- button "Test"
170− multiResp <- multi b (tag (current reqCount) mpGo)
171− dynText =<< holdDyn "No res yet" (fmap tShow $
172− fmapMaybe reqSuccess $
173− (multiResp))
174− return mpGo
175−
176− return ()
177−
178− el "br" $ return ()
179−
180− elClass "div" "demo-group" $ do
181− text "JSON Unicode encoding test"
182− txt <- value <$> textInput def
183− ev <- fmap (1 <$) $ button "Question"
184− let dQ = Right . Question <$> traceDyn "will send: " txt
185− rr <- qna dQ ev
186− el "p" $
187− dynText =<< holdDyn "No Answer" (unAnswer <$> fmapMaybe reqSuccess rr)
188−
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−
94+ multiResp <- multi b mpGo
95+ dynText =<< holdDyn "No res yet" (fmap tShow $ fmapMaybe reqSuccess $ multiResp)
20096
20197showXhrResponse :: XhrResponse -> Text
202−showXhrResponse (XhrResponse stat stattxt rbmay rtmay respHeaders) =
98+showXhrResponse (XhrResponse stat stattxt rbmay rtmay) =
20399 T.unlines ["stat: " <> tShow stat
204100 ,"stattxt: " <> tShow stattxt
205101 ,"resp: " <> maybe "" showRB rbmay
206− ,"rtext: " <> tShow rtmay
207− ,"rHeaders: " <> tShow respHeaders]
102+ ,"rtext: " <> tShow rtmay]
208103
209104tShow :: Show a => a -> Text
210105tShow = T.pack . show
@@ -214,6 +109,3 @@ showRB (XhrResponseBody_Default t) = tShow t
214109showRB (XhrResponseBody_Text t) = tShow t
215110showRB (XhrResponseBody_Blob t) = "<Blob>"
216111showRB (XhrResponseBody_ArrayBuffer t) = tShow t
217−
218−note :: e -> Maybe a -> Either e a
219−note e = maybe (Left e) Right
init-sandbox.shnew file+40
@@ -0,0 +1,40 @@
1+#! /bin/sh
2+
3+cabal sandbox init
4+
5+cabal sandbox add-source deps/snaplet-postgresql-simple
6+
7+#! /bin/sh
8+
9+cabal sandbox init
10+
11+echo "Depend on snap-1.0 from github. Move to Hackage version when snap-1.0 is released"
12+cabal sandbox add-source deps/servant-snap/deps/snap/deps/io-streams
13+cabal sandbox add-source deps/servant-snap/deps/snap/deps/io-streams-haproxy
14+cabal sandbox add-source deps/servant-snap/deps/snap/deps/snap-core
15+cabal sandbox add-source deps/servant-snap/deps/snap/deps/snap-server
16+cabal sandbox add-source deps/servant-snap/deps/snap/deps/xmlhtml
17+cabal sandbox add-source deps/servant-snap/deps/snap/deps/heist
18+cabal sandbox add-source deps/servant-snap/deps/snap-loader-static
19+cabal sandbox add-source deps/servant-snap/deps/snap-loader-static
20+cabal sandbox add-source deps/servant-snap/deps/snap
21+cabal sandbox add-source deps/servant-snap/deps/hspec-snap
22+
23+echo "Depend on particular servant branch with (Raw m a) changes"
24+echo "TODO: Move to hackage version when servant-0.5 is released"
25+cabal sandbox add-source deps/servant-snap/deps/servant/servant
26+cabal sandbox add-source deps/servant-snap/deps/servant/servant-docs
27+cabal sandbox add-source deps/servant-snap/deps/servant/servant-client
28+cabal sandbox add-source deps/servant-snap/deps/servant/servant-blaze
29+cabal sandbox add-source deps/servant-snap/deps/servant/servant-js
30+cabal sandbox add-source deps/servant-snap/deps/servant/servant-lucid
31+cabal sandbox add-source deps/servant-snap/deps/servant/servant-mock
32+
33+cabal sandbox add-source deps/servant-snap
34+cabal sandbox add-source deps/reflex
35+cabal sandbox add-source deps/reflex-dom
36+cabal sandbox add-source deps/reflex-dom-contrib
37+
38+cabal sandbox add-source .
39+
40+cd testserver && cabal sandbox init --sandbox=../.cabal-sandbox && cd ..
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+10
@@ -0,0 +1,10 @@
1+{ reflex-platform, ... }:
2+let
3+ pkgs = import <nixpkgs> {};
4+ reflex-platform = import deps/reflex-platform {};
5+in reflex-platform.ghc.override {
6+ overrides = self: super: {
7+ reflex-dom-contrib = pkgs.haskell.lib.dontCheck (self.callPackage deps/reflex-dom-contrib {});
8+ servant = pkgs.haskell.lib.dontCheck (self.callPackage (reflex-platform.cabal2nixResult deps/servant/servant) {});
9+ };
10+}
overrides.nixnew file+8
@@ -0,0 +1,8 @@
1+{ reflex-platform, ... }:
2+let
3+ pkgs = import <nixpkgs> {};
4+ reflex-platform = import deps/reflex-platform {};
5+in reflex-platform.ghcjs.override {
6+ overrides = self: super: {
7+ };
8+}
testdriver/runTestsAndCoverage.sh → runTestsAndCoverage.shrenamed

The content is the same.

servant-reflex.cabal+31−36
@@ -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.2
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
@@ -11,60 +11,55 @@ Category: Web
1111Build-type: Simple
1212Cabal-version: >=1.10
1313
14−Flag Example
15− description: Enable example
16− default: False
17−
1814library
1915 exposed-modules:
16+ Servant.Reflex
17+
18+ other-modules:
2019 Servant.Common.BaseUrl
2120 Servant.Common.Req
22− Servant.Reflex
23− Servant.Reflex.Multi
2421
2522 hs-source-dirs: src
2623 build-depends:
27− base >= 4.8 && < 5,
24+ base >= 4.8 && < 4.10,
2825 bytestring >= 0.10 && < 0.11,
2926 case-insensitive >= 1.2.0.4 && < 1.3,
30− containers >= 0.5.6 && < 0.7,
27+ containers >= 0.5.6 && < 0.6,
3128 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,
29+ exceptions >= 0.8 && < 0.9,
30+ ghcjs-dom >= 0.2 && < 0.3,
31+ http-api-data >= 0.2 && < 0.3,
32+ http-media >= 0.6 && < 0.7,
3733 mtl >= 2.2.1 && < 2.3,
3834 network-uri >= 2.6 && < 2.7,
39− reflex >= 0.5 && < 0.9,
40− reflex-dom-core >= 0.6 && < 0.8,
35+ reflex >= 0.4 && < 0.5,
36+ reflex-dom == 0.3 && < 0.4,
4137 safe >= 0.3.9 && < 0.4,
42− servant >= 0.16 && < 0.19,
43− servant-auth >= 0.2.1 && < 0.4,
38+ servant >= 0.5 && < 0.9,
4439 string-conversions >= 0.4 && < 0.5,
4540 text >= 1.2 && < 1.3,
4641 transformers >= 0.4 && < 0.6
4742
48− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields
43+ if impl(ghcjs)
44+ build-depends: ghcjs-base >= 0.2 && < 0.3
45+
46+ ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2
4947
5048 default-language: Haskell2010
5149
5250executable example
53− if flag(Example)
54− buildable: True
55− else
56− 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
51+ build-depends: reflex, servant-reflex, base, scientific, servant, reflex-dom, text
6752 default-language: Haskell2010
6853 main-is: Example.hs
6954 other-modules: API
7055 hs-source-dirs: exec
56+
57+test-suite testsuite
58+ type: exitcode-stdio-1.0
59+ main-is: Tests.hs
60+ hs-source-dirs: test
61+ ghc-prof-options: -auto
62+ ghc-options: -Wall -fwarn-tabs -O2 -fhpc -threaded
63+ other-modules:
64+ default-language: Haskell2010
65+ build-depends: base
shell.nixdeleted−1
@@ -1 +0,0 @@
1−(import ./travis.nix {nativeCompiler = "ghc";}).ghcPkgs.servant-reflex.env
shell.shnew file+3
@@ -0,0 +1,3 @@
1+#!/bin/sh
2+
3+deps/reflex-platform/work-on ./overrides.nix ./.
src/Servant/Common/BaseUrl.hs+20−35
@@ -1,5 +1,3 @@
1−{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE CPP #-}
31{-# LANGUAGE DeriveDataTypeable #-}
42{-# LANGUAGE DeriveGeneric #-}
53{-# LANGUAGE FlexibleContexts #-}
@@ -15,29 +13,16 @@ module Servant.Common.BaseUrl (
1513 -- * functions
1614 , baseUrlWidget
1715 , showBaseUrl
18−
19− -- * constraints
20− , SupportsServantReflex
2116) where
2217
23−import Control.Monad (join)
24−-- import Control.Monad.IO.Class (MonadIO)
25−import Control.Monad.Fix (MonadFix)
26−import Data.Monoid ((<>))
18+import Data.Monoid
2719import Data.Text (Text)
2820import qualified Data.Text as T
2921import GHC.Generics
30−import Language.Javascript.JSaddle.Monad (MonadJSM)
3122import Reflex
32−import Reflex.Dom.Core
23+import Reflex.Dom
3324import Text.Read
3425
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
40−
4126-- | URI scheme to use
4227data Scheme =
4328 Http -- ^ http://
@@ -72,31 +57,31 @@ showBaseUrl (BaseFullUrl urlscheme host port path) =
7257 (Https, 443) -> ""
7358 _ -> ":" <> T.pack (show port)
7459
75−baseUrlWidget :: forall t m .(SupportsServantReflex t m,
76− DomBuilderSpace m ~ GhcjsDomSpace,
77− MonadFix m,
78− PostBuild t m,
79− MonadHold t m,
80− DomBuilder t m)
81− => m (Dynamic t BaseUrl)
60+baseUrlWidget :: forall t m .MonadWidget t m => m (Dynamic t BaseUrl)
8261baseUrlWidget = elClass "div" "base-url" $ do
8362 urlWidget <- dropdown (0 :: Int) (constDyn $ 0 =: "BasePath" <> 1 =: "BaseUrlFull") def
84− let bUrlWidget = ffor (value urlWidget) $ \i -> case i of
85− 0 -> pathWidget
86− 1 -> fullUrlWidget
87− _ -> error "Surprising value"
88− join <$> widgetHold pathWidget (updated bUrlWidget)
63+ bUrlWidget <- forDyn (value urlWidget) $ \i -> case i of
64+ 0 -> pathWidget
65+ 1 -> fullUrlWidget
66+ _ -> error "Surprising value"
67+ joinDyn <$> widgetHold pathWidget (updated bUrlWidget)
8968 where pathWidget :: m (Dynamic t BaseUrl)
9069 pathWidget = do
9170 text "Url base path"
92− t <- inputElement def
93− return $ BasePath <$> value t
71+ t <- textInput (def {_textInputConfig_attributes =
72+ constDyn ("placeholder" =: "/a/b")})
73+ mapDyn BasePath (value t)
9474 fullUrlWidget :: m (Dynamic t BaseUrl)
9575 fullUrlWidget = do
9676 schm <- dropdown Https (constDyn $ Https =: "https" <> Http =: "http") def
97− srv <- inputElement def
77+ srv <- textInput def {_textInputConfig_attributes = constDyn $ "placeholder" =: "example.com"}
9878 text ":"
99− prt <- inputElement def
79+ prt <- textInput def { _textInputConfig_attributes = constDyn $ "placeholder" =: "80"}
10080 port :: Dynamic t Int <- holdDyn 80 (fmapMaybe (readMaybe . T.unpack) $ updated (value prt))
101− path <- inputElement def
102− return $ BaseFullUrl <$> value schm <*> value srv <*> port <*> value path
81+ path <- textInput def { _textInputConfig_attributes = constDyn $ "placeholder" =: "a/b" }
82+ BaseFullUrl `mapDyn` value schm `myApDyn` value srv `myApDyn` port `myApDyn` value path
83+
84+myApDyn :: MonadWidget t m => m (Dynamic t (a -> b)) -> Dynamic t a -> m (Dynamic t b)
85+myApDyn f' a = do
86+ f <- f'
87+ combineDyn ($) f a
src/Servant/Common/Req.hs+101−316
@@ -1,174 +1,101 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
12{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFunctor #-}
33{-# LANGUAGE FlexibleContexts #-}
44{-# LANGUAGE GADTs #-}
55{-# LANGUAGE OverloadedStrings #-}
66{-# LANGUAGE LambdaCase #-}
7−{-# LANGUAGE RankNTypes #-}
87{-# LANGUAGE ScopedTypeVariables #-}
98{-# LANGUAGE TupleSections #-}
10−
119module Servant.Common.Req where
1210
1311-------------------------------------------------------------------------------
14−import Control.Applicative (liftA2, liftA3)
15−import Control.Arrow ((&&&))
16−import Control.Concurrent
17−import Control.Monad (join)
18−import Control.Monad.IO.Class (MonadIO, liftIO)
19−import Data.Bifunctor (first)
20−import qualified Data.ByteString.Builder as Builder
12+import Control.Applicative (liftA2, liftA3)
2113import qualified Data.ByteString.Lazy.Char8 as BL
22−import Data.ByteString (ByteString)
23−import qualified Data.Map as Map
24−import Data.Maybe (catMaybes, fromMaybe)
25−import Data.Functor.Compose
26−import Data.Monoid ((<>))
27−import Data.Proxy (Proxy(..))
28−import Data.Text (Text)
29−import qualified Data.Text as T
30−import qualified Data.Text.Encoding as TE
31−import 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)
35−import Servant.Common.BaseUrl (BaseUrl, showBaseUrl,
36− SupportsServantReflex)
37−import Servant.API.ContentTypes (MimeUnrender(..), NoContent(..))
38−import Web.HttpApiData (ToHttpApiData(..))
14+import qualified Data.Map as Map
15+import Data.Maybe
16+import Data.Monoid
17+import Data.Proxy (Proxy(..))
18+import Data.Text (Text)
19+import qualified Data.Text as T
20+import qualified Data.Text.Encoding as TE
21+import qualified Data.Text.Lazy.Encoding as LTE
22+import qualified Data.Text.Lazy as LT
23+import Reflex
24+import Reflex.Dom
25+import Servant.Common.BaseUrl
26+import Servant.API.ContentTypes
27+import Web.HttpApiData
3928-------------------------------------------------------------------------------
4029import Servant.API.BasicAuth
4130
4231
43−------------------------------------------------------------------------------
44−-- | The result of a request event
45−data ReqResult tag a
46− = ResponseSuccess tag a XhrResponse
47− -- ^ The succesfully decoded response from a request tagged with 'tag'
48− | ResponseFailure tag Text XhrResponse
49− -- ^ The failure response, which may have failed decoding or had
50− -- a non-successful response code
51− | RequestFailure tag Text
52− -- ^ 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'
72−
73−------------------------------------------------------------------------------
74−-- | Simple filter/accessor for successful responses, when you want to
75−-- ignore the error case. For example:
76−-- >> goodResponses <- fmapMaybe reqSuccess <$> clientFun triggers
77−reqSuccess :: ReqResult tag a -> Maybe a
78−reqSuccess (ResponseSuccess _ x _) = Just x
79−reqSuccess _ = Nothing
80−
81−
82−------------------------------------------------------------------------------
83−-- | Simple filter/accessor like 'reqSuccess', but keeping the request tag
84−reqSuccess' :: ReqResult tag a -> Maybe (tag,a)
85−reqSuccess' (ResponseSuccess tag x _) = Just (tag,x)
86−reqSuccess' _ = Nothing
87−
88−
89−------------------------------------------------------------------------------
90−-- | Simple filter/accessor for any failure case
91−reqFailure :: ReqResult tag a -> Maybe Text
92−reqFailure (ResponseFailure _ s _) = Just s
93−reqFailure (RequestFailure _ s) = Just s
94−reqFailure _ = Nothing
95−
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−
103−
104−------------------------------------------------------------------------------
105−-- | Simple filter/accessor for the raw XHR response
106−response :: ReqResult tag a -> Maybe XhrResponse
107−response (ResponseSuccess _ _ x) = Just x
108−response (ResponseFailure _ _ x) = Just x
109−response _ = Nothing
110−
111−------------------------------------------------------------------------------
112−-- | Retrieve response tag
113−reqTag :: ReqResult tag a -> tag
114−reqTag (ResponseSuccess tag _ _) = tag
115−reqTag (ResponseFailure tag _ _) = tag
116−reqTag (RequestFailure tag _ ) = tag
11732
118−-------------------------------------------------------------------------------
119−-- | You must wrap the parameter of a QueryParam endpoint with 'QParam' to
120−-- indicate whether the parameter is valid and present, validly absent, or
121−-- invalid
122−data QParam a = QParamSome a
123− -- ^ A valid query parameter
124− | QNone
125− -- ^ Indication that the parameter is intentionally absent (the request is valid)
126− | QParamInvalid Text
127− -- ^ Indication that your validation failed (the request isn't valid)
33+data ReqResult a = ResponseSuccess a XhrResponse
34+ | ResponseFailure Text XhrResponse
35+ | RequestFailure Text
36+
37+reqSuccess :: ReqResult a -> Maybe a
38+reqSuccess (ResponseSuccess x _) = Just x
39+reqSuccess _ = Nothing
40+
41+reqFailure :: ReqResult a -> Maybe Text
42+reqFailure (ResponseFailure s _) = Just s
43+reqFailure (RequestFailure s) = Just s
44+reqFailure _ = Nothing
45+
46+response :: ReqResult a -> Maybe XhrResponse
47+response (ResponseSuccess _ x) = Just x
48+response (ResponseFailure _ x) = Just x
49+response _ = Nothing
50+
12851
52+data QParam a = QParamSome a | QNone | QParamInvalid Text
12953
13054qParamToQueryPart :: ToHttpApiData a => QParam a -> Either Text (Maybe Text)
13155qParamToQueryPart (QParamSome a) = Right (Just $ toQueryParam a)
13256qParamToQueryPart QNone = Right Nothing
13357qParamToQueryPart (QParamInvalid e) = Left e
13458
135−
13659data QueryPart t = QueryPartParam (Dynamic t (Either Text (Maybe Text)))
13760 | QueryPartParams (Dynamic t [Text])
13861 | QueryPartFlag (Dynamic t Bool)
13962
140−
141−-------------------------------------------------------------------------------
142−-- The data structure used to build up request information while traversing
143−-- the shape of a servant API
14463data Req t = Req
14564 { reqMethod :: Text
14665 , reqPathParts :: [Dynamic t (Either Text Text)]
14766 , qParams :: [(Text, QueryPart t)]
14867 , reqBody :: Maybe (Dynamic t (Either Text (BL.ByteString, Text)))
14968 , headers :: [(Text, Dynamic t (Either Text Text))]
150− , respHeaders :: XhrResponseHeaders
15169 , authData :: Maybe (Dynamic t (Maybe BasicAuthData))
15270 }
15371
154−defReq :: Req t
155−defReq = Req "GET" [] [] Nothing [] def Nothing
72+defReq :: Reflex t => Req t
73+defReq = Req "GET" [] [] Nothing [] Nothing
15674
157−prependToPathParts :: Dynamic t (Either Text Text) -> Req t -> Req t
75+prependToPathParts :: Reflex t => Dynamic t (Either Text Text) -> Req t -> Req t
15876prependToPathParts p req =
15977 req { reqPathParts = p : reqPathParts req }
16078
16179addHeader :: (ToHttpApiData a, Reflex t) => Text -> Dynamic t (Either Text a) -> Req t -> Req t
162−addHeader name val req = req { headers = (name, (fmap . fmap) (TE.decodeUtf8 . toHeader) val) : headers req }
80+addHeader name val req = req { headers = (name, (fmap . fmap) (unpack . toHeader) val) : headers req }
81+
82+
83+-- * performing requests
16384
85+displayHttpRequest :: Text -> Text
86+displayHttpRequest httpmethod = "HTTP " <> httpmethod <> " request"
87+
88+-- | This function actually performs the request.
89+performRequest :: forall t m.MonadWidget t m
90+ => Text
91+ -> Req t
92+ -> Dynamic t BaseUrl
93+ -> Event t ()
94+ -> m (Event t XhrResponse, Event t Text)
95+ -- -> ExceptT ServantError IO ( Int, ByteString, MediaType
96+ -- , [HTTP.Header], Response ByteString)
97+performRequest reqMeth req reqHost trigger = do
16498
165−reqToReflexRequest
166− :: forall t. Reflex t
167− => Text
168− -> Dynamic t BaseUrl
169− -> Req t
170− -> Dynamic t (Either Text (XhrRequest XhrPayload))
171−reqToReflexRequest reqMeth reqHost req =
17299 let t :: Dynamic t [Either Text Text]
173100 t = sequence $ reverse $ reqPathParts req
174101
@@ -179,22 +106,18 @@ reqToReflexRequest reqMeth reqHost req =
179106 urlParts = fmap sequence t
180107
181108 urlPath :: Dynamic t (Either Text Text)
182− urlPath = (fmap.fmap)
183− (T.intercalate "/" . fmap escape)
184− urlParts
109+ urlPath = (fmap.fmap) (T.intercalate "/") urlParts
185110
186111 queryPartString :: (Text, QueryPart t) -> Dynamic t (Maybe (Either Text Text))
187112 queryPartString (pName, qp) = case qp of
188113 QueryPartParam p -> ffor p $ \case
189114 Left e -> Just (Left e)
190− Right (Just a) -> Just (Right $ pName <> "=" <> escape a)
115+ Right (Just a) -> Just (Right $ pName <> "=" <> a)
191116 Right Nothing -> Nothing
192117 QueryPartParams ps -> ffor ps $ \pStrings ->
193118 if null pStrings
194119 then Nothing
195− else Just . Right
196− . T.intercalate "&"
197− $ fmap (\p -> pName <> "=" <> escape p) pStrings
120+ else Just $ Right (T.intercalate "&" (fmap (\p -> pName <> "=" <> p) pStrings))
198121 QueryPartFlag fl -> ffor fl $ \case
199122 True -> Just $ Right pName
200123 False -> Nothing
@@ -205,8 +128,8 @@ reqToReflexRequest reqMeth reqHost req =
205128 queryPartStrings' = fmap (sequence . catMaybes) $ sequence queryPartStrings :: Dynamic t (Either Text [Text])
206129 queryString :: Dynamic t (Either Text Text) =
207130 ffor queryPartStrings' $ \qs -> fmap (T.intercalate "&") qs
208− xhrUrl = (liftA3 . liftA3) (\a p q -> a </> if T.null q then p else p <> "?" <> q)
209− baseUrl urlPath queryString
131+-- ffor queryPartStrings' $ \qs -> fmap (T.intercalate "&") (sequence qs)
132+ xhrUrl = (liftA3 . liftA3) (\a p q -> a </> if T.null q then p else p <> "?" <> q) baseUrl urlPath queryString
210133 where
211134 (</>) :: Text -> Text -> Text
212135 x </> y | ("/" `T.isSuffixOf` x) || ("/" `T.isPrefixOf` y) = x <> y
@@ -221,33 +144,20 @@ reqToReflexRequest reqMeth reqHost req =
221144
222145 mkConfigBody :: Either Text [(Text,Text)]
223146 -> (Either Text (BL.ByteString, Text))
224− -> Either Text (XhrRequestConfig XhrPayload)
147+ -> Either Text XhrRequestConfig
225148 mkConfigBody ehs rb = case (ehs, rb) of
226149 (_, Left e) -> Left e
227150 (Left e, _) -> Left e
228151 (Right hs, Right (bBytes, bCT)) ->
229− Right $ XhrRequestConfig
230− { _xhrRequestConfig_sendData = bytesToPayload bBytes
231− , _xhrRequestConfig_headers =
232− Map.insert "Content-Type" bCT (Map.fromList hs)
233− , _xhrRequestConfig_user = Nothing
234− , _xhrRequestConfig_password = Nothing
235− , _xhrRequestConfig_responseType = Just XhrResponseType_ArrayBuffer
236− , _xhrRequestConfig_withCredentials = False
237− , _xhrRequestConfig_responseHeaders = def
238− }
239−
240− xhrOpts :: Dynamic t (Either Text (XhrRequestConfig XhrPayload))
152+ Right $ def { _xhrRequestConfig_sendData = Just (BL.unpack bBytes)
153+ , _xhrRequestConfig_headers =
154+ Map.insert "Content-Type" bCT (Map.fromList hs)}
155+
156+ xhrOpts :: Dynamic t (Either Text (XhrRequestConfig LT.Text))
241157 xhrOpts = case reqBody req of
242158 Nothing -> ffor xhrHeaders $ \case
243159 Left e -> Left e
244− Right hs -> Right $ def { _xhrRequestConfig_headers = Map.fromList hs
245− , _xhrRequestConfig_user = Nothing
246− , _xhrRequestConfig_password = Nothing
247− , _xhrRequestConfig_responseType = Just XhrResponseType_ArrayBuffer
248− , _xhrRequestConfig_sendData = mempty
249− , _xhrRequestConfig_withCredentials = False
250− }
160+ Right hs -> Right $ def { _xhrRequestConfig_headers = Map.fromList hs }
251161 Just rBody -> liftA2 mkConfigBody xhrHeaders rBody
252162
253163 mkAuth :: Maybe BasicAuthData -> Either Text (XhrRequestConfig x) -> Either Text (XhrRequestConfig x)
@@ -265,168 +175,43 @@ reqToReflexRequest reqMeth reqHost req =
265175
266176 xhrReq = (liftA2 . liftA2) (\p opt -> XhrRequest reqMeth p opt) xhrUrl (addAuth xhrOpts)
267177
268− in xhrReq
269−
270−-- * performing requests
271−
272−displayHttpRequest :: Text -> Text
273−displayHttpRequest httpmethod = "HTTP " <> httpmethod <> " request"
178+ let reqs = tagDyn xhrReq trigger
179+ okReqs = fmapMaybe (either (const Nothing) Just) reqs
180+ badReqs = fmapMaybe (either Just (const Nothing)) reqs
274181
275−-- | This function performs the request
276−performRequests :: forall t m f tag.(SupportsServantReflex t m, Traversable f)
277− => Text
278− -> Dynamic t (f (Req t))
279− -> Dynamic t BaseUrl
280− -> ClientOptions
281− -> Event t tag
282− -> 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
293− return $ getCompose <$> resps
294−
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.
298−performSomeRequestsAsync
299− :: (MonadIO (Performable m),
300− MonadJSM (Performable m),
301−#if !MIN_VERSION_reflex_dom_core(0,7,0)
302− HasWebView (Performable m),
182+#ifndef ghcjs_HOST_OS
183+ resps <- performRequestAsync (fmap LT.toStrict <$> okReqs)
184+#else
185+ resps <- performRequestAsync (fmap LT.unpack <$> okReqs)
303186#endif
304− PerformEvent t m,
305− TriggerEvent t m,
306− Traversable f,
307− IsXhrPayload a,
308− Show a
309− )
310− => ClientOptions
311− -> Event t (f (Either Text (XhrRequest a)))
312− -> m (Event t (f (Either Text XhrResponse)))
313−performSomeRequestsAsync opts =
314− performSomeRequestsAsync' opts newXMLHttpRequest . fmap return
315−
316−
317−------------------------------------------------------------------------------
318−-- | A modified version or Reflex.Dom.Xhr.performRequestsAsync
319−-- that accepts 'f (Either e (XhrRequestb))' events
320−performSomeRequestsAsync'
321− :: (MonadJSM (Performable m), PerformEvent t m, TriggerEvent t m, Traversable f, Show b)
322− => ClientOptions
323− -> (XhrRequest b -> (a -> JSM ()) -> Performable m XMLHttpRequest)
324− -> 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
326− rs <- hrs
327− resps <- forM rs $ \r -> case r of
328− Left e -> do
329− resp <- liftIO $ newMVar (Left e)
330− return resp
331− Right r' -> do
332− resp <- liftIO newEmptyMVar
333− r'' <- liftJSM $ (optsRequestFixup opts) r'
334− _ <- newXhr r'' $ liftIO . putMVar resp . Right
335− return resp
336− _ <- liftIO $ forkIO $ cb =<< forM resps takeMVar
337− return ()
338−
339−
340−
341−type XhrPayload = ByteString
342−bytesToPayload :: BL.ByteString -> XhrPayload
343−bytesToPayload = BL.toStrict
344−
345−
346−performRequestsCT
347− :: (SupportsServantReflex t m,
348− MimeUnrender ct a, Traversable f)
349− => Proxy ct
350− -> Text
351− -> Dynamic t (f (Req t))
352− -> Dynamic t BaseUrl
353− -> ClientOptions
354− -> Event t tag
355− -> 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"
363− return $ fmap
364− (\(t,rs) -> ffor rs $ \r -> case r of
365− Left e -> RequestFailure t e
366− Right g -> evalResponse (decodeResp . _xhrResponse_response) (t,g)
367− )
368− resps
369−
370−
371−performRequestsNoBody
372− :: (SupportsServantReflex t m,
373− Traversable f)
374− => Text
375− -> Dynamic t (f (Req t))
376− -> Dynamic t BaseUrl
377− -> ClientOptions
378− -> Event t tag
379− -> m (Event t (f (ReqResult tag NoContent)))
380−performRequestsNoBody reqMeth reqs reqHost opts trigger = do
381− resps <- performRequests reqMeth reqs reqHost opts trigger
382− let decodeResp = const $ Right NoContent
383− return $ ffor resps $ \(tag,rs) -> ffor rs $ \r -> case r of
384− Left e -> RequestFailure tag e
385− Right g -> evalResponse decodeResp (tag,g)
386−
387−
388−------------------------------------------------------------------------------
389−evalResponse
390− :: (XhrResponse -> Either Text a)
391− -> (tag, XhrResponse)
392− -> ReqResult tag a
393−evalResponse decode (tag, xhr) =
394− let status = _xhrResponse_status xhr
395− okStatus = status >= 200 && status < 400
396− errMsg = fromMaybe
397− ("Empty response with error code " <>
398− T.pack (show $ _xhrResponse_status xhr))
399− (_xhrResponse_responseText xhr)
400− respPayld = if okStatus
401− then either
402− (\e -> ResponseFailure tag e xhr)
403− (\v -> ResponseSuccess tag v xhr)
404− (decode xhr)
405− else ResponseFailure tag errMsg xhr
406− in respPayld
407−
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
413−
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'
419187
188+ return (resps, badReqs)
189+
190+
191+-- TODO implement
192+-- => String -> Req -> BaseUrl -> ExceptT ServantError IO [HTTP.Header]
193+ -- TODO Proxy probably not needed
194+performRequestNoBody ::
195+ forall t m .MonadWidget t m => Text -> Req t -> Dynamic t BaseUrl
196+-- -> Event t () -> m (Event t (Maybe NoContent, XhrResponse))
197+ -> Event t () -> m (Event t (ReqResult NoContent))
198+performRequestNoBody _ _ _ _ = do
199+ -- performRequest reqMeth req reqHost trigger
200+ undefined
201+ -- return hdrs
202+
203+performRequestCT :: (MonadWidget t m, MimeUnrender ct a)
204+ => Proxy ct -> Text -> Req t -> Dynamic t BaseUrl
205+ -> Event t () -> m (Event t (ReqResult a))
206+performRequestCT ct reqMeth req reqHost trigger = do
207+ (resp, badReq) <- performRequest reqMeth req reqHost trigger
208+ let decodes = ffor resp $ \xhr ->
209+ ((mimeUnrender ct . BL.fromStrict . TE.encodeUtf8)
210+ =<< note "No body text" (_xhrResponse_responseText xhr), xhr)
211+ reqs = ffor decodes $ \case
212+ (Right a, r) -> ResponseSuccess a r
213+ (Left e, r) -> ResponseFailure (T.pack e) r
214+ return $ leftmost [reqs, fmap RequestFailure badReq]
420215
421216note :: e -> Maybe a -> Either e a
422217note e = maybe (Left e) Right
423−
424−fmapL :: (e -> e') -> Either e a -> Either e' a
425−fmapL _ (Right a) = Right a
426−fmapL 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+197−370
@@ -1,23 +1,16 @@
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 CPP #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE InstanceSigs #-}
6+{-# LANGUAGE OverloadedStrings #-}
7+{-# LANGUAGE PolyKinds #-}
8+{-# LANGUAGE ScopedTypeVariables #-}
9+{-# LANGUAGE TupleSections #-}
10+{-# LANGUAGE TypeFamilies #-}
11+{-# LANGUAGE TypeOperators #-}
12+{-# LANGUAGE UndecidableInstances #-}
13+{-# LANGUAGE MultiParamTypeClasses #-}
2114
2215-- #include "overlapping-compat.h"
2316-- | This module provides 'client' which can automatically generate
@@ -25,71 +18,23 @@
2518-- API.
2619module Servant.Reflex
2720 ( client
28− , clientWithOpts
29− , clientWithOptsAndResultHandler
30− , clientWithRoute
31− , clientWithRouteAndResultHandler
32− , BuildHeaderKeysTo(..)
33− , toHeaders
34− , HasClient
35− , Client
21+ , HasClient(..)
3622 , module Servant.Common.Req
3723 , module Servant.Common.BaseUrl
3824 ) where
3925
40−------------------------------------------------------------------------------
4126import Control.Applicative
42−import qualified Data.CaseInsensitive as CI
43−import 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)
72−------------------------------------------------------------------------------
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)
92−
27+import Data.Proxy
28+import Data.String.Conversions
29+import Data.Text (Text)
30+import qualified Data.Text as T
31+import Data.Text.Encoding
32+import GHC.TypeLits
33+import Servant.API
34+import Servant.Common.BaseUrl
35+import Servant.Common.Req
36+import Reflex
37+import Reflex.Dom
9338
9439-- * Accessing APIs as a Client
9540
@@ -101,191 +46,116 @@ import Servant.Common.Req (ClientOptions(..),
10146-- > myApi :: Proxy MyApi
10247-- > myApi = Proxy
10348-- >
104−-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
105−-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
106−-- > -> m (Event t (l, ReqResult Book)))
49+-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
50+-- > postNewBook :: Dynamic t (Maybe Book) -> Event t ()
51+-- -> m (Event t (Either XhrError (Book,Book)))
10752-- > (getAllBooks :<|> postNewBook) = client myApi host
10853-- > 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
141−
54+client :: (HasClient t m layout, MonadWidget t m)
55+ => Proxy layout -> Proxy m -> Dynamic t BaseUrl -> Client t m layout
56+client p q baseurl = clientWithRoute p q defReq baseurl
14257
14358-- | This class lets us define how each API combinator
14459-- influences the creation of an HTTP request. It's mostly
14560-- an internal class, you can just use 'client'.
146−class Monad m => HasClient t m layout (tag :: *) where
147− 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
167−
168−
169−instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
170− type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
171−
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
61+class HasClient t m layout where
62+ type Client t m layout :: *
63+ clientWithRoute :: Proxy layout -> Proxy m -> Req t -> Dynamic t BaseUrl -> Client t m layout
17564
17665
66+instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
67+ type Client t m (a :<|> b) = Client t m a :<|> Client t m b
68+ clientWithRoute Proxy q req baseurl =
69+ clientWithRoute (Proxy :: Proxy a) q req baseurl :<|>
70+ clientWithRoute (Proxy :: Proxy b) q req baseurl
71+
17772-- Capture. Example:
17873-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
17974-- >
18075-- > myApi :: Proxy MyApi = Proxy
18176-- >
182−-- > getBook :: SupportsServantReflex t m
77+-- > getBook :: MonadWidget t m
18378-- => Dynamic t BaseUrl
18479-- -> Dynamic t (Maybe Text)
185−-- -> Event t l
186−-- -> m (Event t (l, ReqResult Book))
80+-- -> Event t ()
81+-- -> m (Event t (Either XhrError (Text, Book)))
18782-- > getBook = client myApi (constDyn host)
83+instance (MonadWidget t m, KnownSymbol capture, ToHttpApiData a, HasClient t m sublayout)
84+ => HasClient t m (Capture capture a :> sublayout) where
18885
189−instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout tag)
190− => HasClient t m (Capture capture a :> sublayout) tag where
86+ type Client t m (Capture capture a :> sublayout) =
87+ Dynamic t (Either Text a) -> Client t m sublayout
19188
192− type Client t m (Capture capture a :> sublayout) tag =
193− Dynamic t (Either Text a) -> Client t m sublayout tag
89+ clientWithRoute Proxy q req baseurl val =
90+ clientWithRoute (Proxy :: Proxy sublayout)
91+ q
92+ (prependToPathParts p req)
93+ baseurl
19494
195− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196− clientWithRouteAndResultHandler
197− (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
19895 where p = (fmap . fmap) (toUrlPiece) val
19996
200−
20197-- VERB (Returning content) --
20298instance {-# OVERLAPPABLE #-}
20399 -- Note [Non-Empty Content Types]
204− (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
205− ) => HasClient t m (Verb method status cts' a) tag where
206− type Client t m (Verb method status cts' a) tag =
207− Event t tag -> m (Event t (ReqResult tag a))
100+ (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), MonadWidget t m
101+ ) => HasClient t m (Verb method status cts' a) where
102+ type Client t m (Verb method status cts' a) =
103+ Event t () -> m (Event t (ReqResult a))
208104 -- TODO how to access input types here?
209105 -- 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
212− where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
106+ clientWithRoute Proxy _ req baseurl =
107+ performRequestCT (Proxy :: Proxy ct) method req' baseurl
108+ where method = decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
213109 req' = req { reqMethod = method }
214110
215−
216111-- -- VERB (No content) --
217112instance {-# OVERLAPPING #-}
218− (ReflectMethod method, SupportsServantReflex t m) =>
219− HasClient t m (Verb method status cts NoContent) tag where
220− type Client t m (Verb method status cts NoContent) tag =
221− Event t tag -> m (Event t (ReqResult tag NoContent))
113+ (ReflectMethod method, MonadWidget t m) =>
114+ HasClient t m (Verb method status cts NoContent) where
115+ type Client t m (Verb method status cts NoContent) =
116+ Event t () -> m (Event t (ReqResult NoContent))
222117 -- TODO: how to access input types here?
223118 -- ExceptT ServantError IO NoContent
224− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225− wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
226− where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
227−
228−
229−toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
230−toHeaders r =
231− let hdrs = maybe []
232− (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
233− (Map.toList $ _xhrResponse_headers xhr))
234− (response r)
235− in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
119+ clientWithRoute Proxy _ req baseurl =
120+ performRequestNoBody method req baseurl
121+ where method = decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
122+
123+-- -- HEADERS Verb (Content) --
124+-- -- Headers combinator not treated in fully general case,
125+-- -- in order to deny instances for (Headers ls (Capture "id" Int)),
126+-- -- a combinator that wouldn't make sense
127+-- -- TODO Overlapping??
128+-- instance {-# OVERLAPPABLE #-}
129+-- -- Note [Non-Empty Content Types]
130+-- ( MimeUnrender ct a, BuildHeadersTo ls,
131+-- ReflectMethod method, cts' ~ (ct ': cts),
132+-- MonadWidget t m
133+-- ) => HasClient t m (Verb method status cts' (Headers ls a)) where
134+-- type Client t m (Verb method status cts' (Headers ls a))
135+-- = Event t () -> m (Event t (Maybe a, XhrResponse))
136+-- -- ExceptT ServantError IO (Headers ls a)
137+-- clientWithRoute Proxy req baseurl = do
138+-- let method = reflectMethod (Proxy :: Proxy method)
139+-- (hdrs, resp) <- performRequestCT (Proxy :: Proxy ct) method req baseurl
140+-- return $ Headers { getResponse = resp
141+-- , getHeadersHList = buildHeadersTo hdrs
142+-- }
236143
237−
238−class BuildHeaderKeysTo hs where
239− buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
240−
241−instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242− where buildHeaderKeysTo _ = []
243−
244−instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
245− => 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−
251−
252−-- HEADERS Verb (Content) --
253−-- Headers combinator not treated in fully general case,
254−-- in order to deny instances for (Headers ls (Capture "id" Int)),
255−-- a combinator that wouldn't make sense
256144-- TODO Overlapping??
257−instance {-# OVERLAPPABLE #-}
258− -- Note [Non-Empty Content Types]
259− ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
260− ReflectMethod method, cts' ~ (ct ': cts),
261− SupportsServantReflex t m
262− ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
263− type Client t m (Verb method status cts' (Headers ls a)) tag =
264− Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
265− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
266− let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
267− resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268− wrap $ toHeaders <$> resp
269− where req' = req { respHeaders =
270− OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
271− }
272−
273−
274−-- HEADERS Verb (No content) --
275−instance {-# OVERLAPPABLE #-}
276− ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
277− SupportsServantReflex t m
278− ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
279− type Client t m (Verb method status cts (Headers ls NoContent)) tag
280− = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
281− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
282− let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
283− resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284− wrap $ toHeaders <$> resp
285− where req' = req {respHeaders =
286− OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
287− }
288−
145+-- -- HEADERS Verb (No content) --
146+-- instance {-# OVERLAPPABLE #-}
147+-- ( BuildHeadersTo ls, ReflectMethod method,
148+-- MonadWidget t m
149+-- ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
150+-- type Client t m (Verb method status cts (Headers ls NoContent))
151+-- = Event t () -> m (Event t XhrResponse)
152+-- -- ExceptT ServantError IO (Headers ls NoContent)
153+-- clientWithRoute Proxy req baseurl = do
154+-- let method = reflectMethod (Proxy :: Proxy method)
155+-- hdrs <- performRequestNoBody method req baseurl
156+-- return $ Headers { getResponse = NoContent
157+-- , getHeadersHList = buildHeadersTo hdrs
158+-- }
289159
290160
291161-- HEADER
@@ -302,45 +172,28 @@ instance {-# OVERLAPPABLE #-}
302172-- > -- then you can just use "viewRefer" to query that endpoint
303173-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
304174instance (KnownSymbol sym, ToHttpApiData a,
305− HasClient t m sublayout tag, SupportsServantReflex t m)
306− => HasClient t m (Header sym a :> sublayout) tag where
307−
308− type Client t m (Header sym a :> sublayout) tag =
309− Dynamic t (Either Text a) -> Client t m sublayout tag
310−
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
316− where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
317−
175+ HasClient t m sublayout, MonadWidget t m)
176+ => HasClient t m (Header sym a :> sublayout) where
318177
178+ type Client t m (Header sym a :> sublayout) =
179+ Dynamic t (Either Text a) -> Client t m sublayout
319180
181+ clientWithRoute Proxy q req baseurl eVal =
182+ clientWithRoute (Proxy :: Proxy sublayout)
183+ q
184+ (Servant.Common.Req.addHeader hname eVal req)
185+ baseurl
320186
321187-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
322188-- functions.
323−instance HasClient t m sublayout tag
324− => HasClient t m (HttpVersion :> sublayout) tag where
325−
326− type Client t m (HttpVersion :> sublayout) tag =
327− Client t m sublayout tag
328−
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)
189+instance HasClient t m sublayout
190+ => HasClient t m (HttpVersion :> sublayout) where
342191
192+ type Client t m (HttpVersion :> sublayout) =
193+ Client t m sublayout
343194
195+ clientWithRoute Proxy q =
196+ clientWithRoute (Proxy :: Proxy sublayout) q
344197
345198
346199-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -369,16 +222,17 @@ instance (HasClient t m sublayout tag, KnownSymbol sym)
369222-- > -- then you can just use "getBooksBy" to query that endpoint.
370223-- > -- 'getBooksBy Nothing' for all books
371224-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
372−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
373− => HasClient t m (QueryParam' mods sym a :> sublayout) tag where
225+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
226+ => HasClient t m (QueryParam sym a :> sublayout) where
374227
375− type Client t m (QueryParam' mods sym a :> sublayout) tag =
376− Dynamic t (QParam a) -> Client t m sublayout tag
228+ type Client t m (QueryParam sym a :> sublayout) =
229+ -- TODO (Maybe a), or (Maybe (Maybe a))? (should the user be able to send a Nothing)
230+ Dynamic t (QParam a) -> Client t m sublayout
377231
378232 -- 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
233+ clientWithRoute Proxy q req baseurl mparam =
234+ clientWithRoute (Proxy :: Proxy sublayout) q
235+ (req {qParams = paramPair : qParams req}) baseurl
382236
383237 where pname = symbolVal (Proxy :: Proxy sym)
384238 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -386,8 +240,6 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
386240 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
387241 paramPair = (T.pack pname, p mparam)
388242
389−
390−
391243-- | If you use a 'QueryParams' in one of your endpoints in your API,
392244-- the corresponding querying function will automatically take
393245-- an additional argument, a list of values of the type specified
@@ -416,22 +268,21 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
416268-- > -- 'getBooksBy []' for all books
417269-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
418270-- > -- to get all books by Asimov and Heinlein
419−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
420− => HasClient t m (QueryParams sym a :> sublayout) tag where
271+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
272+ => HasClient t m (QueryParams sym a :> sublayout) where
421273
422− type Client t m (QueryParams sym a :> sublayout) tag =
423− Dynamic t [a] -> Client t m sublayout tag
274+ type Client t m (QueryParams sym a :> sublayout) =
275+ Dynamic t [a] -> Client t m sublayout
424276
425− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
277+ clientWithRoute Proxy q req baseurl paramlist =
278+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
427279
428280 where req' = req { qParams = (T.pack pname, params') : qParams req }
429281 pname = symbolVal (Proxy :: Proxy sym)
430− params' = QueryPartParams $ (fmap . fmap) toQueryParam
282+ params' = QueryPartParams $ (fmap . fmap) (toQueryParam)
431283 paramlist
432284
433285
434−
435286-- | If you use a 'QueryFlag' in one of your endpoints in your API,
436287-- the corresponding querying function will automatically take
437288-- an additional 'Bool' argument.
@@ -456,42 +307,49 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
456307-- > -- 'getBooksBy True' to only get _already published_ books
457308
458309-- TODO Bring back
459−instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
460− => HasClient t m (QueryFlag sym :> sublayout) tag where
310+instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
311+ => HasClient t m (QueryFlag sym :> sublayout) where
461312
462− type Client t m (QueryFlag sym :> sublayout) tag =
463− Dynamic t Bool -> Client t m sublayout tag
313+ type Client t m (QueryFlag sym :> sublayout) =
314+ Dynamic t Bool -> Client t m sublayout
464315
465− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
316+ clientWithRoute Proxy q req baseurl flag =
317+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
467318
468319 where req' = req { qParams = thisPair : qParams req }
469320 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
470321 pName = symbolVal (Proxy :: Proxy sym)
471322
472323
473−
474−-- | Send a raw 'XhrRequest ()' directly to 'baseurl'
475−instance SupportsServantReflex t m => HasClient t m Raw tag where
476− type Client t m Raw tag = Dynamic t (Either Text (XhrRequest ()))
477− -> Event t tag
478− -> m (Event t (ReqResult tag ()))
479−
480− clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
481−
482− let xhrs' = liftA2 (\x path -> case x of
483− Left e -> Left e
484− Right jx -> Right $ jx { _xhrRequest_url = path <> _xhrRequest_url jx }
485− ) xhrs (showBaseUrl <$> baseurl)
486− xhrs'' = attachPromptlyDynWith (flip (,)) xhrs' triggers :: Event t (tag, Either Text (XhrRequest ()))
487− badReq = fmapMaybe (\(t,x) -> either (Just . (t,)) (const Nothing) x) xhrs'' :: Event t (tag, Text)
488− okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
489−
490− resps <- performRequestsAsync okReq
491− wrap $ leftmost [ uncurry RequestFailure <$> badReq
492− , evalResponse (const $ Right ()) <$> resps
493− ]
494−
324+-- | Pick a 'Method' and specify where the server you want to query is. You get
325+-- back the full `Response`.
326+-- TODO redo
327+instance (MonadWidget t m) => HasClient t m Raw where
328+ type Client t m Raw = Dynamic t (Either Text (XhrRequest ()))
329+ -> Event t ()
330+ -> m (Event t (ReqResult ()))
331+
332+ -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
333+ clientWithRoute _ _ _ baseurl xhrs triggers = do
334+ let xhrs' = liftA2 (\x path -> case x of
335+ Left e -> Left e
336+ Right jx -> Right $ jx {_xhrRequest_url = path
337+ <> _xhrRequest_url jx})
338+ xhrs
339+ (showBaseUrl <$> baseurl)
340+ reqs = tagDyn xhrs' triggers
341+ okReq = fmapMaybe hush reqs
342+ badReq = fmapMaybe tattle reqs
343+ resps <- performRequestAsync okReq
344+ return $ leftmost [fmap (ResponseSuccess () ) resps
345+ ,fmap RequestFailure badReq]
346+
347+
348+hush :: Either e a -> Maybe a
349+hush = either (const Nothing) Just
350+
351+tattle :: Either e a -> Maybe e
352+tattle = either Just (const Nothing)
495353
496354-- | If you use a 'ReqBody' in one of your endpoints in your API,
497355-- the corresponding querying function will automatically take
@@ -513,64 +371,59 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
513371-- > where host = BaseUrl Http "localhost" 8080
514372-- > -- then you can just use "addBook" to query that endpoint
515373
516−instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
517− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
374+instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
375+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) where
518376
519− type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520− Dynamic t (Either Text a) -> Client t m sublayout tag
377+ type Client t m (ReqBody (ct ': cts) a :> sublayout) =
378+ Dynamic t (Either Text a) -> Client t m sublayout
521379
522− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
380+ clientWithRoute Proxy q req baseurl body =
381+ clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
524382 where req' = req { reqBody = bodyBytesCT }
525383 ctProxy = Proxy :: Proxy ct
526384 ctString = T.pack $ show $ contentType ctProxy
385+ --ctString = decodeUtf8 . CI.original . M.mainType $ contentType ctProxy
527386 bodyBytesCT = Just $ (fmap . fmap)
528387 (\b -> (mimeRender ctProxy b, ctString))
529388 body
530389
531−
532−
533390-- | Make the querying function append @path@ to the request path.
534−instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
535− type Client t m (path :> sublayout) tag = Client t m sublayout tag
391+instance (KnownSymbol path, HasClient t m sublayout, Reflex t) => HasClient t m (path :> sublayout) where
392+ type Client t m (path :> sublayout) = Client t m sublayout
536393
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
394+ clientWithRoute Proxy q req baseurl =
395+ clientWithRoute (Proxy :: Proxy sublayout) q
396+ (prependToPathParts (pure (Right $ T.pack p)) req)
397+ baseurl
540398
541399 where p = symbolVal (Proxy :: Proxy path)
542400
401+instance HasClient t m api => HasClient t m (Vault :> api) where
402+ type Client t m (Vault :> api) = Client t m api
543403
544−instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
545− type Client t m (Vault :> api) tag = Client t m api tag
546−
547− clientWithRouteAndResultHandler Proxy =
548− clientWithRouteAndResultHandler (Proxy :: Proxy api)
549−
404+ clientWithRoute Proxy q req baseurl =
405+ clientWithRoute (Proxy :: Proxy api) q req baseurl
550406
551−instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
552− type Client t m (RemoteHost :> api) tag = Client t m api tag
407+instance HasClient t m api => HasClient t m (RemoteHost :> api) where
408+ type Client t m (RemoteHost :> api) = Client t m api
553409
554− clientWithRouteAndResultHandler Proxy =
555− clientWithRouteAndResultHandler (Proxy :: Proxy api)
410+ clientWithRoute Proxy q req baseurl =
411+ clientWithRoute (Proxy :: Proxy api) q req baseurl
556412
413+instance HasClient t m api => HasClient t m (IsSecure :> api) where
414+ type Client t m (IsSecure :> api) = Client t m api
557415
416+ clientWithRoute Proxy q req baseurl =
417+ clientWithRoute (Proxy :: Proxy api) q req baseurl
558418
559−instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
560− type Client t m (IsSecure :> api) tag = Client t m api tag
419+instance (HasClient t m api, Reflex t)
420+ => HasClient t m (BasicAuth realm usr :> api) where
561421
562− clientWithRouteAndResultHandler Proxy =
563− clientWithRouteAndResultHandler (Proxy :: Proxy api)
422+ type Client t m (BasicAuth realm usr :> api) = Dynamic t (Maybe BasicAuthData)
423+ -> Client t m api
564424
565−
566−instance (HasClient t m api tag, Reflex t)
567− => HasClient t m (BasicAuth realm usr :> api) tag where
568−
569− type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570− -> Client t m api tag
571−
572− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
573− clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
425+ clientWithRoute Proxy q req baseurl authdata =
426+ clientWithRoute (Proxy :: Proxy api) q req' baseurl
574427 where
575428 req' = req { authData = Just authdata }
576429
@@ -596,29 +449,3 @@ non-empty lists, but is otherwise more specific, no instance will be overall
596449more specific. This in turn generally means adding yet another instance (one
597450for empty and one for non-empty lists).
598451-}
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.hsdeleted−401
@@ -1,401 +0,0 @@
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 #-}
15−
16−module Servant.Reflex.Multi (
17− -- * Compute servant client functions
18− clientA
19− , clientWithOptsA
20− , BaseUrl(..)
21− , Scheme(..)
22−
23− -- * Build QueryParam arguments
24− , QParam(..)
25−
26− -- * Access response data
27− , withCredentials
28−
29− -- * Access response data
30− , ReqResult(..)
31− , reqSuccess
32− , reqSuccess'
33− , reqFailure
34− , response
35−
36− , HasClientMulti(..)
37− ) where
38−
39−------------------------------------------------------------------------------
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)
64−------------------------------------------------------------------------------
65−import Servant.Common.BaseUrl (BaseUrl (..), Scheme (..),
66− SupportsServantReflex)
67−import Servant.Common.Req (ClientOptions,
68− QParam (..), QueryPart (..), Req,
69− ReqResult (..), addHeader, authData,
70− defReq,
71− defaultClientOptions,
72− performRequestsCT,
73− performRequestsNoBody,
74− performSomeRequestsAsync,
75− prependToPathParts, qParamToQueryPart,
76− qParams, reqBody, reqFailure,
77− reqMethod, reqSuccess, reqSuccess',
78− respHeaders, response, withCredentials)
79−import Servant.Reflex (BuildHeaderKeysTo (..), toHeaders)
80−
81−
82−------------------------------------------------------------------------------
83−clientA :: (HasClientMulti t m layout f tag, Applicative f, Reflex t)
84− => Proxy layout -> Proxy m -> Proxy f -> Proxy tag
85− -> Dynamic t BaseUrl -> ClientMulti t m layout f tag
86−clientA p q f tag baseurl =
87− clientWithRouteMulti p q f tag (constDyn (pure defReq)) baseurl
88− defaultClientOptions
89−
90−
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
99−
100−------------------------------------------------------------------------------
101−class HasClientMulti t m layout f (tag :: *) where
102− type ClientMulti t m layout f tag :: *
103− clientWithRouteMulti :: Proxy layout -> Proxy m -> Proxy f -> Proxy tag
104− -> Dynamic t (f (Req t)) -> Dynamic t BaseUrl
105− -> ClientOptions -> ClientMulti t m layout f tag
106−
107−
108−------------------------------------------------------------------------------
109−instance (HasClientMulti t m a f tag, HasClientMulti t m b f tag) =>
110− HasClientMulti t m (a :<|> b) f tag where
111− type ClientMulti t m (a :<|> b) f tag = ClientMulti t m a f tag :<|>
112− 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
116−
117−
118−------------------------------------------------------------------------------
119−instance (SupportsServantReflex t m,
120− ToHttpApiData a,
121− HasClientMulti t m sublayout f tag,
122− Applicative f)
123− => HasClientMulti t m (Capture capture a :> sublayout) f tag where
124−
125− type ClientMulti t m (Capture capture a :> sublayout) f tag =
126− f (Dynamic t (Either Text a)) -> ClientMulti t m sublayout f tag
127−
128− clientWithRouteMulti _ q f tag reqs baseurl opts vals =
129− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag reqs' baseurl opts
130− where
131− reqs' = (prependToPathParts <$> ps <*>) <$> reqs
132− ps = (fmap . fmap . fmap) toUrlPiece vals
133−
134−
135−------------------------------------------------------------------------------
136−-- VERB (Returning content) --
137−instance {-# OVERLAPPABLE #-}
138− -- Note [Non-Empty Content Types]
139− (MimeUnrender ct a,
140− ReflectMethod method, cts' ~ (ct ': cts),
141− SupportsServantReflex t m,
142− Applicative f,
143− Traversable f
144− ) => HasClientMulti t m (Verb method status cts' a) f tag where
145−
146− type ClientMulti t m (Verb method status cts' a) f tag =
147− Event t tag -> m (Event t (f (ReqResult tag a)))
148−
149− clientWithRouteMulti _ _ _ _ reqs baseurl opts =
150− performRequestsCT (Proxy :: Proxy ct) method reqs' baseurl opts
151− where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
152− reqs' = fmap (\r -> r { reqMethod = method }) <$> reqs
153−
154−
155−------------------------------------------------------------------------------
156−-- -- VERB (No content) --
157−instance {-# OVERLAPPING #-}
158− (ReflectMethod method, SupportsServantReflex t m, Traversable f) =>
159− HasClientMulti t m (Verb method status cts NoContent) f tag where
160− type ClientMulti t m (Verb method status cts NoContent) f tag =
161− Event t tag -> m (Event t (f (ReqResult tag NoContent)))
162− -- TODO: how to access input types here?
163− -- ExceptT ServantError IO NoContent
164− clientWithRouteMulti Proxy _ _ _ req baseurl opts =
165− performRequestsNoBody method req baseurl opts
166− where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
167−
168−
169−------------------------------------------------------------------------------
170−instance {-# OVERLAPPABLE #-}
171− -- Note [Non-Empty Content Types]
172− ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
173− ReflectMethod method, cts' ~ (ct ': cts),
174− SupportsServantReflex t m,
175− Traversable f
176− ) => HasClientMulti t m (Verb method status cts' (Headers ls a)) f tag where
177− type ClientMulti t m (Verb method status cts' (Headers ls a)) f tag =
178− Event t tag -> m (Event t (f (ReqResult tag (Headers ls a))))
179− clientWithRouteMulti Proxy _ _ _ reqs baseurl opts triggers = do
180− 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)))
182− return $ fmap toHeaders <$> resp
183− where
184− reqs' = fmap (\r ->
185− r { respHeaders =
186− OnlyHeaders (Set.fromList
187− (buildHeaderKeysTo (Proxy :: Proxy ls)))
188− }) <$> reqs
189−
190−
191−------------------------------------------------------------------------------
192−instance {-# OVERLAPPABLE #-}
193− ( BuildHeadersTo ls,
194− BuildHeaderKeysTo ls,
195− ReflectMethod method,
196− SupportsServantReflex t m,
197− Traversable f
198− ) => HasClientMulti t m (Verb method status
199− cts (Headers ls NoContent)) f tag where
200− type ClientMulti t m (Verb method status cts (Headers ls NoContent)) f tag
201− = Event t tag -> m (Event t (f (ReqResult tag (Headers ls NoContent))))
202− clientWithRouteMulti Proxy _ _ _ reqs baseurl opts triggers = do
203− let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
204− resp <- performRequestsNoBody method reqs' baseurl opts triggers
205− return $ fmap toHeaders <$> resp
206− where reqs' = fmap (\req ->
207− req {respHeaders = OnlyHeaders (Set.fromList
208− (buildHeaderKeysTo (Proxy :: Proxy ls)))
209− }) <$> reqs
210−
211−
212−------------------------------------------------------------------------------
213−instance (KnownSymbol sym,
214− ToHttpApiData a,
215− HasClientMulti t m sublayout f tag,
216− SupportsServantReflex t m,
217− Traversable f,
218− Applicative f)
219− => HasClientMulti t m (Header sym a :> sublayout) f tag where
220−
221− type ClientMulti t m (Header sym a :> sublayout) f tag =
222− f (Dynamic t (Either Text a)) -> ClientMulti t m sublayout f tag
223−
224− clientWithRouteMulti Proxy f q tag reqs baseurl opts eVals =
225− clientWithRouteMulti (Proxy :: Proxy sublayout) f
226− q tag
227− reqs'
228− baseurl opts
229− where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
230− reqs' = ((\eVal req -> Servant.Common.Req.addHeader hname eVal req)
231− <$> eVals <*>) <$> reqs
232−
233−
234−------------------------------------------------------------------------------
235−instance HasClientMulti t m sublayout f tag
236− => HasClientMulti t m (HttpVersion :> sublayout) f tag where
237−
238− type ClientMulti t m (HttpVersion :> sublayout) f tag =
239− ClientMulti t m sublayout f tag
240−
241− clientWithRouteMulti Proxy q f tag =
242− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag
243−
244−
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−
256−------------------------------------------------------------------------------
257−instance (KnownSymbol sym,
258− ToHttpApiData a,
259− HasClientMulti t m sublayout f tag,
260− Reflex t,
261− Applicative f)
262− => HasClientMulti t m (QueryParam sym a :> sublayout) f tag where
263−
264− type ClientMulti t m (QueryParam sym a :> sublayout) f tag =
265− Dynamic t (f (QParam a)) -> ClientMulti t m sublayout f tag
266−
267− -- if mparam = Nothing, we don't add it to the query string
268− -- TODO: Check the above comment
269− clientWithRouteMulti Proxy q f tag reqs baseurl opts mparams =
270− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag
271− reqs' baseurl opts
272−
273− where pname = symbolVal (Proxy :: Proxy sym)
274− p prm = QueryPartParam $ fmap qParamToQueryPart prm
275− paramPair mp = (T.pack pname, p mp)
276− -- reqs' = (\params reqs -> (\req param -> req {qParams = paramPair param : qParams req}) <$> reqs <*> params)
277− -- <$> mparams <*> reqs
278− reqs' = liftA2 (\(pr :: QParam a) (r :: Req t) -> r { qParams = paramPair (constDyn pr) : qParams r })
279− <$> mparams <*> reqs
280−
281−
282−instance (KnownSymbol sym,
283− ToHttpApiData a,
284− HasClientMulti t m sublayout f tag,
285− Reflex t,
286− Applicative f)
287− => HasClientMulti t m (QueryParams sym a :> sublayout) f tag where
288−
289− type ClientMulti t m (QueryParams sym a :> sublayout) f tag =
290− Dynamic t (f [a]) -> ClientMulti t m sublayout f tag
291−
292− clientWithRouteMulti Proxy q f tag reqs baseurl opts paramlists =
293− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag reqs' baseurl opts
294−
295− where req' l r = r { qParams = (T.pack pname, params' (constDyn l)) : qParams r }
296− pname = symbolVal (Proxy :: Proxy sym)
297− params' l = QueryPartParams $ (fmap . fmap) (toQueryParam)
298− l
299− reqs' = liftA2 req' <$> paramlists <*> reqs
300−
301−
302−instance (KnownSymbol sym,
303− HasClientMulti t m sublayout f tag,
304− Reflex t,
305− Applicative f)
306− => HasClientMulti t m (QueryFlag sym :> sublayout) f tag where
307−
308− type ClientMulti t m (QueryFlag sym :> sublayout) f tag =
309− Dynamic t (f Bool) -> ClientMulti t m sublayout f tag
310−
311− clientWithRouteMulti Proxy q f' tag reqs baseurl opts flags =
312− clientWithRouteMulti (Proxy :: Proxy sublayout) q f' tag reqs' baseurl opts
313−
314− where req' f req = req { qParams = thisPair (constDyn f) : qParams req }
315− thisPair f = (T.pack pName, QueryPartFlag f) :: (Text, QueryPart t)
316− pName = symbolVal (Proxy :: Proxy sym)
317− reqs' = liftA2 req' <$> flags <*> reqs
318−
319−
320−instance (SupportsServantReflex t m,
321− Traversable f, Applicative f) => HasClientMulti t m Raw f tag where
322− type ClientMulti t m Raw f tag = f (Dynamic t (Either Text (XhrRequest ())))
323− -> Event t tag
324− -> m (Event t (f (ReqResult tag ())))
325−
326− clientWithRouteMulti _ _ _ _ _ _ opts rawReqs triggers = do
327− let rawReqs' = sequence rawReqs :: Dynamic t (f (Either Text (XhrRequest ())))
328− rawReqs'' = attachPromptlyDynWith (\fxhr t -> Compose (t, fxhr)) rawReqs' triggers
329− resps <- fmap (fmap aux . sequenceA . getCompose) <$> performSomeRequestsAsync opts rawReqs''
330− return resps
331− where
332− aux (tag, Right r) = ResponseSuccess tag () r
333− aux (tag, Left e) = RequestFailure tag e
334−
335−
336−instance (MimeRender ct a,
337− HasClientMulti t m sublayout f tag,
338− Reflex t,
339− Applicative f)
340− => HasClientMulti t m (ReqBody (ct ': cts) a :> sublayout) f tag where
341−
342− type ClientMulti t m (ReqBody (ct ': cts) a :> sublayout) f tag =
343− Dynamic t (f (Either Text a)) -> ClientMulti t m sublayout f tag
344−
345− clientWithRouteMulti Proxy q f tag reqs baseurl opts bodies =
346− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag reqs' baseurl opts
347− where req' b r = r { reqBody = bodyBytesCT (constDyn b) }
348− ctProxy = Proxy :: Proxy ct
349− ctString = T.pack $ show $ contentType ctProxy
350− bodyBytesCT b = Just $ (fmap . fmap)
351− (\b' -> (mimeRender ctProxy b', ctString))
352− b
353− reqs' = liftA2 req' <$> bodies <*> reqs
354−
355−
356−instance (KnownSymbol path,
357− HasClientMulti t m sublayout f tag,
358− Reflex t,
359− Functor f) => HasClientMulti t m (path :> sublayout) f tag where
360− type ClientMulti t m (path :> sublayout) f tag = ClientMulti t m sublayout f tag
361−
362− clientWithRouteMulti Proxy q f tag reqs baseurl =
363− clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag
364− (fmap (prependToPathParts (pure (Right $ T.pack p))) <$> reqs)
365− baseurl
366−
367− where p = symbolVal (Proxy :: Proxy path)
368−
369−
370−instance HasClientMulti t m api f tag => HasClientMulti t m (Vault :> api) f tag where
371− type ClientMulti t m (Vault :> api) f tag = ClientMulti t m api f tag
372−
373− clientWithRouteMulti Proxy q f tag reqs baseurl =
374− clientWithRouteMulti (Proxy :: Proxy api) q f tag reqs baseurl
375−
376−
377−instance HasClientMulti t m api f tag => HasClientMulti t m (RemoteHost :> api) f tag where
378− type ClientMulti t m (RemoteHost :> api) f tag = ClientMulti t m api f tag
379−
380− clientWithRouteMulti Proxy q f tag reqs baseurl =
381− clientWithRouteMulti (Proxy :: Proxy api) q f tag reqs baseurl
382−
383−
384−instance HasClientMulti t m api f tag => HasClientMulti t m (IsSecure :> api) f tag where
385− type ClientMulti t m (IsSecure :> api) f tag = ClientMulti t m api f tag
386−
387− clientWithRouteMulti Proxy q f tag reqs baseurl =
388− clientWithRouteMulti (Proxy :: Proxy api) q f tag reqs baseurl
389−
390−
391−instance (HasClientMulti t m api f tag, Reflex t, Applicative f)
392− => HasClientMulti t m (BasicAuth realm usr :> api) f tag where
393−
394− type ClientMulti t m (BasicAuth realm usr :> api) f tag = Dynamic t (f (Maybe BasicAuthData))
395− -> ClientMulti t m api f tag
396−
397− clientWithRouteMulti Proxy q f tag reqs baseurl opts authdatas =
398− clientWithRouteMulti (Proxy :: Proxy api) q f tag reqs' baseurl opts
399− where
400− req' a r = r { authData = Just (constDyn a) }
401− reqs' = liftA2 req' <$> authdatas <*> reqs
stack.yamldeleted−56
@@ -1,56 +0,0 @@
1−flags: {}
2−extra-package-dbs: []
3−packages:
4−- '.'
5−
6−- location:
7− git: https://github.com/reflex-frp/reflex
8− commit: d78ba4318c425ca9b942dc387d7c5c7ab2d2e095
9− extra-dep: true
10−
11−- location:
12− git: https://github.com/mokus0/dependent-sum.git
13− commit: bbc8ad3a81ea7f2b07ce7d036efd56f2e0f7c6ff
14− extra-dep: true
15−
16−- location:
17− git: https://github.com/gtk2hs/gtk2hs.git
18− commit: 21d3a12a82756d04066e5e4198b35097012ee65b
19− subdirs:
20− - cairo
21− - gio
22− - glib
23− - gtk
24− - pango
25− - tools
26− extra-dep: true
27−
28−- location:
29− git: https://github.com/byorgey/hashtables.git
30− commit: 47d9ed261a5aba66a13d3c4da0e391d338b57fc5
31− extra-dep: true
32−
33−- location:
34− git: https://github.com/afcady/reflex-dom.git
35− commit: 39b5ff23f3ae95d77c909ab3ed4bc4bd9e61f600
36− extra-dep: true
37−
38−- location:
39− git: https://github.com/afcady/dependent-sum-template.git
40− commit: 68fc1a90580ea8f20775491cf651eefea422212a
41− extra-dep: true
42−
43−extra-deps:
44−- cpphs-1.20.4
45−- directory-1.2.7.1
46−- ghcjs-dom-0.2.4.0
47−- haskell-src-exts-1.17.1
48−- haskell-src-meta-0.6.0.14
49−- hlint-1.9.35
50−- prim-uniq-0.1.0.1
51−- primitive-0.6.2.0
52−- ref-tf-0.4.0.1
53−- vector-0.12.0.0
54−- webkitgtk3-javascriptcore-0.13.2.0
55−- zenc-0.1.1
56−resolver: lts-8.3
test/Tests.hsnew file+4
@@ -0,0 +1,4 @@
1+module Main where
2+
3+main :: IO ()
4+main = return ()
testdriver/LICENSE.mddeleted−30
@@ -1,30 +0,0 @@
1−Copyright Greg Hale (c) 2016
2−
3−All rights reserved.
4−
5−Redistribution and use in source and binary forms, with or without
6−modification, are permitted provided that the following conditions are met:
7−
8− * Redistributions of source code must retain the above copyright
9− notice, this list of conditions and the following disclaimer.
10−
11− * Redistributions in binary form must reproduce the above
12− copyright notice, this list of conditions and the following
13− disclaimer in the documentation and/or other materials provided
14− with the distribution.
15−
16− * Neither the name of Greg Hale nor the names of other
17− contributors may be used to endorse or promote products derived
18− from this software without specific prior written permission.
19−
20−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
testdriver/test/Servant/ReflexSpec.hsdeleted−94
@@ -1,94 +0,0 @@
1−{-# language OverloadedStrings #-}
2−
3−module Servant.ReflexSpec where
4−
5−import Control.Concurrent (threadDelay)
6−import Control.Monad.IO.Class (liftIO)
7−import Data.Monoid ((<>))
8−import qualified Data.Text as T
9−import Data.Foldable
10−import Test.WebDriver.Commands.Wait
11−import Test.Hspec.WebDriver
12−import Test.Hspec.WebDriver (chromeCaps)
13−
14−
15−clickingShouldCause :: Selector -> Selector -> Double -> (Element -> Element -> WD Bool) -> WD ()
16−clickingShouldCause inp outp timeLimit s = do
17− inputEl <- findElem inp
18− outputEl <- findElem outp
19− click inputEl
20− _ <- waitUntil timeLimit $ do
21− r <- s inputEl outputEl
22− return r
23− return ()
24−
25−hasInfixText :: Element -> T.Text -> WD Bool
26−hasInfixText el t = getText el >>= \txt -> return $ t `T.isInfixOf` txt
27−
28−spec :: Spec
29−spec = do
30− describe "servant-reflex tests" $ do
31−
32− session "test page" $ using [chromeCaps] $ do
33−
34− it "opens the page" $ runWD $
35− openPage "http://localhost:8000"
36−
37− it "has a div" $ runWD $ do
38− e <- waitUntil 5 $ findElem $ ByCSS "div"
39− e `shouldBeTag` "div"
40−
41− it "has demo-group div" $ runWD $ do
42− e <- findElem $ ByCSS "div.demo-group"
43− e `shouldBeTag` "div"
44−
45− it "doesn't have demo-group-nonexistent div" $ runWD $ do
46− e <- findElems $ ByCSS "div.demo-group.nonexistent"
47− e `shouldBe` []
48−
49− it "can get an int or unit from the API" $ runWD $ do
50− let outEl = ByCSS "div.unit-int-response p"
51− clickingShouldCause (ByCSS "div.int-button > button") outEl 0.1
52− (\i o -> o `hasInfixText` "Just \"100\"")
53− clickingShouldCause (ByCSS "div.unit-button > button") outEl 0.1
54− (\i o -> o `hasInfixText` "Just \"[[]]\"")
55−
56− let setupGreeting = do
57− iName <- findElem $ ByCSS ".name-input input"
58− iGreetings <- findElem $ ByCSS ".greetings-input input"
59− bGusto <- findElem $ ByCSS ".gusto-input input"
60− goBtn <- findElem $ ByCSS ".hi-button button"
61− greetingRes <- findElem $ ByCSS ".greeting-response"
62− return (iName, iGreetings, bGusto, goBtn, greetingRes)
63−
64− it "handle query params" $ runWD $ do
65− (iName, iGreetings, bGusto, goBtn, greetingRes) <- setupGreeting
66− sendKeys "Haskell" iName
67− sendKeys "Hello Hi" iGreetings
68− click goBtn
69− greetingRes `shouldHaveText` "Hello, and Hi, Haskell"
70−
71− it "handles queryflag" $ runWD $ do
72− (iName, iGreetings, bGusto, goBtn, greetingRes) <- setupGreeting
73− click bGusto
74− click goBtn
75− greetingRes `shouldHaveText` "HELLO, AND HI, HASKELL"
76−
77− it "tags dyn promptly" $ runWD $ do
78− (iName, iGreetings, bGusto, goBtn, greetingRes) <- setupGreeting
79− sendKeys "!" iName
80− greetingRes `shouldHaveText` "HELLO, AND HI, HASKELL!"
81−
82−{- Broken. Why?
83− it "handles request bodies" $ runWD $ do
84− dText <- findElem $ ByCSS ".double-input input"
85− dSend <- findElem $ ByCSS ".double-button button"
86− dRes <- findElem $ ByCSS ".double-result p"
87− dErr <- findElem $ ByCSS ".double-errors"
88− sendKeys "200" dText
89− click dSend
90− saveScreenshot "/home/ubuntu/screen.png"
91− liftIO (threadDelay 1000000)
92− dErr `shouldHaveText` "(no errors)"
93− dRes `shouldHaveText` "400.0"
94−-}
testdriver/test/Spec.hsdeleted−1
@@ -1 +0,0 @@
1−{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
testdriver/testdriver.cabaldeleted−26
@@ -1,26 +0,0 @@
1−Name: testdriver
2−Version: 0.2
3−Synopsis: Selenium test driver for Servant reflex
4−Description: Servant reflex API generator
5−License: AllRightsReserved
6−License-file: LICENSE.md
7−Author: Greg Hale, Doug Beardsley
8−Maintainer: imalsogreg@gmail.com
9−Stability: Experimental
10−Category: Web
11−Build-type: Simple
12−Cabal-version: >=1.10
13−
14−executable spec
15− type: exitcode-stdio-1.0
16− main-is: Spec.hs
17− hs-source-dirs: test
18− ghc-prof-options: -auto
19− ghc-options: -Wall -fwarn-tabs -O2 -threaded
20− other-modules:
21− default-language: Haskell2010
22− build-depends: base,
23− hspec,
24− hspec-webdriver,
25− text,
26− webdriver
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+16−41
@@ -2,34 +2,27 @@
22{-# LANGUAGE DeriveGeneric #-}
33{-# LANGUAGE OverloadedStrings #-}
44{-# LANGUAGE PolyKinds #-}
5−{-# LANGUAGE TypeApplications #-}
65{-# LANGUAGE TypeFamilies #-}
76{-# LANGUAGE TypeOperators #-}
87
9−import Control.Monad.IO.Class (liftIO)
10−import Control.Monad.Reader (reader)
118import Data.Aeson
129import Data.Bool
13−import Data.Char (toUpper)
14−import qualified Data.List as L
15−import Data.Maybe (fromMaybe)
10+import Data.Char (toUpper)
11+import qualified Data.List as L
1612import Data.Monoid
1713import Data.Proxy
18−import Data.Text hiding (head, length, map,
19− null, toUpper)
20−import qualified Data.Text as T
21−import qualified Data.Text.IO as T
14+import Data.Text hiding (length, null, map, head, toUpper)
15+import qualified Data.Text as T
2216import GHC.Generics
23−import Servant.Server.Internal.SnapShims
24−import Snap.Core
2517import Snap.Http.Server
18+import Snap.Core
19+import Servant.Server.Internal.SnapShims
2620
27−import Servant
21+import Servant -- hiding (serveDirectory)
2822import Servant.Server
2923-- import Snap.Util.FileServe
30−import System.Environment (lookupEnv)
3124import API
32−import Snap
25+import Snap
3326
3427-- * Example
3528
@@ -43,7 +36,7 @@ instance ToJSON Greet
4336testApi :: Proxy API
4437testApi = Proxy
4538
46−data App = App { appStaticDir :: String }
39+data App = App
4740
4841-- Server-side handlers.
4942--
@@ -51,10 +44,8 @@ data App = App { appStaticDir :: String }
5144-- that represents the API, are glued together using :<|>.
5245--
5346-- 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
47+server :: Server API (Handler App App)
48+server = return () :<|> return 100 :<|> sayhi :<|> dbl :<|> multi :<|> serveDirectory "static"
5849 where sayhi :: Maybe Text -> [Text] -> Bool -> Handler App App Text
5950 sayhi nm greetings withGusto = case nm of
6051 Nothing -> return ("Sorry, who are you?" :: Text)
@@ -66,36 +57,20 @@ server = return () :<|> return 100 :<|> sayhi :<|> dbl
6657 | otherwise = T.intercalate ", " (L.init greetings)
6758 <> ", and " <> L.last greetings <> ", "
6859 return . modifier $ greetPart <> n
69− dbl x = if x `elem` [4,13]
70− then throwError $ err500 { errBody = "No unlucky numbers please" }
71− else return $ x * 2
60+ dbl x = return $ x * 2
7261 multi = return . bool "Box unchecked" "Box Checked"
73− qna q = do
74− liftIO $ do
75− putStrLn $ "qna got: " ++ show q
76− T.putStrLn $ unQuestion q
77− 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
8562
8663-- Turn the server into a WAI app. 'serve' is provided by servant,
8764-- more precisely by the Servant.Server module.
88−test :: Handler App App ()
89−test = serveSnapWithContext testApi
90− (BasicAuthCheck (\_ -> return @(Handler App App) (Authorized ())) :. EmptyContext) server
65+test :: Application (Handler App App)
66+test = serve testApi server
9167
9268initApp :: SnapletInit App App
9369initApp = makeSnaplet "myapp" "example" Nothing $ do
94− staticDir <- fromMaybe "static" <$> liftIO (lookupEnv "STATIC_DIR")
95− addRoutes [("", test)
70+ addRoutes [("", applicationToSnap test)
9671 ,("", serveDirectory "static")
9772 ]
98− return (App staticDir)
73+ return App
9974
10075-- Put this all to work!
10176main :: IO ()
testserver/testserver.cabal+16−17
@@ -1,32 +1,31 @@
1−-- Initial back.cabal generated by cabal init. For further documentation,
1+-- Initial back.cabal generated by cabal init. For further documentation,
22-- see http://haskell.org/cabal/users-guide/
33
44name: testserver
55version: 0.1.0.0
6−-- synopsis:
7−-- description:
6+-- synopsis:
7+-- description:
88license: BSD3
99license-file: LICENSE
1010author: Greg Hale
1111maintainer: imalsogreg@gmail.com
12−-- copyright:
13−-- category:
12+-- copyright:
13+-- category:
1414build-type: Simple
15−-- extra-source-files:
15+-- extra-source-files:
1616cabal-version: >=1.10
1717
1818executable back
1919 main-is: Main.hs
20− -- other-modules:
21− -- 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
20+ -- other-modules:
21+ -- other-extensions:
22+ build-depends: aeson >= 0.9 && < 0.12
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
31− -- hs-source-dirs:
27+ , servant >= 0.7.1 && < 0.8
28+ , servant-snap
29+ , text >= 1.2 && < 1.3
30+ -- 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+}
exec/toSite.sh → toSite.shrenamed−2
@@ -1,3 +1 @@
1−#!/usr/bin/env bash
2−
31cp dist/build/example/example.jsexe/* testserver/static
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− }