master..030d852 · typeable/servant

.github/workflows/master.yml+4−1

since splitsnapshots

unifiedsplit

@@ -59,6 +59,9 @@ jobs:

59 cabal test all

60

61 - name: Run doctests

62+ # doctests are broken on GHC 9 due to compiler bug:

63+ # https://gitlab.haskell.org/ghc/ghc/-/issues/19460

64+ continue-on-error: ${{ matrix.ghc == '9.0.1' }}

62 run: |

65 run: |

63 # Necessary for doctest to be found in $PATH

66 # Necessary for doctest to be found in $PATH

64 export PATH="$HOME/.cabal/bin:$PATH"

67 export PATH="$HOME/.cabal/bin:$PATH"

@@ -80,7 +83,7 @@ jobs:

80 runs-on: ubuntu-latest

83 runs-on: ubuntu-latest

81 strategy:

84 strategy:

82 matrix:

85 matrix:

83− stack: ["2.7.5"]

86+ stack: ["2.7.3"]

84 ghc: ["8.10.7"]

87 ghc: ["8.10.7"]

85

88

86 steps:

89 steps:

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/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`

119to http-client's `Request`, and we can inspect it:

120

121```haskell

122− req' <- I.defaultMakeClientRequest burl req

122+ let req' = I.defaultMakeClientRequest burl req

123 putStrLn $ "Making request: " ++ show req'

