git.iko.soy/typeable/servant
on c388c5e help sign in
b3279d9
swap
0 ahead, 92 behind
68 files changed+319−903
since splitsnapshots
unifiedsplit
.github/workflows/master.yml+29−17 CONTRIBUTING.md+2−4 cabal.project+23 changelog.d/1529−10 changelog.d/1556−81 changelog.d/1569−13 changelog.d/1580−12 changelog.d/1589−2 changelog.d/1595−2 doc/Makefile+1−1 doc/conf.py+2−1 doc/cookbook/curl-mock/curl-mock.cabal−3 doc/cookbook/index.rst+2−2 doc/cookbook/using-free-client/UsingFreeClient.lhs+1−1 doc/links.rst+1−1 doc/tutorial/install.rst−26 doc/tutorial/tutorial.cabal+1−1 servant-auth/servant-auth-client/servant-auth-client.cabal+10−10 servant-auth/servant-auth-docs/servant-auth-docs.cabal+8−8 servant-auth/servant-auth-server/servant-auth-server.cabal+14−14 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/AddSetCookie.hs−12 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/ConfigTypes.hs+2−2 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/JWT.hs+3−4 servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/ThrowAll.hs+1−10 servant-auth/servant-auth-server/test/Servant/Auth/ServerSpec.hs−7 servant-auth/servant-auth-swagger/servant-auth-swagger.cabal+13−9 servant-auth/servant-auth/servant-auth.cabal+7−7 servant-client-core/CHANGELOG.md−31 servant-client-core/servant-client-core.cabal+8−8 servant-client-core/src/Servant/Client/Core.hs−1 servant-client-core/src/Servant/Client/Core/HasClient.hs+16−28 servant-client-core/src/Servant/Client/Core/Request.hs+7−23 servant-client-ghcjs/servant-client-ghcjs.cabal+3−3 servant-client-ghcjs/src/Servant/Client/Internal/XhrClient.hs+5−8 servant-client/CHANGELOG.md−31 servant-client/servant-client.cabal+11−11 servant-client/src/Servant/Client/Internal/HttpClient.hs+8−9 servant-client/src/Servant/Client/Internal/HttpClient/Streaming.hs+2−2 servant-client/test/Servant/ClientTestUtils.hs+1−13 servant-client/test/Servant/SuccessSpec.hs+1−11 servant-conduit/servant-conduit.cabal+4−4 servant-docs/CHANGELOG.md−9 servant-docs/servant-docs.cabal+7−7 servant-docs/src/Servant/Docs/Internal.hs−4 servant-foreign/servant-foreign.cabal+7−7 servant-http-streams/CHANGELOG.md−10 servant-http-streams/servant-http-streams.cabal+13−13 servant-machines/servant-machines.cabal+4−4 servant-pipes/servant-pipes.cabal+4−4 servant-server/CHANGELOG.md−24 servant-server/example/greet.hs+1 servant-server/servant-server.cabal+7−7 servant-server/src/Servant/Server.hs+2−3 servant-server/src/Servant/Server/Internal.hs+35−24 servant-server/src/Servant/Server/Internal/Handler.hs+2−7 servant-server/src/Servant/Server/Internal/Router.hs+14−31 servant-server/test/Servant/Server/RouterSpec.hs+6−127 servant-swagger/servant-swagger.cabal+13−14 servant-swagger/src/Servant/Swagger.hs+3−5 servant-swagger/src/Servant/Swagger/Internal.hs−11 servant-swagger/src/Servant/Swagger/Internal/Test.hs+6−8 servant/CHANGELOG.md−116 servant/servant.cabal+7−7 servant/src/Servant/API.hs−4 servant/src/Servant/API/ContentTypes.hs+1−1 servant/src/Servant/Links.hs+1−1 servant/test/Servant/API/ContentTypesSpec.hs−11 stack.yaml−1
.github/workflows/master.yml+29−17
@@ -13,13 +13,12 @@ jobs:
1313 strategy:
1414 matrix:
1515 os: [ubuntu-latest]
16− cabal: ["3.6"]
16+ cabal: ["3.4"]
1717 ghc:
1818 - "8.6.5"
1919 - "8.8.4"
2020 - "8.10.7"
21− - "9.0.2"
22− - "9.2.2"
21+ - "9.0.1"
2322
2423 steps:
2524 - uses: actions/checkout@v2
@@ -48,7 +47,10 @@ jobs:
4847
4948 - name: Configure
5049 run: |
51− cabal install --ignore-project -j2 doctest --constraint='doctest ^>=0.20'
50+ # Using separate store-dir because default one already has 'ghc-paths' package installed
51+ # with hardcoded path to ghcup's GHC path (which it was built with). This leads to failure in
52+ # doctest, as it tries to invoke that GHC, and it doesn't exist here.
53+ cabal --store-dir /tmp/cabal-store install --ignore-project -j2 doctest --constraint='doctest ^>=0.18'
5254
5355 - name: Build
5456 run: |
@@ -59,29 +61,39 @@ jobs:
5961 cabal test all
6062
6163 - name: Run doctests
64+ # doctests are broken on GHC 9 due to compiler bug:
65+ # https://gitlab.haskell.org/ghc/ghc/-/issues/19460
66+ continue-on-error: ${{ matrix.ghc == '9.0.1' }}
6267 run: |
6368 # Necessary for doctest to be found in $PATH
6469 export PATH="$HOME/.cabal/bin:$PATH"
6570
66− DOCTEST="cabal repl --with-ghc=doctest --ghc-options=-w"
67− (cd servant && eval $DOCTEST)
68− (cd servant-client && eval $DOCTEST)
69− (cd servant-client-core && eval $DOCTEST)
70− (cd servant-http-streams && eval $DOCTEST)
71− (cd servant-docs && eval $DOCTEST)
72− (cd servant-foreign && eval $DOCTEST)
73− (cd servant-server && eval $DOCTEST)
74− (cd servant-machines && eval $DOCTEST)
75− (cd servant-conduit && eval $DOCTEST)
76− (cd servant-pipes && eval $DOCTEST)
71+ # Filter out base-compat-batteries from .ghc.environment.*, as its modules
72+ # conflict with those of base-compat.
73+ #
74+ # FIXME: This is an ugly hack. Ultimately, we'll want to use cabal-doctest
75+ # (or cabal v2-doctest, if it ever lands) to provide a clean GHC environment.
76+ # This might allow running doctests in GHCJS build as well.
77+ perl -i -e 'while (<ARGV>) { print unless /package-id\s+(base-compat-batteries)-\d+(\.\d+)*/; }' .ghc.environment.*
78+
79+ (cd servant && doctest src)
80+ (cd servant-client && doctest src)
81+ (cd servant-client-core && doctest src)
82+ (cd servant-http-streams && doctest src)
83+ (cd servant-docs && doctest src)
84+ (cd servant-foreign && doctest src)
85+ (cd servant-server && doctest src)
86+ (cd servant-machines && doctest src)
87+ (cd servant-conduit && doctest src)
88+ (cd servant-pipes && doctest src)
7789
7890 stack:
7991 name: stack / ghc ${{ matrix.ghc }}
8092 runs-on: ubuntu-latest
8193 strategy:
8294 matrix:
83− stack: ["2.7.5"]
84− ghc: ["8.10.7"]
95+ stack: ["2.7.3"]
96+ ghc: ["8.10.4"]
8597
8698 steps:
8799 - uses: actions/checkout@v2
CONTRIBUTING.md+2−4
@@ -79,10 +79,8 @@ not been a timely response to a PR, you can ping the Maintainers group (with
7979We encourage people to experiment with new combinators and instances - it is
8080one of the most powerful ways of using `servant`, and a wonderful way of
8181getting to know it better. If you do write a new combinator, we would love to
82−know about it! Either hop on
83−[#haskell-servant on libera.chat](https://web.libera.chat/#haskell-servant) and
84−let us know, or open an issue with the `news` tag (which we will close when we
85−read it).
82+know about it! Either hop on #servant on freenode and let us know, or open an
83+issue with the `news` tag (which we will close when we read it).
8684
8785As for adding them to the main repo: maintaining combinators can be expensive,
8886since official combinators must have instances for all classes (and new classes
cabal.project+23
@@ -51,3 +51,26 @@ packages:
5151tests: True
5252optimization: False
5353-- reorder-goals: True
54+
55+constraints:
56+ -- see https://github.com/haskell-infra/hackage-trustees/issues/119
57+ foundation >=0.0.14,
58+ memory <0.14.12 || >0.14.12
59+
60+constraints: base-compat ^>=0.11
61+constraints: semigroups ^>=0.19
62+
63+-- allow-newer: sqlite-simple-0.4.16.0:semigroups
64+-- allow-newer: direct-sqlite-2.3.24:semigroups
65+
66+-- needed for doctests
67+write-ghc-environment-files: always
68+
69+-- https://github.com/chordify/haskell-servant-pagination/pull/12
70+allow-newer: servant-pagination-2.2.2:servant
71+allow-newer: servant-pagination-2.2.2:servant-server
72+
73+allow-newer: servant-js:servant
74+
75+-- ghc 9
76+allow-newer: tdigest:base
changelog.d/1529deleted−10
@@ -1,10 +0,0 @@
1−synopsis: Fix performRequest in servant-client-ghcjs
2−prs: #1529
3−
4−description: {
5−
6−performRequest function in servant-client-ghcjs was not compatible with the
7−latest RunClient typeclass. Added the acceptStatus parameter and fixed the
8−functionality to match what servant-client provides.
9−
10−}
changelog.d/1556deleted−81
@@ -1,81 +0,0 @@
1−synopsis: Display capture hints in router layout
2−prs: #1556
3−
4−description: {
5−
6−This PR enhances the `Servant.Server.layout` function, which produces a textual description of the routing layout of an API. More precisely, it changes `<capture>` blocks, so that they display the name and type of the variable being captured instead.
7−
8−Example:
9−
10−For the following API
11−```haskell
12−type API =
13− "a" :> "d" :> Get '[JSON] NoContent
14− :<|> "b" :> Capture "x" Int :> Get '[JSON] Bool
15− :<|> "a" :> "e" :> Get '[JSON] Int
16−```
17−
18−we previously got the following output:
19−
20−```
21−/
22−├─ a/
23−│ ├─ d/
24−│ │ └─•
25−│ └─ e/
26−│ └─•
27−└─ b/
28− └─ <capture>/
29− ├─•
30− ┆
31− └─•
32−```
33−
34−now we get:
35−
36−```
37−/
38−├─ a/
39−│ ├─ d/
40−│ │ └─•
41−│ └─ e/
42−│ └─•
43−└─ b/
44− └─ <x::Int>/
45− ├─•
46− ┆
47− └─•
48−```
49−
50−This change is achieved by the introduction of a CaptureHint type, which is passed as an extra argument to the CaptureRouter and CaptureAllRouter constructors for the Router' type.
51−CaptureHint values are then used in routerLayout, to display the name and type of captured values, instead of just `<capture>` previously.
52−
53−N.B.:
54−Because the choice smart constructor for routers can aggregate Capture combinators with different capture hints, the Capture*Router constructors actually take a list of CaptureHint, instead of a single one.
55−
56−This PR also introduces Spec tests for the routerLayout function.
57−
58−Warning:
59−This change is potentially breaking, because it adds the constraint `Typeable a` to all types that are to be captured. Because all types are typeable since GHC 7.10, this is not as bad as it sounds ; it only break expressions where `a` is quantified in an expression with `Capture a`.
60−In those cases, the fix is easy: it suffices to add `Typeable a` to the left-hand side of the quantification constraint.
61−
62−For instance, the following code will no longer compile:
63−```haskell
64−type MyAPI a = Capture "foo" a :> Get '[JSON] ()
65−
66−myServer :: forall a. Server (MyAPI a)
67−myServer = const $ return ()
68−
69−myApi :: forall a. Proxy (MyAPI a)
70−myApi = Proxy
71−
72−app :: forall a. (FromHttpApiData a) => Application
73−app = serve (myApi @a) (myServer @a)
74−```
75−
76−Indeed, `app` should be replaced with:
77−```haskell
78−app :: forall a. (FromHttpApiData a, Typeable a) => Application
79−app = serve (myApi @a) (myServer @a)
80−```
81−}
changelog.d/1569deleted−13
@@ -1,13 +0,0 @@
1−synopsis: Encode captures using toEncodedUrlPiece
2−prs: #1569
3−issues: #1511
4−
5−description: {
6−The `servant-client` library now makes direct use of `toEncodedUrlPiece` from `ToHttpApiData`
7−to encode captured values when building the request path. It gives user freedom to implement
8−URL-encoding however they need.
9−
10−Previous behavior was to use `toUrlPiece` and URL-encode its output using `toEncodedUrlPiece`
11−from the `Text` instance of `ToHttpApiData`. The issue with this approach is that
12−`ToHttpApiData Text` is overly zealous and also encodes characters, such as `*`, which are perfectly valid in a URL.
13−}
changelog.d/1580deleted−12
@@ -1,12 +0,0 @@
1−synopsis: Allow IO in validationKeys
2−prs: #1580
3−issues: #1579
4−
5−description: {
6−
7−Currently validationKeys are a fixed JWKSet. This does not work with OIDC
8−providers such as AWS Cognito or Okta, which regularly fetching jwks_uri to
9−discover new and expired keys.
10−
11−This change alters the type of validationKeys from JWKSet to IO JWKSet.
12−}
changelog.d/1589deleted−2
@@ -1,2 +0,0 @@
1−synopsis: Only include question mark for nonempty query strings
2−prs: 1589
changelog.d/1595deleted−2
@@ -1,2 +0,0 @@
1−synopsis: Run ClientEnv's makeClientRequest in IO.
2−prs: #1595
doc/Makefile+1−1
@@ -10,7 +10,7 @@ BUILDDIR = _build
1010
1111# Put it first so that "make" without argument is like "make help".
1212help:
13− @if [ ! -d venv ]; then echo "WARNING: There is no venv directory, did you forget to 'virtualenv venv'. Check README.md."; fi
13+ @if [ ! -d venv ]; then echo "WARNING: There is no venv directory, did you forget to 'virtualenv venv'. Check building-the-docs file."; fi
1414 @if [ ! "z$$(which $(SPHINXBUILD))" = "z$$(pwd)/venv/bin/sphinx-build" ]; then echo "WARNING: Did you forgot to 'source venv/bin/activate'"; fi
1515 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1616
doc/conf.py+2−1
@@ -46,7 +46,7 @@ master_doc = 'index'
4646
4747# General information about the project.
4848project = u'Servant'
49−copyright = u'2022, Servant Contributors'
49+copyright = u'2018, Servant Contributors'
5050author = u'Servant Contributors'
5151
5252# The version info for the project you're documenting, acts as replacement for
@@ -169,3 +169,4 @@ texinfo_documents = [
169169source_parsers = {
170170 '.lhs': CommonMarkParser,
171171}
172+
doc/cookbook/curl-mock/curl-mock.cabal−3
@@ -11,9 +11,6 @@ build-type: Simple
1111tested-with: GHC==8.6.5, GHC==8.8.3, GHC ==8.10.7
1212
1313executable cookbock-curl-mock
14− if impl(ghc >= 9.2)
15− -- generic-arbitrary is incompatible
16− buildable: False
1714 main-is: CurlMock.lhs
1815 build-depends: base == 4.*
1916 , aeson
doc/cookbook/index.rst+2−2
@@ -6,8 +6,8 @@ how to solve many common problems with servant. If you're
66interested in contributing examples of your own, feel free
77to open an issue or a pull request on
88`our github repository <https://github.com/haskell-servant/servant>`_
9−or even to just get in touch with us on the `**#haskell-servant** IRC channel
10−on libera.chat <https://web.libera.chat/#haskell-servant>_ or on
9+or even to just get in touch with us on the **#servant** IRC channel
10+on freenode or on
1111`the mailing list <https://groups.google.com/forum/#!forum/haskell-servant>`_.
1212
1313The scope is very wide. Simple and fancy authentication schemes,
doc/cookbook/using-free-client/UsingFreeClient.lhs+1−1
@@ -119,7 +119,7 @@ Now we can use `servant-client`'s internals to convert servant's `Request`
119119to http-client's `Request`, and we can inspect it:
120120
121121```haskell
122− req' <- I.defaultMakeClientRequest burl req
122+ let req' = I.defaultMakeClientRequest burl req
123123 putStrLn $ "Making request: " ++ show req'
124124```
125125
doc/links.rst+1−1
@@ -12,7 +12,7 @@ Helpful Links
1212 `https://github.com/haskell-servant/servant/issues <https://github.com/haskell-servant/servant/issues>`_
1313
1414- the irc channel:
15− `#haskell-servant on libera.chat <https://web.libera.chat/#haskell-servant>`_
15+ ``#servant`` on freenode
1616
1717- the mailing list:
1818 `groups.google.com/forum/#!forum/haskell-servant <https://groups.google.com/forum/#!forum/haskell-servant>`_
doc/tutorial/install.rst−26
@@ -40,29 +40,3 @@ nix
4040`Nix <https://nixos.org/nix/>`_ users should feel free to take a look at
4141the `nix/shell.nix` file in the repository and use it to provision a suitable
4242environment to build and run the examples.
43−
44−Note for Ubuntu users
45−--------
46−
47−Ubuntu's packages for `ghc`, `cabal`, and `stack` are years out of date.
48−If the instructions above fail for you,
49−try replacing the Ubuntu packages with up-to-date versions.
50−First remove the installed versions:
51−
52−.. code-block:: bash
53−
54− # remove the obsolete versions
55− $ sudo apt remove ghc haskell-stack cabal-install
56−
57−Then install fresh versions of the Haskell toolchain
58−using the `ghcup <https://www.haskell.org/ghcup/install/>`_ installer.
59−
60−As of February 2022, one easy way to do this is by running a bootstrap script:
61−
62−.. code-block:: bash
63−
64− $ curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh
65−
66−The script is interactive and will prompt you for details about what
67−you want installed and where. To install manually,
68−see `the detailed instructions <https://www.haskell.org/ghcup/install/#manual-install>`_.
doc/tutorial/tutorial.cabal+1−1
@@ -64,7 +64,7 @@ library
6464 , blaze-markup >= 0.8.0.0 && < 0.9
6565 , cookie >= 0.4.3 && < 0.5
6666 , js-jquery >= 3.3.1 && < 3.4
67− , lucid >= 2.9.11 && < 2.12
67+ , lucid >= 2.9.11 && < 2.10
6868 , random >= 1.1 && < 1.3
6969 , servant-js >= 0.9 && < 0.10
7070 , time >= 1.6.0.1 && < 1.13
servant-auth/servant-auth-client/servant-auth-client.cabal+10−10
@@ -7,9 +7,9 @@ description: This package provides instances that allow generating clients fr
77 APIs that use
88 <https://hackage.haskell.org/package/servant-auth servant-auth's> @Auth@ combinator.
99 .
10− For a quick overview of the usage, see the <https://github.com/haskell-servant/servant/tree/master/servant-auth#readme README>.
10+ For a quick overview of the usage, see the <http://github.com/haskell-servant/servant/servant-auth#readme README>.
1111category: Web, Servant, Authentication
12−homepage: https://github.com/haskell-servant/servant/tree/master/servant-auth#readme
12+homepage: http://github.com/haskell-servant/servant/servant-auth#readme
1313bug-reports: https://github.com/haskell-servant/servant/issues
1414author: Julian K. Arni
1515maintainer: jkarni@gmail.com
@@ -31,12 +31,12 @@ library
3131 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
3232 ghc-options: -Wall
3333 build-depends:
34− base >= 4.10 && < 4.17
35− , bytestring >= 0.10.6.0 && < 0.12
34+ base >= 4.10 && < 4.16
35+ , bytestring >= 0.10.6.0 && < 0.11
3636 , containers >= 0.5.6.2 && < 0.7
3737 , servant-auth == 0.4.*
38− , servant >= 0.13 && < 0.20
39− , servant-client-core >= 0.13 && < 0.20
38+ , servant >= 0.13 && < 0.19
39+ , servant-client-core >= 0.13 && < 0.19
4040
4141 exposed-modules:
4242 Servant.Auth.Client
@@ -50,7 +50,7 @@ test-suite spec
5050 test
5151 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
5252 ghc-options: -Wall
53− build-tool-depends: hspec-discover:hspec-discover >=2.5.5 && <2.10
53+ build-tool-depends: hspec-discover:hspec-discover >=2.5.5 && <2.9
5454
5555 -- dependencies with bounds inherited from the library stanza
5656 build-depends:
@@ -62,14 +62,14 @@ test-suite spec
6262
6363 -- test dependencies
6464 build-depends:
65− hspec >= 2.5.5 && < 2.10
65+ hspec >= 2.5.5 && < 2.9
6666 , QuickCheck >= 2.11.3 && < 2.15
6767 , aeson >= 1.3.1.1 && < 3
68− , bytestring >= 0.10.6.0 && < 0.12
68+ , bytestring >= 0.10.6.0 && < 0.11
6969 , http-client >= 0.5.13.1 && < 0.8
7070 , http-types >= 0.12.2 && < 0.13
7171 , servant-auth-server >= 0.4.2.0 && < 0.5
72− , servant-server >= 0.13 && < 0.20
72+ , servant-server >= 0.13 && < 0.19
7373 , time >= 1.5.0.1 && < 1.13
7474 , transformers >= 0.4.2.0 && < 0.6
7575 , wai >= 3.2.1.2 && < 3.3
servant-auth/servant-auth-docs/servant-auth-docs.cabal+8−8
@@ -7,9 +7,9 @@ description: This package provides instances that allow generating docs from
77 APIs that use
88 <https://hackage.haskell.org/package/servant-auth servant-auth's> @Auth@ combinator.
99 .
10− For a quick overview of the usage, see the <https://github.com/haskell-servant/servant/tree/master/servant-auth#readme README>.
10+ For a quick overview of the usage, see the <http://github.com/haskell-servant/servant/servant-auth#readme README>.
1111category: Web, Servant, Authentication
12−homepage: https://github.com/haskell-servant/servant/tree/master/servant-auth#readme
12+homepage: http://github.com/haskell-servant/servant/servant-auth#readme
1313bug-reports: https://github.com/haskell-servant/servant/issues
1414author: Julian K. Arni
1515maintainer: jkarni@gmail.com
@@ -35,11 +35,11 @@ library
3535 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
3636 ghc-options: -Wall
3737 build-depends:
38− base >= 4.10 && < 4.17
39− , servant-docs >= 0.11.2 && < 0.13
40− , servant >= 0.13 && < 0.20
38+ base >= 4.10 && < 4.16
39+ , servant-docs >= 0.11.2 && < 0.12
40+ , servant >= 0.13 && < 0.19
4141 , servant-auth == 0.4.*
42− , lens >= 4.16.1 && <5.2
42+ , lens >= 4.16.1 && <5.1
4343 exposed-modules:
4444 Servant.Auth.Docs
4545 default-language: Haskell2010
@@ -64,7 +64,7 @@ test-suite spec
6464 test
6565 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
6666 ghc-options: -Wall
67− build-tool-depends: hspec-discover:hspec-discover >=2.5.5 && <2.10
67+ build-tool-depends: hspec-discover:hspec-discover >=2.5.5 && <2.9
6868
6969 -- dependencies with bounds inherited from the library stanza
7070 build-depends:
@@ -78,7 +78,7 @@ test-suite spec
7878 -- test dependencies
7979 build-depends:
8080 servant-auth-docs
81− , hspec >= 2.5.5 && < 2.10
81+ , hspec >= 2.5.5 && < 2.9
8282 , QuickCheck >= 2.11.3 && < 2.15
8383
8484 default-language: Haskell2010
servant-auth/servant-auth-server/servant-auth-server.cabal+14−14
@@ -1,15 +1,15 @@
11cabal-version: 2.2
22name: servant-auth-server
3−version: 0.4.7.0
3+version: 0.4.6.0
44synopsis: servant-server/servant-auth compatibility
55description: This package provides the required instances for using the @Auth@ combinator
66 in your 'servant' server.
77 .
88 Both cookie- and token- (REST API) based authentication is provided.
99 .
10− For a quick overview of the usage, see the <https://github.com/haskell-servant/servant/tree/master/servant-auth#readme README>.
10+ For a quick overview of the usage, see the <http://github.com/haskell-servant/servant/servant-auth#readme README>.
1111category: Web, Servant, Authentication
12−homepage: https://github.com/haskell-servant/servant/tree/master/servant-auth#readme
12+homepage: http://github.com/haskell-servant/servant/servant-auth#readme
1313bug-reports: https://github.com/haskell-servant/servant/issues
1414author: Julian K. Arni
1515maintainer: jkarni@gmail.com
@@ -31,27 +31,27 @@ library
3131 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
3232 ghc-options: -Wall
3333 build-depends:
34− base >= 4.10 && < 4.17
34+ base >= 4.10 && < 4.16
3535 , aeson >= 1.0.0.1 && < 3
3636 , base64-bytestring >= 1.0.0.1 && < 2
3737 , blaze-builder >= 0.4.1.0 && < 0.5
38− , bytestring >= 0.10.6.0 && < 0.12
38+ , bytestring >= 0.10.6.0 && < 0.11
3939 , case-insensitive >= 1.2.0.11 && < 1.3
4040 , cookie >= 0.4.4 && < 0.5
4141 , data-default-class >= 0.1.2.0 && < 0.2
4242 , entropy >= 0.4.1.3 && < 0.5
4343 , http-types >= 0.12.2 && < 0.13
4444 , jose >= 0.7.0.0 && < 0.10
45− , lens >= 4.16.1 && < 5.2
46− , memory >= 0.14.16 && < 0.18
45+ , lens >= 4.16.1 && < 5.1
46+ , memory >= 0.14.16 && < 0.17
4747 , monad-time >= 0.3.1.0 && < 0.4
4848 , mtl >= 2.2.2 && < 2.3
49− , servant >= 0.13 && < 0.20
49+ , servant >= 0.13 && < 0.19
5050 , servant-auth == 0.4.*
51− , servant-server >= 0.13 && < 0.20
51+ , servant-server >= 0.13 && < 0.19
5252 , tagged >= 0.8.4 && < 0.9
53− , text >= 1.2.3.0 && < 2.1
54− , time >= 1.5.0.1 && < 1.12
53+ , text >= 1.2.3.0 && < 1.3
54+ , time >= 1.5.0.1 && < 1.10
5555 , unordered-containers >= 0.2.9.0 && < 0.3
5656 , wai >= 3.2.1.2 && < 3.3
5757
@@ -102,7 +102,7 @@ test-suite spec
102102 test
103103 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
104104 ghc-options: -Wall
105− build-tool-depends: hspec-discover:hspec-discover >=2.5.5 && <2.10
105+ build-tool-depends: hspec-discover:hspec-discover >=2.5.5 && <2.8
106106
107107 -- dependencies with bounds inherited from the library stanza
108108 build-depends:
@@ -123,10 +123,10 @@ test-suite spec
123123 -- test dependencies
124124 build-depends:
125125 servant-auth-server
126− , hspec >= 2.5.5 && < 2.10
126+ , hspec >= 2.5.5 && < 2.8
127127 , QuickCheck >= 2.11.3 && < 2.15
128128 , http-client >= 0.5.13.1 && < 0.8
129− , lens-aeson >= 1.0.2 && < 1.3
129+ , lens-aeson >= 1.0.2 && < 1.2
130130 , warp >= 3.2.25 && < 3.4
131131 , wreq >= 0.5.2.1 && < 0.6
132132 other-modules:
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/AddSetCookie.hs−12
@@ -11,8 +11,6 @@ import Data.Tagged (Tagged (..))
1111import qualified Network.HTTP.Types as HTTP
1212import Network.Wai (mapResponseHeaders)
1313import Servant
14−import Servant.API.Generic
15−import Servant.Server.Generic
1614import Web.Cookie
1715
1816-- What are we doing here? Well, the idea is to add headers to the response,
@@ -36,7 +34,6 @@ type family AddSetCookieApiVerb a where
3634type family AddSetCookieApi a :: *
3735type instance AddSetCookieApi (a :> b) = a :> AddSetCookieApi b
3836type instance AddSetCookieApi (a :<|> b) = AddSetCookieApi a :<|> AddSetCookieApi b
39−type instance AddSetCookieApi (NamedRoutes api) = AddSetCookieApi (ToServantApi api)
4037type instance AddSetCookieApi (Verb method stat ctyps a)
4138 = Verb method stat ctyps (AddSetCookieApiVerb a)
4239type instance AddSetCookieApi Raw = Raw
@@ -75,15 +72,6 @@ instance {-# OVERLAPS #-}
7572 => AddSetCookies ('S n) (a :<|> b) (a' :<|> b') where
7673 addSetCookies cookies (a :<|> b) = addSetCookies cookies a :<|> addSetCookies cookies b
7774
78−instance {-# OVERLAPS #-}
79− ( AddSetCookies ('S n) (ServerT (ToServantApi api) m) cookiedApi
80− , Generic (api (AsServerT m))
81− , GServantProduct (Rep (api (AsServerT m)))
82− , ToServant api (AsServerT m) ~ ServerT (ToServantApi api) m
83− )
84− => AddSetCookies ('S n) (api (AsServerT m)) cookiedApi where
85− addSetCookies cookies = addSetCookies cookies . toServant
86−
8775-- | for @servant <0.11@
8876instance
8977 AddSetCookies ('S n) Application Application where
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/ConfigTypes.hs+2−2
@@ -33,7 +33,7 @@ data JWTSettings = JWTSettings
3333 -- | Algorithm used to sign JWT.
3434 , jwtAlg :: Maybe Jose.Alg
3535 -- | Keys used to validate JWT.
36− , validationKeys :: IO Jose.JWKSet
36+ , validationKeys :: Jose.JWKSet
3737 -- | An @aud@ predicate. The @aud@ is a string or URI that identifies the
3838 -- intended recipient of the JWT.
3939 , audienceMatches :: Jose.StringOrURI -> IsMatch
@@ -44,7 +44,7 @@ defaultJWTSettings :: Jose.JWK -> JWTSettings
4444defaultJWTSettings k = JWTSettings
4545 { signingKey = k
4646 , jwtAlg = Nothing
47− , validationKeys = pure $ Jose.JWKSet [k]
47+ , validationKeys = Jose.JWKSet [k]
4848 , audienceMatches = const Matches }
4949
5050-- | The policies to use when generating cookies.
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/JWT.hs+3−4
@@ -58,15 +58,14 @@ makeJWT v cfg expiry = runExceptT $ do
5858
5959verifyJWT :: FromJWT a => JWTSettings -> BS.ByteString -> IO (Maybe a)
6060verifyJWT jwtCfg input = do
61− keys <- validationKeys jwtCfg
62− verifiedJWT <- runExceptT $ do
61+ verifiedJWT <- liftIO $ runExceptT $ do
6362 unverifiedJWT <- Jose.decodeCompact (BSL.fromStrict input)
6463 Jose.verifyClaims
6564 (jwtSettingsToJwtValidationSettings jwtCfg)
66− keys
65+ (validationKeys jwtCfg)
6766 unverifiedJWT
6867 return $ case verifiedJWT of
6968 Left (_ :: Jose.JWTError) -> Nothing
7069 Right v -> case decodeJWT v of
7170 Left _ -> Nothing
72− Right v' -> Just v'
71+ Right v' -> Just v'
servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/ThrowAll.hs+1−10
@@ -8,10 +8,7 @@ module Servant.Auth.Server.Internal.ThrowAll where
88
99import Control.Monad.Error.Class
1010import Data.Tagged (Tagged (..))
11−import Servant ((:<|>) (..), ServerError(..), NamedRoutes(..))
12−import Servant.API.Generic
13−import Servant.Server.Generic
14−import Servant.Server
11+import Servant ((:<|>) (..), ServerError(..))
1512import Network.HTTP.Types
1613import Network.Wai
1714
@@ -29,12 +26,6 @@ class ThrowAll a where
2926instance (ThrowAll a, ThrowAll b) => ThrowAll (a :<|> b) where
3027 throwAll e = throwAll e :<|> throwAll e
3128
32−instance
33− ( ThrowAll (ToServant api (AsServerT m)) , GenericServant api (AsServerT m)) =>
34− ThrowAll (api (AsServerT m)) where
35−
36− throwAll = fromServant . throwAll
37−
3829-- Really this shouldn't be necessary - ((->) a) should be an instance of
3930-- MonadError, no?
4031instance {-# OVERLAPPING #-} ThrowAll b => ThrowAll (a -> b) where
servant-auth/servant-auth-server/test/Servant/Auth/ServerSpec.hs−7
@@ -50,7 +50,6 @@ import Network.Wreq (Options, auth, basicAuth,
5050import Network.Wreq.Types (Postable(..))
5151import Servant hiding (BasicAuth,
5252 IsSecure (..), header)
53−import Servant.API.Generic ((:-))
5453import Servant.Auth.Server
5554import Servant.Auth.Server.Internal.Cookie (expireTime)
5655import Servant.Auth.Server.SetCookieOrphan ()
@@ -406,7 +405,6 @@ type API auths
406405 = Auth auths User :>
407406 ( Get '[JSON] Int
408407 :<|> ReqBody '[JSON] Int :> Post '[JSON] Int
409− :<|> NamedRoutes DummyRoutes
410408 :<|> "header" :> Get '[JSON] (Headers '[Header "Blah" Int] Int)
411409#if MIN_VERSION_servant_server(0,15,0)
412410 :<|> "stream" :> StreamGet NoFraming OctetStream (SourceIO BS.ByteString)
@@ -418,10 +416,6 @@ type API auths
418416 :<|> "logout" :> Get '[JSON] (Headers '[ Header "Set-Cookie" SetCookie
419417 , Header "Set-Cookie" SetCookie ] NoContent)
420418
421−data DummyRoutes mode = DummyRoutes
422− { dummyInt :: mode :- "dummy" :> Get '[JSON] Int
423− } deriving Generic
424−
425419jwtOnlyApi :: Proxy (API '[Servant.Auth.Server.JWT])
426420jwtOnlyApi = Proxy
427421
@@ -482,7 +476,6 @@ server ccfg =
482476 (\authResult -> case authResult of
483477 Authenticated usr -> getInt usr
484478 :<|> postInt usr
485− :<|> DummyRoutes { dummyInt = getInt usr }
486479 :<|> getHeaderInt
487480#if MIN_VERSION_servant_server(0,15,0)
488481 :<|> return (S.source ["bytestring"])
servant-auth/servant-auth-swagger/servant-auth-swagger.cabal+13−9
@@ -7,9 +7,9 @@ description: This package provides instances that allow generating swagger2 s
77 APIs that use
88 <https://hackage.haskell.org/package/servant-auth servant-auth's> @Auth@ combinator.
99 .
10− For a quick overview of the usage, see the <https://github.com/haskell-servant/servant/tree/master/servant-auth#readme README>.
10+ For a quick overview of the usage, see the <http://github.com/haskell-servant/servant/servant-auth#readme README>.
1111category: Web, Servant, Authentication
12−homepage: https://github.com/haskell-servant/servant/tree/master/servant-auth#readme
12+homepage: http://github.com/haskell-servant/servant/servant-auth#readme
1313bug-reports: https://github.com/haskell-servant/servant/issues
1414author: Julian K. Arni
1515maintainer: jkarni@gmail.com
@@ -31,13 +31,15 @@ library
3131 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
3232 ghc-options: -Wall
3333 build-depends:
34− base >= 4.10 && < 4.17
35− , text >= 1.2.3.0 && < 2.1
34+ base >= 4.10 && < 4.16
35+ , text >= 1.2.3.0 && < 1.3
3636 , servant-swagger >= 1.1.5 && < 2
3737 , swagger2 >= 2.2.2 && < 3
38− , servant >= 0.13 && < 0.20
38+ , servant >= 0.13 && < 0.19
3939 , servant-auth == 0.4.*
40− , lens >= 4.16.1 && < 5.2
40+ , lens >= 4.16.1 && < 5.1
41+ if impl(ghc >= 9)
42+ buildable: False
4143 exposed-modules:
4244 Servant.Auth.Swagger
4345 default-language: Haskell2010
@@ -49,7 +51,7 @@ test-suite spec
4951 test
5052 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
5153 ghc-options: -Wall
52− build-tool-depends: hspec-discover:hspec-discover >= 2.5.5 && <2.10
54+ build-tool-depends: hspec-discover:hspec-discover >= 2.5.5 && <2.9
5355 -- dependencies with bounds inherited from the library stanza
5456 build-depends:
5557 base
@@ -59,11 +61,13 @@ test-suite spec
5961 , servant
6062 , servant-auth
6163 , lens
62−
64+ if impl(ghc >= 9)
65+ buildable: False
66+
6367 -- test dependencies
6468 build-depends:
6569 servant-auth-swagger
66− , hspec >= 2.5.5 && < 2.10
70+ , hspec >= 2.5.5 && < 2.9
6771 , QuickCheck >= 2.11.3 && < 2.15
6872 other-modules:
6973 Servant.Auth.SwaggerSpec
servant-auth/servant-auth/servant-auth.cabal+7−7
@@ -1,6 +1,6 @@
11cabal-version: 2.2
22name: servant-auth
3−version: 0.4.1.0
3+version: 0.4.0.0
44synopsis: Authentication combinators for servant
55description: This package provides an @Auth@ combinator for 'servant'. This combinator
66 allows using different authentication schemes in a straightforward way,
@@ -9,9 +9,9 @@ description: This package provides an @Auth@ combinator for 'servant'. This c
99 'servant-auth' additionally provides concrete authentication schemes, such
1010 as Basic Access Authentication, JSON Web Tokens, and Cookies.
1111 .
12− For more details on how to use this, see the <https://github.com/haskell-servant/servant/tree/master/servant-auth#readme README>.
12+ For more details on how to use this, see the <http://github.com/haskell-servant/servant/servant-auth#readme README>.
1313category: Web, Servant, Authentication
14−homepage: https://github.com/haskell-servant/servant/tree/master/servant-auth#readme
14+homepage: http://github.com/haskell-servant/servant/servant-auth#readme
1515bug-reports: https://github.com/haskell-servant/servant/issues
1616author: Julian K. Arni
1717maintainer: jkarni@gmail.com
@@ -33,13 +33,13 @@ library
3333 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators
3434 ghc-options: -Wall
3535 build-depends:
36− base >= 4.10 && < 4.17
36+ base >= 4.10 && < 4.16
3737 , containers >= 0.6 && < 0.7
3838 , aeson >= 1.3.1.1 && < 3
3939 , jose >= 0.7.0.0 && < 0.10
40− , lens >= 4.16.1 && < 5.2
41− , servant >= 0.15 && < 0.20
42− , text >= 1.2.3.0 && < 2.1
40+ , lens >= 4.16.1 && < 5.1
41+ , servant >= 0.15 && < 0.19
42+ , text >= 1.2.3.0 && < 1.3
4343 , unordered-containers >= 0.2.9.0 && < 0.3
4444 exposed-modules:
4545 Servant.Auth
servant-client-core/CHANGELOG.md−31
@@ -1,37 +1,6 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-client-core/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/): in A.B.C, bumps to either A or B represent major versions.
5−
6−0.19
7−----
8−
9−### Significant changes
10−
11−- Drop support for GHC < 8.6.
12−- Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
13−- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
14− which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
15− related to hash collisions.
16−- Add `NamedRoutes` combinator, making support for records first-class in Servant
17− ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
18−- Add custom type errors for partially applied combinators
19− ([#1289](https://github.com/haskell-servant/servant/pull/1289),
20− [#1486](https://github.com/haskell-servant/servant/pull/1486)).
21−- *servant-client* / *servant-client-core* / *servant-http-streams*: Fix
22− erroneous behavior, where only 2XX status codes would be considered
23− successful, irrelevant of the status parameter specified by the verb
24− combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
25−- *servant-client* / *servant-client-core*: Fix `Show` instance for
26− `Servant.Client.Core.Request`.
27−- *servant-client* / *servant-client-core*: Allow passing arbitrary binary data
28− in Query parameters.
29− ([#1432](https://github.com/haskell-servant/servant/pull/1432)).
30−
31−### Other changes
32−
33−- Various version bumps.
34−
3540.18.3
365------
376
servant-client-core/servant-client-core.cabal+8−8
@@ -1,6 +1,6 @@
11cabal-version: 2.2
22name: servant-client-core
3−version: 0.19
3+version: 0.18.3
44
55synopsis: Core functionality and class for client function generation for servant APIs
66category: Servant, Web
@@ -50,14 +50,14 @@ library
5050 --
5151 -- note: mtl lower bound is so low because of GHC-7.8
5252 build-depends:
53− base >= 4.9 && < 4.17
53+ base >= 4.9 && < 4.16
5454 , bytestring >= 0.10.8.1 && < 0.12
5555 , constraints >= 0.2 && < 0.14
5656 , containers >= 0.5.7.1 && < 0.7
5757 , deepseq >= 1.4.2.0 && < 1.5
58− , text >= 1.2.3.0 && < 2.1
58+ , text >= 1.2.3.0 && < 1.3
5959 , transformers >= 0.5.2.0 && < 0.6
60− , template-haskell >= 2.11.1.0 && < 2.19
60+ , template-haskell >= 2.11.1.0 && < 2.18
6161
6262 if !impl(ghc >= 8.2)
6363 build-depends:
@@ -65,13 +65,13 @@ library
6565
6666 -- Servant dependencies
6767 build-depends:
68− servant >= 0.19
68+ servant >= 0.18.3 && <0.19
6969
7070 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
7171 -- Here can be exceptions if we really need features from the newer versions.
7272 build-depends:
7373 aeson >= 1.4.1.0 && < 3
74− , base-compat >= 0.10.5 && < 0.13
74+ , base-compat >= 0.10.5 && < 0.12
7575 , base64-bytestring >= 1.0.0.1 && < 1.3
7676 , exceptions >= 0.10.0 && < 0.11
7777 , free >= 5.1 && < 5.2
@@ -104,8 +104,8 @@ test-suite spec
104104 -- Additional dependencies
105105 build-depends:
106106 deepseq >= 1.4.2.0 && < 1.5
107− , hspec >= 2.6.0 && < 2.10
107+ , hspec >= 2.6.0 && < 2.9
108108 , QuickCheck >= 2.12.6.1 && < 2.15
109109
110110 build-tool-depends:
111− hspec-discover:hspec-discover >= 2.6.0 && <2.10
111+ hspec-discover:hspec-discover >= 2.6.0 && <2.9
servant-client-core/src/Servant/Client/Core.hs−1
@@ -59,7 +59,6 @@ module Servant.Client.Core
5959 , appendToPath
6060 , setRequestBodyLBS
6161 , setRequestBody
62− , encodeQueryParamValue
6362 ) where
6463import Servant.Client.Core.Auth
6564import Servant.Client.Core.BaseUrl
servant-client-core/src/Servant/Client/Core/HasClient.hs+16−28
@@ -33,7 +33,9 @@ import Control.Arrow
3333import Control.Monad
3434 (unless)
3535import qualified Data.ByteString as BS
36−import qualified Data.ByteString.Lazy as BL
36+import Data.ByteString.Builder
37+ (toLazyByteString)
38+import qualified Data.ByteString.Lazy as BL
3739import Data.Either
3840 (partitionEithers)
3941import Data.Constraint (Dict(..))
@@ -63,7 +65,7 @@ import Data.Text
6365import Data.Proxy
6466 (Proxy (Proxy))
6567import GHC.TypeLits
66− (KnownNat, KnownSymbol, TypeError, symbolVal)
68+ (KnownNat, KnownSymbol, symbolVal)
6769import Network.HTTP.Types
6870 (Status)
6971import qualified Network.HTTP.Types as H
@@ -89,7 +91,6 @@ import Servant.API.Status
8991import Servant.API.TypeLevel (FragmentUnique, AtLeastOneFragment)
9092import Servant.API.Modifiers
9193 (FoldRequired, RequiredArgument, foldRequiredArgument)
92−import Servant.API.TypeErrors
9394import Servant.API.UVerb
9495 (HasStatus, HasStatuses (Statuses, statuses), UVerb, Union, Unique, inject, statusOf, foldMapUnion, matchUnion)
9596
@@ -208,7 +209,7 @@ instance (KnownSymbol capture, ToHttpApiData a, HasClient m api)
208209 clientWithRoute pm (Proxy :: Proxy api)
209210 (appendToPath p req)
210211
211− where p = toEncodedUrlPiece val
212+ where p = (toUrlPiece val)
212213
213214 hoistClientMonad pm _ f cl = \a ->
214215 hoistClientMonad pm (Proxy :: Proxy api) f (cl a)
@@ -243,7 +244,7 @@ instance (KnownSymbol capture, ToHttpApiData a, HasClient m sublayout)
243244 clientWithRoute pm (Proxy :: Proxy sublayout)
244245 (foldl' (flip appendToPath) req ps)
245246
246− where ps = map toEncodedUrlPiece vals
247+ where ps = map (toUrlPiece) vals
247248
248249 hoistClientMonad pm _ f cl = \as ->
249250 hoistClientMonad pm (Proxy :: Proxy sublayout) f (cl as)
@@ -569,7 +570,7 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient m api, SBoolI (FoldRequire
569570 (Proxy :: Proxy mods) add (maybe req add) mparam
570571 where
571572 add :: a -> Request
572− add param = appendToQueryString pname (Just $ encodeQueryParamValue param) req
573+ add param = appendToQueryString pname (Just $ encodeQueryParam param) req
573574
574575 pname :: Text
575576 pname = pack $ symbolVal (Proxy :: Proxy sym)
@@ -577,6 +578,9 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient m api, SBoolI (FoldRequire
577578 hoistClientMonad pm _ f cl = \arg ->
578579 hoistClientMonad pm (Proxy :: Proxy api) f (cl arg)
579580
581+encodeQueryParam :: ToHttpApiData a => a -> BS.ByteString
582+encodeQueryParam = BL.toStrict . toLazyByteString . toEncodedUrlPiece
583+
580584-- | If you use a 'QueryParams' in one of your endpoints in your API,
581585-- the corresponding querying function will automatically take
582586-- an additional argument, a list of values of the type specified
@@ -618,7 +622,7 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient m api)
618622 )
619623
620624 where pname = pack $ symbolVal (Proxy :: Proxy sym)
621− paramlist' = map (Just . encodeQueryParamValue) paramlist
625+ paramlist' = map (Just . encodeQueryParam) paramlist
622626
623627 hoistClientMonad pm _ f cl = \as ->
624628 hoistClientMonad pm (Proxy :: Proxy api) f (cl as)
@@ -740,7 +744,7 @@ instance (KnownSymbol path, HasClient m api) => HasClient m (path :> api) where
740744 clientWithRoute pm (Proxy :: Proxy api)
741745 (appendToPath p req)
742746
743− where p = toEncodedUrlPiece $ pack $ symbolVal (Proxy :: Proxy path)
747+ where p = pack $ symbolVal (Proxy :: Proxy path)
744748
745749 hoistClientMonad pm _ f cl = hoistClientMonad pm (Proxy :: Proxy api) f cl
746750
@@ -874,7 +878,7 @@ infixl 2 /:
874878--
875879-- Example:
876880--
877−-- @
881+-- @@
878882-- type Api = NamedRoutes RootApi
879883--
880884-- data RootApi mode = RootApi
@@ -895,7 +899,7 @@ infixl 2 /:
895899--
896900-- endpointClient :: ClientM Person
897901-- endpointClient = client // subApi // endpoint
898−-- @
902+-- @@
899903(//) :: a -> (a -> b) -> b
900904x // f = f x
901905
@@ -906,7 +910,7 @@ x // f = f x
906910--
907911-- Example:
908912--
909−-- @
913+-- @@
910914-- type Api = NamedRoutes RootApi
911915--
912916-- data RootApi mode = RootApi
@@ -931,7 +935,7 @@ x // f = f x
931935--
932936-- endpointClient :: ClientM Person
933937-- endpointClient = client // subApi /: "foobar123" // endpoint
934−-- @
938+-- @@
935939(/:) :: (a -> b -> c) -> b -> a -> c
936940(/:) = flip
937941
@@ -975,19 +979,3 @@ decodedAs response ct = do
975979 Right val -> return val
976980 where
977981 accept = toList $ contentTypes ct
978−
979−-------------------------------------------------------------------------------
980−-- Custom type errors
981−-------------------------------------------------------------------------------
982−
983−-- Erroring instance for HasClient' when a combinator is not fully applied
984−instance (RunClient m, TypeError (PartialApplication HasClient arr)) => HasClient m ((arr :: a -> b) :> sub)
985− where
986− type Client m (arr :> sub) = TypeError (PartialApplication HasClient arr)
987− clientWithRoute _ _ _ = error "unreachable"
988− hoistClientMonad _ _ _ _ = error "unreachable"
989−
990−-- Erroring instances for 'HasClient' for unknown API combinators
991−instance {-# OVERLAPPABLE #-} (RunClient m, TypeError (NoInstanceForSub (HasClient m) ty)) => HasClient m (ty :> sub)
992−
993−instance {-# OVERLAPPABLE #-} (RunClient m, TypeError (NoInstanceFor (HasClient m api))) => HasClient m api
servant-client-core/src/Servant/Client/Core/Request.hs+7−23
@@ -17,7 +17,6 @@ module Servant.Client.Core.Request (
1717 addHeader,
1818 appendToPath,
1919 appendToQueryString,
20− encodeQueryParamValue,
2120 setRequestBody,
2221 setRequestBodyLBS,
2322 ) where
@@ -34,8 +33,6 @@ import Data.Bifunctor
3433import Data.Bitraversable
3534 (Bitraversable (..), bifoldMapDefault, bimapDefault)
3635import qualified Data.ByteString as BS
37−import Data.ByteString.Builder
38− (Builder)
3936import qualified Data.ByteString.Builder as Builder
4037import qualified Data.ByteString.Lazy as LBS
4138import qualified Data.Sequence as Seq
@@ -51,9 +48,9 @@ import Network.HTTP.Media
5148 (MediaType)
5249import Network.HTTP.Types
5350 (Header, HeaderName, HttpVersion (..), Method, QueryItem,
54− http11, methodGet, urlEncodeBuilder)
51+ http11, methodGet)
5552import Servant.API
56− (ToHttpApiData, toEncodedUrlPiece, toQueryParam, toHeader, SourceIO)
53+ (ToHttpApiData, toEncodedUrlPiece, toHeader, SourceIO)
5754
5855import Servant.Client.Core.Internal (mediaTypeRnf)
5956
@@ -114,7 +111,7 @@ instance (NFData path, NFData body) => NFData (RequestF body path) where
114111 rnfB Nothing = ()
115112 rnfB (Just (b, mt)) = rnf b `seq` mediaTypeRnf mt
116113
117−type Request = RequestF RequestBody Builder
114+type Request = RequestF RequestBody Builder.Builder
118115
119116-- | The request body. R replica of the @http-client@ @RequestBody@.
120117data RequestBody
@@ -145,31 +142,18 @@ defaultRequest = Request
145142 , requestMethod = methodGet
146143 }
147144
148−-- | Append extra path to the request being constructed.
149−--
150−-- Warning: This function assumes that the path fragment is already URL-encoded.
151−appendToPath :: Builder -> Request -> Request
145+appendToPath :: Text -> Request -> Request
152146appendToPath p req
153− = req { requestPath = requestPath req <> "/" <> p }
147+ = req { requestPath = requestPath req <> "/" <> toEncodedUrlPiece p }
154148
155−-- | Append a query parameter to the request being constructed.
156−--
157−appendToQueryString :: Text -- ^ query param name
158− -> Maybe BS.ByteString -- ^ query param value
149+appendToQueryString :: Text -- ^ param name
150+ -> Maybe BS.ByteString -- ^ param value
159151 -> Request
160152 -> Request
161153appendToQueryString pname pvalue req
162154 = req { requestQueryString = requestQueryString req
163155 Seq.|> (encodeUtf8 pname, pvalue)}
164156
165−-- | Encode a query parameter value.
166−--
167−encodeQueryParamValue :: ToHttpApiData a => a -> BS.ByteString
168−encodeQueryParamValue = LBS.toStrict . Builder.toLazyByteString
169− . urlEncodeBuilder True . encodeUtf8 . toQueryParam
170−
171−-- | Add header to the request being constructed.
172−--
173157addHeader :: ToHttpApiData a => HeaderName -> a -> Request -> Request
174158addHeader name val req
175159 = req { requestHeaders = requestHeaders req Seq.|> (name, toHeader val)}
servant-client-ghcjs/servant-client-ghcjs.cabal+3−3
@@ -38,7 +38,7 @@ library
3838 Servant.Client.Internal.XhrClient
3939
4040 build-depends:
41− base >=4.11 && <5
41+ base >=4.11 && <4.12
4242 , bytestring >=0.10 && <0.12
4343 , case-insensitive >=1.2.0.0 && <1.3.0.0
4444 , containers >=0.5 && <0.7
@@ -56,8 +56,8 @@ library
5656
5757 -- strict, as we re-export stuff
5858 build-depends:
59− servant >=0.16 && <0.20
60− , servant-client-core >=0.16 && <0.20
59+ servant >=0.16 && <0.17
60+ , servant-client-core >=0.16 && <0.16.1
6161
6262 hs-source-dirs: src
6363 default-language: Haskell2010
servant-client-ghcjs/src/Servant/Client/Internal/XhrClient.hs+5−8
@@ -120,7 +120,7 @@ instance Exception StreamingNotSupportedException where
120120 displayException _ = "streamingRequest: streaming is not supported!"
121121
122122instance RunClient ClientM where
123− runRequestAcceptStatus = performRequest
123+ runRequest = performRequest
124124 throwClientError = throwError
125125
126126runClientMOrigin :: ClientM a -> ClientEnv -> IO (Either ClientError a)
@@ -152,18 +152,15 @@ runClientM m = do
152152
153153 runClientMOrigin m (ClientEnv (BaseUrl protocol hostname port ""))
154154
155−performRequest :: Maybe [Status] -> Request -> ClientM Response
156−performRequest acceptStatus req = do
155+performRequest :: Request -> ClientM Response
156+performRequest req = do
157157 xhr <- liftIO initXhr
158158 burl <- asks baseUrl
159159 liftIO $ performXhr xhr burl req
160160 resp <- toResponse xhr
161161
162− let status = responseStatusCode resp
163− goodStatus = case acceptStatus of
164− Nothing -> statusIsSuccessful status
165− Just good -> status `elem` good
166− unless goodStatus $ do
162+ let status = statusCode (responseStatusCode resp)
163+ unless (status >= 200 && status < 300) $ do
167164 let f b = (burl, BL.toStrict $ toLazyByteString b)
168165 throwError $ FailureResponse (bimap (const ()) f req) resp
169166
servant-client/CHANGELOG.md−31
@@ -1,37 +1,6 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-client/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/): in A.B.C, bumps to either A or B represent major versions.
5−
6−0.19
7−----
8−
9−### Significant changes
10−
11−- Drop support for GHC < 8.6.
12−- Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
13−- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
14− which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
15− related to hash collisions.
16−- Add `NamedRoutes` combinator, making support for records first-class in Servant
17− ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
18−- Add custom type errors for partially applied combinators
19− ([#1289](https://github.com/haskell-servant/servant/pull/1289),
20− [#1486](https://github.com/haskell-servant/servant/pull/1486)).
21−- *servant-client* / *servant-client-core* / *servant-http-streams*: Fix
22− erroneous behavior, where only 2XX status codes would be considered
23− successful, irrelevant of the status parameter specified by the verb
24− combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
25−- *servant-client* / *servant-client-core*: Fix `Show` instance for
26− `Servant.Client.Core.Request`.
27−- *servant-client* / *servant-client-core*: Allow passing arbitrary binary data
28− in Query parameters.
29− ([#1432](https://github.com/haskell-servant/servant/pull/1432)).
30−
31−### Other changes
32−
33−- Various version bumps.
34−
3540.18.3
365------
376
servant-client/servant-client.cabal+11−11
@@ -1,6 +1,6 @@
11cabal-version: 2.2
22name: servant-client
3−version: 0.19
3+version: 0.18.3
44
55synopsis: Automatic derivation of querying functions for servant
66category: Servant, Web
@@ -41,14 +41,14 @@ library
4141 -- Bundled with GHC: Lower bound to not force re-installs
4242 -- text and mtl are bundled starting with GHC-8.4
4343 build-depends:
44− base >= 4.9 && < 4.17
44+ base >= 4.9 && < 4.16
4545 , bytestring >= 0.10.8.1 && < 0.12
4646 , containers >= 0.5.7.1 && < 0.7
4747 , deepseq >= 1.4.2.0 && < 1.5
4848 , mtl >= 2.2.2 && < 2.3
4949 , stm >= 2.4.5.1 && < 2.6
50− , text >= 1.2.3.0 && < 2.1
51− , time >= 1.6.0.1 && < 1.12
50+ , text >= 1.2.3.0 && < 1.3
51+ , time >= 1.6.0.1 && < 1.10
5252 , transformers >= 0.5.2.0 && < 0.6
5353
5454 if !impl(ghc >= 8.2)
@@ -58,13 +58,13 @@ library
5858 -- Servant dependencies.
5959 -- Strict dependency on `servant-client-core` as we re-export things.
6060 build-depends:
61− servant >= 0.18 && < 0.20
62− , servant-client-core >= 0.19 && < 0.19.1
61+ servant == 0.18.*
62+ , servant-client-core >= 0.18.3 && <0.18.4
6363
6464 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
6565 -- Here can be exceptions if we really need features from the newer versions.
6666 build-depends:
67− base-compat >= 0.10.5 && < 0.13
67+ base-compat >= 0.10.5 && < 0.12
6868 , http-client >= 0.5.13.1 && < 0.8
6969 , http-media >= 0.7.1.3 && < 0.9
7070 , http-types >= 0.12.2 && < 0.13
@@ -124,16 +124,16 @@ test-suite spec
124124 -- Additional dependencies
125125 build-depends:
126126 entropy >= 0.4.1.3 && < 0.5
127− , hspec >= 2.6.0 && < 2.10
127+ , hspec >= 2.6.0 && < 2.9
128128 , HUnit >= 1.6.0.0 && < 1.7
129129 , network >= 2.8.0.0 && < 3.2
130130 , QuickCheck >= 2.12.6.1 && < 2.15
131− , servant == 0.19.*
132− , servant-server == 0.19.*
131+ , servant == 0.18.*
132+ , servant-server == 0.18.*
133133 , tdigest >= 0.2 && < 0.3
134134
135135 build-tool-depends:
136− hspec-discover:hspec-discover >= 2.6.0 && < 2.10
136+ hspec-discover:hspec-discover >= 2.6.0 && < 2.9
137137
138138test-suite readme
139139 type: exitcode-stdio-1.0
servant-client/src/Servant/Client/Internal/HttpClient.hs+8−9
@@ -24,7 +24,7 @@ import Control.Monad
2424import Control.Monad.Base
2525 (MonadBase (..))
2626import Control.Monad.Catch
27− (MonadCatch, MonadThrow, MonadMask)
27+ (MonadCatch, MonadThrow)
2828import Control.Monad.Error.Class
2929 (MonadError (..))
3030import Control.Monad.IO.Class
@@ -80,7 +80,7 @@ data ClientEnv
8080 { manager :: Client.Manager
8181 , baseUrl :: BaseUrl
8282 , cookieJar :: Maybe (TVar Client.CookieJar)
83− , makeClientRequest :: BaseUrl -> Request -> IO Client.Request
83+ , makeClientRequest :: BaseUrl -> Request -> Client.Request
8484 -- ^ this function can be used to customize the creation of @http-client@ requests from @servant@ requests. Default value: 'defaultMakeClientRequest'
8585 -- Note that:
8686 -- 1. 'makeClientRequest' exists to allow overriding operational semantics e.g. 'responseTimeout' per request,
@@ -136,7 +136,7 @@ newtype ClientM a = ClientM
136136 { unClientM :: ReaderT ClientEnv (ExceptT ClientError IO) a }
137137 deriving ( Functor, Applicative, Monad, MonadIO, Generic
138138 , MonadReader ClientEnv, MonadError ClientError, MonadThrow
139− , MonadCatch, MonadMask)
139+ , MonadCatch)
140140
141141instance MonadBase IO ClientM where
142142 liftBase = ClientM . liftBase
@@ -162,7 +162,7 @@ runClientM cm env = runExceptT $ flip runReaderT env $ unClientM cm
162162performRequest :: Maybe [Status] -> Request -> ClientM Response
163163performRequest acceptStatus req = do
164164 ClientEnv m burl cookieJar' createClientRequest <- ask
165− clientRequest <- liftIO $ createClientRequest burl req
165+ let clientRequest = createClientRequest burl req
166166 request <- case cookieJar' of
167167 Nothing -> pure clientRequest
168168 Just cj -> liftIO $ do
@@ -229,8 +229,8 @@ clientResponseToResponse f r = Response
229229-- | Create a @http-client@ 'Client.Request' from a @servant@ 'Request'
230230-- The 'Client.host', 'Client.path' and 'Client.port' fields are extracted from the 'BaseUrl'
231231-- otherwise the body, headers and query string are derived from the @servant@ 'Request'
232−defaultMakeClientRequest :: BaseUrl -> Request -> IO Client.Request
233−defaultMakeClientRequest burl r = return Client.defaultRequest
232+defaultMakeClientRequest :: BaseUrl -> Request -> Client.Request
233+defaultMakeClientRequest burl r = Client.defaultRequest
234234 { Client.method = requestMethod r
235235 , Client.host = fromString $ baseUrlHost burl
236236 , Client.port = baseUrlPort burl
@@ -246,7 +246,7 @@ defaultMakeClientRequest burl r = return Client.defaultRequest
246246 where
247247 -- Content-Type and Accept are specified by requestBody and requestAccept
248248 headers = filter (\(h, _) -> h /= "Accept" && h /= "Content-Type") $
249− toList $ requestHeaders r
249+ toList $requestHeaders r
250250
251251 acceptHdr
252252 | null hs = Nothing
@@ -289,8 +289,7 @@ defaultMakeClientRequest burl r = return Client.defaultRequest
289289 Https -> True
290290
291291 -- Query string builder which does not do any encoding
292− buildQueryString [] = mempty
293− buildQueryString qps = "?" <> foldl' addQueryParam mempty qps
292+ buildQueryString = ("?" <>) . foldl' addQueryParam mempty
294293
295294 addQueryParam qs (k, v) =
296295 qs <> (if BS.null qs then mempty else "&") <> urlEncode True k <> foldMap ("=" <>) v
servant-client/src/Servant/Client/Internal/HttpClient/Streaming.hs+2−2
@@ -140,7 +140,7 @@ performRequest :: Maybe [Status] -> Request -> ClientM Response
140140performRequest acceptStatus req = do
141141 -- TODO: should use Client.withResponse here too
142142 ClientEnv m burl cookieJar' createClientRequest <- ask
143− clientRequest <- liftIO $ createClientRequest burl req
143+ let clientRequest = createClientRequest burl req
144144 request <- case cookieJar' of
145145 Nothing -> pure clientRequest
146146 Just cj -> liftIO $ do
@@ -177,7 +177,7 @@ performWithStreamingRequest req k = do
177177 m <- asks manager
178178 burl <- asks baseUrl
179179 createClientRequest <- asks makeClientRequest
180− request <- liftIO $ createClientRequest burl req
180+ let request = createClientRequest burl req
181181 ClientM $ lift $ lift $ Codensity $ \k1 ->
182182 Client.withResponse request m $ \res -> do
183183 let status = Client.responseStatus res
servant-client/test/Servant/ClientTestUtils.hs+1−13
@@ -160,7 +160,6 @@ type Api =
160160 WithStatus 301 Text]
161161 :<|> "uverb-get-created" :> UVerb 'GET '[PlainText] '[WithStatus 201 Person]
162162 :<|> NamedRoutes RecordRoutes
163− :<|> "captureVerbatim" :> Capture "someString" Verbatim :> Get '[PlainText] Text
164163
165164api :: Proxy Api
166165api = Proxy
@@ -215,8 +214,7 @@ getRoot
215214 :<|> EmptyClient
216215 :<|> uverbGetSuccessOrRedirect
217216 :<|> uverbGetCreated
218− :<|> recordRoutes
219− :<|> captureVerbatim = client api
217+ :<|> recordRoutes = client api
220218
221219server :: Application
222220server = serve api (
@@ -261,7 +259,6 @@ server = serve api (
261259 { something = pure ["foo", "bar", "pweet"]
262260 }
263261 }
264− :<|> pure . decodeUtf8 . unVerbatim
265262 )
266263
267264-- * api for testing failures
@@ -373,12 +370,3 @@ instance ToHttpApiData UrlEncodedByteString where
373370
374371instance FromHttpApiData UrlEncodedByteString where
375372 parseUrlPiece = pure . UrlEncodedByteString . HTTP.urlDecode True . encodeUtf8
376−
377−newtype Verbatim = Verbatim { unVerbatim :: ByteString }
378−
379−instance ToHttpApiData Verbatim where
380− toEncodedUrlPiece = byteString . unVerbatim
381− toUrlPiece = decodeUtf8 . unVerbatim
382−
383−instance FromHttpApiData Verbatim where
384− parseUrlPiece = pure . Verbatim . encodeUtf8
servant-client/test/Servant/SuccessSpec.hs+1−11
@@ -36,8 +36,6 @@ import Data.Maybe
3636import Data.Monoid ()
3737import Data.Text
3838 (Text)
39−import Data.Text.Encoding
40− (encodeUtf8)
4139import qualified Network.HTTP.Client as C
4240import qualified Network.HTTP.Types as HTTP
4341import Test.Hspec
@@ -162,8 +160,7 @@ successSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do
162160 mgr <- C.newManager C.defaultManagerSettings
163161 -- In proper situation, extra headers should probably be visible in API type.
164162 -- However, testing for response timeout is difficult, so we test with something which is easy to observe
165− let createClientRequest url r = fmap (\req -> req { C.requestHeaders = [("X-Added-Header", "XXX")] })
166− (defaultMakeClientRequest url r)
163+ let createClientRequest url r = (defaultMakeClientRequest url r) { C.requestHeaders = [("X-Added-Header", "XXX")] }
167164 clientEnv = (mkClientEnv mgr baseUrl) { makeClientRequest = createClientRequest }
168165 res <- runClientM (getRawSuccessPassHeaders HTTP.methodGet) clientEnv
169166 case res of
@@ -199,10 +196,3 @@ successSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do
199196 case eitherResponse of
200197 Left clientError -> fail $ show clientError
201198 Right response -> matchUnion response `shouldBe` Just (WithStatus @201 carol)
202−
203− it "encodes URL pieces following ToHttpApiData instance" $ \(_, baseUrl) -> do
204− let textOrig = "*"
205− eitherResponse <- runClient (captureVerbatim $ Verbatim $ encodeUtf8 textOrig) baseUrl
206− case eitherResponse of
207− Left clientError -> fail $ show clientError
208− Right textBack -> textBack `shouldBe` textOrig
servant-conduit/servant-conduit.cabal+4−4
@@ -23,7 +23,7 @@ extra-source-files:
2323
2424source-repository head
2525 type: git
26− location: http://github.com/haskell-servant/servant.git
26+ location: http://github.com/haskell-servant/servant-conduit.git
2727
2828library
2929 exposed-modules: Servant.Conduit
@@ -33,7 +33,7 @@ library
3333 , conduit >=1.3.1 && <1.4
3434 , mtl >=2.2.2 && <2.3
3535 , resourcet >=1.2.2 && <1.3
36− , servant >=0.15 && <0.20
36+ , servant >=0.15 && <0.19
3737 , unliftio-core >=0.1.2.0 && <0.3
3838 hs-source-dirs: src
3939 default-language: Haskell2010
@@ -54,8 +54,8 @@ test-suite example
5454 , resourcet
5555 , servant
5656 , servant-conduit
57− , servant-server >=0.15 && <0.20
58− , servant-client >=0.15 && <0.20
57+ , servant-server >=0.15 && <0.19
58+ , servant-client >=0.15 && <0.19
5959 , wai >=3.2.1.2 && <3.3
6060 , warp >=3.2.25 && <3.4
6161 , http-client
servant-docs/CHANGELOG.md−9
@@ -1,15 +1,6 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-docs/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−0.12
5−----
6−
7−### Significant changes
8−
9−- Generate sample cURL requests
10− ([#1401](https://github.com/haskell-servant/servant/pull/1401/files)).
11− Breaking change: requires sample header values to be supplied with `headers`.
12−
1340.11.9
145------
156
servant-docs/servant-docs.cabal+7−7
@@ -1,6 +1,6 @@
11cabal-version: 2.2
22name: servant-docs
3−version: 0.12
3+version: 0.11.9
44
55synopsis: generate API docs for your servant webservice
66category: Servant, Web
@@ -41,25 +41,25 @@ library
4141 --
4242 -- note: mtl lower bound is so low because of GHC-7.8
4343 build-depends:
44− base >= 4.9 && < 4.17
44+ base >= 4.9 && < 4.16
4545 , bytestring >= 0.10.8.1 && < 0.12
46− , text >= 1.2.3.0 && < 2.1
46+ , text >= 1.2.3.0 && < 1.3
4747
4848 -- Servant dependencies
4949 build-depends:
50− servant >= 0.18 && <0.20
50+ servant >= 0.18 && <0.19
5151
5252 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
5353 -- Here can be exceptions if we really need features from the newer versions.
5454 build-depends:
5555 aeson >= 1.4.1.0 && < 3
5656 , aeson-pretty >= 0.8.5 && < 0.9
57− , base-compat >= 0.10.5 && < 0.13
57+ , base-compat >= 0.10.5 && < 0.12
5858 , case-insensitive >= 1.2.0.11 && < 1.3
59− , hashable >= 1.2.7.0 && < 1.5
59+ , hashable >= 1.2.7.0 && < 1.4
6060 , http-media >= 0.7.1.3 && < 0.9
6161 , http-types >= 0.12.2 && < 0.13
62− , lens >= 4.17 && < 5.2
62+ , lens >= 4.17 && < 5.1
6363 , string-conversions >= 0.4.0.1 && < 0.5
6464 , universe-base >= 1.1.1 && < 1.2
6565 , unordered-containers >= 0.2.9.0 && < 0.3
servant-docs/src/Servant/Docs/Internal.hs−4
@@ -62,7 +62,6 @@ import GHC.TypeLits
6262import Servant.API
6363import Servant.API.ContentTypes
6464import Servant.API.TypeLevel
65−import Servant.API.Generic
6665
6766import qualified Data.Universe.Helpers as U
6867
@@ -1151,9 +1150,6 @@ instance (ToAuthInfo (BasicAuth realm usr), HasDocs api) => HasDocs (BasicAuth r
11511150 authProxy = Proxy :: Proxy (BasicAuth realm usr)
11521151 action' = over authInfo (|> toAuthInfo authProxy) action
11531152
1154−instance HasDocs (ToServantApi api) => HasDocs (NamedRoutes api) where
1155− docsFor Proxy = docsFor (Proxy :: Proxy (ToServantApi api))
1156−
11571153-- ToSample instances for simple types
11581154instance ToSample NoContent
11591155instance ToSample Bool
servant-foreign/servant-foreign.cabal+7−7
@@ -41,18 +41,18 @@ library
4141 --
4242 -- note: mtl lower bound is so low because of GHC-7.8
4343 build-depends:
44− base >= 4.9 && < 4.17
45− , text >= 1.2.3.0 && < 2.1
44+ base >= 4.9 && < 4.16
45+ , text >= 1.2.3.0 && < 1.3
4646
4747 -- Servant dependencies
4848 build-depends:
49− servant >=0.18 && <0.20
49+ servant >=0.18 && <0.19
5050
5151 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
5252 -- Here can be exceptions if we really need features from the newer versions.
5353 build-depends:
54− base-compat >= 0.10.5 && < 0.13
55− , lens >= 4.17 && < 5.2
54+ base-compat >= 0.10.5 && < 0.12
55+ , lens >= 4.17 && < 5.1
5656 , http-types >= 0.12.2 && < 0.13
5757
5858 hs-source-dirs: src
@@ -74,7 +74,7 @@ test-suite spec
7474
7575 -- Additional dependencies
7676 build-depends:
77− hspec >= 2.6.0 && <2.10
77+ hspec >= 2.6.0 && <2.9
7878 build-tool-depends:
79− hspec-discover:hspec-discover >=2.6.0 && <2.10
79+ hspec-discover:hspec-discover >=2.6.0 && <2.9
8080 default-language: Haskell2010
servant-http-streams/CHANGELOG.md−10
@@ -1,16 +1,6 @@
11 [The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-http-streams/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−0.18.4
5−------
6−
7−### Significant changes
8−
9−- *servant-client* / *servant-client-core* / *servant-http-streams*:
10− Fix erroneous behavior, where only 2XX status codes would be considered
11− successful, irrelevant of the status parameter specified by the verb
12− combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
13−
1440.18.3
155------
166
servant-http-streams/servant-http-streams.cabal+13−13
@@ -1,6 +1,6 @@
11cabal-version: 2.2
22name: servant-http-streams
3−version: 0.18.4
3+version: 0.18.3
44
55synopsis: Automatic derivation of querying functions for servant
66category: Servant, Web
@@ -38,13 +38,13 @@ library
3838 -- Bundled with GHC: Lower bound to not force re-installs
3939 -- text and mtl are bundled starting with GHC-8.4
4040 build-depends:
41− base >= 4.9 && < 4.17
41+ base >= 4.9 && < 4.16
4242 , bytestring >= 0.10.8.1 && < 0.12
4343 , containers >= 0.5.7.1 && < 0.7
4444 , deepseq >= 1.4.2.0 && < 1.5
4545 , mtl >= 2.2.2 && < 2.3
46− , text >= 1.2.3.0 && < 2.1
47− , time >= 1.6.0.1 && < 1.12
46+ , text >= 1.2.3.0 && < 1.3
47+ , time >= 1.6.0.1 && < 1.10
4848 , transformers >= 0.5.2.0 && < 0.6
4949
5050 if !impl(ghc >= 8.2)
@@ -54,25 +54,25 @@ library
5454 -- Servant dependencies.
5555 -- Strict dependency on `servant-client-core` as we re-export things.
5656 build-depends:
57− servant >= 0.18 && < 0.20
58− , servant-client-core >= 0.18.3 && <0.20
57+ servant == 0.18.*
58+ , servant-client-core >= 0.18.3 && <0.18.4
5959
6060 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
6161 -- Here can be exceptions if we really need features from the newer versions.
6262 build-depends:
63− base-compat >= 0.10.5 && < 0.13
63+ base-compat >= 0.10.5 && < 0.12
6464 , case-insensitive
6565 , http-streams >= 0.8.6.1 && < 0.9
6666 , http-media >= 0.7.1.3 && < 0.9
6767 , io-streams >= 1.5.0.1 && < 1.6
6868 , http-types >= 0.12.2 && < 0.13
69− , http-common >= 0.8.2.0 && < 0.9
69+ , http-common >= 0.8.2.0 && < 0.8.3
7070 , exceptions >= 0.10.0 && < 0.11
7171 , kan-extensions >= 5.2 && < 5.3
7272 , monad-control >= 1.0.2.3 && < 1.1
7373 , semigroupoids >= 5.3.1 && < 5.4
7474 , transformers-base >= 0.4.5.2 && < 0.5
75− , transformers-compat >= 0.6.2 && < 0.8
75+ , transformers-compat >= 0.6.2 && < 0.7
7676
7777 hs-source-dirs: src
7878 default-language: Haskell2010
@@ -112,16 +112,16 @@ test-suite spec
112112 -- Additional dependencies
113113 build-depends:
114114 entropy >= 0.4.1.3 && < 0.5
115− , hspec >= 2.6.0 && < 2.10
115+ , hspec >= 2.6.0 && < 2.9
116116 , HUnit >= 1.6.0.0 && < 1.7
117117 , network >= 2.8.0.0 && < 3.2
118118 , QuickCheck >= 2.12.6.1 && < 2.15
119− , servant == 0.19.*
120− , servant-server == 0.19.*
119+ , servant == 0.18.*
120+ , servant-server == 0.18.*
121121 , tdigest >= 0.2 && < 0.3
122122
123123 build-tool-depends:
124− hspec-discover:hspec-discover >= 2.6.0 && < 2.10
124+ hspec-discover:hspec-discover >= 2.6.0 && < 2.9
125125
126126test-suite readme
127127 type: exitcode-stdio-1.0
servant-machines/servant-machines.cabal+4−4
@@ -23,7 +23,7 @@ extra-source-files:
2323
2424source-repository head
2525 type: git
26− location: http://github.com/haskell-servant/servant.git
26+ location: http://github.com/haskell-servant/servant-machines.git
2727
2828library
2929 exposed-modules: Servant.Machines
@@ -32,7 +32,7 @@ library
3232 , bytestring >=0.10.8.1 && <0.12
3333 , machines >=0.6.4 && <0.8
3434 , mtl >=2.2.2 && <2.3
35− , servant >=0.15 && <0.20
35+ , servant >=0.15 && <0.19
3636 hs-source-dirs: src
3737 default-language: Haskell2010
3838 ghc-options: -Wall
@@ -51,8 +51,8 @@ test-suite example
5151 , servant
5252 , machines
5353 , servant-machines
54− , servant-server >=0.15 && <0.20
55− , servant-client >=0.15 && <0.20
54+ , servant-server >=0.15 && <0.19
55+ , servant-client >=0.15 && <0.19
5656 , wai >=3.2.1.2 && <3.3
5757 , warp >=3.2.25 && <3.4
5858 , http-client
servant-pipes/servant-pipes.cabal+4−4
@@ -23,7 +23,7 @@ extra-source-files:
2323
2424source-repository head
2525 type: git
26− location: http://github.com/haskell-servant/servant.git
26+ location: http://github.com/haskell-servant/servant-pipes.git
2727
2828library
2929 exposed-modules: Servant.Pipes
@@ -34,7 +34,7 @@ library
3434 , pipes-safe >=2.3.1 && <2.4
3535 , mtl >=2.2.2 && <2.3
3636 , monad-control >=1.0.2.3 && <1.1
37− , servant >=0.15 && <0.20
37+ , servant >=0.15 && <0.19
3838 hs-source-dirs: src
3939 default-language: Haskell2010
4040 ghc-options: -Wall
@@ -55,8 +55,8 @@ test-suite example
5555 , pipes-safe
5656 , servant-pipes
5757 , pipes-bytestring >=2.1.6 && <2.2
58− , servant-server >=0.15 && <0.20
59− , servant-client >=0.15 && <0.20
58+ , servant-server >=0.15 && <0.19
59+ , servant-client >=0.15 && <0.19
6060 , wai >=3.2.1.2 && <3.3
6161 , warp >=3.2.25 && <3.4
6262 , http-client
servant-server/CHANGELOG.md−24
@@ -1,30 +1,6 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-server/CHANGELOG.md)
22[Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
33
4−Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/): in A.B.C, bumps to either A or B represent major versions.
5−
6−0.19.1
7−------
8−
9−- Add `MonadFail` instance for `Handler` wrt [#1545](https://github.com/haskell-servant/servant/issues/1545)
10−- Support GHC 9.2 [#1525](https://github.com/haskell-servant/servant/issues/1525)
11−
12−0.19
13−----
14−
15−### Significant changes
16−
17−- Drop support for GHC < 8.6.
18−- Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
19−- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
20− which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
21− related to hash collisions.
22−- Add `NamedRoutes` combinator, making support for records first-class in Servant
23− ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
24−- Add custom type errors for partially applied combinators
25− ([#1289](https://github.com/haskell-servant/servant/pull/1289),
26− [#1486](https://github.com/haskell-servant/servant/pull/1486)).
27−
2840.18.3
295------
306
servant-server/example/greet.hs+1
@@ -18,6 +18,7 @@ import Network.Wai.Handler.Warp
1818
1919import Servant
2020import Servant.Server.Generic ()
21+import Servant.API.Generic
2122
2223-- * Example
2324
servant-server/servant-server.cabal+7−7
@@ -1,6 +1,6 @@
11cabal-version: 2.2
22name: servant-server
3−version: 0.19.1
3+version: 0.18.3
44
55synopsis: A family of combinators for defining webservices APIs and serving them
66category: Servant, Web
@@ -60,25 +60,25 @@ library
6060 -- Bundled with GHC: Lower bound to not force re-installs
6161 -- text and mtl are bundled starting with GHC-8.4
6262 build-depends:
63− base >= 4.9 && < 4.17
63+ base >= 4.9 && < 4.16
6464 , bytestring >= 0.10.8.1 && < 0.12
6565 , constraints >= 0.2 && < 0.14
6666 , containers >= 0.5.7.1 && < 0.7
6767 , mtl >= 2.2.2 && < 2.3
68− , text >= 1.2.3.0 && < 2.1
68+ , text >= 1.2.3.0 && < 1.3
6969 , transformers >= 0.5.2.0 && < 0.6
7070 , filepath >= 1.4.1.1 && < 1.5
7171
7272 -- Servant dependencies
7373 -- strict dependency as we re-export 'servant' things.
7474 build-depends:
75− servant >= 0.19 && < 0.20
75+ servant >= 0.18.3 && < 0.18.4
7676 , http-api-data >= 0.4.1 && < 0.4.4
7777
7878 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
7979 -- Here can be exceptions if we really need features from the newer versions.
8080 build-depends:
81− base-compat >= 0.10.5 && < 0.13
81+ base-compat >= 0.10.5 && < 0.12
8282 , base64-bytestring >= 1.0.0.1 && < 1.3
8383 , exceptions >= 0.10.0 && < 0.11
8484 , http-media >= 0.7.1.3 && < 0.9
@@ -159,7 +159,7 @@ test-suite spec
159159 build-depends:
160160 aeson >= 1.4.1.0 && < 3
161161 , directory >= 1.3.0.0 && < 1.4
162− , hspec >= 2.6.0 && < 2.10
162+ , hspec >= 2.6.0 && < 2.9
163163 , hspec-wai >= 0.10.1 && < 0.12
164164 , QuickCheck >= 2.12.6.1 && < 2.15
165165 , should-not-typecheck >= 2.1.0 && < 2.2
@@ -167,4 +167,4 @@ test-suite spec
167167 , wai-extra >= 3.0.24.3 && < 3.2
168168
169169 build-tool-depends:
170− hspec-discover:hspec-discover >= 2.6.0 && <2.10
170+ hspec-discover:hspec-discover >= 2.6.0 && <2.9
servant-server/src/Servant/Server.hs+2−3
@@ -235,7 +235,7 @@ hoistServer p = hoistServerWithContext p (Proxy :: Proxy '[])
235235-- > │ └─ e/
236236-- > │ └─•
237237-- > ├─ b/
238−-- > │ └─ <x::Int>/
238+-- > │ └─ <capture>/
239239-- > │ ├─•
240240-- > │ ┆
241241-- > │ └─•
@@ -252,8 +252,7 @@ hoistServer p = hoistServerWithContext p (Proxy :: Proxy '[])
252252--
253253-- [@─•@] Leaves reflect endpoints.
254254--
255−-- [@\<x::Int\>/@] This is a delayed capture of a single
256−-- path component named @x@, of expected type @Int@.
255+-- [@\<capture\>/@] This is a delayed capture of a path component.
257256--
258257-- [@\<raw\>@] This is a part of the API we do not know anything about.
259258--
servant-server/src/Servant/Server/Internal.hs+35−24
@@ -41,7 +41,7 @@ import qualified Data.ByteString as B
4141import qualified Data.ByteString.Builder as BB
4242import qualified Data.ByteString.Char8 as BC8
4343import qualified Data.ByteString.Lazy as BL
44−import Data.Constraint (Constraint, Dict(..))
44+import Data.Constraint (Dict(..))
4545import Data.Either
4646 (partitionEithers)
4747import Data.Maybe
@@ -56,7 +56,7 @@ import qualified Data.Text as T
5656import Data.Typeable
5757import GHC.Generics
5858import GHC.TypeLits
59− (KnownNat, KnownSymbol, TypeError, symbolVal)
59+ (KnownNat, KnownSymbol, symbolVal)
6060import qualified Network.HTTP.Media as NHM
6161import Network.HTTP.Types hiding
6262 (Header, ResponseHeaders)
@@ -90,7 +90,6 @@ import Servant.API.ResponseHeaders
9090import Servant.API.Status
9191 (statusFromNat)
9292import qualified Servant.Types.SourceT as S
93−import Servant.API.TypeErrors
9493import Web.HttpApiData
9594 (FromHttpApiData, parseHeader, parseQueryParam, parseUrlPiece,
9695 parseUrlPieces)
@@ -173,7 +172,7 @@ instance (HasServer a context, HasServer b context) => HasServer (a :<|> b) cont
173172-- > server = getBook
174173-- > where getBook :: Text -> Handler Book
175174-- > getBook isbn = ...
176−instance (KnownSymbol capture, FromHttpApiData a, Typeable a
175+instance (KnownSymbol capture, FromHttpApiData a
177176 , HasServer api context, SBoolI (FoldLenient mods)
178177 , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
179178 )
@@ -185,7 +184,7 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a
185184 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
186185
187186 route Proxy context d =
188− CaptureRouter [hint] $
187+ CaptureRouter $
189188 route (Proxy :: Proxy api)
190189 context
191190 (addCapture d $ \ txt -> withRequest $ \ request ->
@@ -197,7 +196,6 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a
197196 where
198197 rep = typeRep (Proxy :: Proxy Capture')
199198 formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
200− hint = CaptureHint (T.pack $ symbolVal $ Proxy @capture) (typeRep (Proxy :: Proxy a))
201199
202200-- | If you use 'CaptureAll' in one of the endpoints for your API,
203201-- this automatically requires your server-side handler to be a
@@ -216,7 +214,7 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a
216214-- > server = getSourceFile
217215-- > where getSourceFile :: [Text] -> Handler Book
218216-- > getSourceFile pathSegments = ...
219−instance (KnownSymbol capture, FromHttpApiData a, Typeable a
217+instance (KnownSymbol capture, FromHttpApiData a
220218 , HasServer api context
221219 , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters
222220 )
@@ -228,7 +226,7 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a
228226 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s
229227
230228 route Proxy context d =
231− CaptureAllRouter [hint] $
229+ CaptureAllRouter $
232230 route (Proxy :: Proxy api)
233231 context
234232 (addCapture d $ \ txts -> withRequest $ \ request ->
@@ -239,7 +237,6 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a
239237 where
240238 rep = typeRep (Proxy :: Proxy CaptureAll)
241239 formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)
242− hint = CaptureHint (T.pack $ symbolVal $ Proxy @capture) (typeRep (Proxy :: Proxy [a]))
243240
244241allowedMethodHead :: Method -> Request -> Bool
245242allowedMethodHead method request = method == methodGet && requestMethod request == methodHead
@@ -817,15 +814,38 @@ instance (HasContextEntry context (NamedContext name subContext), HasServer subA
817814 hoistServerWithContext _ _ nt s = hoistServerWithContext (Proxy :: Proxy subApi) (Proxy :: Proxy subContext) nt s
818815
819816-------------------------------------------------------------------------------
820−-- Custom type errors
817+-- TypeError helpers
821818-------------------------------------------------------------------------------
822819
823−-- Erroring instance for 'HasServer' when a combinator is not fully applied
824−instance TypeError (PartialApplication HasServer arr) => HasServer ((arr :: a -> b) :> sub) context
820+-- | This instance catches mistakes when there are non-saturated
821+-- type applications on LHS of ':>'.
822+--
823+-- >>> serve (Proxy :: Proxy (Capture "foo" :> Get '[JSON] Int)) (error "...")
824+-- ...
825+-- ...Expected something of kind Symbol or *, got: k -> l on the LHS of ':>'.
826+-- ...Maybe you haven't applied enough arguments to
827+-- ...Capture' '[] "foo"
828+-- ...
829+--
830+-- >>> undefined :: Server (Capture "foo" :> Get '[JSON] Int)
831+-- ...
832+-- ...Expected something of kind Symbol or *, got: k -> l on the LHS of ':>'.
833+-- ...Maybe you haven't applied enough arguments to
834+-- ...Capture' '[] "foo"
835+-- ...
836+--
837+instance TypeError (HasServerArrowKindError arr) => HasServer ((arr :: k -> l) :> api) context
825838 where
826− type ServerT (arr :> sub) _ = TypeError (PartialApplication (HasServer :: * -> [*] -> Constraint) arr)
827− route = error "unreachable"
828− hoistServerWithContext _ _ _ _ = error "unreachable"
839+ type ServerT (arr :> api) m = TypeError (HasServerArrowKindError arr)
840+ -- it doesn't really matter what sub route we peak
841+ route _ _ _ = error "servant-server panic: impossible happened in HasServer (arr :> api)"
842+ hoistServerWithContext _ _ _ = id
843+
844+-- Cannot have TypeError here, otherwise use of this symbol will error :)
845+type HasServerArrowKindError arr =
846+ 'Text "Expected something of kind Symbol or *, got: k -> l on the LHS of ':>'."
847+ ':$$: 'Text "Maybe you haven't applied enough arguments to"
848+ ':$$: 'ShowType arr
829849
830850-- | This instance prevents from accidentally using '->' instead of ':>'
831851--
@@ -860,15 +880,6 @@ type HasServerArrowTypeError a b =
860880 ':$$: 'Text "and"
861881 ':$$: 'ShowType b
862882
863−-- Erroring instances for 'HasServer' for unknown API combinators
864−
865−-- XXX: This omits the @context@ parameter, e.g.:
866−--
867−-- "There is no instance for HasServer (Bool :> …)". Do we care ?
868−instance {-# OVERLAPPABLE #-} TypeError (NoInstanceForSub HasServer ty) => HasServer (ty :> sub) context
869−
870−instance {-# OVERLAPPABLE #-} TypeError (NoInstanceFor (HasServer api context)) => HasServer api context
871−
872883-- | Ignore @'Fragment'@ in server handlers.
873884-- See <https://ietf.org/rfc/rfc2616.html#section-15.1.3> for more details.
874885--
servant-server/src/Servant/Server/Internal/Handler.hs+2−7
@@ -13,19 +13,17 @@ import Control.Monad.Base
1313import Control.Monad.Catch
1414 (MonadCatch, MonadMask, MonadThrow)
1515import Control.Monad.Error.Class
16− (MonadError, throwError)
16+ (MonadError)
1717import Control.Monad.IO.Class
1818 (MonadIO)
1919import Control.Monad.Trans.Control
2020 (MonadBaseControl (..))
2121import Control.Monad.Trans.Except
2222 (ExceptT, runExceptT)
23−import Data.String
24− (fromString)
2523import GHC.Generics
2624 (Generic)
2725import Servant.Server.Internal.ServerError
28− (ServerError, errBody, err500)
26+ (ServerError)
2927
3028newtype Handler a = Handler { runHandler' :: ExceptT ServerError IO a }
3129 deriving
@@ -34,9 +32,6 @@ newtype Handler a = Handler { runHandler' :: ExceptT ServerError IO a }
3432 , MonadThrow, MonadCatch, MonadMask
3533 )
3634
37−instance MonadFail Handler where
38− fail str = throwError err500 { errBody = fromString str }
39−
4035instance MonadBase IO Handler where
4136 liftBase = Handler . liftBase
4237
servant-server/src/Servant/Server/Internal/Router.hs+14−31
@@ -9,16 +9,12 @@ import Prelude.Compat
99
1010import Data.Function
1111 (on)
12−import Data.List
13− (nub)
1412import Data.Map
1513 (Map)
1614import qualified Data.Map as M
1715import Data.Text
1816 (Text)
1917import qualified Data.Text as T
20−import Data.Typeable
21− (TypeRep)
2218import Network.Wai
2319 (Response, pathInfo)
2420import Servant.Server.Internal.ErrorFormatter
@@ -28,18 +24,6 @@ import Servant.Server.Internal.ServerError
2824
2925type Router env = Router' env RoutingApplication
3026
31−data CaptureHint = CaptureHint
32− { captureName :: Text
33− , captureType :: TypeRep
34− }
35− deriving (Show, Eq)
36−
37−toCaptureTag :: CaptureHint -> Text
38−toCaptureTag hint = captureName hint <> "::" <> (T.pack . show) (captureType hint)
39−
40−toCaptureTags :: [CaptureHint] -> Text
41−toCaptureTags hints = "<" <> T.intercalate "|" (map toCaptureTag hints) <> ">"
42−
4327-- | Internal representation of a router.
4428--
4529-- The first argument describes an environment type that is
@@ -52,10 +36,10 @@ data Router' env a =
5236 -- ^ the map contains routers for subpaths (first path component used
5337 -- for lookup and removed afterwards), the list contains handlers
5438 -- for the empty path, to be tried in order
55− | CaptureRouter [CaptureHint] (Router' (Text, env) a)
39+ | CaptureRouter (Router' (Text, env) a)
5640 -- ^ first path component is passed to the child router in its
5741 -- environment and removed afterwards
58− | CaptureAllRouter [CaptureHint] (Router' ([Text], env) a)
42+ | CaptureAllRouter (Router' ([Text], env) a)
5943 -- ^ all path components are passed to the child router in its
6044 -- environment and are removed afterwards
6145 | RawRouter (env -> a)
@@ -85,8 +69,8 @@ leafRouter l = StaticRouter M.empty [l]
8569choice :: Router' env a -> Router' env a -> Router' env a
8670choice (StaticRouter table1 ls1) (StaticRouter table2 ls2) =
8771 StaticRouter (M.unionWith choice table1 table2) (ls1 ++ ls2)
88−choice (CaptureRouter hints1 router1) (CaptureRouter hints2 router2) =
89− CaptureRouter (nub $ hints1 ++ hints2) (choice router1 router2)
72+choice (CaptureRouter router1) (CaptureRouter router2) =
73+ CaptureRouter (choice router1 router2)
9074choice router1 (Choice router2 router3) = Choice (choice router1 router2) router3
9175choice router1 router2 = Choice router1 router2
9276
@@ -100,7 +84,7 @@ choice router1 router2 = Choice router1 router2
10084--
10185data RouterStructure =
10286 StaticRouterStructure (Map Text RouterStructure) Int
103− | CaptureRouterStructure [CaptureHint] RouterStructure
87+ | CaptureRouterStructure RouterStructure
10488 | RawRouterStructure
10589 | ChoiceStructure RouterStructure RouterStructure
10690 deriving (Eq, Show)
@@ -114,11 +98,11 @@ data RouterStructure =
11498routerStructure :: Router' env a -> RouterStructure
11599routerStructure (StaticRouter m ls) =
116100 StaticRouterStructure (fmap routerStructure m) (length ls)
117−routerStructure (CaptureRouter hints router) =
118− CaptureRouterStructure hints $
101+routerStructure (CaptureRouter router) =
102+ CaptureRouterStructure $
119103 routerStructure router
120−routerStructure (CaptureAllRouter hints router) =
121− CaptureRouterStructure hints $
104+routerStructure (CaptureAllRouter router) =
105+ CaptureRouterStructure $
122106 routerStructure router
123107routerStructure (RawRouter _) =
124108 RawRouterStructure
@@ -130,8 +114,8 @@ routerStructure (Choice r1 r2) =
130114-- | Compare the structure of two routers.
131115--
132116sameStructure :: Router' env a -> Router' env b -> Bool
133−sameStructure router1 router2 =
134− routerStructure router1 == routerStructure router2
117+sameStructure r1 r2 =
118+ routerStructure r1 == routerStructure r2
135119
136120-- | Provide a textual representation of the
137121-- structure of a router.
@@ -142,8 +126,7 @@ routerLayout router =
142126 where
143127 mkRouterLayout :: Bool -> RouterStructure -> [Text]
144128 mkRouterLayout c (StaticRouterStructure m n) = mkSubTrees c (M.toList m) n
145− mkRouterLayout c (CaptureRouterStructure hints r) =
146− mkSubTree c (toCaptureTags hints) (mkRouterLayout False r)
129+ mkRouterLayout c (CaptureRouterStructure r) = mkSubTree c "<capture>" (mkRouterLayout False r)
147130 mkRouterLayout c RawRouterStructure =
148131 if c then ["├─ <raw>"] else ["└─ <raw>"]
149132 mkRouterLayout c (ChoiceStructure r1 r2) =
@@ -186,7 +169,7 @@ runRouterEnv fmt router env request respond =
186169 -> let request' = request { pathInfo = rest }
187170 in runRouterEnv fmt router' env request' respond
188171 _ -> respond $ Fail $ fmt request
189− CaptureRouter _ router' ->
172+ CaptureRouter router' ->
190173 case pathInfo request of
191174 [] -> respond $ Fail $ fmt request
192175 -- This case is to handle trailing slashes.
@@ -194,7 +177,7 @@ runRouterEnv fmt router env request respond =
194177 first : rest
195178 -> let request' = request { pathInfo = rest }
196179 in runRouterEnv fmt router' (first, env) request' respond
197− CaptureAllRouter _ router' ->
180+ CaptureAllRouter router' ->
198181 let segments = pathInfo request
199182 request' = request { pathInfo = [] }
200183 in runRouterEnv fmt router' (segments, env) request' respond
servant-server/test/Servant/Server/RouterSpec.hs+6−127
@@ -9,9 +9,7 @@ import Control.Monad
99import Data.Proxy
1010 (Proxy (..))
1111import Data.Text
12− (Text, unpack)
13−import Data.Typeable
14− (typeRep)
12+ (unpack)
1513import Network.HTTP.Types
1614 (Status (..))
1715import Network.Wai
@@ -29,7 +27,6 @@ spec :: Spec
2927spec = describe "Servant.Server.Internal.Router" $ do
3028 routerSpec
3129 distributivitySpec
32− serverLayoutSpec
3330
3431routerSpec :: Spec
3532routerSpec = do
@@ -54,7 +51,7 @@ routerSpec = do
5451 toApp = toApplication . runRouter (const err404)
5552
5653 cap :: Router ()
57− cap = CaptureRouter [hint] $
54+ cap = CaptureRouter $
5855 let delayed = addCapture (emptyDelayed $ Route pure) (const $ delayedFail err400)
5956 in leafRouter
6057 $ \env req res ->
@@ -62,9 +59,6 @@ routerSpec = do
6259 . const
6360 $ Route success
6461
65− hint :: CaptureHint
66− hint = CaptureHint "anything" $ typeRep (Proxy :: Proxy ())
67−
6862 router :: Router ()
6963 router = leafRouter (\_ _ res -> res $ Route success)
7064 `Choice` cap
@@ -104,30 +98,12 @@ distributivitySpec =
10498 it "properly handles mixing static paths at different levels" $ do
10599 level `shouldHaveSameStructureAs` levelRef
106100
107−serverLayoutSpec :: Spec
108−serverLayoutSpec =
109− describe "serverLayout" $ do
110− it "correctly represents the example API" $ do
111− exampleLayout `shouldHaveLayout` expectedExampleLayout
112− it "aggregates capture hints when different" $ do
113− captureDifferentTypes `shouldHaveLayout` expectedCaptureDifferentTypes
114− it "nubs capture hints when equal" $ do
115− captureSameType `shouldHaveLayout` expectedCaptureSameType
116− it "properly displays CaptureAll hints" $ do
117− captureAllLayout `shouldHaveLayout` expectedCaptureAllLayout
118−
119101shouldHaveSameStructureAs ::
120102 (HasServer api1 '[], HasServer api2 '[]) => Proxy api1 -> Proxy api2 -> Expectation
121103shouldHaveSameStructureAs p1 p2 =
122104 unless (sameStructure (makeTrivialRouter p1) (makeTrivialRouter p2)) $
123105 expectationFailure ("expected:\n" ++ unpack (layout p2) ++ "\nbut got:\n" ++ unpack (layout p1))
124106
125−shouldHaveLayout ::
126− (HasServer api '[]) => Proxy api -> Text -> Expectation
127−shouldHaveLayout p l =
128− unless (routerLayout (makeTrivialRouter p) == l) $
129− expectationFailure ("expected:\n" ++ unpack l ++ "\nbut got:\n" ++ unpack (layout p))
130−
131107makeTrivialRouter :: (HasServer layout '[]) => Proxy layout -> Router ()
132108makeTrivialRouter p =
133109 route p EmptyContext (emptyDelayed (FailFatal err501))
@@ -168,12 +144,12 @@ staticRef = Proxy
168144-- structure:
169145
170146type Dynamic =
171− "a" :> Capture "foo" Int :> "b" :> End
172− :<|> "a" :> Capture "foo" Int :> "c" :> End
173− :<|> "a" :> Capture "foo" Int :> "d" :> End
147+ "a" :> Capture "foo" Int :> "b" :> End
148+ :<|> "a" :> Capture "bar" Bool :> "c" :> End
149+ :<|> "a" :> Capture "baz" Char :> "d" :> End
174150
175151type DynamicRef =
176− "a" :> Capture "foo" Int :>
152+ "a" :> Capture "anything" () :>
177153 ("b" :> End :<|> "c" :> End :<|> "d" :> End)
178154
179155dynamic :: Proxy Dynamic
@@ -363,100 +339,3 @@ level = Proxy
363339
364340levelRef :: Proxy LevelRef
365341levelRef = Proxy
366−
367−-- The example API for the 'layout' function.
368−-- Should get factorized by the 'choice' smart constructor.
369−type ExampleLayout =
370− "a" :> "d" :> Get '[JSON] NoContent
371− :<|> "b" :> Capture "x" Int :> Get '[JSON] Bool
372− :<|> "c" :> Put '[JSON] Bool
373− :<|> "a" :> "e" :> Get '[JSON] Int
374− :<|> "b" :> Capture "x" Int :> Put '[JSON] Bool
375− :<|> Raw
376−
377−exampleLayout :: Proxy ExampleLayout
378−exampleLayout = Proxy
379−
380−-- The expected representation of the example API layout
381−--
382−expectedExampleLayout :: Text
383−expectedExampleLayout =
384− "/\n\
385− \├─ a/\n\
386− \│ ├─ d/\n\
387− \│ │ └─•\n\
388− \│ └─ e/\n\
389− \│ └─•\n\
390− \├─ b/\n\
391− \│ └─ <x::Int>/\n\
392− \│ ├─•\n\
393− \│ ┆\n\
394− \│ └─•\n\
395− \├─ c/\n\
396− \│ └─•\n\
397− \┆\n\
398− \└─ <raw>\n"
399−
400−-- A capture API with all capture types being the same
401−--
402−type CaptureSameType =
403− "a" :> Capture "foo" Int :> "b" :> End
404− :<|> "a" :> Capture "foo" Int :> "c" :> End
405− :<|> "a" :> Capture "foo" Int :> "d" :> End
406−
407−captureSameType :: Proxy CaptureSameType
408−captureSameType = Proxy
409−
410−-- The expected representation of the CaptureSameType API layout.
411−--
412−expectedCaptureSameType :: Text
413−expectedCaptureSameType =
414− "/\n\
415− \└─ a/\n\
416− \ └─ <foo::Int>/\n\
417− \ ├─ b/\n\
418− \ │ └─•\n\
419− \ ├─ c/\n\
420− \ │ └─•\n\
421− \ └─ d/\n\
422− \ └─•\n"
423−
424−-- A capture API capturing different types
425−--
426−type CaptureDifferentTypes =
427− "a" :> Capture "foo" Int :> "b" :> End
428− :<|> "a" :> Capture "bar" Bool :> "c" :> End
429− :<|> "a" :> Capture "baz" Char :> "d" :> End
430−
431−captureDifferentTypes :: Proxy CaptureDifferentTypes
432−captureDifferentTypes = Proxy
433−
434−-- The expected representation of the CaptureDifferentTypes API layout.
435−--
436−expectedCaptureDifferentTypes :: Text
437−expectedCaptureDifferentTypes =
438− "/\n\
439− \└─ a/\n\
440− \ └─ <foo::Int|bar::Bool|baz::Char>/\n\
441− \ ├─ b/\n\
442− \ │ └─•\n\
443− \ ├─ c/\n\
444− \ │ └─•\n\
445− \ └─ d/\n\
446− \ └─•\n"
447−
448−-- An API with a CaptureAll part
449−
450−type CaptureAllLayout = "a" :> CaptureAll "foos" Int :> End
451−
452−captureAllLayout :: Proxy CaptureAllLayout
453−captureAllLayout = Proxy
454−
455−-- The expected representation of the CaptureAllLayout API.
456−--
457−expectedCaptureAllLayout :: Text
458−expectedCaptureAllLayout =
459− "/\n\
460− \└─ a/\n\
461− \ └─ <foos::[Int]>/\n\
462− \ └─•\n"
servant-swagger/servant-swagger.cabal+13−14
@@ -3,10 +3,10 @@ name: servant-swagger
33version: 1.1.11
44synopsis: Generate a Swagger/OpenAPI/OAS 2.0 specification for your servant API.
55description:
6− Swagger is a project used to describe and document RESTful APIs. The core of the
7− project is the [OpenAPI Specification (OAS)](https://swagger.io/docs/specification/about/).
8− This library implements v2.0 of the spec. Unlike Servant it is language-agnostic and thus is
9− quite popular among developers in different languages. It has also existed for a longer time
6+ Swagger is a project used to describe and document RESTful APIs. The core of the
7+ project is the [OpenAPI Specification (OAS)](https://swagger.io/docs/specification/about/).
8+ This library implements v2.0 of the spec. Unlike Servant it is language-agnostic and thus is
9+ quite popular among developers in different languages. It has also existed for a longer time
1010 and has more helpful tooling.
1111 .
1212 This package provides means to generate a Swagger/OAS specification for a Servant API
@@ -19,7 +19,7 @@ description:
1919 * generating clients and servers in many languages using [Swagger Codegen](http://swagger.io/swagger-codegen/);
2020 .
2121 * and [many others](http://swagger.io/open-source-integrations/).
22−homepage: https://github.com/haskell-servant/servant/tree/master/servant-swagger#readme
22+homepage: https://github.com/haskell-servant/servant/servant-swagger
2323bug-reports: https://github.com/haskell-servant/servant/issues
2424license: BSD-3-Clause
2525license-file: LICENSE
@@ -50,7 +50,6 @@ source-repository head
5050custom-setup
5151 setup-depends:
5252 base >=4.9 && <5,
53− Cabal >= 1.24,
5453 cabal-doctest >=1.0.6 && <1.1
5554
5655library
@@ -72,15 +71,15 @@ library
7271 build-depends: aeson >=1.4.2.0 && <3
7372 , aeson-pretty >=0.8.7 && <0.9
7473 , base >=4.9.1.0 && <5
75− , base-compat >=0.10.5 && <0.13
76− , bytestring >=0.10.8.1 && <0.12
74+ , base-compat >=0.10.5 && <0.12
75+ , bytestring >=0.10.8.1 && <0.11
7776 , http-media >=0.7.1.3 && <0.9
7877 , insert-ordered-containers >=0.2.1.0 && <0.3
7978 , lens >=4.17 && <6
80− , servant >=0.18.2 && <0.20
79+ , servant >=0.18.1 && <0.19
8180 , singleton-bool >=0.1.4 && <0.2
8281 , swagger2 >=2.3.0.1 && <3
83− , text >=1.2.3.0 && <2.1
82+ , text >=1.2.3.0 && <1.3
8483 , unordered-containers >=0.2.9.0 && <0.3
8584
8685 , hspec
@@ -92,7 +91,7 @@ test-suite doctests
9291 build-depends:
9392 base,
9493 directory >= 1.0,
95− doctest >= 0.17 && <0.21,
94+ doctest >= 0.18 && <0.19,
9695 servant,
9796 QuickCheck,
9897 filepath
@@ -106,14 +105,14 @@ test-suite spec
106105 type: exitcode-stdio-1.0
107106 hs-source-dirs: test
108107 main-is: Spec.hs
109− build-tool-depends: hspec-discover:hspec-discover >=2.6.0 && <2.10
108+ build-tool-depends: hspec-discover:hspec-discover >=2.6.0 && <2.8
110109 build-depends: base
111110 , base-compat
112111 , aeson >=1.4.2.0 && <3
113− , hspec >=2.6.0 && <2.10
112+ , hspec >=2.6.0 && <2.8
114113 , QuickCheck
115114 , lens
116− , lens-aeson >=1.0.2 && <1.3
115+ , lens-aeson >=1.0.2 && <1.2
117116 , servant
118117 , servant-swagger
119118 , swagger2
servant-swagger/src/Servant/Swagger.hs+3−5
@@ -55,7 +55,6 @@ import Servant.Swagger.Internal.Orphans ()
5555-- >>> import Data.Typeable
5656-- >>> import GHC.Generics
5757-- >>> import Servant.API
58−-- >>> import System.Environment
5958-- >>> import Test.Hspec
6059-- >>> import Test.QuickCheck
6160-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL8
@@ -65,7 +64,6 @@ import Servant.Swagger.Internal.Orphans ()
6564-- >>> :set -XGeneralizedNewtypeDeriving
6665-- >>> :set -XOverloadedStrings
6766-- >>> :set -XTypeOperators
68−-- >>> setEnv "HSPEC_COLOR" "no"
6967-- >>> data User = User { name :: String, age :: Int } deriving (Show, Generic, Typeable)
7068-- >>> newtype UserId = UserId Integer deriving (Show, Generic, Typeable, ToJSON)
7169-- >>> instance ToJSON User
@@ -162,11 +160,11 @@ import Servant.Swagger.Internal.Orphans ()
162160-- >>> instance Arbitrary UserId where arbitrary = UserId <$> arbitrary
163161-- >>> hspec $ validateEveryToJSON (Proxy :: Proxy UserAPI)
164162-- <BLANKLINE>
165−-- [User]...
163+-- [User]
166164-- ...
167−-- User...
165+-- User
168166-- ...
169−-- UserId...
167+-- UserId
170168-- ...
171169-- Finished in ... seconds
172170-- 3 examples, 0 failures
servant-swagger/src/Servant/Swagger/Internal.hs−11
@@ -3,13 +3,11 @@
33{-# LANGUAGE DataKinds #-}
44{-# LANGUAGE FlexibleContexts #-}
55{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE OverloadedLists #-}
76{-# LANGUAGE OverloadedStrings #-}
87{-# LANGUAGE PolyKinds #-}
98{-# LANGUAGE RankNTypes #-}
109{-# LANGUAGE ScopedTypeVariables #-}
1110{-# LANGUAGE TypeOperators #-}
12−{-# LANGUAGE TypeFamilies #-}
1311#if __GLASGOW_HASKELL__ >= 806
1412{-# LANGUAGE UndecidableInstances #-}
1513#endif
@@ -32,13 +30,11 @@ import qualified Data.Swagger as Swagger
3230import Data.Swagger.Declare
3331import Data.Text (Text)
3432import qualified Data.Text as Text
35−import GHC.Generics (D1, Meta(..), Rep)
3633import GHC.TypeLits
3734import Network.HTTP.Media (MediaType)
3835import Servant.API
3936import Servant.API.Description (FoldDescription,
4037 reflectDescription)
41−import Servant.API.Generic (ToServantApi, AsApi)
4238import Servant.API.Modifiers (FoldRequired)
4339
4440import Servant.Swagger.Internal.TypeLevel.API
@@ -153,10 +149,6 @@ mkEndpointNoContentVerb path _ = mempty
153149addParam :: Param -> Swagger -> Swagger
154150addParam param = allOperations.parameters %~ (Inline param :)
155151
156−-- | Add a tag to every operation in the spec.
157−addTag :: Text -> Swagger -> Swagger
158−addTag tag = allOperations.tags %~ ([tag] <>)
159−
160152-- | Add accepted content types to every operation in the spec.
161153addConsumes :: [MediaType] -> Swagger -> Swagger
162154addConsumes cs = allOperations.consumes %~ (<> Just (MimeList cs))
@@ -447,9 +439,6 @@ instance (ToSchema a, Accept ct, HasSwagger sub, KnownSymbol (FoldDescription mo
447439 & required ?~ True
448440 & schema .~ ParamBody ref
449441
450−instance (HasSwagger (ToServantApi routes), KnownSymbol datatypeName, Rep (routes AsApi) ~ D1 ('MetaData datatypeName moduleName packageName isNewtype) f) => HasSwagger (NamedRoutes routes) where
451− toSwagger _ = addTag (Text.pack $ symbolVal (Proxy :: Proxy datatypeName)) (toSwagger (Proxy :: Proxy (ToServantApi routes)))
452−
453442-- =======================================================================
454443-- Below are the definitions that should be in Servant.API.ContentTypes
455444-- =======================================================================
servant-swagger/src/Servant/Swagger/Internal/Test.hs+6−8
@@ -29,12 +29,10 @@ import Servant.Swagger.Internal.TypeLevel
2929-- >>> import Control.Applicative
3030-- >>> import GHC.Generics
3131-- >>> import Test.QuickCheck
32−-- >>> import System.Environment (setEnv)
3332-- >>> :set -XDeriveGeneric
3433-- >>> :set -XGeneralizedNewtypeDeriving
3534-- >>> :set -XDataKinds
3635-- >>> :set -XTypeOperators
37−-- >>> setEnv "HSPEC_COLOR" "no"
3836
3937-- | Verify that every type used with @'JSON'@ content type in a servant API
4038-- has compatible @'ToJSON'@ and @'ToSchema'@ instances using @'validateToJSON'@.
@@ -55,10 +53,10 @@ import Servant.Swagger.Internal.TypeLevel
5553--
5654-- >>> hspec $ context "ToJSON matches ToSchema" $ validateEveryToJSON (Proxy :: Proxy UserAPI)
5755-- <BLANKLINE>
58−-- ToJSON matches ToSchema...
59−-- User...
56+-- ToJSON matches ToSchema
57+-- User
6058-- ...
61−-- UserId...
59+-- UserId
6260-- ...
6361-- Finished in ... seconds
6462-- 2 examples, 0 failures
@@ -120,11 +118,11 @@ validateEveryToJSONWithPatternChecker checker _ = props
120118-- :}
121119-- <BLANKLINE>
122120-- read . show == id
123−-- Bool...
121+-- Bool
124122-- ...
125−-- Int...
123+-- Int
126124-- ...
127−-- [Char]...
125+-- [Char]
128126-- ...
129127-- Finished in ... seconds
130128-- 3 examples, 0 failures
servant/CHANGELOG.md−116
@@ -1,121 +1,5 @@
11[The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md)
22
3−Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/): in A.B.C, bumps to either A or B represent major versions.
4−
5−0.19
6−----
7−
8−### Significant changes
9−
10−- Drop support for GHC < 8.6.
11−- Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet).
12−- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)),
13− which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864)
14− related to hash collisions.
15−- Add `NamedRoutes` combinator, making support for records first-class in Servant
16− ([#1388](https://github.com/haskell-servant/servant/pull/1388)).
17−
18− Users can now directly mark part as an API as defined by a record, instead of
19− using `(:<|>)` to combine routes. Concretely, the anonymous:
20−
21− ```haskell
22− type API =
23− "version" :> Get '[JSON] String :<|>
24− "products" :> Get '[JSON] [Product]
25− ```
26−
27− can be replaced with the explicitly-named:
28−
29− ```haskell
30− type API = NamedRoutes NamedAPI
31− data NamedAPI mode = NamedAPI
32− { version :: mode :- "version" :> Get '[JSON] String
33− , products :: mode :- "products" :> Get '[JSON] [Product]
34− }
35− ```
36−
37− `NamedRoutes` builds upon `servant-generic`, but improves usability by freeing
38− users from the need to perform `toServant` / `fromServant` conversions
39− manually. Serving `NamedRoutes NamedAPI` is now done directly by providing a
40− record of handlers, and servant generates clients directly as records as well.
41− In particular, it makes it much more practical to work with nested hierarchies
42− of named routes.
43−
44− Two convenience functions, `(//)` and `(/:)`, have been added to make the
45− usage of named route hierarchies more pleasant:
46−
47− ```haskell
48− rootClient :: RootApi (AsClientT ClientM)
49− rootClient = client (Proxy @API)
50−
51− helloClient :: String -> ClientM String
52− helloClient name = rootClient // hello /: name
53−
54− endpointClient :: ClientM Person
55− endpointClient = rootClient // subApi /: "foobar123" // endpoint
56−
57− type Api = NamedRoutes RootApi
58−
59− data RootApi mode = RootApi
60− { subApi :: mode :- Capture "token" String :> NamedRoutes SubApi
61− , hello :: mode :- Capture "name" String :> Get '[JSON] String
62− , …
63− } deriving Generic
64−
65− data SubApi mode = SubApi
66− { endpoint :: mode :- Get '[JSON] Person
67− , …
68− } deriving Generic
69− ```
70−
71−- Add custom type errors for partially applied combinators
72− ([#1289](https://github.com/haskell-servant/servant/pull/1289),
73− [#1486](https://github.com/haskell-servant/servant/pull/1486)).
74−
75− For example, forgetting to document the expected type for a query parameter,
76− as in:
77−
78− ``` haskell
79− type API = QueryParam "param" :> Get '[JSON] NoContent
80− ```
81−
82− will raise to the following error when trying to serve the API:
83−
84− ```
85− • There is no instance for HasServer (QueryParam'
86− '[Optional, Strict] "param" :> ...)
87− QueryParam' '[Optional, Strict] "1" expects 1 more arguments
88− ```
89−
90− As a consequence of this change, unsaturated types are now forbidden before `(:>)`.
91−
92−- Add a `HeadNoContent` verb ([#1502](https://github.com/haskell-servant/servant/pull/1502)).
93−
94−- *servant-client* / *servant-client-core* / *servant-http-streams*:
95− Fix erroneous behavior, where only 2XX status codes would be considered
96− successful, irrelevant of the status parameter specified by the verb
97− combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469))
98−
99−- *servant-client* / *servant-client-core*: Fix `Show` instance for
100− `Servant.Client.Core.Request`.
101−
102−
103−- *servant-client* / *servant-client-core*: Allow passing arbitrary binary data
104− in Query parameters.
105− ([#1432](https://github.com/haskell-servant/servant/pull/1432)).
106−
107−- *servant-docs*: Generate sample cURL requests
108− ([#1401](https://github.com/haskell-servant/servant/pull/1401/files)).
109−
110− Breaking change: requires sample header values to be supplied with `headers`.
111−
112−### Other changes
113−
114−- Various bit rotten cookbooks have been updated and re-introduced on
115− [docs.servant.dev](https://docs.servant.dev).
116−
117−- Various version bumps.
118−
11930.18.3
1204------
1215
servant/servant.cabal+7−7
@@ -1,6 +1,6 @@
11cabal-version: 2.2
22name: servant
3−version: 0.19
3+version: 0.18.3
44
55synopsis: A family of combinators for defining webservices APIs
66category: Servant, Web
@@ -80,13 +80,13 @@ library
8080 --
8181 -- note: mtl lower bound is so low because of GHC-7.8
8282 build-depends:
83− base >= 4.9 && < 4.17
83+ base >= 4.9 && < 4.16
8484 , bytestring >= 0.10.8.1 && < 0.12
8585 , constraints >= 0.2
8686 , mtl >= 2.2.2 && < 2.3
8787 , sop-core >= 0.4.0.0 && < 0.6
8888 , transformers >= 0.5.2.0 && < 0.6
89− , text >= 1.2.3.0 && < 2.1
89+ , text >= 1.2.3.0 && < 1.3
9090
9191
9292 -- We depend (heavily) on the API of these packages:
@@ -98,7 +98,7 @@ library
9898 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.
9999 -- Here can be exceptions if we really need features from the newer versions.
100100 build-depends:
101− base-compat >= 0.10.5 && < 0.13
101+ base-compat >= 0.10.5 && < 0.12
102102 , aeson >= 1.4.1.0 && < 3
103103 , attoparsec >= 0.13.2.2 && < 0.15
104104 , bifunctors >= 5.5.3 && < 5.6
@@ -106,7 +106,7 @@ library
106106 , deepseq >= 1.4.2.0 && < 1.5
107107 , http-media >= 0.7.1.3 && < 0.9
108108 , http-types >= 0.12.2 && < 0.13
109− , mmorph >= 1.1.2 && < 1.3
109+ , mmorph >= 1.1.2 && < 1.2
110110 , network-uri >= 2.6.1.0 && < 2.7
111111 , QuickCheck >= 2.12.6.1 && < 2.15
112112 , string-conversions >= 0.4.0.1 && < 0.5
@@ -166,9 +166,9 @@ test-suite spec
166166
167167 -- Additional dependencies
168168 build-depends:
169− hspec >= 2.6.0 && < 2.10
169+ hspec >= 2.6.0 && < 2.9
170170 , QuickCheck >= 2.12.6.1 && < 2.15
171171 , quickcheck-instances >= 0.3.19 && < 0.4
172172
173173 build-tool-depends:
174− hspec-discover:hspec-discover >= 2.6.0 && < 2.10
174+ hspec-discover:hspec-discover >= 2.6.0 && < 2.9
servant/src/Servant/API.hs−4
@@ -38,7 +38,6 @@ module Servant.API (
3838
3939 -- * Sub-APIs defined as records of routes
4040 module Servant.API.NamedRoutes,
41− module Servant.API.Generic,
4241
4342 -- * Streaming endpoints, distinguished by HTTP method
4443 module Servant.API.Stream,
@@ -103,9 +102,6 @@ import Servant.API.Fragment
103102 (Fragment)
104103import Servant.API.Header
105104 (Header, Header')
106−import Servant.API.Generic
107− (GenericMode ((:-)), AsApi, ToServant, ToServantApi, GServantProduct,
108− GenericServant, fromServant, toServant, genericApi)
109105import Servant.API.HttpVersion
110106 (HttpVersion (..))
111107import Servant.API.IsSecure
servant/src/Servant/API/ContentTypes.hs+1−1
@@ -295,7 +295,7 @@ instance {-# OVERLAPPABLE #-}
295295-- then this would be taken care of. However there is no more specific instance
296296-- between that and 'MimeRender JSON a', so we do this instead
297297instance {-# OVERLAPPING #-} ( Accept ctyp ) => AllMimeRender '[ctyp] NoContent where
298− allMimeRender _ NoContent = map (, "") $ NE.toList $ contentTypes pctyp
298+ allMimeRender _ _ = map (, "") $ NE.toList $ contentTypes pctyp
299299 where
300300 pctyp = Proxy :: Proxy ctyp
301301
servant/src/Servant/Links.hs+1−1
@@ -649,7 +649,7 @@ simpleToLink _ toA _ = toLink toA (Proxy :: Proxy sub)
649649-- Erroring instance for 'HasLink' when a combinator is not fully applied
650650instance TypeError (PartialApplication HasLink arr) => HasLink ((arr :: a -> b) :> sub)
651651 where
652− type MkLink (arr :> sub) _ = TypeError (PartialApplication (HasLink :: * -> Constraint) arr)
652+ type MkLink (arr :> sub) _ = TypeError (PartialApplication HasLink arr)
653653 toLink = error "unreachable"
654654
655655-- Erroring instances for 'HasLink' for unknown API combinators
servant/test/Servant/API/ContentTypesSpec.hs−11
@@ -33,8 +33,6 @@ import Data.String.Conversions
3333import qualified Data.Text as TextS
3434import qualified Data.Text.Encoding as TextSE
3535import qualified Data.Text.Lazy as TextL
36−import Control.Exception
37− (evaluate)
3836import GHC.Generics
3937import Test.Hspec
4038import Test.QuickCheck
@@ -80,15 +78,6 @@ spec = describe "Servant.API.ContentTypes" $ do
8078 it "has mimeUnrender reverse mimeRender for valid top-level json " $ do
8179 property $ \x -> mimeUnrender p (mimeRender p x) == Right (x::SomeData)
8280
83− describe "The NoContent Content-Type type" $ do
84− let p = Proxy :: Proxy '[JSON]
85−
86− it "does not render any content" $
87− allMimeRender p NoContent `shouldSatisfy` (all (BSL8.null . snd))
88−
89− it "evaluates the NoContent value" $
90− evaluate (allMimeRender p (undefined :: NoContent)) `shouldThrow` anyErrorCall
91−
9281 describe "The PlainText Content-Type type" $ do
9382 let p = Proxy :: Proxy PlainText
9483
stack.yaml−1
@@ -11,7 +11,6 @@ packages:
1111- servant-conduit
1212- servant-machines/
1313- servant-pipes/
14−- servant-swagger/
1514
1615# allow-newer: true # ignores all bounds, that's a sledgehammer
1716# - doc/tutorial/