master..d5b9cbf · servant

.github/workflows/master.yml+34−34

since splitsnapshots

unifiedsplit

@@ -76,40 +76,40 @@ jobs:

76 (cd servant-conduit && eval $DOCTEST)

77 (cd servant-pipes && eval $DOCTEST)

78

79− # stack:

79+ stack:

80− # name: stack / ghc ${{ matrix.ghc }}

80+ name: stack / ghc ${{ matrix.ghc }}

81− # runs-on: ubuntu-latest

81+ runs-on: ubuntu-latest

82− # strategy:

82+ strategy:

83− # matrix:

83+ matrix:

84− # stack: ["2.7.5"]

84+ stack: ["2.7.5"]

85− # ghc: ["8.10.7"]

85+ ghc: ["8.10.7"]

86−

86+

87− # steps:

87+ steps:

88− # - uses: actions/checkout@v2

88+ - uses: actions/checkout@v2

89−

89+

90− # - uses: haskell/actions/setup@v1

90+ - uses: haskell/actions/setup@v1

91− # name: Setup Haskell Stack

91+ name: Setup Haskell Stack

92− # with:

92+ with:

93− # ghc-version: ${{ matrix.ghc }}

93+ ghc-version: ${{ matrix.ghc }}

94− # stack-version: ${{ matrix.stack }}

94+ stack-version: ${{ matrix.stack }}

95−

95+

96− # - uses: actions/cache@v2.1.3

96+ - uses: actions/cache@v2.1.3

97− # name: Cache ~/.stack

97+ name: Cache ~/.stack

98− # with:

98+ with:

99− # path: ~/.stack

99+ path: ~/.stack

100− # key: ${{ runner.os }}-${{ matrix.ghc }}-stack

100+ key: ${{ runner.os }}-${{ matrix.ghc }}-stack

101−

101+

102− # - name: Install dependencies

102+ - name: Install dependencies

103− # run: |

103+ run: |

104− # stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks --only-dependencies

104+ stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks --only-dependencies

105−

105+

106− # - name: Build

106+ - name: Build

107− # run: |

107+ run: |

108− # stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks

108+ stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks

109−

109+

110− # - name: Test

110+ - name: Test

111− # run: |

111+ run: |

112− # stack test --system-ghc

112+ stack test --system-ghc

113

114 ghcjs:

115 name: ubuntu-latest / ghcjs 8.6

cabal.project+5−1

@@ -47,8 +47,12 @@ packages:

47 doc/cookbook/using-custom-monad

48 doc/cookbook/using-free-client

49 -- doc/cookbook/open-id-connect

50− doc/cookbook/managed-resource

51

50

52tests: True

51tests: True

53optimization: False

52optimization: False

54-- reorder-goals: True

53-- reorder-goals: True

54+

55+allow-newer:

56+-- see https://github.com/haskellari/postgresql-simple/issues/104

57+ postgresql-simple:base

58+ , postgresql-simple:template-haskell

changelog.d/1571deleted−10

@@ -1,10 +0,0 @@

1−synopsis: Support UVerb in servant-auth-server

2−prs: #1571

3−issues: #1570

4−description: {

5−UVerb endpoints are now supported by servant-auth-server and can be used under the

6−Auth combinator when writing servers. It is still unsupported by

7−servant-auth-client.

8−

9−This PR also brings Headers support in UVerb responses

10−}

changelog.d/1573deleted−2

@@ -1,2 +0,0 @@

1−synopsis: Add API docs for ServerT

2−prs: #1573

changelog.d/1606deleted−10

@@ -1,10 +0,0 @@

1−synopsis: Handle Cookies correctly for RunStreamingClient

2−prs: #1606

3−issues: #1605

4−

5−description: {

6−

7−Makes performWithStreamingRequest take into consideration the

8−CookieJar, which it previously didn't.

9−

10−}

changelog.d/1638deleted−2

@@ -1,2 +0,0 @@

1−synopsis: Add Functor instance to AuthHandler.

2−prs: #1638

changelog.d/1649deleted−8

@@ -1,8 +0,0 @@

1−synopsis: Add HasStatus instance for Headers (that defers StatusOf to underlying value)

2−prs: #1649

3−

4−description: {

5−

6−Adds a new HasStatus (Headers hs a) instance (StatusOf (Headers hs a) = StatusOf a)

7−

8−}

doc/cookbook/index.rst−1

@@ -37,4 +37,3 @@ you name it!

37 sentry/Sentry.lhs

38 testing/Testing.lhs

39 open-id-connect/OpenIdConnect.lhs

40− managed-resource/ManagedResource.lhs

doc/cookbook/managed-resource/ManagedResource.lhsdeleted−114

@@ -1,114 +0,0 @@

1−# Request-lifetime Managed Resources

2−

3−Let's see how we can write a handle that uses a resource managed by Servant. The resource is created automatically by Servant when the server recieves a request, and the resource is automatically destroyed when the server is finished handling a request.

4−

5−As usual, we start with a little bit of throat clearing.

6−

7−

8−``` haskell

9−{-# LANGUAGE DataKinds #-}

10−{-# LANGUAGE TypeOperators #-}

11−import Control.Concurrent

12−import Control.Exception (bracket, throwIO)

13−import Control.Monad.IO.Class

14−import Control.Monad.Trans.Resource

15−import Data.Acquire

16−import Network.HTTP.Client (newManager, defaultManagerSettings)

17−import Network.Wai.Handler.Warp

18−import Servant

19−import Servant.Client

20−import System.IO

21−```

22−

23−Here we define an API type that uses the `WithResource` combinator. The server handler for an endpoint with a `WithResource res` component will receive a value of that type as an argument.

24−

25−``` haskell

26−type API = WithResource Handle :> ReqBody '[PlainText] String :> Post '[JSON] NoContent

27−

28−api :: Proxy API

29−api = Proxy

30−```

31−

32−But this resource value has to come from somewhere. Servant obtains the value using an Acquire provided in the context. The Acquire knows how to both create and destroy resources of a particular type.

33−

34−``` haskell

35−appContext :: Context '[Acquire Handle]

36−appContext = acquireHandle :. EmptyContext

37−

38−acquireHandle :: Acquire Handle

39−acquireHandle = mkAcquire newHandle closeHandle

40−

41−newHandle :: IO Handle

42−newHandle = do

43− putStrLn "opening file"

44− h <- openFile "test.txt" AppendMode

45− putStrLn "opened file"

46− return h

47−

48−closeHandle :: Handle -> IO ()

49−closeHandle h = do

50− putStrLn "closing file"

51− hClose h

52− putStrLn "closed file"

53−```

54−

55−Now we create the handler which will use this resource. This handler will write the request message to the System.IO.Handle which was provided to us. In some situations the handler will succeed, but in some in will fail. In either case, Servant will clean up the resource for us.

56−

57−``` haskell

58−server :: Server API

59−server = writeToFile

60−

61− where writeToFile :: (ReleaseKey, Handle) -> String -> Handler NoContent

62− writeToFile (_, h) msg = case msg of

63− "illegal" -> error "wait, that's illegal!"

64− legalMsg -> liftIO $ do

65− putStrLn "writing file"

66− hPutStrLn h legalMsg

67− putStrLn "wrote file"

68− return NoContent

69−```

70−

71−Finally we run the server in the background while we post messages to it.

72−

73−``` haskell

74−runApp :: IO ()

75−runApp = run 8080 (serveWithContext api appContext $ server)

76−

77−postMsg :: String -> ClientM NoContent

78−postMsg = client api

79−

80−main :: IO ()

81−main = do

82− mgr <- newManager defaultManagerSettings

83− bracket (forkIO $ runApp) killThread $ \_ -> do

84− ms <- flip runClientM (mkClientEnv mgr (BaseUrl Http "localhost" 8080 "")) $ do

85− liftIO $ putStrLn "sending hello message"

86− _ <- postMsg "hello"

87− liftIO $ putStrLn "sending illegal message"

88− _ <- postMsg "illegal"

89− liftIO $ putStrLn "done"

90− print ms

91−```

92−

93−This program prints

94−

95−```

96−sending hello message

97−opening file

98−opened file

99−writing file

100−wrote file

101−closing file

102−closed file

103−sending illegal message

104−opening file

105−opened file

106−closing file

107−closed file

108−wait, that's illegal!

109−CallStack (from HasCallStack):

110− error, called at ManagedResource.lhs:63:24 in main:Main

111−Left (FailureResponse (Request {requestPath = (BaseUrl {baseUrlScheme = Http, baseUrlHost = "localhost", baseUrlPort = 8080, baseUrlPath = ""},""), requestQueryString = fromList [], requestBody = Just ((),text/plain;charset=utf-8), requestAccept = fromList [], requestHeaders = fromList [], requestHttpVersion = HTTP/1.1, requestMethod = "POST"}) (Response {responseStatusCode = Status {statusCode = 500, statusMessage = "Internal Server Error"}, responseHeaders = fromList [("Transfer-Encoding","chunked"),("Date","Thu, 24 Nov 2022 21:04:47 GMT"),("Server","Warp/3.3.23"),("Content-Type","text/plain; charset=utf-8")], responseHttpVersion = HTTP/1.1, responseBody = "Something went wrong"}))

112−```

113−

114−and appends to a file called `test.txt`. We can see from the output that when a legal message is sent, the file is opened, written to, and closed. We can also see that when an illegal message is sent, the file is opened but not written to. Crucially, it is still closed even though the handler threw an exception.

doc/cookbook/managed-resource/managed-resource.cabaldeleted−30

@@ -1,30 +0,0 @@

1−cabal-version: 2.2

2−name: cookbook-managed-resource

3−version: 0.1

4−synopsis: Simple managed resource cookbook example

5−homepage: http://docs.servant.dev/

6−license: BSD-3-Clause

7−license-file: ../../../servant/LICENSE