124```

125

servant-auth/servant-auth-client/servant-auth-client.cabal+2−2

@@ -50,7 +50,7 @@ test-suite spec

50 test

51 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators

52 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

54

55 -- dependencies with bounds inherited from the library stanza

56 build-depends:

@@ -62,7 +62,7 @@ test-suite spec

62

63 -- test dependencies

64 build-depends:

65− hspec >= 2.5.5 && < 2.10

65+ hspec >= 2.5.5 && < 2.9

66 , QuickCheck >= 2.11.3 && < 2.15

67 , aeson >= 1.3.1.1 && < 3

68 , bytestring >= 0.10.6.0 && < 0.12

servant-auth/servant-auth-docs/servant-auth-docs.cabal+2−2

@@ -64,7 +64,7 @@ test-suite spec

64 test

65 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators

66 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

68

69 -- dependencies with bounds inherited from the library stanza

70 build-depends:

@@ -78,7 +78,7 @@ test-suite spec

78 -- test dependencies

79 build-depends:

80 servant-auth-docs

81− , hspec >= 2.5.5 && < 2.10

81+ , hspec >= 2.5.5 && < 2.9

82 , QuickCheck >= 2.11.3 && < 2.15

83

84 default-language: Haskell2010

servant-auth/servant-auth-server/servant-auth-server.cabal+4−3

@@ -102,7 +102,7 @@ test-suite spec

102 test

103 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators

104 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

106

107 -- dependencies with bounds inherited from the library stanza

108 build-depends:

@@ -123,12 +123,13 @@ test-suite spec

123 -- test dependencies

124 build-depends:

125 servant-auth-server

126− , hspec >= 2.5.5 && < 2.10

126+ , hspec >= 2.5.5 && < 2.8

127 , QuickCheck >= 2.11.3 && < 2.15

128 , http-client >= 0.5.13.1 && < 0.8

129− , lens-aeson >= 1.0.2 && < 1.3

129+ , lens-aeson >= 1.0.2 && < 1.2

130 , warp >= 3.2.25 && < 3.4

131 , wreq >= 0.5.2.1 && < 0.6

132+ , text >= 1.2.3.0 && < 2.1

132 other-modules:

133 other-modules:

133 Servant.Auth.ServerSpec

134 Servant.Auth.ServerSpec

134 default-language: Haskell2010

135 default-language: Haskell2010

servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/AddSetCookie.hs+14−1

@@ -11,6 +11,7 @@ import Data.Tagged (Tagged (..))

11import qualified Network.HTTP.Types as HTTP

12import Network.Wai (mapResponseHeaders)

13import Servant

14+import Servant.API.UVerb.Union

14import Servant.API.Generic

15import Servant.API.Generic

15import Servant.Server.Generic

16import Servant.Server.Generic

16import Web.Cookie

17import Web.Cookie

@@ -33,12 +34,24 @@ type family AddSetCookieApiVerb a where

33 AddSetCookieApiVerb (Headers ls a) = Headers (Header "Set-Cookie" SetCookie ': ls) a

34 AddSetCookieApiVerb (Headers ls a) = Headers (Header "Set-Cookie" SetCookie ': ls) a

34 AddSetCookieApiVerb a = Headers '[Header "Set-Cookie" SetCookie] a

35 AddSetCookieApiVerb a = Headers '[Header "Set-Cookie" SetCookie] a

35

36

37+#if MIN_VERSION_servant_server(0,18,1)

38+type family MapAddSetCookieApiVerb (as :: [*]) where

39+ MapAddSetCookieApiVerb '[] = '[]

40+ MapAddSetCookieApiVerb (a ': as) = (AddSetCookieApiVerb a ': MapAddSetCookieApiVerb as)

41+#endif

42+

36type family AddSetCookieApi a :: *

43type family AddSetCookieApi a :: *

37type instance AddSetCookieApi (a :> b) = a :> AddSetCookieApi b

44type instance AddSetCookieApi (a :> b) = a :> AddSetCookieApi b

38type instance AddSetCookieApi (a :<|> b) = AddSetCookieApi a :<|> AddSetCookieApi b

45type instance AddSetCookieApi (a :<|> b) = AddSetCookieApi a :<|> AddSetCookieApi b

46+#if MIN_VERSION_servant_server(0,19,0)

39type instance AddSetCookieApi (NamedRoutes api) = AddSetCookieApi (ToServantApi api)

47type instance AddSetCookieApi (NamedRoutes api) = AddSetCookieApi (ToServantApi api)

48+#endif

40type instance AddSetCookieApi (Verb method stat ctyps a)

49type instance AddSetCookieApi (Verb method stat ctyps a)

41 = Verb method stat ctyps (AddSetCookieApiVerb a)

50 = Verb method stat ctyps (AddSetCookieApiVerb a)

51+#if MIN_VERSION_servant_server(0,18,1)

52+type instance AddSetCookieApi (UVerb method ctyps as)

53+ = UVerb method ctyps (MapAddSetCookieApiVerb as)

54+#endif

42type instance AddSetCookieApi Raw = Raw

55type instance AddSetCookieApi Raw = Raw

43#if MIN_VERSION_servant_server(0,15,0)

56#if MIN_VERSION_servant_server(0,15,0)

44type instance AddSetCookieApi (Stream method stat framing ctyps a)

57type instance AddSetCookieApi (Stream method stat framing ctyps a)

@@ -57,7 +70,7 @@ instance {-# OVERLAPS #-} AddSetCookies ('S n) oldb newb

57 => AddSetCookies ('S n) (a -> oldb) (a -> newb) where

70 => AddSetCookies ('S n) (a -> oldb) (a -> newb) where

58 addSetCookies cookies oldfn = addSetCookies cookies . oldfn

71 addSetCookies cookies oldfn = addSetCookies cookies . oldfn

59

72

60−instance AddSetCookies 'Z orig orig where

73+instance (orig1 ~ orig2) => AddSetCookies 'Z orig1 orig2 where

61 addSetCookies _ = id

74 addSetCookies _ = id

62

75

63instance {-# OVERLAPPABLE #-}

76instance {-# OVERLAPPABLE #-}

servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/ConfigTypes.hs+2−2

@@ -33,7 +33,7 @@ data JWTSettings = JWTSettings

33 -- | Algorithm used to sign JWT.

34 , jwtAlg :: Maybe Jose.Alg

35 -- | Keys used to validate JWT.

36− , validationKeys :: IO Jose.JWKSet

36+ , validationKeys :: Jose.JWKSet

37 -- | An @aud@ predicate. The @aud@ is a string or URI that identifies the

38 -- intended recipient of the JWT.

39 , audienceMatches :: Jose.StringOrURI -> IsMatch

@@ -44,7 +44,7 @@ defaultJWTSettings :: Jose.JWK -> JWTSettings

44defaultJWTSettings k = JWTSettings

45 { signingKey = k

46 , jwtAlg = Nothing

47− , validationKeys = pure $ Jose.JWKSet [k]

47+ , validationKeys = Jose.JWKSet [k]

48 , audienceMatches = const Matches }

49

50-- | 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

58

59verifyJWT :: FromJWT a => JWTSettings -> BS.ByteString -> IO (Maybe a)

60verifyJWT jwtCfg input = do

61− keys <- validationKeys jwtCfg

62− verifiedJWT <- runExceptT $ do

61+ verifiedJWT <- liftIO $ runExceptT $ do

63 unverifiedJWT <- Jose.decodeCompact (BSL.fromStrict input)

62 unverifiedJWT <- Jose.decodeCompact (BSL.fromStrict input)

64 Jose.verifyClaims

63 Jose.verifyClaims

65 (jwtSettingsToJwtValidationSettings jwtCfg)

64 (jwtSettingsToJwtValidationSettings jwtCfg)

66− keys

65+ (validationKeys jwtCfg)

67 unverifiedJWT

66 unverifiedJWT

68 return $ case verifiedJWT of

67 return $ case verifiedJWT of

69 Left (_ :: Jose.JWTError) -> Nothing

68 Left (_ :: Jose.JWTError) -> Nothing

70 Right v -> case decodeJWT v of

69 Right v -> case decodeJWT v of

71 Left _ -> Nothing

70 Left _ -> Nothing

72− Right v' -> Just v'

71+ Right v' -> Just v'

servant-auth/servant-auth-server/test/Servant/Auth/ServerSpec.hs+4

@@ -1,4 +1,5 @@

1{-# LANGUAGE CPP #-}

2+{-# LANGUAGE TypeApplications #-}

2module Servant.Auth.ServerSpec (spec) where

3module Servant.Auth.ServerSpec (spec) where

3

4

4#if !MIN_VERSION_servant_server(0,16,0)

5#if !MIN_VERSION_servant_server(0,16,0)

@@ -25,6 +26,7 @@ import Data.Aeson (FromJSON, ToJSON, Value,

25import Data.Aeson.Lens (_JSON)

26import Data.Aeson.Lens (_JSON)

26import qualified Data.ByteString as BS

27import qualified Data.ByteString as BS

27import qualified Data.ByteString.Lazy as BSL

28import qualified Data.ByteString.Lazy as BSL

29+import Data.Text (Text)

28import Data.CaseInsensitive (mk)

30import Data.CaseInsensitive (mk)

29import Data.Foldable (find)

31import Data.Foldable (find)

30import Data.Monoid

32import Data.Monoid

@@ -407,6 +409,7 @@ type API auths

407 ( Get '[JSON] Int

409 ( Get '[JSON] Int

408 :<|> ReqBody '[JSON] Int :> Post '[JSON] Int

410 :<|> ReqBody '[JSON] Int :> Post '[JSON] Int

409 :<|> NamedRoutes DummyRoutes

411 :<|> NamedRoutes DummyRoutes

412+ :<|> UVerb 'GET '[JSON] '[WithStatus 200 Int, WithStatus 500 Text]

410 :<|> "header" :> Get '[JSON] (Headers '[Header "Blah" Int] Int)

413 :<|> "header" :> Get '[JSON] (Headers '[Header "Blah" Int] Int)

411#if MIN_VERSION_servant_server(0,15,0)

414#if MIN_VERSION_servant_server(0,15,0)

412 :<|> "stream" :> StreamGet NoFraming OctetStream (SourceIO BS.ByteString)

415 :<|> "stream" :> StreamGet NoFraming OctetStream (SourceIO BS.ByteString)

@@ -483,6 +486,7 @@ server ccfg =

483 Authenticated usr -> getInt usr

486 Authenticated usr -> getInt usr

484 :<|> postInt usr

487 :<|> postInt usr

485 :<|> DummyRoutes { dummyInt = getInt usr }

488 :<|> DummyRoutes { dummyInt = getInt usr }

489+ :<|> respond (WithStatus @200 (42 :: Int))

486 :<|> getHeaderInt

490 :<|> getHeaderInt

487#if MIN_VERSION_servant_server(0,15,0)

491#if MIN_VERSION_servant_server(0,15,0)

488 :<|> return (S.source ["bytestring"])

492 :<|> return (S.source ["bytestring"])

servant-auth/servant-auth-swagger/servant-auth-swagger.cabal+7−3

@@ -31,13 +31,15 @@ library

31 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators

32 ghc-options: -Wall

33 build-depends:

34− base >= 4.10 && < 4.17

34+ base >= 4.10 && < 4.16

35 , text >= 1.2.3.0 && < 2.1

36 , servant-swagger >= 1.1.5 && < 2

37 , swagger2 >= 2.2.2 && < 3

38 , servant >= 0.13 && < 0.20

39 , servant-auth == 0.4.*

40 , lens >= 4.16.1 && < 5.2

41+ if impl(ghc >= 9)

42+ buildable: False

41 exposed-modules:

43 exposed-modules:

42 Servant.Auth.Swagger

44 Servant.Auth.Swagger

43 default-language: Haskell2010

45 default-language: Haskell2010

@@ -49,7 +51,7 @@ test-suite spec

49 test

51 test

50 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators

52 default-extensions: ConstraintKinds DataKinds DefaultSignatures DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable FlexibleContexts FlexibleInstances FunctionalDependencies GADTs KindSignatures MultiParamTypeClasses OverloadedStrings RankNTypes ScopedTypeVariables TypeFamilies TypeOperators

51 ghc-options: -Wall

53 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

53 -- dependencies with bounds inherited from the library stanza

55 -- dependencies with bounds inherited from the library stanza

54 build-depends:

56 build-depends:

55 base

57 base

@@ -59,11 +61,13 @@ test-suite spec

59 , servant

61 , servant

60 , servant-auth

62 , servant-auth

61 , lens

63 , lens

64+ if impl(ghc >= 9)

65+ buildable: False

62

66

63 -- test dependencies

67 -- test dependencies

64 build-depends:

68 build-depends:

65 servant-auth-swagger

69 servant-auth-swagger

66− , hspec >= 2.5.5 && < 2.10

70+ , hspec >= 2.5.5 && < 2.9

67 , QuickCheck >= 2.11.3 && < 2.15

71 , QuickCheck >= 2.11.3 && < 2.15

68 other-modules:

72 other-modules:

69 Servant.Auth.SwaggerSpec

73 Servant.Auth.SwaggerSpec

servant-client-core/servant-client-core.cabal+2−2

@@ -104,8 +104,8 @@ test-suite spec

104 -- Additional dependencies

105 build-depends:

106 deepseq >= 1.4.2.0 && < 1.5

107− , hspec >= 2.6.0 && < 2.10

107+ , hspec >= 2.6.0 && < 2.9

108 , QuickCheck >= 2.12.6.1 && < 2.15

109

110 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/HasClient.hs+3−3

@@ -208,7 +208,7 @@ instance (KnownSymbol capture, ToHttpApiData a, HasClient m api)

208 clientWithRoute pm (Proxy :: Proxy api)

209 (appendToPath p req)

210

211− where p = toEncodedUrlPiece val

211+ where p = (toUrlPiece val)

212

213 hoistClientMonad pm _ f cl = \a ->

214 hoistClientMonad pm (Proxy :: Proxy api) f (cl a)

@@ -243,7 +243,7 @@ instance (KnownSymbol capture, ToHttpApiData a, HasClient m sublayout)

243 clientWithRoute pm (Proxy :: Proxy sublayout)

244 (foldl' (flip appendToPath) req ps)

245

246− where ps = map toEncodedUrlPiece vals

246+ where ps = map (toUrlPiece) vals

247

248 hoistClientMonad pm _ f cl = \as ->

249 hoistClientMonad pm (Proxy :: Proxy sublayout) f (cl as)

@@ -740,7 +740,7 @@ instance (KnownSymbol path, HasClient m api) => HasClient m (path :> api) where

740 clientWithRoute pm (Proxy :: Proxy api)

741 (appendToPath p req)

742

743− where p = toEncodedUrlPiece $ pack $ symbolVal (Proxy :: Proxy path)

743+ where p = pack $ symbolVal (Proxy :: Proxy path)

744

745 hoistClientMonad pm _ f cl = hoistClientMonad pm (Proxy :: Proxy api) f cl

746

servant-client-core/src/Servant/Client/Core/Request.hs+6−10

@@ -34,8 +34,6 @@ import Data.Bifunctor

34import Data.Bitraversable

35 (Bitraversable (..), bifoldMapDefault, bimapDefault)

36import qualified Data.ByteString as BS

37−import Data.ByteString.Builder

38− (Builder)

39import qualified Data.ByteString.Builder as Builder

37import qualified Data.ByteString.Builder as Builder

40import qualified Data.ByteString.Lazy as LBS

38import qualified Data.ByteString.Lazy as LBS

41import qualified Data.Sequence as Seq

39import qualified Data.Sequence as Seq

@@ -51,9 +49,9 @@ import Network.HTTP.Media

51 (MediaType)

49 (MediaType)

52import Network.HTTP.Types

50import Network.HTTP.Types

53 (Header, HeaderName, HttpVersion (..), Method, QueryItem,

51 (Header, HeaderName, HttpVersion (..), Method, QueryItem,

54− http11, methodGet, urlEncodeBuilder)

52+ http11, methodGet)

55import Servant.API

53import Servant.API

56− (ToHttpApiData, toEncodedUrlPiece, toQueryParam, toHeader, SourceIO)

54+ (ToHttpApiData, toEncodedUrlPiece, toHeader, SourceIO)

57

55

58import Servant.Client.Core.Internal (mediaTypeRnf)

56import Servant.Client.Core.Internal (mediaTypeRnf)

59

57

@@ -114,7 +112,7 @@ instance (NFData path, NFData body) => NFData (RequestF body path) where

114 rnfB Nothing = ()

112 rnfB Nothing = ()

115 rnfB (Just (b, mt)) = rnf b `seq` mediaTypeRnf mt

113 rnfB (Just (b, mt)) = rnf b `seq` mediaTypeRnf mt

116

114

117−type Request = RequestF RequestBody Builder

115+type Request = RequestF RequestBody Builder.Builder

118

116

119-- | The request body. R replica of the @http-client@ @RequestBody@.

117-- | The request body. R replica of the @http-client@ @RequestBody@.

120data RequestBody

118data RequestBody

@@ -147,10 +145,9 @@ defaultRequest = Request

147

145

148-- | Append extra path to the request being constructed.

146-- | Append extra path to the request being constructed.

149--

147--

150−-- Warning: This function assumes that the path fragment is already URL-encoded.

151−appendToPath :: Builder -> Request -> Request

148+appendToPath :: Text -> Request -> Request

152appendToPath p req

149appendToPath p req

153− = req { requestPath = requestPath req <> "/" <> p }

150+ = req { requestPath = requestPath req <> "/" <> toEncodedUrlPiece p }

154

151

155-- | Append a query parameter to the request being constructed.

152-- | Append a query parameter to the request being constructed.

156--

153--

@@ -165,8 +162,7 @@ appendToQueryString pname pvalue req

165-- | Encode a query parameter value.

162-- | Encode a query parameter value.

166--

163--

167encodeQueryParamValue :: ToHttpApiData a => a -> BS.ByteString

164encodeQueryParamValue :: ToHttpApiData a => a -> BS.ByteString

168−encodeQueryParamValue = LBS.toStrict . Builder.toLazyByteString

165+encodeQueryParamValue = LBS.toStrict . Builder.toLazyByteString . toEncodedUrlPiece

169− . urlEncodeBuilder True . encodeUtf8 . toQueryParam

170

166

171-- | Add header to the request being constructed.

167-- | Add header to the request being constructed.

172--

168--

servant-client/servant-client.cabal+2−2

@@ -124,7 +124,7 @@ test-suite spec

124 -- Additional dependencies

125 build-depends:

126 entropy >= 0.4.1.3 && < 0.5

127− , hspec >= 2.6.0 && < 2.10

127+ , hspec >= 2.6.0 && < 2.9

128 , HUnit >= 1.6.0.0 && < 1.7

129 , network >= 2.8.0.0 && < 3.2

130 , QuickCheck >= 2.12.6.1 && < 2.15

@@ -133,7 +133,7 @@ test-suite spec

133 , tdigest >= 0.2 && < 0.3

134

135 build-tool-depends:

136− hspec-discover:hspec-discover >= 2.6.0 && < 2.10

136+ hspec-discover:hspec-discover >= 2.6.0 && < 2.9

137

138test-suite readme

139 type: exitcode-stdio-1.0

servant-client/src/Servant/Client/Internal/HttpClient.hs+7−8

@@ -24,7 +24,7 @@ import Control.Monad

24import Control.Monad.Base

25 (MonadBase (..))

26import Control.Monad.Catch

27− (MonadCatch, MonadThrow, MonadMask)

27+ (MonadCatch, MonadThrow)

28import Control.Monad.Error.Class

29 (MonadError (..))

30import Control.Monad.IO.Class

@@ -80,7 +80,7 @@ data ClientEnv

80 { manager :: Client.Manager

81 , baseUrl :: BaseUrl

82 , cookieJar :: Maybe (TVar Client.CookieJar)

83− , makeClientRequest :: BaseUrl -> Request -> IO Client.Request

83+ , makeClientRequest :: BaseUrl -> Request -> Client.Request

84 -- ^ this function can be used to customize the creation of @http-client@ requests from @servant@ requests. Default value: 'defaultMakeClientRequest'

85 -- Note that:

86 -- 1. 'makeClientRequest' exists to allow overriding operational semantics e.g. 'responseTimeout' per request,

@@ -136,7 +136,7 @@ newtype ClientM a = ClientM

136 { unClientM :: ReaderT ClientEnv (ExceptT ClientError IO) a }

137 deriving ( Functor, Applicative, Monad, MonadIO, Generic

138 , MonadReader ClientEnv, MonadError ClientError, MonadThrow

139− , MonadCatch, MonadMask)

139+ , MonadCatch)

140

141instance MonadBase IO ClientM where

142 liftBase = ClientM . liftBase

@@ -162,7 +162,7 @@ runClientM cm env = runExceptT $ flip runReaderT env $ unClientM cm

162performRequest :: Maybe [Status] -> Request -> ClientM Response

163performRequest acceptStatus req = do

164 ClientEnv m burl cookieJar' createClientRequest <- ask

165− clientRequest <- liftIO $ createClientRequest burl req

165+ let clientRequest = createClientRequest burl req

166 request <- case cookieJar' of

167 Nothing -> pure clientRequest

168 Just cj -> liftIO $ do

@@ -229,8 +229,8 @@ clientResponseToResponse f r = Response

229-- | Create a @http-client@ 'Client.Request' from a @servant@ 'Request'

230-- The 'Client.host', 'Client.path' and 'Client.port' fields are extracted from the 'BaseUrl'

231-- otherwise the body, headers and query string are derived from the @servant@ 'Request'

232−defaultMakeClientRequest :: BaseUrl -> Request -> IO Client.Request

232+defaultMakeClientRequest :: BaseUrl -> Request -> Client.Request

233−defaultMakeClientRequest burl r = return Client.defaultRequest

233+defaultMakeClientRequest burl r = Client.defaultRequest

234 { Client.method = requestMethod r

235 , Client.host = fromString $ baseUrlHost burl

236 , Client.port = baseUrlPort burl

@@ -289,8 +289,7 @@ defaultMakeClientRequest burl r = return Client.defaultRequest

289 Https -> True

290

291 -- Query string builder which does not do any encoding

292− buildQueryString [] = mempty

293− buildQueryString qps = "?" <> foldl' addQueryParam mempty qps

292+ buildQueryString = ("?" <>) . foldl' addQueryParam mempty

294

293

295 addQueryParam qs (k, v) =

294 addQueryParam qs (k, v) =

296 qs <> (if BS.null qs then mempty else "&") <> urlEncode True k <> foldMap ("=" <>) v

295 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

140performRequest acceptStatus req = do

141 -- TODO: should use Client.withResponse here too

142 ClientEnv m burl cookieJar' createClientRequest <- ask

143− clientRequest <- liftIO $ createClientRequest burl req

143+ let clientRequest = createClientRequest burl req

144 request <- case cookieJar' of

145 Nothing -> pure clientRequest

146 Just cj -> liftIO $ do

@@ -177,7 +177,7 @@ performWithStreamingRequest req k = do

177 m <- asks manager

178 burl <- asks baseUrl

179 createClientRequest <- asks makeClientRequest

180− request <- liftIO $ createClientRequest burl req

180+ let request = createClientRequest burl req

181 ClientM $ lift $ lift $ Codensity $ \k1 ->

182 Client.withResponse request m $ \res -> do

183 let status = Client.responseStatus res

servant-client/test/Servant/ClientTestUtils.hs+1−13

@@ -160,7 +160,6 @@ type Api =

160 WithStatus 301 Text]

161 :<|> "uverb-get-created" :> UVerb 'GET '[PlainText] '[WithStatus 201 Person]

162 :<|> NamedRoutes RecordRoutes

163− :<|> "captureVerbatim" :> Capture "someString" Verbatim :> Get '[PlainText] Text

164

163

165api :: Proxy Api

164api :: Proxy Api

166api = Proxy

165api = Proxy

@@ -215,8 +214,7 @@ getRoot

215 :<|> EmptyClient

214 :<|> EmptyClient

216 :<|> uverbGetSuccessOrRedirect

215 :<|> uverbGetSuccessOrRedirect

217 :<|> uverbGetCreated

216 :<|> uverbGetCreated

218− :<|> recordRoutes

217+ :<|> recordRoutes = client api

219− :<|> captureVerbatim = client api

220

218

221server :: Application

219server :: Application

222server = serve api (

220server = serve api (

@@ -261,7 +259,6 @@ server = serve api (

261 { something = pure ["foo", "bar", "pweet"]

259 { something = pure ["foo", "bar", "pweet"]

262 }

260 }

263 }

261 }

264− :<|> pure . decodeUtf8 . unVerbatim

265 )

262 )

266

263

267-- * api for testing failures

264-- * api for testing failures

@@ -373,12 +370,3 @@ instance ToHttpApiData UrlEncodedByteString where

373

370

374instance FromHttpApiData UrlEncodedByteString where

371instance FromHttpApiData UrlEncodedByteString where

375 parseUrlPiece = pure . UrlEncodedByteString . HTTP.urlDecode True . encodeUtf8

372 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

36import Data.Monoid ()

37import Data.Text

38 (Text)

39−import Data.Text.Encoding

40− (encodeUtf8)

41import qualified Network.HTTP.Client as C

39import qualified Network.HTTP.Client as C

42import qualified Network.HTTP.Types as HTTP

40import qualified Network.HTTP.Types as HTTP

43import Test.Hspec

41import Test.Hspec

@@ -162,8 +160,7 @@ successSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do

162 mgr <- C.newManager C.defaultManagerSettings

160 mgr <- C.newManager C.defaultManagerSettings

163 -- In proper situation, extra headers should probably be visible in API type.

161 -- In proper situation, extra headers should probably be visible in API type.

164 -- However, testing for response timeout is difficult, so we test with something which is easy to observe

162 -- 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")] })

163+ let createClientRequest url r = (defaultMakeClientRequest url r) { C.requestHeaders = [("X-Added-Header", "XXX")] }

166− (defaultMakeClientRequest url r)

167 clientEnv = (mkClientEnv mgr baseUrl) { makeClientRequest = createClientRequest }

164 clientEnv = (mkClientEnv mgr baseUrl) { makeClientRequest = createClientRequest }

168 res <- runClientM (getRawSuccessPassHeaders HTTP.methodGet) clientEnv

165 res <- runClientM (getRawSuccessPassHeaders HTTP.methodGet) clientEnv

169 case res of

166 case res of

@@ -199,10 +196,3 @@ successSpec = beforeAll (startWaiApp server) $ afterAll endWaiApp $ do

199 case eitherResponse of

196 case eitherResponse of

200 Left clientError -> fail $ show clientError

197 Left clientError -> fail $ show clientError

201 Right response -> matchUnion response `shouldBe` Just (WithStatus @201 carol)

198 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-docs/src/Servant/Docs/Internal.hs−4

@@ -62,7 +62,6 @@ import GHC.TypeLits

62import Servant.API

63import Servant.API.ContentTypes

64import Servant.API.TypeLevel

65−import Servant.API.Generic

66

65

67import qualified Data.Universe.Helpers as U

66import qualified Data.Universe.Helpers as U

68

67

@@ -1151,9 +1150,6 @@ instance (ToAuthInfo (BasicAuth realm usr), HasDocs api) => HasDocs (BasicAuth r

1151 authProxy = Proxy :: Proxy (BasicAuth realm usr)

1150 authProxy = Proxy :: Proxy (BasicAuth realm usr)

1152 action' = over authInfo (|> toAuthInfo authProxy) action

1151 action' = over authInfo (|> toAuthInfo authProxy) action

1153

1152

1154−instance HasDocs (ToServantApi api) => HasDocs (NamedRoutes api) where

1155− docsFor Proxy = docsFor (Proxy :: Proxy (ToServantApi api))

1156−

1157-- ToSample instances for simple types

1153-- ToSample instances for simple types

1158instance ToSample NoContent

1154instance ToSample NoContent

1159instance ToSample Bool

1155instance ToSample Bool

servant-foreign/servant-foreign.cabal+2−2

@@ -74,7 +74,7 @@ test-suite spec

74

75 -- Additional dependencies

76 build-depends:

77− hspec >= 2.6.0 && <2.10

77+ hspec >= 2.6.0 && <2.9

78 build-tool-depends:

79− hspec-discover:hspec-discover >=2.6.0 && <2.10

79+ hspec-discover:hspec-discover >=2.6.0 && <2.9

80 default-language: Haskell2010

servant-http-streams/servant-http-streams.cabal+2−2

@@ -112,7 +112,7 @@ test-suite spec

112 -- Additional dependencies

113 build-depends:

114 entropy >= 0.4.1.3 && < 0.5

115− , hspec >= 2.6.0 && < 2.10

115+ , hspec >= 2.6.0 && < 2.9

116 , HUnit >= 1.6.0.0 && < 1.7

117 , network >= 2.8.0.0 && < 3.2

118 , QuickCheck >= 2.12.6.1 && < 2.15

@@ -121,7 +121,7 @@ test-suite spec

121 , tdigest >= 0.2 && < 0.3

122

123 build-tool-depends:

124− hspec-discover:hspec-discover >= 2.6.0 && < 2.10

124+ hspec-discover:hspec-discover >= 2.6.0 && < 2.9

125

126test-suite readme

127 type: exitcode-stdio-1.0

servant-server/servant-server.cabal+3−3

@@ -72,7 +72,7 @@ library

72 -- Servant dependencies

73 -- strict dependency as we re-export 'servant' things.

74 build-depends:

75− servant >= 0.19 && < 0.20

75+ servant >= 0.19

76 , http-api-data >= 0.4.1 && < 0.4.4

77

78 -- Other dependencies: Lower bound around what is in the latest Stackage LTS.

@@ -159,7 +159,7 @@ test-suite spec

159 build-depends:

160 aeson >= 1.4.1.0 && < 3

161 , directory >= 1.3.0.0 && < 1.4

162− , hspec >= 2.6.0 && < 2.10

162+ , hspec >= 2.6.0 && < 2.9

163 , hspec-wai >= 0.10.1 && < 0.12

164 , QuickCheck >= 2.12.6.1 && < 2.15

165 , should-not-typecheck >= 2.1.0 && < 2.2

@@ -167,4 +167,4 @@ test-suite spec

167 , wai-extra >= 3.0.24.3 && < 3.2

168

169 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 '[])

235-- > │ └─ e/

236-- > │ └─•

237-- > ├─ b/

238−-- > │ └─ <x::Int>/

238+-- > │ └─ <capture>/

239-- > │ ├─•

240-- > │ ┆

241-- > │ └─•

@@ -252,8 +252,7 @@ hoistServer p = hoistServerWithContext p (Proxy :: Proxy '[])

252--

253-- [@─•@] Leaves reflect endpoints.

254--

255−-- [@\<x::Int\>/@] This is a delayed capture of a single

255+-- [@\<capture\>/@] This is a delayed capture of a path component.

256−-- path component named @x@, of expected type @Int@.

257--

256--

258-- [@\<raw\>@] This is a part of the API we do not know anything about.

257-- [@\<raw\>@] This is a part of the API we do not know anything about.

259--

258--

servant-server/src/Servant/Server/Internal.hs+4−6

@@ -173,7 +173,7 @@ instance (HasServer a context, HasServer b context) => HasServer (a :<|> b) cont

173-- > server = getBook

174-- > where getBook :: Text -> Handler Book

175-- > getBook isbn = ...

176−instance (KnownSymbol capture, FromHttpApiData a, Typeable a

176+instance (KnownSymbol capture, FromHttpApiData a

177 , HasServer api context, SBoolI (FoldLenient mods)

178 , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters

179 )

@@ -185,7 +185,7 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a

185 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s

186

187 route Proxy context d =

188− CaptureRouter [hint] $

188+ CaptureRouter $

189 route (Proxy :: Proxy api)

190 context

191 (addCapture d $ \ txt -> withRequest $ \ request ->

@@ -197,7 +197,6 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a

197 where

198 rep = typeRep (Proxy :: Proxy Capture')

199 formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)

200− hint = CaptureHint (T.pack $ symbolVal $ Proxy @capture) (typeRep (Proxy :: Proxy a))

201

200

202-- | If you use 'CaptureAll' in one of the endpoints for your API,

201-- | If you use 'CaptureAll' in one of the endpoints for your API,

203-- this automatically requires your server-side handler to be a

202-- this automatically requires your server-side handler to be a

@@ -216,7 +215,7 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a

216-- > server = getSourceFile

215-- > server = getSourceFile

217-- > where getSourceFile :: [Text] -> Handler Book

216-- > where getSourceFile :: [Text] -> Handler Book

218-- > getSourceFile pathSegments = ...

217-- > getSourceFile pathSegments = ...

219−instance (KnownSymbol capture, FromHttpApiData a, Typeable a

218+instance (KnownSymbol capture, FromHttpApiData a

220 , HasServer api context

219 , HasServer api context

221 , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters

220 , HasContextEntry (MkContextWithErrorFormatter context) ErrorFormatters

222 )

221 )

@@ -228,7 +227,7 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a

228 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s

227 hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy :: Proxy api) pc nt . s

229

228

230 route Proxy context d =

229 route Proxy context d =

231− CaptureAllRouter [hint] $

230+ CaptureAllRouter $

232 route (Proxy :: Proxy api)

231 route (Proxy :: Proxy api)

233 context

232 context

234 (addCapture d $ \ txts -> withRequest $ \ request ->

233 (addCapture d $ \ txts -> withRequest $ \ request ->

@@ -239,7 +238,6 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a

239 where

238 where

240 rep = typeRep (Proxy :: Proxy CaptureAll)

239 rep = typeRep (Proxy :: Proxy CaptureAll)

241 formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)

240 formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)

242− hint = CaptureHint (T.pack $ symbolVal $ Proxy @capture) (typeRep (Proxy :: Proxy [a]))

243

241

244allowedMethodHead :: Method -> Request -> Bool

242allowedMethodHead :: Method -> Request -> Bool

245allowedMethodHead method request = method == methodGet && requestMethod request == methodHead

243allowedMethodHead method request = method == methodGet && requestMethod request == methodHead

servant-server/src/Servant/Server/Internal/Router.hs+14−31

@@ -9,16 +9,12 @@ import Prelude.Compat

9

10import Data.Function

11 (on)

12−import Data.List

13− (nub)

14import Data.Map

12import Data.Map

15 (Map)

13 (Map)

16import qualified Data.Map as M

14import qualified Data.Map as M

17import Data.Text

15import Data.Text

18 (Text)

16 (Text)

19import qualified Data.Text as T

17import qualified Data.Text as T

20−import Data.Typeable

21− (TypeRep)

22import Network.Wai

18import Network.Wai

23 (Response, pathInfo)

19 (Response, pathInfo)

24import Servant.Server.Internal.ErrorFormatter

20import Servant.Server.Internal.ErrorFormatter

@@ -28,18 +24,6 @@ import Servant.Server.Internal.ServerError

28

24

29type Router env = Router' env RoutingApplication

25type Router env = Router' env RoutingApplication

30

26

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−

43-- | Internal representation of a router.

27-- | Internal representation of a router.

44--

28--

45-- The first argument describes an environment type that is

29-- The first argument describes an environment type that is

@@ -52,10 +36,10 @@ data Router' env a =

52 -- ^ the map contains routers for subpaths (first path component used

36 -- ^ the map contains routers for subpaths (first path component used

53 -- for lookup and removed afterwards), the list contains handlers

37 -- for lookup and removed afterwards), the list contains handlers

54 -- for the empty path, to be tried in order

38 -- for the empty path, to be tried in order

55− | CaptureRouter [CaptureHint] (Router' (Text, env) a)

39+ | CaptureRouter (Router' (Text, env) a)

56 -- ^ first path component is passed to the child router in its

40 -- ^ first path component is passed to the child router in its

57 -- environment and removed afterwards

41 -- environment and removed afterwards

58− | CaptureAllRouter [CaptureHint] (Router' ([Text], env) a)

42+ | CaptureAllRouter (Router' ([Text], env) a)

59 -- ^ all path components are passed to the child router in its

43 -- ^ all path components are passed to the child router in its

60 -- environment and are removed afterwards

44 -- environment and are removed afterwards

61 | RawRouter (env -> a)

45 | RawRouter (env -> a)

@@ -85,8 +69,8 @@ leafRouter l = StaticRouter M.empty [l]

85choice :: Router' env a -> Router' env a -> Router' env a

69choice :: Router' env a -> Router' env a -> Router' env a

86choice (StaticRouter table1 ls1) (StaticRouter table2 ls2) =

70choice (StaticRouter table1 ls1) (StaticRouter table2 ls2) =

87 StaticRouter (M.unionWith choice table1 table2) (ls1 ++ ls2)

71 StaticRouter (M.unionWith choice table1 table2) (ls1 ++ ls2)

88−choice (CaptureRouter hints1 router1) (CaptureRouter hints2 router2) =

72+choice (CaptureRouter router1) (CaptureRouter router2) =

89− CaptureRouter (nub $ hints1 ++ hints2) (choice router1 router2)

73+ CaptureRouter (choice router1 router2)

90choice router1 (Choice router2 router3) = Choice (choice router1 router2) router3

74choice router1 (Choice router2 router3) = Choice (choice router1 router2) router3

91choice router1 router2 = Choice router1 router2

75choice router1 router2 = Choice router1 router2

92

76

@@ -100,7 +84,7 @@ choice router1 router2 = Choice router1 router2

100--

84--

101data RouterStructure =

85data RouterStructure =

102 StaticRouterStructure (Map Text RouterStructure) Int

86 StaticRouterStructure (Map Text RouterStructure) Int

103− | CaptureRouterStructure [CaptureHint] RouterStructure

87+ | CaptureRouterStructure RouterStructure

104 | RawRouterStructure

88 | RawRouterStructure

105 | ChoiceStructure RouterStructure RouterStructure

89 | ChoiceStructure RouterStructure RouterStructure

106 deriving (Eq, Show)

90 deriving (Eq, Show)

@@ -114,11 +98,11 @@ data RouterStructure =

114routerStructure :: Router' env a -> RouterStructure

98routerStructure :: Router' env a -> RouterStructure

115routerStructure (StaticRouter m ls) =

99routerStructure (StaticRouter m ls) =

116 StaticRouterStructure (fmap routerStructure m) (length ls)

100 StaticRouterStructure (fmap routerStructure m) (length ls)

117−routerStructure (CaptureRouter hints router) =

101+routerStructure (CaptureRouter router) =

118− CaptureRouterStructure hints $

102+ CaptureRouterStructure $

119 routerStructure router

103 routerStructure router

120−routerStructure (CaptureAllRouter hints router) =

104+routerStructure (CaptureAllRouter router) =

121− CaptureRouterStructure hints $

105+ CaptureRouterStructure $

122 routerStructure router

106 routerStructure router

123routerStructure (RawRouter _) =

107routerStructure (RawRouter _) =

124 RawRouterStructure

108 RawRouterStructure

@@ -130,8 +114,8 @@ routerStructure (Choice r1 r2) =

130-- | Compare the structure of two routers.

114-- | Compare the structure of two routers.

131--

115--

132sameStructure :: Router' env a -> Router' env b -> Bool

116sameStructure :: Router' env a -> Router' env b -> Bool

133−sameStructure router1 router2 =

117+sameStructure r1 r2 =

134− routerStructure router1 == routerStructure router2

118+ routerStructure r1 == routerStructure r2

135

119

136-- | Provide a textual representation of the

120-- | Provide a textual representation of the

137-- structure of a router.

121-- structure of a router.

@@ -142,8 +126,7 @@ routerLayout router =

142 where

126 where

143 mkRouterLayout :: Bool -> RouterStructure -> [Text]

127 mkRouterLayout :: Bool -> RouterStructure -> [Text]

144 mkRouterLayout c (StaticRouterStructure m n) = mkSubTrees c (M.toList m) n

128 mkRouterLayout c (StaticRouterStructure m n) = mkSubTrees c (M.toList m) n

145− mkRouterLayout c (CaptureRouterStructure hints r) =

129+ mkRouterLayout c (CaptureRouterStructure r) = mkSubTree c "<capture>" (mkRouterLayout False r)

146− mkSubTree c (toCaptureTags hints) (mkRouterLayout False r)

147 mkRouterLayout c RawRouterStructure =

130 mkRouterLayout c RawRouterStructure =

148 if c then ["├─ <raw>"] else ["└─ <raw>"]

131 if c then ["├─ <raw>"] else ["└─ <raw>"]

149 mkRouterLayout c (ChoiceStructure r1 r2) =

132 mkRouterLayout c (ChoiceStructure r1 r2) =

@@ -186,7 +169,7 @@ runRouterEnv fmt router env request respond =

186 -> let request' = request { pathInfo = rest }

169 -> let request' = request { pathInfo = rest }

187 in runRouterEnv fmt router' env request' respond

170 in runRouterEnv fmt router' env request' respond

188 _ -> respond $ Fail $ fmt request

171 _ -> respond $ Fail $ fmt request

189− CaptureRouter _ router' ->

172+ CaptureRouter router' ->

190 case pathInfo request of

173 case pathInfo request of

191 [] -> respond $ Fail $ fmt request

174 [] -> respond $ Fail $ fmt request

192 -- This case is to handle trailing slashes.

175 -- This case is to handle trailing slashes.

@@ -194,7 +177,7 @@ runRouterEnv fmt router env request respond =

194 first : rest

177 first : rest

195 -> let request' = request { pathInfo = rest }

178 -> let request' = request { pathInfo = rest }

196 in runRouterEnv fmt router' (first, env) request' respond

179 in runRouterEnv fmt router' (first, env) request' respond

197− CaptureAllRouter _ router' ->

180+ CaptureAllRouter router' ->

198 let segments = pathInfo request

181 let segments = pathInfo request

199 request' = request { pathInfo = [] }

182 request' = request { pathInfo = [] }

200 in runRouterEnv fmt router' (segments, env) request' respond

183 in runRouterEnv fmt router' (segments, env) request' respond

servant-server/test/Servant/Server/RouterSpec.hs+6−127

@@ -9,9 +9,7 @@ import Control.Monad

9import Data.Proxy

10 (Proxy (..))

11import Data.Text

12− (Text, unpack)

12+ (unpack)

13−import Data.Typeable

14− (typeRep)

15import Network.HTTP.Types

13import Network.HTTP.Types

16 (Status (..))

14 (Status (..))

17import Network.Wai

15import Network.Wai

@@ -29,7 +27,6 @@ spec :: Spec

29spec = describe "Servant.Server.Internal.Router" $ do

27spec = describe "Servant.Server.Internal.Router" $ do

30 routerSpec

28 routerSpec

31 distributivitySpec

29 distributivitySpec

32− serverLayoutSpec

33

30

34routerSpec :: Spec

31routerSpec :: Spec

35routerSpec = do

32routerSpec = do

@@ -54,7 +51,7 @@ routerSpec = do

54 toApp = toApplication . runRouter (const err404)

51 toApp = toApplication . runRouter (const err404)

55

52

56 cap :: Router ()

53 cap :: Router ()

57− cap = CaptureRouter [hint] $

54+ cap = CaptureRouter $

58 let delayed = addCapture (emptyDelayed $ Route pure) (const $ delayedFail err400)

55 let delayed = addCapture (emptyDelayed $ Route pure) (const $ delayedFail err400)

59 in leafRouter

56 in leafRouter

60 $ \env req res ->

57 $ \env req res ->

@@ -62,9 +59,6 @@ routerSpec = do

62 . const

59 . const

63 $ Route success

60 $ Route success

64

61

65− hint :: CaptureHint

66− hint = CaptureHint "anything" $ typeRep (Proxy :: Proxy ())

67−

68 router :: Router ()

62 router :: Router ()

69 router = leafRouter (\_ _ res -> res $ Route success)

63 router = leafRouter (\_ _ res -> res $ Route success)

70 `Choice` cap

64 `Choice` cap

@@ -104,30 +98,12 @@ distributivitySpec =

104 it "properly handles mixing static paths at different levels" $ do

98 it "properly handles mixing static paths at different levels" $ do

105 level `shouldHaveSameStructureAs` levelRef

99 level `shouldHaveSameStructureAs` levelRef

106

100

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−

119shouldHaveSameStructureAs ::

101shouldHaveSameStructureAs ::

120 (HasServer api1 '[], HasServer api2 '[]) => Proxy api1 -> Proxy api2 -> Expectation

102 (HasServer api1 '[], HasServer api2 '[]) => Proxy api1 -> Proxy api2 -> Expectation

121shouldHaveSameStructureAs p1 p2 =

103shouldHaveSameStructureAs p1 p2 =

122 unless (sameStructure (makeTrivialRouter p1) (makeTrivialRouter p2)) $

104 unless (sameStructure (makeTrivialRouter p1) (makeTrivialRouter p2)) $

123 expectationFailure ("expected:\n" ++ unpack (layout p2) ++ "\nbut got:\n" ++ unpack (layout p1))

105 expectationFailure ("expected:\n" ++ unpack (layout p2) ++ "\nbut got:\n" ++ unpack (layout p1))

124

106

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−

131makeTrivialRouter :: (HasServer layout '[]) => Proxy layout -> Router ()

107makeTrivialRouter :: (HasServer layout '[]) => Proxy layout -> Router ()

132makeTrivialRouter p =

108makeTrivialRouter p =

133 route p EmptyContext (emptyDelayed (FailFatal err501))

109 route p EmptyContext (emptyDelayed (FailFatal err501))

@@ -168,12 +144,12 @@ staticRef = Proxy

168-- structure:

144-- structure:

169

145

170type Dynamic =

146type Dynamic =

171− "a" :> Capture "foo" Int :> "b" :> End

147+ "a" :> Capture "foo" Int :> "b" :> End

172− :<|> "a" :> Capture "foo" Int :> "c" :> End

148+ :<|> "a" :> Capture "bar" Bool :> "c" :> End

173− :<|> "a" :> Capture "foo" Int :> "d" :> End

149+ :<|> "a" :> Capture "baz" Char :> "d" :> End

174

150

175type DynamicRef =

151type DynamicRef =

176− "a" :> Capture "foo" Int :>

152+ "a" :> Capture "anything" () :>

177 ("b" :> End :<|> "c" :> End :<|> "d" :> End)

153 ("b" :> End :<|> "c" :> End :<|> "d" :> End)

178

154

179dynamic :: Proxy Dynamic

155dynamic :: Proxy Dynamic

@@ -363,100 +339,3 @@ level = Proxy

363

339

364levelRef :: Proxy LevelRef

340levelRef :: Proxy LevelRef

365levelRef = Proxy

341levelRef = 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+4−4

@@ -77,7 +77,7 @@ library

77 , http-media >=0.7.1.3 && <0.9

78 , insert-ordered-containers >=0.2.1.0 && <0.3

79 , lens >=4.17 && <6

80− , servant >=0.18.2 && <0.20

80+ , servant >=0.18.1 && <0.20

81 , singleton-bool >=0.1.4 && <0.2

82 , swagger2 >=2.3.0.1 && <3

83 , text >=1.2.3.0 && <2.1

@@ -106,14 +106,14 @@ test-suite spec

106 type: exitcode-stdio-1.0

107 hs-source-dirs: test

108 main-is: Spec.hs

109− build-tool-depends: hspec-discover:hspec-discover >=2.6.0 && <2.10

109+ build-tool-depends: hspec-discover:hspec-discover >=2.6.0 && <2.8

110 build-depends: base

111 , base-compat

112 , aeson >=1.4.2.0 && <3

113− , hspec >=2.6.0 && <2.10

113+ , hspec >=2.6.0 && <2.8

114 , QuickCheck

115 , lens

116− , lens-aeson >=1.0.2 && <1.3

116+ , lens-aeson >=1.0.2 && <1.2

117 , servant

118 , servant-swagger

119 , swagger2

servant-swagger/src/Servant/Swagger.hs+3−5

@@ -55,7 +55,6 @@ import Servant.Swagger.Internal.Orphans ()

55-- >>> import Data.Typeable

56-- >>> import GHC.Generics

57-- >>> import Servant.API

58−-- >>> import System.Environment

59-- >>> import Test.Hspec

58-- >>> import Test.Hspec

60-- >>> import Test.QuickCheck

59-- >>> import Test.QuickCheck

61-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL8

60-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL8

@@ -65,7 +64,6 @@ import Servant.Swagger.Internal.Orphans ()

65-- >>> :set -XGeneralizedNewtypeDeriving

64-- >>> :set -XGeneralizedNewtypeDeriving

66-- >>> :set -XOverloadedStrings

65-- >>> :set -XOverloadedStrings

67-- >>> :set -XTypeOperators

66-- >>> :set -XTypeOperators

68−-- >>> setEnv "HSPEC_COLOR" "no"

69-- >>> data User = User { name :: String, age :: Int } deriving (Show, Generic, Typeable)

67-- >>> data User = User { name :: String, age :: Int } deriving (Show, Generic, Typeable)

70-- >>> newtype UserId = UserId Integer deriving (Show, Generic, Typeable, ToJSON)

68-- >>> newtype UserId = UserId Integer deriving (Show, Generic, Typeable, ToJSON)

71-- >>> instance ToJSON User

69-- >>> instance ToJSON User

@@ -162,11 +160,11 @@ import Servant.Swagger.Internal.Orphans ()

162-- >>> instance Arbitrary UserId where arbitrary = UserId <$> arbitrary

160-- >>> instance Arbitrary UserId where arbitrary = UserId <$> arbitrary

163-- >>> hspec $ validateEveryToJSON (Proxy :: Proxy UserAPI)

161-- >>> hspec $ validateEveryToJSON (Proxy :: Proxy UserAPI)

164-- <BLANKLINE>

162-- <BLANKLINE>

165−-- [User]...

163+-- [User]

166-- ...

164-- ...

167−-- User...

165+-- User

168-- ...

166-- ...

169−-- UserId...

167+-- UserId

170-- ...

168-- ...

171-- Finished in ... seconds

169-- Finished in ... seconds

172-- 3 examples, 0 failures

170-- 3 examples, 0 failures

servant-swagger/src/Servant/Swagger/Internal.hs−11

@@ -3,13 +3,11 @@

3{-# LANGUAGE DataKinds #-}

4{-# LANGUAGE FlexibleContexts #-}

5{-# LANGUAGE FlexibleInstances #-}

6−{-# LANGUAGE OverloadedLists #-}

7{-# LANGUAGE OverloadedStrings #-}

6{-# LANGUAGE OverloadedStrings #-}

8{-# LANGUAGE PolyKinds #-}

7{-# LANGUAGE PolyKinds #-}

9{-# LANGUAGE RankNTypes #-}

8{-# LANGUAGE RankNTypes #-}

10{-# LANGUAGE ScopedTypeVariables #-}

9{-# LANGUAGE ScopedTypeVariables #-}

11{-# LANGUAGE TypeOperators #-}

10{-# LANGUAGE TypeOperators #-}

12−{-# LANGUAGE TypeFamilies #-}

13#if __GLASGOW_HASKELL__ >= 806

11#if __GLASGOW_HASKELL__ >= 806

14{-# LANGUAGE UndecidableInstances #-}

12{-# LANGUAGE UndecidableInstances #-}

15#endif

13#endif

@@ -32,13 +30,11 @@ import qualified Data.Swagger as Swagger

32import Data.Swagger.Declare

30import Data.Swagger.Declare

33import Data.Text (Text)

31import Data.Text (Text)

34import qualified Data.Text as Text

32import qualified Data.Text as Text

35−import GHC.Generics (D1, Meta(..), Rep)

36import GHC.TypeLits

33import GHC.TypeLits

37import Network.HTTP.Media (MediaType)

34import Network.HTTP.Media (MediaType)

38import Servant.API

35import Servant.API

39import Servant.API.Description (FoldDescription,

36import Servant.API.Description (FoldDescription,

40 reflectDescription)

37 reflectDescription)

41−import Servant.API.Generic (ToServantApi, AsApi)

42import Servant.API.Modifiers (FoldRequired)

38import Servant.API.Modifiers (FoldRequired)

43

39

44import Servant.Swagger.Internal.TypeLevel.API

40import Servant.Swagger.Internal.TypeLevel.API

@@ -153,10 +149,6 @@ mkEndpointNoContentVerb path _ = mempty

153addParam :: Param -> Swagger -> Swagger

149addParam :: Param -> Swagger -> Swagger

154addParam param = allOperations.parameters %~ (Inline param :)

150addParam param = allOperations.parameters %~ (Inline param :)

155

151

156−-- | Add a tag to every operation in the spec.

157−addTag :: Text -> Swagger -> Swagger

158−addTag tag = allOperations.tags %~ ([tag] <>)

159−

160-- | Add accepted content types to every operation in the spec.

152-- | Add accepted content types to every operation in the spec.

161addConsumes :: [MediaType] -> Swagger -> Swagger

153addConsumes :: [MediaType] -> Swagger -> Swagger

162addConsumes cs = allOperations.consumes %~ (<> Just (MimeList cs))

154addConsumes cs = allOperations.consumes %~ (<> Just (MimeList cs))

@@ -447,9 +439,6 @@ instance (ToSchema a, Accept ct, HasSwagger sub, KnownSymbol (FoldDescription mo

447 & required ?~ True

439 & required ?~ True

448 & schema .~ ParamBody ref

440 & schema .~ ParamBody ref

449

441

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−

453-- =======================================================================

442-- =======================================================================

454-- Below are the definitions that should be in Servant.API.ContentTypes

443-- Below are the definitions that should be in Servant.API.ContentTypes

455-- =======================================================================

444-- =======================================================================

servant-swagger/src/Servant/Swagger/Internal/Test.hs+6−8

@@ -29,12 +29,10 @@ import Servant.Swagger.Internal.TypeLevel

29-- >>> import Control.Applicative

30-- >>> import GHC.Generics

31-- >>> import Test.QuickCheck

32−-- >>> import System.Environment (setEnv)

33-- >>> :set -XDeriveGeneric

32-- >>> :set -XDeriveGeneric

34-- >>> :set -XGeneralizedNewtypeDeriving

33-- >>> :set -XGeneralizedNewtypeDeriving

35-- >>> :set -XDataKinds

34-- >>> :set -XDataKinds

36-- >>> :set -XTypeOperators

35-- >>> :set -XTypeOperators

37−-- >>> setEnv "HSPEC_COLOR" "no"

38

36

39-- | Verify that every type used with @'JSON'@ content type in a servant API

37-- | Verify that every type used with @'JSON'@ content type in a servant API

40-- has compatible @'ToJSON'@ and @'ToSchema'@ instances using @'validateToJSON'@.

38-- has compatible @'ToJSON'@ and @'ToSchema'@ instances using @'validateToJSON'@.

@@ -55,10 +53,10 @@ import Servant.Swagger.Internal.TypeLevel

55--

53--

56-- >>> hspec $ context "ToJSON matches ToSchema" $ validateEveryToJSON (Proxy :: Proxy UserAPI)

54-- >>> hspec $ context "ToJSON matches ToSchema" $ validateEveryToJSON (Proxy :: Proxy UserAPI)

57-- <BLANKLINE>

55-- <BLANKLINE>

58−-- ToJSON matches ToSchema...

56+-- ToJSON matches ToSchema

59−-- User...

57+-- User

60-- ...

58-- ...

61−-- UserId...

59+-- UserId

62-- ...

60-- ...

63-- Finished in ... seconds

61-- Finished in ... seconds

64-- 2 examples, 0 failures

62-- 2 examples, 0 failures

@@ -120,11 +118,11 @@ validateEveryToJSONWithPatternChecker checker _ = props

120-- :}

118-- :}

121-- <BLANKLINE>

119-- <BLANKLINE>

122-- read . show == id

120-- read . show == id

123−-- Bool...

121+-- Bool

124-- ...

122-- ...

125−-- Int...

123+-- Int

126-- ...

124-- ...

127−-- [Char]...

125+-- [Char]

128-- ...

126-- ...

129-- Finished in ... seconds

127-- Finished in ... seconds

130-- 3 examples, 0 failures

128-- 3 examples, 0 failures

servant/servant.cabal+2−2

@@ -166,9 +166,9 @@ test-suite spec

166

167 -- Additional dependencies

168 build-depends:

169− hspec >= 2.6.0 && < 2.10

169+ hspec >= 2.6.0 && < 2.9

170 , QuickCheck >= 2.12.6.1 && < 2.15

171 , quickcheck-instances >= 0.3.19 && < 0.4

172

173 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/ContentTypes.hs+1−1

@@ -295,7 +295,7 @@ instance {-# OVERLAPPABLE #-}

295-- then this would be taken care of. However there is no more specific instance

296-- between that and 'MimeRender JSON a', so we do this instead

297instance {-# OVERLAPPING #-} ( Accept ctyp ) => AllMimeRender '[ctyp] NoContent where

298− allMimeRender _ NoContent = map (, "") $ NE.toList $ contentTypes pctyp

298+ allMimeRender _ _ = map (, "") $ NE.toList $ contentTypes pctyp

299 where

300 pctyp = Proxy :: Proxy ctyp

301

servant/src/Servant/API/ResponseHeaders.hs+19

@@ -8,6 +8,7 @@

8{-# LANGUAGE PolyKinds #-}

9{-# LANGUAGE ScopedTypeVariables #-}

10{-# LANGUAGE TypeFamilies #-}

11+{-# LANGUAGE TypeFamilyDependencies #-}

11{-# LANGUAGE TypeOperators #-}

12{-# LANGUAGE TypeOperators #-}

12{-# LANGUAGE UndecidableInstances #-}

13{-# LANGUAGE UndecidableInstances #-}

13{-# OPTIONS_HADDOCK not-home #-}

14{-# OPTIONS_HADDOCK not-home #-}

@@ -51,6 +52,9 @@ import Prelude ()

51import Prelude.Compat

52import Prelude.Compat

52import Servant.API.Header

53import Servant.API.Header

53 (Header)

54 (Header)

55+import Servant.API.UVerb.Union

56+import qualified Data.SOP.BasicFunctors as SOP

57+import qualified Data.SOP.NS as SOP

54

58

55-- | Response Header objects. You should never need to construct one directly.

59-- | Response Header objects. You should never need to construct one directly.

56-- Instead, use 'addOptionalHeader'.

60-- Instead, use 'addOptionalHeader'.

@@ -170,6 +174,21 @@ instance {-# OVERLAPPABLE #-} ( KnownSymbol h, ToHttpApiData v , new ~ Headers '

170 => AddHeader h v a new where

174 => AddHeader h v a new where

171 addOptionalHeader hdr resp = Headers resp (HCons hdr HNil)

175 addOptionalHeader hdr resp = Headers resp (HCons hdr HNil)

172

176

177+-- Instances to decorate all responses in a 'Union' with headers. The functional

178+-- dependencies force us to consider singleton lists as the base case in the

179+-- recursion (it is impossible to determine h and v otherwise from old / new

180+-- responses if the list is empty).

181+instance (AddHeader h v old new) => AddHeader h v (Union '[old]) (Union '[new]) where

182+ addOptionalHeader hdr resp =

183+ SOP.Z $ SOP.I $ addOptionalHeader hdr $ SOP.unI $ SOP.unZ $ resp

184+

185+instance

186+ (AddHeader h v old new, AddHeader h v (Union oldrest) (Union newrest), oldrest ~ (a ': as), newrest ~ (b ': bs))

187+ => AddHeader h v (Union (old ': (a ': as))) (Union (new ': (b ': bs))) where

188+ addOptionalHeader hdr resp = case resp of

189+ SOP.Z (SOP.I rHead) -> SOP.Z $ SOP.I $ addOptionalHeader hdr rHead

190+ SOP.S rOthers -> SOP.S $ addOptionalHeader hdr rOthers

191+

173-- | @addHeader@ adds a header to a response. Note that it changes the type of

192-- | @addHeader@ adds a header to a response. Note that it changes the type of

174-- the value in the following ways:

193-- the value in the following ways:

175--

194--

servant/src/Servant/API/UVerb.hs+3

@@ -38,6 +38,7 @@ import GHC.TypeLits (Nat)

38import Network.HTTP.Types (Status, StdMethod)

39import Servant.API.ContentTypes (JSON, PlainText, FormUrlEncoded, OctetStream, NoContent, MimeRender(mimeRender), MimeUnrender(mimeUnrender))

40import Servant.API.Status (KnownStatus, statusVal)

41+import Servant.API.ResponseHeaders (Headers)

41import Servant.API.UVerb.Union

42import Servant.API.UVerb.Union

42

43

43class KnownStatus (StatusOf a) => HasStatus (a :: *) where

44class KnownStatus (StatusOf a) => HasStatus (a :: *) where

@@ -86,6 +87,8 @@ newtype WithStatus (k :: Nat) a = WithStatus a

86instance KnownStatus n => HasStatus (WithStatus n a) where

87instance KnownStatus n => HasStatus (WithStatus n a) where

87 type StatusOf (WithStatus n a) = n

88 type StatusOf (WithStatus n a) = n

88

89

90+instance HasStatus a => HasStatus (Headers ls a) where

91+ type StatusOf (Headers ls a) = StatusOf a

89

92

90-- | A variant of 'Verb' that can have any of a number of response values and status codes.

93-- | A variant of 'Verb' that can have any of a number of response values and status codes.

91--

94--

servant/test/Servant/API/ContentTypesSpec.hs−11

@@ -33,8 +33,6 @@ import Data.String.Conversions

33import qualified Data.Text as TextS

34import qualified Data.Text.Encoding as TextSE

35import qualified Data.Text.Lazy as TextL

36−import Control.Exception

37− (evaluate)

38import GHC.Generics

36import GHC.Generics

39import Test.Hspec

37import Test.Hspec

40import Test.QuickCheck

38import Test.QuickCheck

@@ -80,15 +78,6 @@ spec = describe "Servant.API.ContentTypes" $ do

80 it "has mimeUnrender reverse mimeRender for valid top-level json " $ do

78 it "has mimeUnrender reverse mimeRender for valid top-level json " $ do

81 property $ \x -> mimeUnrender p (mimeRender p x) == Right (x::SomeData)

79 property $ \x -> mimeUnrender p (mimeRender p x) == Right (x::SomeData)

82

80

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−

92 describe "The PlainText Content-Type type" $ do

81 describe "The PlainText Content-Type type" $ do

93 let p = Proxy :: Proxy PlainText

82 let p = Proxy :: Proxy PlainText

94

83