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

Submodule changed.

deps/reflex-platformnew file+1

Submodule changed.

deps/servantnew file+1

Submodule changed.

deps/servant-snapnew file+1

Submodule changed.

exec/Example.hs+2−2
@@ -21,8 +21,7 @@ import Servant.API
2121import API
2222import Data.Proxy
2323import Text.Read (readMaybe)
24−import Reflex.Dom.Core hiding (run, mainWidget)
25−import Reflex.Dom (mainWidget)
24+import Reflex.Dom hiding (run)
2625------------------------------------------------------------------------------
2726import Servant.Reflex
2827import Servant.Reflex.Multi
@@ -98,6 +97,7 @@ run = mdo
9897
9998 -- Name the computed API client functions
10099 let tweakRequest = ClientOptions $ \r -> do
100+ putStrLn ("Got req: " ++ show r)
101101 return $ r & withCredentials .~ True
102102 let (getUnit :<|> getInt :<|> sayhi :<|> dbl
103103 :<|> multi :<|> qna :<|> secret :<|> doRaw) =
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+11
@@ -0,0 +1,11 @@
1+{ reflex-platform, ... }:
2+let
3+ c2n = reflex-platform.cabal2nixResult;
4+ dc = reflex-platform.lib.dontCheck;
5+in reflex-platform.ghc.override {
6+ overrides = self: super: {
7+ servant-snap = dc (self.callPackage (c2n deps/servant-snap) {});
8+ heist = dc (self.callPackage (c2n deps/servant-snap/deps/snap/deps/heist) {});
9+ xmlhtml = dc (self.callPackage (c2n deps/servant-snap/deps/snap/deps/xmlhtml) {});
10+ };
11+}
overrides.nixnew file+9
@@ -0,0 +1,9 @@
1+{ reflex-platform, ... }:
2+let
3+ dc = reflex-platform.lib.dontCheck;
4+ c2n = reflex-platform.cabal2nixResult;
5+in
6+reflex-platform.ghcjs.override {
7+ overrides = self: super: {
8+ };
9+}
servant-reflex.cabal+18−24
@@ -1,7 +1,7 @@
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
2+Version: 0.3.3
3+Synopsis: Servant reflex API generator
4+Description: Servant reflex API generator
55License: BSD3
66License-file: LICENSE.md
77Author: Greg Hale, Doug Beardsley
@@ -17,35 +17,38 @@ Flag Example
1717
1818library
1919 exposed-modules:
20− Servant.Common.BaseUrl
21− Servant.Common.Req
2220 Servant.Reflex
2321 Servant.Reflex.Multi
2422
23+ other-modules:
24+ Servant.Common.BaseUrl
25+ Servant.Common.Req
26+
2527 hs-source-dirs: src
2628 build-depends:
27− base >= 4.8 && < 5,
29+ base >= 4.8 && < 4.10,
30+ aeson >= 0.11 && < 1.3,
2831 bytestring >= 0.10 && < 0.11,
2932 case-insensitive >= 1.2.0.4 && < 1.3,
30− containers >= 0.5.6 && < 0.7,
33+ containers >= 0.5.6 && < 0.6,
3134 data-default >= 0.5 && < 0.8,
32− exceptions >= 0.8 && < 0.11,
35+ exceptions >= 0.8 && < 0.9,
3336 ghcjs-dom >= 0.2 && < 0.10,
34− http-api-data >= 0.3.6 && < 0.5,
35− http-media >= 0.6 && < 0.9,
37+ http-api-data >= 0.3.6 && < 0.4,
38+ http-media >= 0.6 && < 0.7,
3639 jsaddle >= 0.8 && < 0.10,
3740 mtl >= 2.2.1 && < 2.3,
3841 network-uri >= 2.6 && < 2.7,
39− reflex >= 0.5 && < 0.9,
40− reflex-dom-core >= 0.6 && < 0.7,
42+ reflex >= 0.5 && < 0.6,
43+ reflex-dom-core == 0.4 && < 0.5,
4144 safe >= 0.3.9 && < 0.4,
42− servant >= 0.16 && < 0.18,
45+ servant >= 0.8 && < 0.12,
4346 servant-auth >= 0.2.1 && < 0.4,
4447 string-conversions >= 0.4 && < 0.5,
4548 text >= 1.2 && < 1.3,
4649 transformers >= 0.4 && < 0.6
4750
48− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields
51+ ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2
4952
5053 default-language: Haskell2010
5154
@@ -54,16 +57,7 @@ executable example
5457 buildable: True
5558 else
5659 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
60+ build-depends: aeson, reflex, servant-reflex, base, scientific, servant, reflex-dom, text
6761 default-language: Haskell2010
6862 main-is: Example.hs
6963 other-modules: API
shell.nixdeleted−1
@@ -1 +0,0 @@
1−(import ./travis.nix {nativeCompiler = "ghc";}).ghcPkgs.servant-reflex.env
src/Servant/Common/BaseUrl.hs+5−4
@@ -85,14 +85,15 @@ baseUrlWidget = elClass "div" "base-url" $ do
8585 where pathWidget :: m (Dynamic t BaseUrl)
8686 pathWidget = do
8787 text "Url base path"
88− t <- inputElement def
88+ t <- textInput (def {_textInputConfig_attributes =
89+ constDyn ("placeholder" =: "/a/b")})
8990 return $ BasePath <$> value t
9091 fullUrlWidget :: m (Dynamic t BaseUrl)
9192 fullUrlWidget = do
9293 schm <- dropdown Https (constDyn $ Https =: "https" <> Http =: "http") def
93− srv <- inputElement def
94+ srv <- textInput def {_textInputConfig_attributes = constDyn $ "placeholder" =: "example.com"}
9495 text ":"
95− prt <- inputElement def
96+ prt <- textInput def { _textInputConfig_attributes = constDyn $ "placeholder" =: "80"}
9697 port :: Dynamic t Int <- holdDyn 80 (fmapMaybe (readMaybe . T.unpack) $ updated (value prt))
97− path <- inputElement def
98+ path <- textInput def { _textInputConfig_attributes = constDyn $ "placeholder" =: "a/b" }
9899 return $ BaseFullUrl <$> value schm <*> value srv <*> port <*> value path
src/Servant/Common/Req.hs+138−104
@@ -1,46 +1,65 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE OverloadedStrings #-}
6−{-# LANGUAGE LambdaCase #-}
7−{-# LANGUAGE RankNTypes #-}
8−{-# LANGUAGE ScopedTypeVariables #-}
9−{-# LANGUAGE TupleSections #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveFunctor #-}
3+{-# LANGUAGE ExistentialQuantification #-}
4+{-# LANGUAGE FlexibleContexts #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE FunctionalDependencies #-}
7+{-# LANGUAGE GADTs #-}
8+{-# LANGUAGE LambdaCase #-}
9+{-# LANGUAGE MultiParamTypeClasses #-}
10+{-# LANGUAGE NamedFieldPuns #-}
11+{-# LANGUAGE OverloadedStrings #-}
12+{-# LANGUAGE RankNTypes #-}
13+{-# LANGUAGE ScopedTypeVariables #-}
14+{-# LANGUAGE TupleSections #-}
15+{-# OPTIONS_GHC -fno-warn-orphans #-}
1016
1117module Servant.Common.Req where
1218
1319-------------------------------------------------------------------------------
14−import Control.Applicative (liftA2, liftA3)
15−import Control.Arrow ((&&&))
20+import Control.Applicative (liftA2, liftA3)
1621import 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
21−import 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)
22+import Control.Monad (join)
23+import Control.Monad.IO.Class (MonadIO, liftIO)
24+import Data.Aeson
25+import Data.Bifunctor (first)
26+import qualified Data.ByteString as BS
27+import qualified Data.ByteString.Builder as BB
28+import Data.ByteString.Lazy (ByteString)
29+import qualified Data.ByteString.Lazy.Char8 as BL
2530import 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)
31+import qualified Data.JSString.Text as JS (lazyTextFromJSString)
32+import qualified Data.Map as Map
33+import Data.Maybe (catMaybes, fromMaybe)
34+import Data.Monoid ((<>))
35+import Data.Proxy (Proxy (..))
36+import Data.Text (Text)
37+import qualified Data.Text as T
38+import qualified Data.Text.Encoding as T
39+import qualified Data.Text.Lazy as TL
40+import Data.Traversable (forM)
41+import qualified Language.Javascript.JSaddle as JS
3242import 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(..))
43+import qualified Network.URI as N
44+import Reflex.Dom.Core hiding (tag)
45+import Servant.API.ContentTypes (Accept, FormUrlEncoded,
46+ JSON, NoContent (..),
47+ OctetStream, PlainText)
48+import Servant.Common.BaseUrl (BaseUrl,
49+ SupportsServantReflex,
50+ showBaseUrl)
51+import Web.FormUrlEncoded (FromForm, urlDecodeAsForm)
52+import Web.HttpApiData (ToHttpApiData (..))
3953-------------------------------------------------------------------------------
4054import Servant.API.BasicAuth
55+-------------------------------------------------------------------------------
4156
57+-- #ifndef __GHCJS__
58+-- jsonDecode :: JS.JSString -> Maybe a
59+-- jsonDecode = error "jsonDecode is only available in GHCJS"
60+-- #endif
4261
43−------------------------------------------------------------------------------
62+-----------------------------------------------------------------------------
4463-- | The result of a request event
4564data ReqResult tag a
4665 = ResponseSuccess tag a XhrResponse
@@ -93,13 +112,6 @@ reqFailure (ResponseFailure _ s _) = Just s
93112reqFailure (RequestFailure _ s) = Just s
94113reqFailure _ = Nothing
95114
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−
103115
104116------------------------------------------------------------------------------
105117-- | Simple filter/accessor for the raw XHR response
@@ -141,34 +153,35 @@ data QueryPart t = QueryPartParam (Dynamic t (Either Text (Maybe Text)))
141153-------------------------------------------------------------------------------
142154-- The data structure used to build up request information while traversing
143155-- the shape of a servant API
144−data Req t = Req
156+data Req t = forall o. (IsXhrPayload o, Show o) => Req
145157 { reqMethod :: Text
146158 , reqPathParts :: [Dynamic t (Either Text Text)]
147159 , qParams :: [(Text, QueryPart t)]
148− , reqBody :: Maybe (Dynamic t (Either Text (BL.ByteString, Text)))
160+ , reqBody :: Maybe (Dynamic t (Either Text (o, Text)))
149161 , headers :: [(Text, Dynamic t (Either Text Text))]
150162 , respHeaders :: XhrResponseHeaders
151163 , authData :: Maybe (Dynamic t (Maybe BasicAuthData))
152164 }
153165
166+data SomeXhrRequest = forall o. (IsXhrPayload o, Show o) => SomeXhrRequest (XhrRequest (Maybe o))
167+
154168defReq :: Req t
155−defReq = Req "GET" [] [] Nothing [] def Nothing
169+defReq = Req "GET" [] [] (Nothing :: Maybe (Dynamic t (Either Text ((), Text)))) [] def Nothing
156170
157171prependToPathParts :: Dynamic t (Either Text Text) -> Req t -> Req t
158172prependToPathParts p req =
159173 req { reqPathParts = p : reqPathParts req }
160174
161175addHeader :: (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 }
163−
176+addHeader name val req = req { headers = (name, (fmap . fmap) (T.decodeUtf8 . toHeader) val) : headers req }
164177
165178reqToReflexRequest
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 =
179+ :: forall t. Reflex t
180+ => Text
181+ -> Dynamic t BaseUrl
182+ -> Req t
183+ -> Dynamic t (Either Text SomeXhrRequest)
184+reqToReflexRequest reqMeth reqHost req@(Req _ _ _ (reqBody :: Maybe (Dynamic t (Either Text (o, Text)))) _ _ _) =
172185 let t :: Dynamic t [Either Text Text]
173186 t = sequence $ reverse $ reqPathParts req
174187
@@ -220,33 +233,33 @@ reqToReflexRequest reqMeth reqHost req =
220233 fmap (fmap (\rightVal -> (headerName, rightVal))) dynam
221234
222235 mkConfigBody :: Either Text [(Text,Text)]
223− -> (Either Text (BL.ByteString, Text))
224− -> Either Text (XhrRequestConfig XhrPayload)
236+ -> (Either Text (o, Text))
237+ -> Either Text (XhrRequestConfig (Maybe o))
225238 mkConfigBody ehs rb = case (ehs, rb) of
226239 (_, Left e) -> Left e
227240 (Left e, _) -> Left e
228241 (Right hs, Right (bBytes, bCT)) ->
229242 Right $ XhrRequestConfig
230− { _xhrRequestConfig_sendData = bytesToPayload bBytes
243+ { _xhrRequestConfig_sendData = Just bBytes
231244 , _xhrRequestConfig_headers =
232245 Map.insert "Content-Type" bCT (Map.fromList hs)
233246 , _xhrRequestConfig_user = Nothing
234247 , _xhrRequestConfig_password = Nothing
235− , _xhrRequestConfig_responseType = Just XhrResponseType_ArrayBuffer
248+ , _xhrRequestConfig_responseType = Nothing
236249 , _xhrRequestConfig_withCredentials = False
237250 , _xhrRequestConfig_responseHeaders = def
238251 }
239252
240− xhrOpts :: Dynamic t (Either Text (XhrRequestConfig XhrPayload))
241− xhrOpts = case reqBody req of
253+ xhrOpts :: Dynamic t (Either Text (XhrRequestConfig (Maybe o)))
254+ xhrOpts = case reqBody of
242255 Nothing -> ffor xhrHeaders $ \case
243256 Left e -> Left e
244257 Right hs -> Right $ def { _xhrRequestConfig_headers = Map.fromList hs
245258 , _xhrRequestConfig_user = Nothing
246259 , _xhrRequestConfig_password = Nothing
247− , _xhrRequestConfig_responseType = Just XhrResponseType_ArrayBuffer
248− , _xhrRequestConfig_sendData = mempty
260+ , _xhrRequestConfig_responseType = Nothing
249261 , _xhrRequestConfig_withCredentials = False
262+ , _xhrRequestConfig_sendData = Nothing
250263 }
251264 Just rBody -> liftA2 mkConfigBody xhrHeaders rBody
252265
@@ -254,16 +267,16 @@ reqToReflexRequest reqMeth reqHost req =
254267 mkAuth _ (Left e) = Left e
255268 mkAuth Nothing r = r
256269 mkAuth (Just (BasicAuthData u p)) (Right config) = Right $ config
257− { _xhrRequestConfig_user = Just $ TE.decodeUtf8 u
258− , _xhrRequestConfig_password = Just $ TE.decodeUtf8 p}
270+ { _xhrRequestConfig_user = Just $ T.decodeUtf8 u
271+ , _xhrRequestConfig_password = Just $ T.decodeUtf8 p}
259272
260273 addAuth :: Dynamic t (Either Text (XhrRequestConfig x))
261274 -> Dynamic t (Either Text (XhrRequestConfig x))
262275 addAuth xhr = case authData req of
263− Nothing -> xhr
276+ Nothing -> xhr
264277 Just auth -> liftA2 mkAuth auth xhr
265278
266− xhrReq = (liftA2 . liftA2) (\p opt -> XhrRequest reqMeth p opt) xhrUrl (addAuth xhrOpts)
279+ xhrReq = (liftA2 . liftA2) (\p opt -> SomeXhrRequest $ XhrRequest reqMeth p opt) xhrUrl (addAuth xhrOpts)
267280
268281 in xhrReq
269282
@@ -272,8 +285,14 @@ reqToReflexRequest reqMeth reqHost req =
272285displayHttpRequest :: Text -> Text
273286displayHttpRequest httpmethod = "HTTP " <> httpmethod <> " request"
274287
288+instance IsXhrPayload o => IsXhrPayload (Maybe o) where
289+ sendXhrPayload xhr = maybe (sendXhrPayload xhr ()) (sendXhrPayload xhr)
290+
291+instance (IsXhrPayload o, IsXhrPayload o') => IsXhrPayload (Either o o') where
292+ sendXhrPayload xhr = either (sendXhrPayload xhr) (sendXhrPayload xhr)
293+
275294-- | This function performs the request
276−performRequests :: forall t m f tag.(SupportsServantReflex t m, Traversable f)
295+performRequests :: forall t m f tag. (SupportsServantReflex t m, Traversable f)
277296 => Text
278297 -> Dynamic t (f (Req t))
279298 -> Dynamic t BaseUrl
@@ -286,6 +305,7 @@ performRequests reqMeth rs reqHost opts trigger = do
286305 reqToReflexRequest reqMeth reqHost <$> fxhr) <$> rs
287306
288307 -- xhrReqs = fmap snd <$> xhrReqsAndDebugs
308+ reqs :: Event t (Compose ((,) tag) f (Either Text SomeXhrRequest))
289309 reqs = attachPromptlyDynWith
290310 (\fxhr t -> Compose (t, fxhr)) xhrReqs trigger
291311
@@ -301,32 +321,31 @@ performSomeRequestsAsync
301321 HasWebView (Performable m),
302322 PerformEvent t m,
303323 TriggerEvent t m,
304− Traversable f,
305− IsXhrPayload a,
306− Show a
324+ Traversable f
307325 )
308326 => ClientOptions
309− -> Event t (f (Either Text (XhrRequest a)))
327+ -> Event t (f (Either Text SomeXhrRequest))
310328 -> m (Event t (f (Either Text XhrResponse)))
311−performSomeRequestsAsync opts =
312− performSomeRequestsAsync' opts newXMLHttpRequest . fmap return
329+performSomeRequestsAsync opts sxhr =
330+ performSomeRequestsAsync' opts newXMLHttpRequest $ return <$> sxhr
313331
314332
315333------------------------------------------------------------------------------
316334-- | A modified version or Reflex.Dom.Xhr.performRequestsAsync
317335-- that accepts 'f (Either e (XhrRequestb))' events
318336performSomeRequestsAsync'
319− :: (MonadJSM (Performable m), PerformEvent t m, TriggerEvent t m, Traversable f, Show b)
337+ :: (MonadJSM (Performable m), PerformEvent t m, TriggerEvent t m, Traversable f)
320338 => ClientOptions
321− -> (XhrRequest b -> (a -> JSM ()) -> Performable m XMLHttpRequest)
322− -> Event t (Performable m (f (Either Text (XhrRequest b)))) -> m (Event t (f (Either Text a)))
339+ -> (forall b. IsXhrPayload b => XhrRequest b -> (a -> JSM ()) -> Performable m XMLHttpRequest)
340+ -> Event t (Performable m (f (Either Text SomeXhrRequest)))
341+ -> m (Event t (f (Either Text a)))
323342performSomeRequestsAsync' opts newXhr req = performEventAsync $ ffor req $ \hrs cb -> do
324343 rs <- hrs
325344 resps <- forM rs $ \r -> case r of
326345 Left e -> do
327346 resp <- liftIO $ newMVar (Left e)
328347 return resp
329− Right r' -> do
348+ Right (SomeXhrRequest r') -> do
330349 resp <- liftIO newEmptyMVar
331350 r'' <- liftJSM $ (optsRequestFixup opts) r'
332351 _ <- newXhr r'' $ liftIO . putMVar resp . Right
@@ -335,12 +354,6 @@ performSomeRequestsAsync' opts newXhr req = performEventAsync $ ffor req $ \hrs
335354 return ()
336355
337356
338−
339−type XhrPayload = ByteString
340−bytesToPayload :: BL.ByteString -> XhrPayload
341−bytesToPayload = BL.toStrict
342−
343−
344357performRequestsCT
345358 :: (SupportsServantReflex t m,
346359 MimeUnrender ct a, Traversable f)
@@ -353,15 +366,14 @@ performRequestsCT
353366 -> m (Event t (f (ReqResult tag a)))
354367performRequestsCT ct reqMeth reqs reqHost opts trigger = do
355368 resps <- performRequests reqMeth reqs reqHost opts trigger
356− let decodeResp (Just (XhrResponseBody_ArrayBuffer x)) =
357− first T.pack .
358− mimeUnrender ct $
359− BL.fromStrict x
360− decodeResp _ = Left "No body"
369+ let decodeResp x = first T.pack
370+ . mimeUnrender ct
371+ . JS.textToJSString
372+ =<< note "No body text" (_xhrResponse_responseText x)
361373 return $ fmap
362374 (\(t,rs) -> ffor rs $ \r -> case r of
363375 Left e -> RequestFailure t e
364− Right g -> evalResponse (decodeResp . _xhrResponse_response) (t,g)
376+ Right g -> evalResponse decodeResp (t,g)
365377 )
366378 resps
367379
@@ -388,9 +400,8 @@ evalResponse
388400 :: (XhrResponse -> Either Text a)
389401 -> (tag, XhrResponse)
390402 -> ReqResult tag a
391−evalResponse decode (tag, xhr) =
392− let status = _xhrResponse_status xhr
393− okStatus = status >= 200 && status < 400
403+evalResponse decodeRes (tag, xhr) =
404+ let okStatus = _xhrResponse_status xhr < 400
394405 errMsg = fromMaybe
395406 ("Empty response with error code " <>
396407 T.pack (show $ _xhrResponse_status xhr))
@@ -399,33 +410,56 @@ evalResponse decode (tag, xhr) =
399410 then either
400411 (\e -> ResponseFailure tag e xhr)
401412 (\v -> ResponseSuccess tag v xhr)
402− (decode xhr)
413+ (decodeRes xhr)
403414 else ResponseFailure tag errMsg xhr
404415 in respPayld
405416
406−------------------------------------------------------------------------------
407−-- | Utility for simultaneously accessing/filtering Success and Failure
408−-- response 'Event's,
409−fanReqResult :: Reflex t => Event t (ReqResult tag a) -> (Event t Text, Event t a)
410−fanReqResult = fmapMaybe reqFailure &&& fmapMaybe reqSuccess
411417
412−------------------------------------------------------------------------------
413−-- | Utility for simultaneously accessing/filtering Success and Failure
414−-- response 'Event's, but keeping the request tag
415−fanReqResult' :: Reflex t => Event t (ReqResult tag a) -> (Event t (tag, Text), Event t (tag, a))
416−fanReqResult' = fmapMaybe reqFailure' &&& fmapMaybe reqSuccess'
418+-- | Similar to 'Servant.API.ContentType.MimeUnrender' but with the differnce that
419+-- the second argument expects a JSString instead of ByteString.
420+-- This can lead to better performance ghcjs.
421+class Accept contentType => MimeUnrender contentType a where
422+ mimeUnrender :: Proxy contentType -> JS.JSString -> Either String a
423+
424+instance FromJSON a => MimeUnrender JSON a where
425+ mimeUnrender _ = note "Failed to decode response" . jsonDecode
426+
427+-- | @urlDecodeAsForm@
428+-- Note that the @mimeUnrender p (mimeRender p x) == Right x@ law only
429+-- holds if every element of x is non-null (i.e., not @("", "")@)
430+instance FromForm a => MimeUnrender FormUrlEncoded a where
431+ mimeUnrender _ = first T.unpack . urlDecodeAsForm . BB.toLazyByteString . T.encodeUtf8Builder . JS.textFromJSString
417432
433+-- | @left show . TextL.decodeUtf8'@
434+instance MimeUnrender PlainText TL.Text where
435+ mimeUnrender _ = pure . JS.lazyTextFromJSString
436+
437+-- | @left show . TextS.decodeUtf8' . toStrict@
438+instance MimeUnrender PlainText T.Text where
439+ mimeUnrender _ = pure . JS.textFromJSString
440+
441+-- | @Right . BC.unpack@
442+instance MimeUnrender PlainText String where
443+ mimeUnrender _ = Right . T.unpack . JS.textFromJSString
444+
445+-- | @Right . id@
446+instance MimeUnrender OctetStream ByteString where
447+ mimeUnrender _ = pure . BB.toLazyByteString . T.encodeUtf8Builder . JS.textFromJSString
448+
449+-- | @Right . toStrict@
450+instance MimeUnrender OctetStream BS.ByteString where
451+ mimeUnrender _ = pure . T.encodeUtf8 . JS.textFromJSString
418452
419453note :: e -> Maybe a -> Either e a
420−note e = maybe (Left e) Right
454+note e Nothing = Left e
455+note _ (Just a) = Right a
421456
422457fmapL :: (e -> e') -> Either e a -> Either e' a
423458fmapL _ (Right a) = Right a
424459fmapL f (Left e) = Left (f e)
425460
426−builderToText :: Builder.Builder -> T.Text
427−builderToText = TE.decodeUtf8 . BL.toStrict . Builder.toLazyByteString
461+builderToText :: BB.Builder -> T.Text
462+builderToText = T.decodeUtf8 . BL.toStrict . BB.toLazyByteString
428463
429464escape :: T.Text -> T.Text
430−escape = T.pack . N.escapeURIString (not . N.isReserved) . T.unpack . TE.decodeUtf8 . BL.toStrict . Builder.toLazyByteString . toEncodedUrlPiece
431−
465+escape = T.pack . N.escapeURIString (not . N.isReserved) . T.unpack . T.decodeUtf8 . BL.toStrict . BB.toLazyByteString . toEncodedUrlPiece
src/Servant/Reflex.hs+159−161
@@ -1,14 +1,18 @@
11{-# LANGUAGE AllowAmbiguousTypes #-}
22{-# LANGUAGE CPP #-}
33{-# LANGUAGE DataKinds #-}
4+{-# LANGUAGE DefaultSignatures #-}
5+{-# LANGUAGE ExtendedDefaultRules #-}
46{-# LANGUAGE FlexibleContexts #-}
57{-# LANGUAGE FlexibleInstances #-}
8+{-# LANGUAGE FunctionalDependencies #-}
69{-# LANGUAGE GeneralizedNewtypeDeriving #-}
710{-# LANGUAGE InstanceSigs #-}
11+{-# LANGUAGE LambdaCase #-}
812{-# LANGUAGE MultiParamTypeClasses #-}
913{-# LANGUAGE OverloadedStrings #-}
1014{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE Rank2Types #-}
15+{-# LANGUAGE RecordWildCards #-}
1216{-# LANGUAGE ScopedTypeVariables #-}
1317{-# LANGUAGE TupleSections #-}
1418{-# LANGUAGE TypeFamilies #-}
@@ -26,10 +30,9 @@
2630module Servant.Reflex
2731 ( client
2832 , clientWithOpts
29− , clientWithOptsAndResultHandler
3033 , clientWithRoute
31− , clientWithRouteAndResultHandler
3234 , BuildHeaderKeysTo(..)
35+ , GHCJS'MimeRender(..)
3336 , toHeaders
3437 , HasClient
3538 , Client
@@ -39,56 +42,56 @@ module Servant.Reflex
3942
4043------------------------------------------------------------------------------
4144import Control.Applicative
42−import qualified Data.CaseInsensitive as CI
45+import qualified Data.ByteString as BS
46+import qualified Data.ByteString.Lazy as BL
47+import Data.CaseInsensitive (mk)
4348import 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)
49+import Data.Kind (Type)
50+import qualified Data.Map as Map
51+import Data.Monoid ((<>))
52+import Data.Proxy (Proxy (..))
53+import qualified Data.Set as Set
54+import Data.Text (Text)
55+import qualified Data.Text as T
56+import qualified Data.Text.Encoding as E
57+import qualified Data.Text.Lazy as TL
58+import GHC.Exts (Constraint)
59+import GHC.TypeLits (KnownSymbol, symbolVal)
60+import GHCJS.DOM.Types (Blob)
61+import Servant.API ((:<|>) (..), (:>), Accept (..),
62+ BasicAuth, BasicAuthData,
63+ BuildHeadersTo (..), Capture,
64+ FormUrlEncoded, Header, Headers (..),
65+ HttpVersion, IsSecure, JSON,
66+ MimeRender (..), NoContent,
67+ OctetStream, PlainText, QueryFlag,
68+ QueryParam, QueryParams, Raw,
69+ ReflectMethod (..), RemoteHost,
70+ ReqBody, ToHttpApiData (..), Vault,
71+ Verb, contentType)
72+import qualified Servant.Auth as Auth
73+
74+import Reflex.Dom.Core (Dynamic, Event, IsXhrPayload, Reflex,
75+ XhrRequest (..), XhrResponse (..),
76+ XhrResponseHeaders (..),
77+ attachPromptlyDynWith, constDyn, ffor,
78+ fmapMaybe, leftmost,
79+ performRequestsAsync)
7280------------------------------------------------------------------------------
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)
81+import Servant.Common.BaseUrl (BaseUrl (..), Scheme (..),
82+ SupportsServantReflex, baseUrlWidget,
83+ showBaseUrl)
84+import Servant.Common.Req (ClientOptions (..), MimeUnrender (..),
85+ QParam (..), QueryPart (..), Req (..),
86+ ReqResult (..), addHeader, authData,
87+ defReq, defaultClientOptions,
88+ evalResponse, performRequestsCT,
89+ performRequestsNoBody,
90+ performSomeRequestsAsync,
91+ prependToPathParts, qParamToQueryPart,
92+ qParams, reqBody, reqFailure,
93+ reqMethod, reqSuccess, reqTag,
94+ respHeaders, response, withCredentials)
9295
9396
9497-- * Accessing APIs as a Client
@@ -103,7 +106,7 @@ import Servant.Common.Req (ClientOptions(..),
103106-- >
104107-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
105108-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
106−-- > -> m (Event t (l, ReqResult Book)))
109+-- -> m (Event t (l, ReqResult Book)))
107110-- > (getAllBooks :<|> postNewBook) = client myApi host
108111-- > where host = constDyn $ BaseUrl Http "localhost" 8080
109112client
@@ -125,53 +128,21 @@ clientWithOpts
125128 -> Client t m layout tag
126129clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
127130
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−
142131
143132-- | This class lets us define how each API combinator
144133-- influences the creation of an HTTP request. It's mostly
145134-- 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
135+class HasClient t m layout (tag :: Type) where
136+ type Client t m layout tag :: Type
137+ clientWithRoute :: Proxy layout -> Proxy m -> Proxy tag -> Req t -> Dynamic t BaseUrl -> ClientOptions -> Client t m layout tag
167138
168139
169140instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
170141 type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
171142
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
143+ clientWithRoute Proxy q pTag req baseurl opts =
144+ clientWithRoute (Proxy :: Proxy a) q pTag req baseurl opts :<|>
145+ clientWithRoute (Proxy :: Proxy b) q pTag req baseurl opts
175146
176147
177148-- Capture. Example:
@@ -192,9 +163,11 @@ instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout ta
192163 type Client t m (Capture capture a :> sublayout) tag =
193164 Dynamic t (Either Text a) -> Client t m sublayout tag
194165
195− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196− clientWithRouteAndResultHandler
197− (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
166+ clientWithRoute Proxy q t req baseurl opts val =
167+ clientWithRoute (Proxy :: Proxy sublayout)
168+ q t
169+ (prependToPathParts p req)
170+ baseurl opts
198171 where p = (fmap . fmap) (toUrlPiece) val
199172
200173
@@ -207,8 +180,8 @@ instance {-# OVERLAPPABLE #-}
207180 Event t tag -> m (Event t (ReqResult tag a))
208181 -- TODO how to access input types here?
209182 -- 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
183+ clientWithRoute Proxy _ _ req baseurl opts trigs =
184+ fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
212185 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
213186 req' = req { reqMethod = method }
214187
@@ -221,33 +194,29 @@ instance {-# OVERLAPPING #-}
221194 Event t tag -> m (Event t (ReqResult tag NoContent))
222195 -- TODO: how to access input types here?
223196 -- ExceptT ServantError IO NoContent
224− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225− wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
197+ clientWithRoute Proxy _ _ req baseurl opts =
198+ (fmap . fmap) runIdentity . performRequestsNoBody method (constDyn $ Identity req) baseurl opts
226199 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
227200
228201
229202toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
230203toHeaders r =
231− let hdrs = maybe []
232− (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
204+ let toBS = E.encodeUtf8
205+ hdrs = maybe []
206+ (\xhr -> fmap (\(h,v) -> (mk (toBS h), toBS v))
233207 (Map.toList $ _xhrResponse_headers xhr))
234208 (response r)
235209 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
236210
237−
238211class BuildHeaderKeysTo hs where
239− buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
212+ buildHeaderKeysTo :: Proxy hs -> [T.Text]
240213
241214instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
242215 where buildHeaderKeysTo _ = []
243216
244217instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
245218 => 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−
219+ buildHeaderKeysTo _ = T.pack (symbolVal (Proxy :: Proxy h)) : buildHeaderKeysTo (Proxy :: Proxy xs)
251220
252221-- HEADERS Verb (Content) --
253222-- Headers combinator not treated in fully general case,
@@ -262,10 +231,10 @@ instance {-# OVERLAPPABLE #-}
262231 ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
263232 type Client t m (Verb method status cts' (Headers ls a)) tag =
264233 Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
265− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
234+ clientWithRoute Proxy _ _ req baseurl opts trigs = do
266235 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
267236 resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268− wrap $ toHeaders <$> resp
237+ return $ toHeaders <$> resp
269238 where req' = req { respHeaders =
270239 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
271240 }
@@ -278,10 +247,10 @@ instance {-# OVERLAPPABLE #-}
278247 ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
279248 type Client t m (Verb method status cts (Headers ls NoContent)) tag
280249 = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
281− clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
250+ clientWithRoute Proxy _ _ req baseurl opts trigs = do
282251 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
283252 resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284− wrap $ toHeaders <$> resp
253+ return $ toHeaders <$> resp
285254 where req' = req {respHeaders =
286255 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
287256 }
@@ -308,11 +277,11 @@ instance (KnownSymbol sym, ToHttpApiData a,
308277 type Client t m (Header sym a :> sublayout) tag =
309278 Dynamic t (Either Text a) -> Client t m sublayout tag
310279
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
280+ clientWithRoute Proxy q t req baseurl opts eVal =
281+ clientWithRoute (Proxy :: Proxy sublayout)
282+ q t
283+ (Servant.Common.Req.addHeader hname eVal req)
284+ baseurl opts
316285 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
317286
318287
@@ -326,21 +295,8 @@ instance HasClient t m sublayout tag
326295 type Client t m (HttpVersion :> sublayout) tag =
327296 Client t m sublayout tag
328297
329− clientWithRouteAndResultHandler Proxy =
330− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
331−
332−-- | Using a 'Summary' combinator in your API doesn't affect the client
333−-- functions.
334−instance (HasClient t m sublayout tag, KnownSymbol sym)
335− => HasClient t m (Summary sym :> sublayout) tag where
336−
337− type Client t m (Summary sym :> sublayout) tag =
338− Client t m sublayout tag
339−
340− clientWithRouteAndResultHandler Proxy =
341− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
342−
343−
298+ clientWithRoute Proxy q t =
299+ clientWithRoute (Proxy :: Proxy sublayout) q t
344300
345301
346302-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -376,9 +332,9 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
376332 Dynamic t (QParam a) -> Client t m sublayout tag
377333
378334 -- 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
335+ clientWithRoute Proxy q t req baseurl opts mparam =
336+ clientWithRoute (Proxy :: Proxy sublayout) q t
337+ (req {qParams = paramPair : qParams req}) baseurl opts
382338
383339 where pname = symbolVal (Proxy :: Proxy sym)
384340 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -422,8 +378,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
422378 type Client t m (QueryParams sym a :> sublayout) tag =
423379 Dynamic t [a] -> Client t m sublayout tag
424380
425− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
381+ clientWithRoute Proxy q t req baseurl opts paramlist =
382+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl opts
427383
428384 where req' = req { qParams = (T.pack pname, params') : qParams req }
429385 pname = symbolVal (Proxy :: Proxy sym)
@@ -462,8 +418,8 @@ instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
462418 type Client t m (QueryFlag sym :> sublayout) tag =
463419 Dynamic t Bool -> Client t m sublayout tag
464420
465− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
421+ clientWithRoute Proxy q t req baseurl opts flag =
422+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl opts
467423
468424 where req' = req { qParams = thisPair : qParams req }
469425 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
@@ -477,7 +433,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
477433 -> Event t tag
478434 -> m (Event t (ReqResult tag ()))
479435
480− clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
436+ clientWithRoute _ _ _ _ baseurl _ xhrs triggers = do
481437
482438 let xhrs' = liftA2 (\x path -> case x of
483439 Left e -> Left e
@@ -488,7 +444,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
488444 okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
489445
490446 resps <- performRequestsAsync okReq
491− wrap $ leftmost [ uncurry RequestFailure <$> badReq
447+ return $ leftmost [ uncurry RequestFailure <$> badReq
492448 , evalResponse (const $ Right ()) <$> resps
493449 ]
494450
@@ -513,30 +469,73 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
513469-- > where host = BaseUrl Http "localhost" 8080
514470-- > -- then you can just use "addBook" to query that endpoint
515471
516−instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
517− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
472+instance (GHCJS'MimeRender ct a, IsXhrPayload (ToSend ct a), Show (ToSend ct a),
473+ HasClient t m sublayout tag, Reflex t)
474+ => HasClient t m (ReqBody (ct ': cts) (a :: Type) :> sublayout) tag where
518475
519476 type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
520− Dynamic t (Either Text a) -> Client t m sublayout tag
477+ Dynamic t (Either Text (ToConvert ct a)) -> Client t m sublayout tag
521478
522− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523− clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
524− where req' = req { reqBody = bodyBytesCT }
479+ clientWithRoute Proxy q t Req{..} baseurl opts body =
480+ clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl opts
481+ where req' = Req { reqBody = Just $ (fmap . fmap)
482+ (\b -> (ghcjsMimeRender ctProxy atProxy b, ctString)) body
483+ , ..}
525484 ctProxy = Proxy :: Proxy ct
485+ atProxy = Proxy :: Proxy a
526486 ctString = T.pack $ show $ contentType ctProxy
527− bodyBytesCT = Just $ (fmap . fmap)
528− (\b -> (mimeRender ctProxy b, ctString))
529− body
530487
488+class Accept ctype => GHCJS'MimeRender (ctype :: Type) (a :: Type) where
489+ type ToConvert ctype a :: Type
490+ type ToConvert ctype a = a
491+
492+ type ToSend ctype a :: Type
493+ type ToSend ctype a = BS.ByteString
531494
495+ ghcjsMimeRender
496+ :: IsXhrPayload (ToSend ctype a)
497+ => Proxy ctype -> Proxy a -> ToConvert ctype a -> ToSend ctype a
498+ default ghcjsMimeRender
499+ :: (MimeRender ctype a,
500+ MimeRender ctype (ToConvert ctype a), ToSend ctype a ~ BS.ByteString)
501+ => Proxy ctype -> Proxy a -> ToConvert ctype a -> ToSend ctype a
502+ ghcjsMimeRender ctype _ = BL.toStrict . mimeRender ctype
503+
504+instance MimeRender JSON x => GHCJS'MimeRender JSON x
505+
506+instance MimeRender FormUrlEncoded x => GHCJS'MimeRender FormUrlEncoded x
507+
508+instance GHCJS'MimeRender OctetStream BL.ByteString where
509+ type ToConvert OctetStream BL.ByteString = Either BL.ByteString Blob
510+ type ToSend OctetStream BL.ByteString = Either BS.ByteString Blob
511+ ghcjsMimeRender _ _ = \case Left bl -> Left $ BL.toStrict bl; Right x -> Right x
512+
513+instance GHCJS'MimeRender PlainText String where
514+ type ToSend PlainText String = Text
515+ ghcjsMimeRender _ _ = T.pack
516+
517+instance GHCJS'MimeRender PlainText Text where
518+ type ToSend PlainText Text = Text
519+ ghcjsMimeRender _ _ = id
520+
521+instance GHCJS'MimeRender PlainText TL.Text where
522+ type ToSend PlainText TL.Text = Text
523+ ghcjsMimeRender _ _ = TL.toStrict
524+
525+instance GHCJS'MimeRender PlainText BL.ByteString where
526+ type ToSend PlainText BL.ByteString = BS.ByteString
527+ ghcjsMimeRender _ _ = BL.toStrict
528+
529+instance GHCJS'MimeRender PlainText BS.ByteString where
530+ ghcjsMimeRender _ _ = id
532531
533532-- | Make the querying function append @path@ to the request path.
534533instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
535534 type Client t m (path :> sublayout) tag = Client t m sublayout tag
536535
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
536+ clientWithRoute Proxy q t req baseurl opts =
537+ clientWithRoute (Proxy :: Proxy sublayout) q t
538+ (prependToPathParts (pure (Right $ T.pack p)) req) baseurl opts
540539
541540 where p = symbolVal (Proxy :: Proxy path)
542541
@@ -544,23 +543,23 @@ instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient
544543instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
545544 type Client t m (Vault :> api) tag = Client t m api tag
546545
547− clientWithRouteAndResultHandler Proxy =
548− clientWithRouteAndResultHandler (Proxy :: Proxy api)
546+ clientWithRoute Proxy q t req baseurl =
547+ clientWithRoute (Proxy :: Proxy api) q t req baseurl
549548
550549
551550instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
552551 type Client t m (RemoteHost :> api) tag = Client t m api tag
553552
554− clientWithRouteAndResultHandler Proxy =
555− clientWithRouteAndResultHandler (Proxy :: Proxy api)
553+ clientWithRoute Proxy q t req baseurl =
554+ clientWithRoute (Proxy :: Proxy api) q t req baseurl
556555
557556
558557
559558instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
560559 type Client t m (IsSecure :> api) tag = Client t m api tag
561560
562− clientWithRouteAndResultHandler Proxy =
563− clientWithRouteAndResultHandler (Proxy :: Proxy api)
561+ clientWithRoute Proxy q t req baseurl =
562+ clientWithRoute (Proxy :: Proxy api) q t req baseurl
564563
565564
566565instance (HasClient t m api tag, Reflex t)
@@ -569,8 +568,8 @@ instance (HasClient t m api tag, Reflex t)
569568 type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570569 -> Client t m api tag
571570
572− clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
573− clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
571+ clientWithRoute Proxy q t req baseurl opts authdata =
572+ clientWithRoute (Proxy :: Proxy api) q t req' baseurl opts
574573 where
575574 req' = req { authData = Just authdata }
576575
@@ -613,7 +612,7 @@ for empty and one for non-empty lists).
613612instance (HasCookieAuth auths, HasClient t m api tag) => HasClient t m (Auth.Auth auths a :> api) tag where
614613
615614 type Client t m (Auth.Auth auths a :> api) tag = Client t m api tag
616− clientWithRouteAndResultHandler Proxy = clientWithRouteAndResultHandler (Proxy :: Proxy api)
615+ clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy api)
617616
618617
619618type family HasCookieAuth xs :: Constraint where
@@ -622,4 +621,3 @@ type family HasCookieAuth xs :: Constraint where
622621 HasCookieAuth '[] = CookieAuthNotEnabled
623622
624623class CookieAuthNotEnabled
625−
src/Servant/Reflex/Multi.hs+35−45
@@ -7,6 +7,7 @@
77{-# LANGUAGE MultiParamTypeClasses #-}
88{-# LANGUAGE OverloadedStrings #-}
99{-# LANGUAGE PolyKinds #-}
10+{-# LANGUAGE RecordWildCards #-}
1011{-# LANGUAGE ScopedTypeVariables #-}
1112{-# LANGUAGE TupleSections #-}
1213{-# LANGUAGE TypeFamilies #-}
@@ -37,37 +38,34 @@ module Servant.Reflex.Multi (
3738 ) where
3839
3940------------------------------------------------------------------------------
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)
41+import Control.Applicative (liftA2)
42+import Data.Functor.Compose (Compose (..), getCompose)
43+import Data.Proxy (Proxy (..))
44+import qualified Data.Set as Set
45+import Data.Text (Text)
46+import qualified Data.Text as T
47+import qualified Data.Text.Encoding as E
48+import GHC.TypeLits (KnownSymbol, symbolVal)
49+import Servant.API ((:<|>) (..), (:>), BasicAuth,
50+ BasicAuthData, BuildHeadersTo (..),
51+ Capture, Header, Headers (..),
52+ HttpVersion, IsSecure, NoContent,
53+ QueryFlag, QueryParam, QueryParams,
54+ Raw, ReflectMethod (..), RemoteHost,
55+ ReqBody, ToHttpApiData (..), Vault,
56+ Verb, contentType)
57+
58+import Reflex.Dom.Core (Dynamic, Event, IsXhrPayload, Reflex,
59+ XhrRequest (..),
60+ XhrResponseHeaders (..),
61+ attachPromptlyDynWith, constDyn)
6462------------------------------------------------------------------------------
6563import Servant.Common.BaseUrl (BaseUrl (..), Scheme (..),
6664 SupportsServantReflex)
67−import Servant.Common.Req (ClientOptions,
68− QParam (..), QueryPart (..), Req,
69− ReqResult (..), addHeader, authData,
70− defReq,
65+import Servant.Common.Req (ClientOptions, MimeUnrender,
66+ QParam (..), QueryPart (..), Req (..),
67+ ReqResult (..), SomeXhrRequest (..),
68+ addHeader, authData, defReq,
7169 defaultClientOptions,
7270 performRequestsCT,
7371 performRequestsNoBody,
@@ -76,7 +74,8 @@ import Servant.Common.Req (ClientOptions,
7674 qParams, reqBody, reqFailure,
7775 reqMethod, reqSuccess, reqSuccess',
7876 respHeaders, response, withCredentials)
79−import Servant.Reflex (BuildHeaderKeysTo (..), toHeaders)
77+import Servant.Reflex (BuildHeaderKeysTo (..),
78+ GHCJS'MimeRender (..), toHeaders)
8079
8180
8281------------------------------------------------------------------------------
@@ -242,17 +241,6 @@ instance HasClientMulti t m sublayout f tag
242241 clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag
243242
244243
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−
256244------------------------------------------------------------------------------
257245instance (KnownSymbol sym,
258246 ToHttpApiData a,
@@ -326,29 +314,31 @@ instance (SupportsServantReflex t m,
326314 clientWithRouteMulti _ _ _ _ _ _ opts rawReqs triggers = do
327315 let rawReqs' = sequence rawReqs :: Dynamic t (f (Either Text (XhrRequest ())))
328316 rawReqs'' = attachPromptlyDynWith (\fxhr t -> Compose (t, fxhr)) rawReqs' triggers
329− resps <- fmap (fmap aux . sequenceA . getCompose) <$> performSomeRequestsAsync opts rawReqs''
317+ rawReqs''' = (fmap . fmap . fmap) (SomeXhrRequest . fmap Just) rawReqs''
318+ resps <- fmap (fmap aux . sequenceA . getCompose) <$> performSomeRequestsAsync opts rawReqs'''
330319 return resps
331320 where
332321 aux (tag, Right r) = ResponseSuccess tag () r
333322 aux (tag, Left e) = RequestFailure tag e
334323
335324
336−instance (MimeRender ct a,
325+instance (GHCJS'MimeRender ct a, IsXhrPayload (ToSend ct a), Show (ToSend ct a),
337326 HasClientMulti t m sublayout f tag,
338327 Reflex t,
339328 Applicative f)
340329 => HasClientMulti t m (ReqBody (ct ': cts) a :> sublayout) f tag where
341330
342331 type ClientMulti t m (ReqBody (ct ': cts) a :> sublayout) f tag =
343− Dynamic t (f (Either Text a)) -> ClientMulti t m sublayout f tag
332+ Dynamic t (f (Either Text (ToConvert ct a))) -> ClientMulti t m sublayout f tag
344333
345334 clientWithRouteMulti Proxy q f tag reqs baseurl opts bodies =
346335 clientWithRouteMulti (Proxy :: Proxy sublayout) q f tag reqs' baseurl opts
347− where req' b r = r { reqBody = bodyBytesCT (constDyn b) }
336+ where req' b Req{..} = Req { reqBody = bodyBytesCT (constDyn b), .. }
348337 ctProxy = Proxy :: Proxy ct
338+ atProxy = Proxy :: Proxy a
349339 ctString = T.pack $ show $ contentType ctProxy
350340 bodyBytesCT b = Just $ (fmap . fmap)
351− (\b' -> (mimeRender ctProxy b', ctString))
341+ (\b' -> (ghcjsMimeRender ctProxy atProxy b', ctString))
352342 b
353343 reqs' = liftA2 req' <$> bodies <*> reqs
354344
testdriver/test/Servant/ReflexSpec.hs+1−2
@@ -9,7 +9,6 @@ import qualified Data.Text as T
99import Data.Foldable
1010import Test.WebDriver.Commands.Wait
1111import Test.Hspec.WebDriver
12−import Test.Hspec.WebDriver (chromeCaps)
1312
1413
1514clickingShouldCause :: Selector -> Selector -> Double -> (Element -> Element -> WD Bool) -> WD ()
@@ -29,7 +28,7 @@ spec :: Spec
2928spec = do
3029 describe "servant-reflex tests" $ do
3130
32− session "test page" $ using [chromeCaps] $ do
31+ session "test page" $ using Chrome $ do
3332
3433 it "opens the page" $ runWD $
3534 openPage "http://localhost:8000"
testserver/API.hsmode 100644 → 120000+1−69
@@ -1,69 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE TypeOperators #-}
4−
5−module API where
6−
7−import Data.Aeson
8−import Data.Aeson.Types (typeMismatch)
9−import Data.Text (Text)
10−import Servant.API
11−
12−newtype Question = Question { unQuestion :: Text } deriving (Show)
13−
14−instance ToJSON Question where
15− toJSON (Question txt) = object ["question" .= txt]
16−
17−instance FromJSON Question where
18− parseJSON (Object v) = Question <$> v .: "question"
19− parseJSON x = typeMismatch "Couldn't find key 'question'" x
20−
21−newtype Answer = Answer { unAnswer :: Text } deriving (Show)
22−
23−instance ToJSON Answer where
24− toJSON (Answer txt) = object ["answer" .= txt]
25−
26−instance FromJSON Answer where
27− parseJSON (Object v) = Answer <$> v .: "answer"
28− parseJSON x = typeMismatch "Couldn't find key 'answer'" x
29−
30−
31−-- | API spec for server, client, and docs
32−type API = "getunit" :> Get '[JSON] ()
33− :<|> "getint" :> Get '[JSON] Int
34− :<|> "sayhi" :> QueryParam "username" Text
35− :> QueryParams "greetings" Text
36− :> QueryFlag "gusto"
37− :> Get '[JSON] Text
38− :<|> "double" :> ReqBody '[JSON] Double
39− :> Post '[JSON] Double
40− :<|> "a" :> "b" :> QueryFlag "gusto" :> Get '[JSON] Text
41− :<|> "qna" :> ReqBody '[JSON] Question
42− :> Post '[JSON] Answer
43− :<|> "secret" :> BasicAuth "realm" () :> Get '[JSON] Int
44− :<|> Raw
45−
46−type GET = Get '[JSON] ()
47−
48−-- Imported the comprehensive API example for testing.
49−-- https://github.com/haskell-servant/servant/blob/master/servant/src/Servant/API/Internal/Test/ComprehensiveAPI.hs
50−type ComprehensiveAPI =
51− GET :<|>
52− Get '[JSON] Int :<|>
53− Capture "foo" Int :> GET :<|>
54− Header "foo" Int :> GET :<|>
55− HttpVersion :> GET :<|>
56− IsSecure :> GET :<|>
57− QueryParam "foo" Int :> GET :<|>
58− QueryParams "foo" Int :> GET :<|>
59− QueryFlag "foo" :> GET :<|>
60−-- Raw :<|>
61− RemoteHost :> GET :<|>
62− ReqBody '[JSON] Int :> GET :<|>
63− Get '[JSON] (Headers '[Header "foo" Int] ()) :<|>
64− "foo" :> GET :<|>
65− Vault :> GET :<|>
66− Verb 'POST 204 '[JSON] () :<|>
67− Verb 'POST 204 '[JSON] Int
68−-- This one isn't in scope
69−-- :<|> WithNamedContext "foo" '[] GET
@@ -0,0 +1 @@
1+../exec/API.hs
testserver/Main.hs+3−10
@@ -7,12 +7,10 @@
77{-# LANGUAGE TypeOperators #-}
88
99import Control.Monad.IO.Class (liftIO)
10−import Control.Monad.Reader (reader)
1110import Data.Aeson
1211import Data.Bool
1312import Data.Char (toUpper)
1413import qualified Data.List as L
15−import Data.Maybe (fromMaybe)
1614import Data.Monoid
1715import Data.Proxy
1816import Data.Text hiding (head, length, map,
@@ -27,7 +25,6 @@ import Snap.Http.Server
2725import Servant
2826import Servant.Server
2927-- import Snap.Util.FileServe
30−import System.Environment (lookupEnv)
3128import API
3229import Snap
3330
@@ -43,7 +40,7 @@ instance ToJSON Greet
4340testApi :: Proxy API
4441testApi = Proxy
4542
46−data App = App { appStaticDir :: String }
43+data App = App
4744
4845-- Server-side handlers.
4946--
@@ -54,7 +51,7 @@ data App = App { appStaticDir :: String }
5451server :: Server API '[BasicAuthCheck (Handler App App) ()] (Handler App App)
5552server = return () :<|> return 100 :<|> sayhi :<|> dbl
5653 :<|> multi :<|> qna :<|> serveSecret
57− :<|> statics
54+ :<|> serveDirectory "static"
5855 where sayhi :: Maybe Text -> [Text] -> Bool -> Handler App App Text
5956 sayhi nm greetings withGusto = case nm of
6057 Nothing -> return ("Sorry, who are you?" :: Text)
@@ -79,9 +76,6 @@ server = return () :<|> return 100 :<|> sayhi :<|> dbl
7976 req <- getRequest
8077 liftIO $ putStrLn (show req)
8178 return 101
82− statics = do
83− staticDir <- reader appStaticDir
84− serveDirectory staticDir
8579
8680-- Turn the server into a WAI app. 'serve' is provided by servant,
8781-- more precisely by the Servant.Server module.
@@ -91,11 +85,10 @@ test = serveSnapWithContext testApi
9185
9286initApp :: SnapletInit App App
9387initApp = makeSnaplet "myapp" "example" Nothing $ do
94− staticDir <- fromMaybe "static" <$> liftIO (lookupEnv "STATIC_DIR")
9588 addRoutes [("", test)
9689 ,("", serveDirectory "static")
9790 ]
98− return (App staticDir)
91+ return App
9992
10093-- Put this all to work!
10194main :: IO ()
testserver/run-wd-tests.shnew file+5
@@ -0,0 +1,5 @@
1+#!/usr/bin/env bash
2+
3+dist/build/back/back -p 8000 &
4+phantomjs --webdriver=127.0.0.1:4444 &
5+dist/build/spec/spec
testserver/testserver.cabal+4−5
@@ -19,13 +19,12 @@ executable back
1919 main-is: Main.hs
2020 -- other-modules:
2121 -- other-extensions:
22− build-depends: aeson >= 0.9 && < 1.5
23− , base >=4.8 && < 5
24− , mtl
22+ build-depends: aeson >= 0.9 && < 1.4
23+ , base >=4.8 && <4.11
2524 , snap >= 1.0 && < 1.2
26− , snap-server >= 1.0 && < 1.2
25+ , snap-server >= 1.0 && < 1.1
2726 , snap-core >= 1.0 && < 1.1
28− , servant >= 0.16 && < 0.18
27+ , servant >= 0.8 && < 0.12
2928 , servant-snap >= 0.8 && < 0.9
3029 , text >= 1.0 && < 1.3
3130 -- hs-source-dirs:
testserver/tr.nixnew file+32
@@ -0,0 +1,32 @@
1+{ reflex-platform, ... }:
2+let
3+
4+ dontCheck = (import <nixpkgs> {}).pkgs.haskell.lib.dontCheck;
5+ cabal2nixResult = reflex-platform.cabal2nixResult;
6+ nixpkgs = (import <nixpkgs> {});
7+in
8+reflex-platform.ghc.override {
9+ overrides = self: super: {
10+ servant-snap = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap) {});
11+ snap = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap) {});
12+ io-streams = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/io-streams) {});
13+ io-streams-haproxy = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/io-streams-haproxy) {});
14+ heist = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/heist) {});
15+ xmlhtml = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/xmlhtml) {});
16+ snap-core = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/snap-core) {});
17+ snap-server = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap/deps/snap-server) {});
18+ snap-loader-static = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap-loader-static) {});
19+ snap-loader-dynamic = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/snap-loader-dynamic) {});
20+ hspec-snap = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/hspec-snap) {});
21+
22+ # servant-foreign = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-foreign) {});
23+ # servant-js = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-js) {});
24+ # servant-docs = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-docs) {});
25+ # servant-client = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-client) {});
26+ # servant-blaze = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-blaze) {});
27+ # servant-lucid = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-lucid) {});
28+ # servant-server = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant-server) {});
29+ # servant = dontCheck (self.callPackage (cabal2nixResult ../deps/servant-snap/deps/servant/servant) {});
30+
31+ };
32+}
travis.nixdeleted−70
@@ -1,70 +0,0 @@
1−{
2− nativeCompiler ? "ghc",
3− # ^ Choose a GHC for compiling backend components (web server, selenium)
4− # (ghc, ghc8_0, ghc8_2, ghc8_4 or ghcHEAD)
5−
6− jsCompiler ? "ghcjs"
7− # ^ Choose a GHCJS for compiling the frontend
8− # (ghcjs, ghcjs8_0, ghcjs8_2 or ghcjs8_4)
9−
10−}:
11−
12−let
13−
14− reflexPlatform = import ./nix/reflex-platform.nix;
15−
16− lib = reflexPlatform.nixpkgs.haskell.lib;
17− do = funs: pkg: builtins.foldl' (a: b: b a) pkg funs;
18−
19− ghcjsPkgs = with lib; reflexPlatform.${jsCompiler}.override {
20− overrides = self: super: {
21− http-media = dontCheck super.http-media;
22− servant = dontCheck super.servant;
23− lens-aeson = dontCheck super.lens-aeson;
24− servant-reflex = lib.appendConfigureFlag
25− (self.callPackage ./default.nix {}) "-fExample";
26− };
27− };
28−
29− ghcPkgs = with lib; reflexPlatform.${nativeCompiler}.override {
30− overrides = self: super: {
31− servant-snap = dontCheck ((import ./nix/servant-snap.nix {}) self super);
32− testdriver = self.callCabal2nix "testdriver" ./testdriver {};
33− testserver = import nix/testserver.nix ghcjsPkgs.servant-reflex self super;
34− servant-reflex = self.callPackage ./default.nix {};
35− };
36− };
37−
38− testresults = import ./nix/testresults.nix
39− { inherit reflexPlatform;
40− inherit (ghcPkgs) testserver testdriver;
41− inherit (reflexPlatform.nixpkgs) curl;
42− phantomjs = reflexPlatform.nixpkgs.phantomjs2;
43− };
44−
45−in
46− rec {
47−
48− inherit reflexPlatform ghcPkgs ghcjsPkgs;
49−
50− build = ghcjsPkgs.servant-reflex;
51− buildGhc = ghcPkgs.servant-reflex;
52− testserver = ghcPkgs.testserver;
53− testdriver = ghcPkgs.testdriver;
54− inherit testresults;
55−
56− cabalBuild = reflexPlatform.${jsCompiler}.shellFor {
57− name = "servant-reflex-cabal-builder";
58−
59− packages = p: [
60− build
61− ];
62−
63− shellHook = ''
64− cabal configure --ghcjs -f Example
65− cabal build
66− exec/toSite.sh
67− exit $?
68− '';
69− };
70− }