8−author: Servant Contributors

9−maintainer: haskell-servant-maintainers@googlegroups.com

10−build-type: Simple

11−tested-with: GHC==9.4.2

12−

13−executable cookbook-managed-resource

14− main-is: ManagedResource.lhs

15− build-depends: base == 4.*

16− , text >= 1.2

17− , aeson >= 1.2

18− , servant

19− , servant-client

20− , servant-server

21− , warp >= 3.2

22− , wai >= 3.2

23− , http-types >= 0.12

24− , markdown-unlit >= 0.4

25− , http-client >= 0.5

26− , transformers

27− , resourcet

28− default-language: Haskell2010

29− ghc-options: -Wall -pgmL markdown-unlit

30− build-tool-depends: markdown-unlit:markdown-unlit

doc/cookbook/open-id-connect/OpenIdConnect.lhs+1−1

@@ -330,7 +330,7 @@ data Customer = Customer {

330```

331

332Here is the code that displays the homepage.

333−It should contain a link to the `/login` URL.

333+It should contain a link to the the `/login` URL.

334When the user clicks on this link it will be redirected to Google login page

335with some generated information.

336

doc/cookbook/uverb/UVerb.lhs+1−1

@@ -199,7 +199,7 @@ parsers in the hope that the ones that should will always error out so

199you can try until the right one returns a value.)

200

201[servant-exceptions](https://github.com/ch1bo/servant-exceptions) is

202−another shot at the problem. It is inspired by

202+another shot at at the problem. It is inspired by

203servant-checked-exceptions, so it may be worth taking a closer look.

204The README claims that

205[cardano-sl](https://github.com/input-output-hk/cardano-sl) also has

doc/requirements.txt−1

@@ -1,4 +1,3 @@

1recommonmark==0.5.0

2Sphinx==1.8.4

3sphinx_rtd_theme>=0.4.2

4−jinja2<3.1.0

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

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

74 , transformers >= 0.4.2.0 && < 0.6

75 , wai >= 3.2.1.2 && < 3.3

76 , warp >= 3.2.25 && < 3.4

77− , jose >= 0.10 && < 0.11

77+ , jose >= 0.7.0.0 && < 0.10

78 other-modules:

79 Servant.Auth.ClientSpec

80 default-language: Haskell2010

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

@@ -41,11 +41,11 @@ library

41 , data-default-class >= 0.1.2.0 && < 0.2

42 , entropy >= 0.4.1.3 && < 0.5

43 , http-types >= 0.12.2 && < 0.13

44− , jose >= 0.10 && < 0.11

44+ , jose >= 0.7.0.0 && < 0.10

45 , lens >= 4.16.1 && < 5.3

46 , memory >= 0.14.16 && < 0.19

47 , monad-time >= 0.3.1.0 && < 0.4

48− , mtl ^>= 2.2.2 || ^>= 2.3.1

48+ , mtl >= 2.2.2 && < 2.3

49 , servant >= 0.13 && < 0.20

50 , servant-auth == 0.4.*

51 , servant-server >= 0.13 && < 0.20

@@ -129,7 +129,6 @@ test-suite spec

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

130 , warp >= 3.2.25 && < 3.4

131 , wreq >= 0.5.2.1 && < 0.6

132− , text >= 1.2.3.0 && < 2.1

133 other-modules:

132 other-modules:

134 Servant.Auth.ServerSpec

133 Servant.Auth.ServerSpec

135 default-language: Haskell2010

134 default-language: Haskell2010

servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal.hs+9−6

@@ -54,12 +54,15 @@ instance ( n ~ 'S ('S 'Z)

54

55 makeCookies :: AuthResult v -> IO (SetCookieList ('S ('S 'Z)))

56 makeCookies authResult = do

57+ xsrf <- makeXsrfCookie cookieSettings

58+ fmap (Just xsrf `SetCookieCons`) $

57− case authResult of

59+ case authResult of

58− (Authenticated v) -> do

60+ (Authenticated v) -> do

59− ejwt <- makeSessionCookie cookieSettings jwtSettings v

61+ ejwt <- makeSessionCookie cookieSettings jwtSettings v

60− xsrf <- makeXsrfCookie cookieSettings

62+ case ejwt of

63+ Nothing -> return $ Nothing `SetCookieCons` SetCookieNil

61− return $ Just xsrf `SetCookieCons` (ejwt `SetCookieCons` SetCookieNil)

64+ Just jwt -> return $ Just jwt `SetCookieCons` SetCookieNil

62− _ -> return $ Nothing `SetCookieCons` (Nothing `SetCookieCons` SetCookieNil)

65+ _ -> return $ Nothing `SetCookieCons` SetCookieNil

63

66

64 go :: (AuthResult v -> ServerT api Handler)

67 go :: (AuthResult v -> ServerT api Handler)

65 -> (AuthResult v, SetCookieList n)

68 -> (AuthResult v, SetCookieList n)

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

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

11import qualified Network.HTTP.Types as HTTP

12import Network.Wai (mapResponseHeaders)

13import Servant

14−import Servant.API.UVerb.Union

15import Servant.API.Generic

14import Servant.API.Generic

16import Servant.Server.Generic

15import Servant.Server.Generic

17import Web.Cookie

16import Web.Cookie

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

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

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

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

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

36

35

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−

43type family AddSetCookieApi a :: *

36type family AddSetCookieApi a :: *

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

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

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

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

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

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

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

48−#endif

49type instance AddSetCookieApi (Verb method stat ctyps a)

40type instance AddSetCookieApi (Verb method stat ctyps a)

50 = Verb method stat ctyps (AddSetCookieApiVerb a)

41 = 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

55type instance AddSetCookieApi Raw = Raw

42type instance AddSetCookieApi Raw = Raw

56#if MIN_VERSION_servant_server(0,15,0)

43#if MIN_VERSION_servant_server(0,15,0)

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

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

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

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

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

71 addSetCookies cookies oldfn = addSetCookies cookies . oldfn

58 addSetCookies cookies oldfn = addSetCookies cookies . oldfn

72

59

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

60+instance AddSetCookies 'Z orig orig where

74 addSetCookies _ = id

61 addSetCookies _ = id

75

62

76instance {-# OVERLAPPABLE #-}

63instance {-# OVERLAPPABLE #-}

servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/Cookie.hs−1

@@ -2,7 +2,6 @@

2module Servant.Auth.Server.Internal.Cookie where

3

4import Blaze.ByteString.Builder (toByteString)

5−import Control.Monad (MonadPlus(..), guard)

6import Control.Monad.Except

5import Control.Monad.Except

7import Control.Monad.Reader

6import Control.Monad.Reader

8import qualified Crypto.JOSE as Jose

7import qualified Crypto.JOSE as Jose

servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/JWT.hs+7−3

@@ -1,14 +1,18 @@

1module Servant.Auth.Server.Internal.JWT where

2

3import Control.Lens

4−import Control.Monad (MonadPlus(..), guard)

4+import Control.Monad.Except

5import Control.Monad.Reader

6import qualified Crypto.JOSE as Jose

7import qualified Crypto.JWT as Jose

8+import Data.Aeson (FromJSON, Result (..), ToJSON, fromJSON,

9+ toJSON)

8import Data.ByteArray (constEq)

10import Data.ByteArray (constEq)

9import qualified Data.ByteString as BS

11import qualified Data.ByteString as BS

10import qualified Data.ByteString.Lazy as BSL

12import qualified Data.ByteString.Lazy as BSL

13+import qualified Data.HashMap.Strict as HM

11import Data.Maybe (fromMaybe)

14import Data.Maybe (fromMaybe)

15+import qualified Data.Text as T

12import Data.Time (UTCTime)

16import Data.Time (UTCTime)

13import Network.Wai (requestHeaders)

17import Network.Wai (requestHeaders)

14

18

@@ -38,7 +42,7 @@ jwtAuthCheck jwtSettings = do

38-- token expires.

42-- token expires.

39makeJWT :: ToJWT a

43makeJWT :: ToJWT a

40 => a -> JWTSettings -> Maybe UTCTime -> IO (Either Jose.Error BSL.ByteString)

44 => a -> JWTSettings -> Maybe UTCTime -> IO (Either Jose.Error BSL.ByteString)

41−makeJWT v cfg expiry = Jose.runJOSE $ do

45+makeJWT v cfg expiry = runExceptT $ do

42 bestAlg <- Jose.bestJWSAlg $ signingKey cfg

46 bestAlg <- Jose.bestJWSAlg $ signingKey cfg

43 let alg = fromMaybe bestAlg $ jwtAlg cfg

47 let alg = fromMaybe bestAlg $ jwtAlg cfg

44 ejwt <- Jose.signClaims (signingKey cfg)

48 ejwt <- Jose.signClaims (signingKey cfg)

@@ -55,7 +59,7 @@ makeJWT v cfg expiry = Jose.runJOSE $ do

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

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

56verifyJWT jwtCfg input = do

60verifyJWT jwtCfg input = do

57 keys <- validationKeys jwtCfg

61 keys <- validationKeys jwtCfg

58− verifiedJWT <- Jose.runJOSE $ do

62+ verifiedJWT <- runExceptT $ do

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

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

60 Jose.verifyClaims

64 Jose.verifyClaims

61 (jwtSettingsToJwtValidationSettings jwtCfg)

65 (jwtSettingsToJwtValidationSettings jwtCfg)

servant-auth/servant-auth-server/src/Servant/Auth/Server/Internal/Types.hs−1

@@ -2,7 +2,6 @@

2module Servant.Auth.Server.Internal.Types where

3

4import Control.Applicative

5−import Control.Monad (MonadPlus(..), ap)

6import Control.Monad.Reader

5import Control.Monad.Reader

7import Control.Monad.Time

6import Control.Monad.Time

8import Data.Monoid (Monoid (..))

7import Data.Monoid (Monoid (..))

servant-auth/servant-auth-server/test/Servant/Auth/ServerSpec.hs+6−33

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

1{-# LANGUAGE CPP #-}

2−{-# LANGUAGE TypeApplications #-}

3module Servant.Auth.ServerSpec (spec) where

2module Servant.Auth.ServerSpec (spec) where

4

3

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

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

@@ -7,12 +6,13 @@ module Servant.Auth.ServerSpec (spec) where

7#endif

6#endif

8

7

9import Control.Lens

8import Control.Lens

9+import Control.Monad.Except (runExceptT)

10import Control.Monad.IO.Class (liftIO)

11import Crypto.JOSE (Alg (HS256, None), Error,

12 JWK, JWSHeader,

13 KeyMaterialGenParam (OctGenParam),

14 ToCompact, encodeCompact,

15− genJWK, newJWSHeader, runJOSE)

15+ genJWK, newJWSHeader)

16import Crypto.JWT (Audience (..), ClaimsSet,

17 NumericDate (NumericDate),

18 SignedJWT,

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

25import Data.Aeson.Lens (_JSON)

26import qualified Data.ByteString as BS

27import qualified Data.ByteString.Lazy as BSL

28−import Data.Text (Text, pack)

29import Data.CaseInsensitive (mk)

28import Data.CaseInsensitive (mk)

30import Data.Foldable (find)

29import Data.Foldable (find)

31import Data.Monoid

30import Data.Monoid

@@ -41,7 +40,6 @@ import Network.HTTP.Types (Status, status200,

41import Network.Wai (responseLBS)

40import Network.Wai (responseLBS)

42import Network.Wai.Handler.Warp (testWithApplication)

41import Network.Wai.Handler.Warp (testWithApplication)

43import Network.Wreq (Options, auth, basicAuth,

42import Network.Wreq (Options, auth, basicAuth,

44− checkResponse,

45 cookieExpiryTime, cookies,

43 cookieExpiryTime, cookies,

46 defaults, get, getWith, postWith,

44 defaults, get, getWith, postWith,

47 header, oauth2Bearer,

45 header, oauth2Bearer,

@@ -185,21 +183,8 @@ cookieAuthSpec

185 it "fails with no XSRF header or cookie" $ \port -> property

183 it "fails with no XSRF header or cookie" $ \port -> property

186 $ \(user :: User) -> do

184 $ \(user :: User) -> do

187 jwt <- createJWT theKey (newJWSHeader ((), HS256)) (claims $ toJSON user)

185 jwt <- createJWT theKey (newJWSHeader ((), HS256)) (claims $ toJSON user)

188− opts' <- addJwtToCookie cookieCfg jwt

186+ opts <- addJwtToCookie cookieCfg jwt

189− let opts = opts' & checkResponse .~ Just mempty

190− resp <- getWith opts (url port)

187+ getWith opts (url port) `shouldHTTPErrorWith` status401

191− resp ^. responseStatus `shouldBe` status401

192− (resp ^. responseCookieJar) `shouldNotHaveCookies` ["XSRF-TOKEN"]

193−

194− -- Validating that the XSRF cookie isn't added for UVerb routes either.

195− -- These routes can return a 401 response directly without using throwError / throwAll,

196− -- which revealed a bug:

197− --

198− -- https://github.com/haskell-servant/servant/issues/1570#issuecomment-1076374449

199− resp <- getWith opts (url port ++ "/uverb")

200− resp ^. responseStatus `shouldBe` status401

201− (resp ^. responseCookieJar) `shouldNotHaveCookies` ["XSRF-TOKEN"]

202−

203

188

204 it "succeeds if XSRF header and cookie match, and JWT is valid" $ \port -> property

189 it "succeeds if XSRF header and cookie match, and JWT is valid" $ \port -> property

205 $ \(user :: User) -> do

190 $ \(user :: User) -> do

@@ -421,14 +406,13 @@ type API auths

421 = Auth auths User :>

406 = Auth auths User :>

422 ( Get '[JSON] Int

407 ( Get '[JSON] Int

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

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

424− :<|> "named" :> NamedRoutes DummyRoutes

409+ :<|> NamedRoutes DummyRoutes

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

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

426#if MIN_VERSION_servant_server(0,15,0)

411#if MIN_VERSION_servant_server(0,15,0)

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

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

428#endif

413#endif

429 :<|> "raw" :> Raw

414 :<|> "raw" :> Raw

430 )

415 )

431− :<|> "uverb" :> Auth auths User :> UVerb 'GET '[JSON] '[WithStatus 200 Int, WithStatus 401 Text, WithStatus 403 Text]

432 :<|> "login" :> ReqBody '[JSON] User :> Post '[JSON] (Headers '[ Header "Set-Cookie" SetCookie

416 :<|> "login" :> ReqBody '[JSON] User :> Post '[JSON] (Headers '[ Header "Set-Cookie" SetCookie

433 , Header "Set-Cookie" SetCookie ] NoContent)

417 , Header "Set-Cookie" SetCookie ] NoContent)

434 :<|> "logout" :> Get '[JSON] (Headers '[ Header "Set-Cookie" SetCookie

418 :<|> "logout" :> Get '[JSON] (Headers '[ Header "Set-Cookie" SetCookie

@@ -506,11 +490,6 @@ server ccfg =

506 :<|> raw

490 :<|> raw

507 Indefinite -> throwAll err401

491 Indefinite -> throwAll err401

508 _ -> throwAll err403

492 _ -> throwAll err403

509− ) :<|>

510− (\authResult -> case authResult of

511− Authenticated usr -> respond (WithStatus @200 (42 :: Int))

512− Indefinite -> respond (WithStatus @401 $ pack "Authentication required")

513− _ -> respond (WithStatus @403 $ pack "Forbidden")

514 )

493 )

515 :<|> getLogin

494 :<|> getLogin

516 :<|> getLogout

495 :<|> getLogout

@@ -561,7 +540,7 @@ addJwtToHeader jwt = case jwt of

561 $ defaults & header "Authorization" .~ ["Bearer " <> BSL.toStrict v]

540 $ defaults & header "Authorization" .~ ["Bearer " <> BSL.toStrict v]

562

541

563createJWT :: JWK -> JWSHeader () -> ClaimsSet -> IO (Either Error Crypto.JWT.SignedJWT)

542createJWT :: JWK -> JWSHeader () -> ClaimsSet -> IO (Either Error Crypto.JWT.SignedJWT)

564−createJWT k a b = runJOSE $ signClaims k a b

543+createJWT k a b = runExceptT $ signClaims k a b

565

544

566addJwtToCookie :: ToCompact a => CookieSettings -> Either Error a -> IO Options

545addJwtToCookie :: ToCompact a => CookieSettings -> Either Error a -> IO Options

567addJwtToCookie ccfg jwt = case jwt >>= (return . encodeCompact) of

546addJwtToCookie ccfg jwt = case jwt >>= (return . encodeCompact) of

@@ -591,12 +570,6 @@ shouldMatchCookieNames cj patterns

591 = fmap cookie_name (destroyCookieJar cj)

570 = fmap cookie_name (destroyCookieJar cj)

592 `shouldMatchList` patterns

571 `shouldMatchList` patterns

593

572

594−shouldNotHaveCookies :: HCli.CookieJar -> [BS.ByteString] -> Expectation

595−shouldNotHaveCookies cj patterns =

596− sequence_ $ (\cookieName -> cookieNames `shouldNotContain` [cookieName]) <$> patterns

597− where cookieNames :: [BS.ByteString]

598− cookieNames = cookie_name <$> destroyCookieJar cj

599−

600shouldMatchCookieNameValues :: HCli.CookieJar -> [(BS.ByteString, BS.ByteString)] -> Expectation

573shouldMatchCookieNameValues :: HCli.CookieJar -> [(BS.ByteString, BS.ByteString)] -> Expectation

601shouldMatchCookieNameValues cj patterns

574shouldMatchCookieNameValues cj patterns

602 = fmap ((,) <$> cookie_name <*> cookie_value) (destroyCookieJar cj)

575 = fmap ((,) <$> cookie_name <*> cookie_value) (destroyCookieJar cj)

servant-auth/servant-auth/servant-auth.cabal+1−1

@@ -36,7 +36,7 @@ library

36 base >= 4.10 && < 4.18

37 , containers >= 0.6 && < 0.7

38 , aeson >= 1.3.1.1 && < 3

39− , jose >= 0.10 && < 0.11

39+ , jose >= 0.7.0.0 && < 0.10

40 , lens >= 4.16.1 && < 5.3

41 , servant >= 0.15 && < 0.20

42 , text >= 1.2.3.0 && < 2.1

servant-auth/servant-auth/src/Servant/Auth.hs+1−1

@@ -27,7 +27,7 @@ instance HasLink sub => HasLink (Auth (tag :: [*]) value :> sub) where

27

28-- ** Combinators

29

30−-- | A JSON Web Token (JWT) in the Authorization header:

30+-- | A JSON Web Token (JWT) in the the Authorization header:

31--

32-- @Authorization: Bearer \<token\>@

33--

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

@@ -56,7 +56,7 @@ library

56 , containers >= 0.5.7.1 && < 0.7

57 , deepseq >= 1.4.2.0 && < 1.5

58 , text >= 1.2.3.0 && < 2.1

59− , transformers >= 0.5.2.0 && < 0.7

59+ , transformers >= 0.5.2.0 && < 0.6

60 , template-haskell >= 2.11.1.0 && < 2.20

61

62 if !impl(ghc >= 8.2)

servant-client-core/src/Servant/Client/Core/HasClient.hs+5−23

@@ -74,10 +74,10 @@ import Servant.API

74 FromSourceIO (..), Header', Headers (..), HttpVersion,

75 IsSecure, MimeRender (mimeRender),

76 MimeUnrender (mimeUnrender), NoContent (NoContent),

77− NoContentVerb, QueryFlag, QueryParam', QueryParams, Raw, RawM,

77+ NoContentVerb, QueryFlag, QueryParam', QueryParams, Raw,

78 ReflectMethod (..), RemoteHost, ReqBody', SBoolI, Stream,

79 StreamBody', Summary, ToHttpApiData, ToSourceIO (..), Vault,

80− Verb, WithNamedContext, WithResource, WithStatus (..), contentType, getHeadersHList,

80+ Verb, WithNamedContext, WithStatus (..), contentType, getHeadersHList,

81 getResponse, toEncodedUrlPiece, toUrlPiece, NamedRoutes)

82import Servant.API.Generic

83 (GenericMode(..), ToServant, ToServantApi

@@ -674,16 +674,6 @@ instance RunClient m => HasClient m Raw where

674

675 hoistClientMonad _ _ f cl = \meth -> f (cl meth)

676

677−instance RunClient m => HasClient m RawM where

678− type Client m RawM

679− = H.Method -> m Response

680−

681− clientWithRoute :: Proxy m -> Proxy RawM -> Request -> Client m RawM

682− clientWithRoute _pm Proxy req httpMethod = do

683− runRequest req { requestMethod = httpMethod }

684−

685− hoistClientMonad _ _ f cl = \meth -> f (cl meth)

686−

687-- | If you use a 'ReqBody' in one of your endpoints in your API,

677-- | If you use a 'ReqBody' in one of your endpoints in your API,

688-- the corresponding querying function will automatically take

678-- the corresponding querying function will automatically take

689-- an additional argument of the type specified by your 'ReqBody'.

679-- an additional argument of the type specified by your 'ReqBody'.

@@ -786,14 +776,6 @@ instance HasClient m subapi =>

786

776

787 hoistClientMonad pm _ f cl = hoistClientMonad pm (Proxy :: Proxy subapi) f cl

777 hoistClientMonad pm _ f cl = hoistClientMonad pm (Proxy :: Proxy subapi) f cl

788

778

789−instance HasClient m subapi =>

790− HasClient m (WithResource res :> subapi) where

791−

792− type Client m (WithResource res :> subapi) = Client m subapi

793− clientWithRoute pm Proxy = clientWithRoute pm (Proxy :: Proxy subapi)

794−

795− hoistClientMonad pm _ f cl = hoistClientMonad pm (Proxy :: Proxy subapi) f cl

796−

797instance ( HasClient m api

779instance ( HasClient m api

798 ) => HasClient m (AuthProtect tag :> api) where

780 ) => HasClient m (AuthProtect tag :> api) where

799 type Client m (AuthProtect tag :> api)

781 type Client m (AuthProtect tag :> api)

@@ -912,7 +894,7 @@ infixl 2 /:

912-- rootClient = client api

894-- rootClient = client api

913--

895--

914-- endpointClient :: ClientM Person

896-- endpointClient :: ClientM Person

915−-- endpointClient = client \/\/ subApi \/\/ endpoint

897+-- endpointClient = client // subApi // endpoint

916-- @

898-- @

917(//) :: a -> (a -> b) -> b

899(//) :: a -> (a -> b) -> b

918x // f = f x

900x // f = f x

@@ -945,10 +927,10 @@ x // f = f x

945-- rootClient = client api

927-- rootClient = client api

946--

928--

947-- hello :: String -> ClientM String

929-- hello :: String -> ClientM String

948−-- hello name = rootClient \/\/ hello \/: name

930+-- hello name = rootClient // hello /: name

949--

931--

950-- endpointClient :: ClientM Person

932-- endpointClient :: ClientM Person

951−-- endpointClient = client \/\/ subApi \/: "foobar123" \/\/ endpoint

933+-- endpointClient = client // subApi /: "foobar123" // endpoint

952-- @

934-- @

953(/:) :: (a -> b -> c) -> b -> a -> c

935(/:) :: (a -> b -> c) -> b -> a -> c

954(/:) = flip

936(/:) = flip

servant-client-ghcjs/servant-client-ghcjs.cabal+1−1

@@ -48,7 +48,7 @@ library

48 , http-media >=0.6.2 && <0.9

49 , http-types >=0.12 && <0.13

50 , monad-control >=1.0.0.4 && <1.1

51− , mtl ^>=2.2.2 || ^>=2.3.1

51+ , mtl >=2.2.2 && <2.3

52 , semigroupoids >=5.3 && <5.4

53 , string-conversions >=0.3 && <0.5

54 , transformers >=0.3 && <0.6

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

@@ -45,11 +45,11 @@ library

45 , bytestring >= 0.10.8.1 && < 0.12

46 , containers >= 0.5.7.1 && < 0.7

47 , deepseq >= 1.4.2.0 && < 1.5

48− , mtl ^>= 2.2.2 || ^>= 2.3.1

48+ , mtl >= 2.2.2 && < 2.3

49 , stm >= 2.4.5.1 && < 2.6

50 , text >= 1.2.3.0 && < 2.1

51 , time >= 1.6.0.1 && < 1.13

52− , transformers >= 0.5.2.0 && < 0.7

52+ , transformers >= 0.5.2.0 && < 0.6

53

54 if !impl(ghc >= 8.2)

55 build-depends:

servant-client/src/Servant/Client/Internal/HttpClient/Streaming.hs+5−17

@@ -24,8 +24,7 @@ import Control.DeepSeq

24 (NFData, force)

25import Control.Exception

26 (evaluate, throwIO)

27−import Control.Monad

27+import Control.Monad ()

28− (unless)

29import Control.Monad.Base

28import Control.Monad.Base

30 (MonadBase (..))

29 (MonadBase (..))

31import Control.Monad.Codensity

30import Control.Monad.Codensity

@@ -175,21 +174,10 @@ performRequest acceptStatus req = do

175-- | TODO: support UVerb ('acceptStatus' argument, like in 'performRequest' above).

174-- | TODO: support UVerb ('acceptStatus' argument, like in 'performRequest' above).

176performWithStreamingRequest :: Request -> (StreamingResponse -> IO a) -> ClientM a

175performWithStreamingRequest :: Request -> (StreamingResponse -> IO a) -> ClientM a

177performWithStreamingRequest req k = do

176performWithStreamingRequest req k = do

178− ClientEnv m burl cookieJar' createClientRequest <- ask

177+ m <- asks manager

179− clientRequest <- liftIO $ createClientRequest burl req

178+ burl <- asks baseUrl

180− request <- case cookieJar' of

179+ createClientRequest <- asks makeClientRequest

181− Nothing -> pure clientRequest

180+ request <- liftIO $ createClientRequest burl req

182− Just cj -> liftIO $ do

183− now <- getCurrentTime

184− atomically $ do

185− oldCookieJar <- readTVar cj

186− let (newRequest, newCookieJar) =

187− Client.insertCookiesIntoRequest

188− clientRequest

189− oldCookieJar

190− now

191− writeTVar cj newCookieJar

192− pure newRequest

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

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

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

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

195 let status = Client.responseStatus res

183 let status = Client.responseStatus res

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

@@ -31,8 +31,8 @@ library

31 base >=4.9 && <5

32 , bytestring >=0.10.8.1 && <0.12

33 , conduit >=1.3.1 && <1.4

34− , mtl ^>=2.2.2 || ^>=2.3.1

34+ , mtl >=2.2.2 && <2.3

35− , resourcet >=1.2.2 && <1.4

35+ , resourcet >=1.2.2 && <1.3

36 , servant >=0.15 && <0.20

37 , unliftio-core >=0.1.2.0 && <0.3

38 hs-source-dirs: src

servant-docs/golden/comprehensive.md−18

@@ -530,24 +530,6 @@

530

531```

532

533−## GET /resource

534−

535−### Response:

536−

537−- Status code 200

538−- Headers: []

539−

540−- Supported content types are:

541−

542− - `application/json;charset=utf-8`

543− - `application/json`

544−

545−- Example (`application/json;charset=utf-8`, `application/json`):

546−

547−```javascript

548−

549−```

550−

551## GET /streaming

533## GET /streaming

552

534

553### Request:

535### Request:

servant-docs/src/Servant/Docs/Internal.hs+1−4

@@ -447,7 +447,7 @@ docsWith opts intros (ExtraInfo endpoints) p =

447 & apiEndpoints %~ HM.unionWith (flip combineAction) endpoints

448

449

450−-- | Generate the docs for a given API that implements 'HasDocs' with any

450+-- | Generate the docs for a given API that implements 'HasDocs' with with any

451-- number of introduction(s)

452docsWithIntros :: HasDocs api => [DocIntro] -> Proxy api -> API

453docsWithIntros intros = docsWith defaultDocOptions intros mempty

@@ -1144,9 +1144,6 @@ instance HasDocs api => HasDocs (Vault :> api) where

1144instance HasDocs api => HasDocs (WithNamedContext name context api) where

1145 docsFor Proxy = docsFor (Proxy :: Proxy api)

1146

1147−instance HasDocs api => HasDocs (WithResource res :> api) where

1148− docsFor Proxy = docsFor (Proxy :: Proxy api)

1149−

1150instance (ToAuthInfo (BasicAuth realm usr), HasDocs api) => HasDocs (BasicAuth realm usr :> api) where

1147instance (ToAuthInfo (BasicAuth realm usr), HasDocs api) => HasDocs (BasicAuth realm usr :> api) where

1151 docsFor Proxy (endpoint, action) =

1148 docsFor Proxy (endpoint, action) =

1152 docsFor (Proxy :: Proxy api) (endpoint, action')

1149 docsFor (Proxy :: Proxy api) (endpoint, action')

servant-foreign/src/Servant/Foreign/Internal.hs−7

@@ -487,13 +487,6 @@ instance HasForeign lang ftype api =>

487

488 foreignFor lang ftype Proxy = foreignFor lang ftype (Proxy :: Proxy api)

489

490−instance HasForeign lang ftype api =>

491− HasForeign lang ftype (WithResource res :> api) where

492−

493− type Foreign ftype (WithResource res :> api) = Foreign ftype api

494−

495− foreignFor lang ftype Proxy = foreignFor lang ftype (Proxy :: Proxy api)

496−

497instance HasForeign lang ftype api

490instance HasForeign lang ftype api

498 => HasForeign lang ftype (HttpVersion :> api) where

491 => HasForeign lang ftype (HttpVersion :> api) where

499 type Foreign ftype (HttpVersion :> api) = Foreign ftype api

492 type Foreign ftype (HttpVersion :> api) = Foreign ftype api

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

@@ -42,10 +42,10 @@ library

42 , bytestring >= 0.10.8.1 && < 0.12

43 , containers >= 0.5.7.1 && < 0.7

44 , deepseq >= 1.4.2.0 && < 1.5

45− , mtl ^>= 2.2.2 || ^>= 2.3.1

45+ , mtl >= 2.2.2 && < 2.3

46 , text >= 1.2.3.0 && < 2.1

47 , time >= 1.6.0.1 && < 1.13

48− , transformers >= 0.5.2.0 && < 0.7

48+ , transformers >= 0.5.2.0 && < 0.6

49

50 if !impl(ghc >= 8.2)

51 build-depends:

servant-machines/servant-machines.cabal+1−1

@@ -31,7 +31,7 @@ library

31 base >=4.9 && <5

32 , bytestring >=0.10.8.1 && <0.12

33 , machines >=0.6.4 && <0.8

34− , mtl ^>=2.2.2 || ^>=2.3.1

34+ , mtl >=2.2.2 && <2.3

35 , servant >=0.15 && <0.20

36 hs-source-dirs: src

37 default-language: Haskell2010

servant-pipes/servant-pipes.cabal+1−1

@@ -32,7 +32,7 @@ library

32 , bytestring >=0.10.8.1 && <0.12

33 , pipes >=4.3.9 && <4.4

34 , pipes-safe >=2.3.1 && <2.4

35− , mtl ^>=2.2.2 || ^>=2.3.1

35+ , mtl >=2.2.2 && <2.3

36 , monad-control >=1.0.2.3 && <1.1

37 , servant >=0.15 && <0.20

38 hs-source-dirs: src

servant-server/CHANGELOG.md−6

@@ -3,17 +3,11 @@

3

4Package 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.2

7−------

8−

9−Compatibility with GHC 9.4, see [PR #1592](https://github.com/haskell-servant/servant/pull/1592).

10−

110.19.1

60.19.1

12------

7------

13

8

14- Add `MonadFail` instance for `Handler` wrt [#1545](https://github.com/haskell-servant/servant/issues/1545)

9- Add `MonadFail` instance for `Handler` wrt [#1545](https://github.com/haskell-servant/servant/issues/1545)

15- Support GHC 9.2 [#1525](https://github.com/haskell-servant/servant/issues/1525)

10- Support GHC 9.2 [#1525](https://github.com/haskell-servant/servant/issues/1525)

16−- Add capture hints in `Router` type for debug and display purposes [PR #1556] (https://github.com/haskell-servant/servant/pull/1556)

17

11

180.19

120.19

19----

13----

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

@@ -1,6 +1,6 @@

1cabal-version: 2.2

2name: servant-server

3−version: 0.19.2

3+version: 0.19.1

4

5synopsis: A family of combinators for defining webservices APIs and serving them

6category: Servant, Web

@@ -23,7 +23,7 @@ author: Servant Contributors

23maintainer: haskell-servant-maintainers@googlegroups.com

24copyright: 2014-2016 Zalora South East Asia Pte Ltd, 2016-2019 Servant Contributors

25build-type: Simple

26−tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.7 || ==9.0.2 || ==9.2.4 || ==9.4.3

26+tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2 || ==9.0.1

27

28extra-source-files:

29 CHANGELOG.md

@@ -64,9 +64,9 @@ library

64 , bytestring >= 0.10.8.1 && < 0.12

65 , constraints >= 0.2 && < 0.14

66 , containers >= 0.5.7.1 && < 0.7

67− , mtl ^>= 2.2.2 || ^>= 2.3.1

67+ , mtl >= 2.2.2 && < 2.3

68 , text >= 1.2.3.0 && < 2.1

69− , transformers >= 0.5.2.0 && < 0.7

69+ , transformers >= 0.5.2.0 && < 0.6

70 , filepath >= 1.4.1.1 && < 1.5

71

72 -- Servant dependencies

@@ -88,10 +88,10 @@ library

88 , network >= 2.8 && < 3.2

89 , sop-core >= 0.4.0.0 && < 0.6

90 , string-conversions >= 0.4.0.1 && < 0.5

91− , resourcet >= 1.2.2 && < 1.4

91+ , resourcet >= 1.2.2 && < 1.3

92 , tagged >= 0.8.6 && < 0.9

93 , transformers-base >= 0.4.5.2 && < 0.5

94− , wai >= 3.2.2.1 && < 3.3

94+ , wai >= 3.2.1.2 && < 3.3

95 , wai-app-static >= 3.1.6.2 && < 3.2

96 , word8 >= 0.1.3 && < 0.2

97

servant-server/src/Servant/Server/Experimental/Auth.hs+1−2

@@ -1,6 +1,5 @@

1{-# OPTIONS_GHC -fno-warn-orphans #-}

2{-# LANGUAGE DeriveDataTypeable #-}

3−{-# LANGUAGE DeriveFunctor #-}

4{-# LANGUAGE DeriveGeneric #-}

3{-# LANGUAGE DeriveGeneric #-}

5{-# LANGUAGE FlexibleContexts #-}

4{-# LANGUAGE FlexibleContexts #-}

6{-# LANGUAGE FlexibleInstances #-}

5{-# LANGUAGE FlexibleInstances #-}

@@ -45,7 +44,7 @@ type family AuthServerData a :: *

45-- NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE

44-- NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE

46newtype AuthHandler r usr = AuthHandler

45newtype AuthHandler r usr = AuthHandler

47 { unAuthHandler :: r -> Handler usr }

46 { unAuthHandler :: r -> Handler usr }

48− deriving (Functor, Generic, Typeable)

47+ deriving (Generic, Typeable)

49

48

50-- | NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE

49-- | NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE

51mkAuthHandler :: (r -> Handler usr) -> AuthHandler r usr

50mkAuthHandler :: (r -> Handler usr) -> AuthHandler r usr

servant-server/src/Servant/Server/Internal.hs+5−76

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

6{-# LANGUAGE FlexibleContexts #-}

7{-# LANGUAGE FlexibleInstances #-}

8{-# LANGUAGE InstanceSigs #-}

9−{-# LANGUAGE LambdaCase #-}

10{-# LANGUAGE MultiParamTypeClasses #-}

9{-# LANGUAGE MultiParamTypeClasses #-}

11{-# LANGUAGE OverloadedStrings #-}

10{-# LANGUAGE OverloadedStrings #-}

12{-# LANGUAGE PolyKinds #-}

11{-# LANGUAGE PolyKinds #-}

@@ -36,10 +35,9 @@ module Servant.Server.Internal

36import Control.Monad

35import Control.Monad

37 (join, when)

36 (join, when)

38import Control.Monad.Trans

37import Control.Monad.Trans

39− (liftIO, lift)

38+ (liftIO)

40import Control.Monad.Trans.Resource

39import Control.Monad.Trans.Resource

41− (runResourceT, ReleaseKey)

40+ (runResourceT)

42−import Data.Acquire

43import qualified Data.ByteString as B

41import qualified Data.ByteString as B

44import qualified Data.ByteString.Builder as BB

42import qualified Data.ByteString.Builder as BB

45import qualified Data.ByteString.Char8 as BC8

43import qualified Data.ByteString.Char8 as BC8

@@ -66,7 +64,7 @@ import Network.HTTP.Types hiding

66import Network.Socket

64import Network.Socket

67 (SockAddr)

65 (SockAddr)

68import Network.Wai

66import Network.Wai

69− (Application, Request, Response, ResponseReceived, httpVersion, isSecure, lazyRequestBody,

67+ (Application, Request, httpVersion, isSecure, lazyRequestBody,

70 queryString, remoteHost, getRequestBodyChunk, requestHeaders,

68 queryString, remoteHost, getRequestBodyChunk, requestHeaders,

71 requestMethod, responseLBS, responseStream, vault)

69 requestMethod, responseLBS, responseStream, vault)

72import Prelude ()

70import Prelude ()

@@ -76,10 +74,10 @@ import Servant.API

76 CaptureAll, Description, EmptyAPI, Fragment,

74 CaptureAll, Description, EmptyAPI, Fragment,

77 FramingRender (..), FramingUnrender (..), FromSourceIO (..),

75 FramingRender (..), FramingUnrender (..), FromSourceIO (..),

78 Header', If, IsSecure (..), NoContentVerb, QueryFlag,

76 Header', If, IsSecure (..), NoContentVerb, QueryFlag,

79− QueryParam', QueryParams, Raw, RawM, ReflectMethod (reflectMethod),

77+ QueryParam', QueryParams, Raw, ReflectMethod (reflectMethod),

80 RemoteHost, ReqBody', SBool (..), SBoolI (..), SourceIO,

78 RemoteHost, ReqBody', SBool (..), SBoolI (..), SourceIO,

81 Stream, StreamBody', Summary, ToSourceIO (..), Vault, Verb,

79 Stream, StreamBody', Summary, ToSourceIO (..), Vault, Verb,

82− WithNamedContext, WithResource, NamedRoutes)

80+ WithNamedContext, NamedRoutes)

83import Servant.API.Generic (GenericMode(..), ToServant, ToServantApi, GServantProduct, toServant, fromServant)

81import Servant.API.Generic (GenericMode(..), ToServant, ToServantApi, GServantProduct, toServant, fromServant)

84import Servant.API.ContentTypes

82import Servant.API.ContentTypes

85 (AcceptHeader (..), AllCTRender (..), AllCTUnrender (..),

83 (AcceptHeader (..), AllCTRender (..), AllCTUnrender (..),

@@ -117,10 +115,6 @@ import Servant.API.TypeLevel

117 (AtLeastOneFragment, FragmentUnique)

115 (AtLeastOneFragment, FragmentUnique)

118

116

119class HasServer api context where

117class HasServer api context where

120− -- | The type of a server for this API, given a monad to run effects in.

121− --

122− -- Note that the result kind is @*@, so it is /not/ a monad transformer, unlike

123− -- what the @T@ in the name might suggest.

124 type ServerT api (m :: * -> *) :: *

118 type ServerT api (m :: * -> *) :: *

125

119

126 route ::

120 route ::

@@ -250,42 +244,6 @@ instance (KnownSymbol capture, FromHttpApiData a, Typeable a

250 formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)

244 formatError = urlParseErrorFormatter $ getContextEntry (mkContextWithErrorFormatter context)

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

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

252

246

253−-- | If you use 'WithResource' in one of the endpoints for your API Servant

254−-- will provide the handler for this endpoint an argument of the specified type.

255−-- The lifespan of this resource will be automatically managed by Servant. This

256−-- resource will be created before the handler starts and it will be destoyed

257−-- after it ends. A new resource is created for each request to the endpoint.

258−

259−-- The creation and destruction are done using a 'Data.Acquire.Acquire'

260−-- provided via server 'Context'.

261−--

262−-- Example

263−--

264−-- > type MyApi = WithResource Handle :> "writeToFile" :> Post '[JSON] NoContent

265−-- >

266−-- > server :: Server MyApi

267−-- > server = writeToFile

268−-- > where writeToFile :: (ReleaseKey, Handle) -> Handler NoContent

269−-- > writeToFile (_, h) = hPutStrLn h "message"

270−--

271−-- In addition to the resource, the handler will also receive a 'ReleaseKey'

272−-- which can be used to deallocate the resource before the end of the request

273−-- if desired.

274−

275−instance (HasServer api ctx, HasContextEntry ctx (Acquire a))

276− => HasServer (WithResource a :> api) ctx where

277−

278− type ServerT (WithResource a :> api) m = (ReleaseKey, a) -> ServerT api m

279−

280− hoistServerWithContext _ pc nt s = hoistServerWithContext (Proxy @api) pc nt . s

281−

282− route Proxy context d = route (Proxy @api) context (d `addParameterCheck` allocateResource)

283− where

284− allocateResource :: DelayedIO (ReleaseKey, a)

285− allocateResource = DelayedIO $ lift $ allocateAcquire (getContextEntry context)

286−

287−

288−

289allowedMethodHead :: Method -> Request -> Bool

247allowedMethodHead :: Method -> Request -> Bool

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

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

291

249

@@ -653,35 +611,6 @@ instance HasServer Raw context where

653 Fail a -> respond $ Fail a

611 Fail a -> respond $ Fail a

654 FailFatal e -> respond $ FailFatal e

612 FailFatal e -> respond $ FailFatal e

655

613

656−-- | Just pass the request to the underlying application and serve its response.

657−--

658−-- Example:

659−--

660−-- > type MyApi = "images" :> Raw

661−-- >

662−-- > server :: Server MyApi

663−-- > server = serveDirectory "/var/www/images"

664−instance HasServer RawM context where

665− type ServerT RawM m = Request -> (Response -> IO ResponseReceived) -> m ResponseReceived

666−

667− route

668− :: Proxy RawM

669− -> Context context

670− -> Delayed env (Request -> (Response -> IO ResponseReceived) -> Handler ResponseReceived) -> Router env

671− route _ _ handleDelayed = RawRouter $ \env request respond -> runResourceT $ do

672− routeResult <- runDelayed handleDelayed env request

673− let respond' = liftIO . respond

674− liftIO $ case routeResult of

675− Route handler -> runHandler (handler request (respond . Route)) >>=

676− \case

677− Left e -> respond' $ FailFatal e

678− Right a -> pure a

679− Fail e -> respond' $ Fail e

680− FailFatal e -> respond' $ FailFatal e

681−

682− hoistServerWithContext _ _ f srvM = \req respond -> f (srvM req respond)

683−

684−

685-- | If you use 'ReqBody' in one of the endpoints for your API,

614-- | If you use 'ReqBody' in one of the endpoints for your API,

686-- this automatically requires your server-side handler to be a function

615-- this automatically requires your server-side handler to be a function

687-- that takes an argument of the type specified by 'ReqBody'.

616-- that takes an argument of the type specified by 'ReqBody'.

servant-server/src/Servant/Server/Internal/Router.hs+1−19

@@ -28,12 +28,9 @@ import Servant.Server.Internal.ServerError

28

29type Router env = Router' env RoutingApplication

30

31−-- | Holds information about pieces of url that are captured as variables.

32data CaptureHint = CaptureHint

31data CaptureHint = CaptureHint

33 { captureName :: Text

32 { captureName :: Text

34− -- ^ Holds the name of the captured variable

35 , captureType :: TypeRep

33 , captureType :: TypeRep

36− -- ^ Holds the type of the captured variable

37 }

34 }

38 deriving (Show, Eq)

35 deriving (Show, Eq)

39

36

@@ -57,21 +54,10 @@ data Router' env a =

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

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

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

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

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

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

60− -- environment and removed afterwards.

57+ -- environment and removed afterwards

61− -- The first argument is a list of hints for all variables that can be

62− -- captured by the router. The fact that it is a list is counter-intuitive,

63− -- because the 'Capture' combinator only allows to capture a single varible,

64− -- with a single name and a single type. However, the 'choice' smart

65− -- constructor may merge two 'Capture' combinators with different hints, thus

66− -- forcing the type to be '[CaptureHint]'.

67− -- Because 'CaptureRouter' is built from a 'Capture' combinator, the list of

68− -- hints should always be non-empty.

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

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

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

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

71 -- environment and are removed afterwards

60 -- environment and are removed afterwards

72− -- The first argument is a hint for the list of variables that can be

73− -- captured by the router. Note that the 'captureType' field of the hint

74− -- should always be '[a]' for some 'a'.

75 | RawRouter (env -> a)

61 | RawRouter (env -> a)

76 -- ^ to be used for routes we do not know anything about

62 -- ^ to be used for routes we do not know anything about

77 | Choice (Router' env a) (Router' env a)

63 | Choice (Router' env a) (Router' env a)

@@ -115,10 +101,6 @@ choice router1 router2 = Choice router1 router2

115data RouterStructure =

101data RouterStructure =

116 StaticRouterStructure (Map Text RouterStructure) Int

102 StaticRouterStructure (Map Text RouterStructure) Int

117 | CaptureRouterStructure [CaptureHint] RouterStructure

103 | CaptureRouterStructure [CaptureHint] RouterStructure

118− -- ^ The first argument holds information about variables

119− -- that are captured by the router. There may be several hints

120− -- if several routers have been aggregated by the 'choice'

121− -- smart constructor.

122 | RawRouterStructure

104 | RawRouterStructure

123 | ChoiceStructure RouterStructure RouterStructure

105 | ChoiceStructure RouterStructure RouterStructure

124 deriving (Eq, Show)

106 deriving (Eq, Show)

servant-server/test/Servant/ServerSpec.hs+6−54

@@ -17,14 +17,10 @@ import Prelude.Compat

17

18import Control.Monad

19 (forM_, unless, when)

20−import Control.Monad.Reader (runReaderT, ask)

21import Control.Monad.Error.Class

20import Control.Monad.Error.Class

22 (MonadError (..))

21 (MonadError (..))

23−import Control.Monad.IO.Class (MonadIO(..))

24import Data.Aeson

22import Data.Aeson

25 (FromJSON, ToJSON, decode', encode)

23 (FromJSON, ToJSON, decode', encode)

26−import Data.Acquire

27− (Acquire, mkAcquire)

28import qualified Data.ByteString as BS

24import qualified Data.ByteString as BS

29import qualified Data.ByteString.Base64 as Base64

25import qualified Data.ByteString.Base64 as Base64

30import Data.Char

26import Data.Char

@@ -56,19 +52,19 @@ import Servant.API

56 Delete, EmptyAPI, Fragment, Get, HasStatus (StatusOf), Header,

52 Delete, EmptyAPI, Fragment, Get, HasStatus (StatusOf), Header,

57 Headers, HttpVersion, IsSecure (..), JSON, Lenient,

53 Headers, HttpVersion, IsSecure (..), JSON, Lenient,

58 NoContent (..), NoContentVerb, NoFraming, OctetStream, Patch,

54 NoContent (..), NoContentVerb, NoFraming, OctetStream, Patch,

59− PlainText, Post, Put, QueryFlag, QueryParam, QueryParams, Raw, RawM,

55+ PlainText, Post, Put, QueryFlag, QueryParam, QueryParams, Raw,

60 RemoteHost, ReqBody, SourceIO, StdMethod (..), Stream, Strict,

56 RemoteHost, ReqBody, SourceIO, StdMethod (..), Stream, Strict,

61 UVerb, Union, Verb, WithStatus (..), addHeader)

57 UVerb, Union, Verb, WithStatus (..), addHeader)

62import Servant.Server

58import Servant.Server

63− (Context ((:.), EmptyContext), Handler, Server, ServerT, Tagged (..),

59+ (Context ((:.), EmptyContext), Handler, Server, Tagged (..),

64− emptyServer, err401, err403, err404, hoistServer, respond, serve,

60+ emptyServer, err401, err403, err404, respond, serve,

65 serveWithContext)

61 serveWithContext)

66import Servant.Test.ComprehensiveAPI

62import Servant.Test.ComprehensiveAPI

67import qualified Servant.Types.SourceT as S

63import qualified Servant.Types.SourceT as S

68import Test.Hspec

64import Test.Hspec

69 (Spec, context, describe, it, shouldBe, shouldContain)

65 (Spec, context, describe, it, shouldBe, shouldContain)

70import Test.Hspec.Wai

66import Test.Hspec.Wai

71− (get, matchHeaders, matchStatus, shouldRespondWith,

67+ (get, liftIO, matchHeaders, matchStatus, shouldRespondWith,

72 with, (<:>))

68 with, (<:>))

73import qualified Test.Hspec.Wai as THW

69import qualified Test.Hspec.Wai as THW

74

70

@@ -85,11 +81,8 @@ import Servant.Server.Internal.Context

85-- This declaration simply checks that all instances are in place.

81-- This declaration simply checks that all instances are in place.

86_ = serveWithContext comprehensiveAPI comprehensiveApiContext

82_ = serveWithContext comprehensiveAPI comprehensiveApiContext

87

83

88−comprehensiveApiContext :: Context '[NamedContext "foo" '[], Acquire Int]

84+comprehensiveApiContext :: Context '[NamedContext "foo" '[]]

89−comprehensiveApiContext =

90− NamedContext EmptyContext :.

85+comprehensiveApiContext = NamedContext EmptyContext :. EmptyContext

91− mkAcquire (pure 10) (\_ -> pure ()) :.

92− EmptyContext

93

86

94-- * Specs

87-- * Specs

95

88

@@ -104,7 +97,6 @@ spec = do

104 reqBodySpec

97 reqBodySpec

105 headerSpec

98 headerSpec

106 rawSpec

99 rawSpec

107− rawMSpec

108 alternativeSpec

100 alternativeSpec

109 responseHeadersSpec

101 responseHeadersSpec

110 uverbResponseHeadersSpec

102 uverbResponseHeadersSpec

@@ -613,46 +605,6 @@ rawSpec = do

613

605

614-- }}}

606-- }}}

615------------------------------------------------------------------------------

607------------------------------------------------------------------------------

616−-- * rawMSpec {{{

617−------------------------------------------------------------------------------

618−

619−type RawMApi = "foo" :> RawM

620−

621−rawMApi :: Proxy RawMApi

622−rawMApi = Proxy

623−

624−rawMServer :: (Monad m, MonadIO m, Show a) => (Request -> m a) -> ServerT RawMApi m

625−rawMServer f req resp = liftIO . resp . responseLBS ok200 [] . cs . show =<< f req

626−

627−rawMSpec :: Spec

628−rawMSpec = do

629− describe "Servant.API.RawM" $ do

630− it "gives access to monadic context" $ do

631− flip runSession (serve rawMApi

632− (hoistServer rawMApi (flip runReaderT (42 :: Integer)) (rawMServer (const ask)))) $ do

633− response <- Network.Wai.Test.request defaultRequest{

634− pathInfo = ["foo"]

635− }

636− liftIO $ do

637− simpleBody response `shouldBe` "42"

638−

639− it "lets users throw servant errors" $ do

640− flip runSession (serve rawMApi (rawMServer (const $ throwError err404 >> pure (42 :: Integer)))) $ do

641− response <- Network.Wai.Test.request defaultRequest{

642− pathInfo = ["foo"]

643− }

644− liftIO $ do

645− statusCode (simpleStatus response) `shouldBe` 404

646−

647− it "gets the pathInfo modified" $ do

648− flip runSession (serve rawMApi (rawMServer (pure . pathInfo))) $ do

649− response <- Network.Wai.Test.request defaultRequest{

650− pathInfo = ["foo", "bar"]

651− }

652− liftIO $ do

653− simpleBody response `shouldBe` cs (show ["bar" :: String])

654−-- }}}

655−------------------------------------------------------------------------------

656-- * alternativeSpec {{{

608-- * alternativeSpec {{{

657------------------------------------------------------------------------------

609------------------------------------------------------------------------------

658type AlternativeApi =

610type AlternativeApi =

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

@@ -304,10 +304,6 @@ instance (HasSwagger sub) => HasSwagger (HttpVersion :> sub) where

304instance (HasSwagger sub) => HasSwagger (WithNamedContext x c sub) where

305 toSwagger _ = toSwagger (Proxy :: Proxy sub)

306

307−-- | @'WithResource'@ combinator does not change our specification at all.

308−instance (HasSwagger sub) => HasSwagger (WithResource res :> sub) where

309− toSwagger _ = toSwagger (Proxy :: Proxy sub)

310−

311instance (KnownSymbol sym, HasSwagger sub) => HasSwagger (sym :> sub) where

307instance (KnownSymbol sym, HasSwagger sub) => HasSwagger (sym :> sub) where

312 toSwagger _ = prependPath piece (toSwagger (Proxy :: Proxy sub))

308 toSwagger _ = prependPath piece (toSwagger (Proxy :: Proxy sub))

313 where

309 where

servant/CHANGELOG.md−5

@@ -2,11 +2,6 @@

2

3Package 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.1

6−------

7−

8−Compatibility with GHC 9.4, see [PR #1592](https://github.com/haskell-servant/servant/pull/1592).

9−

100.19

50.19

11----

6----

12

7

servant/servant.cabal+3−4

@@ -1,6 +1,6 @@

1cabal-version: 2.2

2name: servant

3−version: 0.19.1

3+version: 0.19

4

5synopsis: A family of combinators for defining webservices APIs

6category: Servant, Web

@@ -62,7 +62,6 @@ library

62 Servant.API.Vault

63 Servant.API.Verbs

64 Servant.API.WithNamedContext

65− Servant.API.WithResource

66

65

67 -- Types

66 -- Types

68 exposed-modules:

67 exposed-modules:

@@ -84,9 +83,9 @@ library

84 base >= 4.9 && < 4.18

83 base >= 4.9 && < 4.18

85 , bytestring >= 0.10.8.1 && < 0.12

84 , bytestring >= 0.10.8.1 && < 0.12

86 , constraints >= 0.2

85 , constraints >= 0.2

87− , mtl ^>= 2.2.2 || ^>= 2.3.1

86+ , mtl >= 2.2.2 && < 2.3

88 , sop-core >= 0.4.0.0 && < 0.6

87 , sop-core >= 0.4.0.0 && < 0.6

89− , transformers >= 0.5.2.0 && < 0.7

88+ , transformers >= 0.5.2.0 && < 0.6

90 , text >= 1.2.3.0 && < 2.1

89 , text >= 1.2.3.0 && < 2.1

91

90

92

91

servant/src/Servant/API.hs+6−10

@@ -31,8 +31,6 @@ module Servant.API (

31 -- | Access the location for arbitrary data to be shared by applications and middleware

32 module Servant.API.WithNamedContext,

33 -- | Access context entries in combinators in servant-server

34− module Servant.API.WithResource,

35− -- | Access a managed resource scoped to a single request

36

34

37 -- * Actual endpoints, distinguished by HTTP method

35 -- * Actual endpoints, distinguished by HTTP method

38 module Servant.API.Verbs,

36 module Servant.API.Verbs,

@@ -103,23 +101,21 @@ import Servant.API.Experimental.Auth

103 (AuthProtect)

101 (AuthProtect)

104import Servant.API.Fragment

102import Servant.API.Fragment

105 (Fragment)

103 (Fragment)

106−import Servant.API.Generic

107− (AsApi, GServantProduct, GenericMode ((:-)), GenericServant,

108− ToServant, ToServantApi, fromServant, genericApi, toServant)

109import Servant.API.Header

104import Servant.API.Header

110 (Header, Header')

105 (Header, Header')

106+import Servant.API.Generic

107+ (GenericMode ((:-)), AsApi, ToServant, ToServantApi, GServantProduct,

108+ GenericServant, fromServant, toServant, genericApi)

111import Servant.API.HttpVersion

109import Servant.API.HttpVersion

112 (HttpVersion (..))

110 (HttpVersion (..))

113import Servant.API.IsSecure

111import Servant.API.IsSecure

114 (IsSecure (..))

112 (IsSecure (..))

115import Servant.API.Modifiers

113import Servant.API.Modifiers

116 (Lenient, Optional, Required, Strict)

114 (Lenient, Optional, Required, Strict)

117−import Servant.API.NamedRoutes

118− (NamedRoutes)

119import Servant.API.QueryParam

115import Servant.API.QueryParam

120 (QueryFlag, QueryParam, QueryParam', QueryParams)

116 (QueryFlag, QueryParam, QueryParam', QueryParams)

121import Servant.API.Raw

117import Servant.API.Raw

122− (Raw, RawM)

118+ (Raw)

123import Servant.API.RemoteHost

119import Servant.API.RemoteHost

124 (RemoteHost)

120 (RemoteHost)

125import Servant.API.ReqBody

121import Servant.API.ReqBody

@@ -141,6 +137,8 @@ import Servant.API.UVerb

141 Unique, WithStatus (..), inject, statusOf)

137 Unique, WithStatus (..), inject, statusOf)

142import Servant.API.Vault

138import Servant.API.Vault

143 (Vault)

139 (Vault)

140+import Servant.API.NamedRoutes

141+ (NamedRoutes)

144import Servant.API.Verbs

142import Servant.API.Verbs

145 (Delete, DeleteAccepted, DeleteNoContent,

143 (Delete, DeleteAccepted, DeleteNoContent,

146 DeleteNonAuthoritative, Get, GetAccepted, GetNoContent,

144 DeleteNonAuthoritative, Get, GetAccepted, GetNoContent,

@@ -152,8 +150,6 @@ import Servant.API.Verbs

152 ReflectMethod (reflectMethod), StdMethod (..), Verb)

150 ReflectMethod (reflectMethod), StdMethod (..), Verb)

153import Servant.API.WithNamedContext

151import Servant.API.WithNamedContext

154 (WithNamedContext)

152 (WithNamedContext)

155−import Servant.API.WithResource

156− (WithResource)

157import Servant.Links

153import Servant.Links

158 (HasLink (..), IsElem, IsElem', Link, URI (..), safeLink)

154 (HasLink (..), IsElem, IsElem', Link, URI (..), safeLink)

159import Web.HttpApiData

155import Web.HttpApiData

servant/src/Servant/API/Raw.hs−3

@@ -15,6 +15,3 @@ import Data.Typeable

15-- <https://hackage.haskell.org/package/servant-server/docs/Servant-Server-StaticFiles.html Servant.Server.StaticFiles>

16-- to serve static files stored in a particular directory on your filesystem

17data Raw deriving Typeable

18−

19−-- | Variant of 'Raw' that lets you access the underlying monadic context to process the request.

20−data RawM deriving Typeable

servant/src/Servant/API/ResponseHeaders.hs−23

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

8{-# LANGUAGE PolyKinds #-}

9{-# LANGUAGE ScopedTypeVariables #-}

10{-# LANGUAGE TypeFamilies #-}

11−{-# LANGUAGE TypeFamilyDependencies #-}

12{-# LANGUAGE TypeOperators #-}

11{-# LANGUAGE TypeOperators #-}

13{-# LANGUAGE UndecidableInstances #-}

12{-# LANGUAGE UndecidableInstances #-}

14{-# OPTIONS_HADDOCK not-home #-}

13{-# OPTIONS_HADDOCK not-home #-}

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

52import Prelude.Compat

51import Prelude.Compat

53import Servant.API.Header

52import Servant.API.Header

54 (Header)

53 (Header)

55−import Servant.API.UVerb.Union

56−import qualified Data.SOP.BasicFunctors as SOP

57−import qualified Data.SOP.NS as SOP

58

54

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

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

60-- Instead, use 'addOptionalHeader'.

56-- Instead, use 'addOptionalHeader'.

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

174 => AddHeader h v a new where

170 => AddHeader h v a new where

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

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

176

172

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)

187− -- This ensures that the remainder of the response list is _not_ empty

188− -- It is necessary to prevent the two instances for union types from

189− -- overlapping.

190− , oldrest ~ (a ': as), newrest ~ (b ': bs))

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

192− addOptionalHeader hdr resp = case resp of

193− SOP.Z (SOP.I rHead) -> SOP.Z $ SOP.I $ addOptionalHeader hdr rHead

194− SOP.S rOthers -> SOP.S $ addOptionalHeader hdr rOthers

195−

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

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

197-- the value in the following ways:

174-- the value in the following ways:

198--

175--

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

@@ -38,7 +38,6 @@ 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)

42import Servant.API.UVerb.Union

41import Servant.API.UVerb.Union

43

42

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

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

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

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

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

88 type StatusOf (WithStatus n a) = n

87 type StatusOf (WithStatus n a) = n

89

88

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

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

92

89

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

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

94--

91--

servant/src/Servant/API/UVerb/Union.hs+2−2

@@ -128,9 +128,9 @@ type DuplicateElementError (rs :: [k]) =

128 ':$$: 'Text " " ':<>: 'ShowType rs

129

130type family Elem (x :: k) (xs :: [k]) :: Bool where

131− Elem x (x ': _) = 'True

132− Elem x (_ ': xs) = Elem x xs

133 Elem _ '[] = 'False

131 Elem _ '[] = 'False

132+ Elem x (x' ': xs) =

133+ If (x == x') 'True (Elem x xs)

134

135type family Unique xs :: Constraint where

136 Unique xs = If (Nubbed xs == 'True) (() :: Constraint) (TypeError (DuplicateElementError xs))

servant/src/Servant/API/WithResource.hsdeleted−3

@@ -1,3 +0,0 @@

1−module Servant.API.WithResource (WithResource) where

2−

3−data WithResource res

servant/src/Servant/Links.hs+1−11

@@ -175,7 +175,7 @@ import Servant.API.NamedRoutes

175import Servant.API.QueryParam

176 (QueryFlag, QueryParam', QueryParams)

177import Servant.API.Raw

178− (Raw, RawM)

178+ (Raw)

179import Servant.API.RemoteHost

180 (RemoteHost)

181import Servant.API.ReqBody

@@ -193,8 +193,6 @@ import Servant.API.Verbs

193 (Verb, NoContentVerb)

194import Servant.API.WithNamedContext

195 (WithNamedContext)

196−import Servant.API.WithResource

197− (WithResource)

198import Web.HttpApiData

196import Web.HttpApiData

199import Data.Kind

197import Data.Kind

200 (Type)

198 (Type)

@@ -560,10 +558,6 @@ instance HasLink sub => HasLink (WithNamedContext name context sub) where

560 type MkLink (WithNamedContext name context sub) a = MkLink sub a

558 type MkLink (WithNamedContext name context sub) a = MkLink sub a

561 toLink toA _ = toLink toA (Proxy :: Proxy sub)

559 toLink toA _ = toLink toA (Proxy :: Proxy sub)

562

560

563−instance HasLink sub => HasLink (WithResource res :> sub) where

564− type MkLink (WithResource res :> sub) a = MkLink sub a

565− toLink toA _ = toLink toA (Proxy :: Proxy sub)

566−

567instance HasLink sub => HasLink (RemoteHost :> sub) where

561instance HasLink sub => HasLink (RemoteHost :> sub) where

568 type MkLink (RemoteHost :> sub) a = MkLink sub a

562 type MkLink (RemoteHost :> sub) a = MkLink sub a

569 toLink = simpleToLink (Proxy :: Proxy sub)

563 toLink = simpleToLink (Proxy :: Proxy sub)

@@ -589,10 +583,6 @@ instance HasLink Raw where

589 type MkLink Raw a = a

583 type MkLink Raw a = a

590 toLink toA _ = toA

584 toLink toA _ = toA

591

585

592−instance HasLink RawM where

593− type MkLink RawM a = a

594− toLink toA _ = toA

595−

596instance HasLink (Stream m status fr ct a) where

586instance HasLink (Stream m status fr ct a) where

597 type MkLink (Stream m status fr ct a) r = r

587 type MkLink (Stream m status fr ct a) r = r

598 toLink toA _ = toA

588 toLink toA _ = toA

servant/src/Servant/Test/ComprehensiveAPI.hs−1

@@ -72,7 +72,6 @@ type ComprehensiveAPIWithoutStreamingOrRaw' endpoint =

72 :<|> "description" :> Description "foo" :> GET

73 :<|> "alternative" :> ("left" :> GET :<|> "right" :> GET)

74 :<|> "fragment" :> Fragment Int :> GET

75− :<|> "resource" :> WithResource Int :> GET

76 :<|> endpoint

75 :<|> endpoint

77

76

78type ComprehensiveAPIWithoutStreamingOrRaw = ComprehensiveAPIWithoutStreamingOrRaw' EmptyEndpoint

77type ComprehensiveAPIWithoutStreamingOrRaw = ComprehensiveAPIWithoutStreamingOrRaw' EmptyEndpoint

servant/src/Servant/Types/SourceT.hs−3

@@ -1,4 +1,3 @@

1−{-# LANGUAGE CPP #-}

2{-# LANGUAGE DeriveFunctor #-}

1{-# LANGUAGE DeriveFunctor #-}

3{-# LANGUAGE GADTs #-}

2{-# LANGUAGE GADTs #-}

4{-# LANGUAGE RankNTypes #-}

3{-# LANGUAGE RankNTypes #-}

@@ -155,10 +154,8 @@ instance (Applicative m, Show1 m, Show a) => Show (StepT m a) where

155-- | >>> lift [1,2,3] :: StepT [] Int

154-- | >>> lift [1,2,3] :: StepT [] Int

156-- Effect [Yield 1 Stop,Yield 2 Stop,Yield 3 Stop]

155-- Effect [Yield 1 Stop,Yield 2 Stop,Yield 3 Stop]

157--

156--

158−#if !MIN_VERSION_transformers(0,6,0)

159instance MonadTrans StepT where

157instance MonadTrans StepT where

160 lift = Effect . fmap (`Yield` Stop)

158 lift = Effect . fmap (`Yield` Stop)

161−#endif

162

159

163instance MFunctor StepT where

160instance MFunctor StepT where

164 hoist f = go where

161 hoist f = go where

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

@@ -2,14 +2,10 @@

2{-# LANGUAGE OverloadedStrings #-}

3module Servant.API.ResponseHeadersSpec where

4

5−import Data.Proxy

6−import GHC.TypeLits

7import Test.Hspec

5import Test.Hspec

8

6

9−import Servant.API.ContentTypes

10import Servant.API.Header

7import Servant.API.Header

11import Servant.API.ResponseHeaders

8import Servant.API.ResponseHeaders

12−import Servant.API.UVerb

13

9

14spec :: Spec

10spec :: Spec

15spec = describe "Servant.API.ResponseHeaders" $ do

11spec = describe "Servant.API.ResponseHeaders" $ do

@@ -32,10 +28,3 @@ spec = describe "Servant.API.ResponseHeaders" $ do

32 it "does not add a header" $ do

28 it "does not add a header" $ do

33 let val = noHeader 5 :: Headers '[Header "test" Int] Int

29 let val = noHeader 5 :: Headers '[Header "test" Int] Int

34 getHeaders val `shouldBe` []

30 getHeaders val `shouldBe` []

35−

36− describe "HasStatus Headers" $ do

37−

38− it "gets the status from the underlying value" $ do

39− natVal (Proxy :: Proxy (StatusOf (Headers '[Header "first" Int] NoContent))) `shouldBe` 204

40− natVal (Proxy :: Proxy (StatusOf (Headers '[Header "first" Int] (WithStatus 503 ())))) `shouldBe` 503

41−