on master help sign in
10 files changed+244−197
since splitsnapshots
unifiedsplit
.github/workflows/ci.yaml+14−13 .gitignore+1 CHANGELOG.md+26 Network/HTTP/Req.hs+67−77 README.md+1−1 Setup.hs−6 cabal.project+4 httpbin-tests/Network/HTTP/ReqSpec.hs+73−41 pure-tests/Network/HTTP/ReqSpec.hs+18−18 req.cabal+40−41
.github/workflows/ci.yaml+14−13
@@ -11,27 +11,25 @@ jobs:
1111 ormolu:
1212 runs-on: ubuntu-latest
1313 steps:
14− - uses: actions/checkout@v3
15− - uses: mrkkrp/ormolu-action@v7
14+ - uses: actions/checkout@v4
15+ - uses: haskell-actions/run-ormolu@v17
1616 build:
1717 runs-on: ubuntu-latest
1818 needs: ormolu
1919 strategy:
2020 matrix:
21− cabal: ["3.8"]
22− ghc: ["9.0.2", "9.2.4", "9.4.1"]
23− env:
24− CONFIG: "--enable-tests --enable-benchmarks --flags=dev"
21+ cabal: ["3.12"]
22+ ghc: ["9.6.3", "9.8.2", "9.10.1"]
2523 steps:
26− - uses: actions/checkout@v3
27− - uses: haskell/actions/setup@v2
24+ - uses: actions/checkout@v4
25+ - uses: haskell-actions/setup@v2
2826 id: setup-haskell-cabal
2927 with:
3028 ghc-version: ${{ matrix.ghc }}
3129 cabal-version: ${{ matrix.cabal }}
3230 - run: cabal update
33− - run: cabal freeze $CONFIG
34− - uses: actions/cache@v3.0.7
31+ - run: cabal freeze
32+ - uses: actions/cache@v4.2.3
3533 with:
3634 path: |
3735 ${{ steps.setup-haskell-cabal.outputs.cabal-store }}
@@ -40,7 +38,10 @@ jobs:
4038 restore-keys: |
4139 ${{ runner.os }}-${{ matrix.ghc }}-
4240 - run: cabal format && git diff --exit-code --color=always
43− - run: cabal build $CONFIG
44− - run: cabal test $CONFIG
45− - run: cabal haddock $CONFIG
41+ - run: cabal build
42+ - run: |
43+ docker pull kennethreitz/httpbin
44+ docker run -p 1234:80 kennethreitz/httpbin &
45+ cabal test
46+ - run: cabal haddock
4647 - run: cabal sdist
.gitignore+1
@@ -25,5 +25,6 @@ cabal.project.local
2525cabal.sandbox.config
2626dist-*/
2727dist/
28+hie.yaml
2829stack.yaml
2930stack.yaml.lock
CHANGELOG.md+26
@@ -1,3 +1,29 @@
1+## Req 3.13.4
2+
3+* Fixed empty ciphersuite list when compiling against `tls < 2.0.6`
4+ (see [PR 175](https://github.com/mrkkrp/req/pull/175)). As a side effect, now
5+ compatible with older versions of `crypton-connection` (>= 0.3).
6+
7+## Req 3.13.3
8+
9+* Works with `crypton-connection-0.4` and newer.
10+
11+## Req 3.13.2
12+
13+* Disable the problematic `httpbin-tests` test suite by default. Only enable
14+ it when the `dev` flag is enabled. In that case it is expected that an
15+ httpbin server is run locally at `localhost:1234`.
16+
17+## Req 3.13.1
18+
19+* Switched the non-pure test suite to use https://httpbun.org instead of
20+ https://httpbin.org since the latter proved to be highly unreliable
21+ lately.
22+
23+* Switched from `connection` to `crypton-connection`.
24+
25+* Builds with GHC 9.6.1.
26+
127## Req 3.13.0
228
329* Add `headerRedacted` function to add header fields, which will be with
Network/HTTP/Req.hs+67−77
@@ -1,19 +1,9 @@
1−{-# LANGUAGE BangPatterns #-}
21{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE DeriveDataTypeable #-}
4−{-# LANGUAGE DeriveGeneric #-}
5−{-# LANGUAGE DeriveLift #-}
6−{-# LANGUAGE FlexibleInstances #-}
7−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
82{-# LANGUAGE LambdaCase #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
103{-# LANGUAGE OverloadedStrings #-}
114{-# LANGUAGE QuasiQuotes #-}
12−{-# LANGUAGE RankNTypes #-}
135{-# LANGUAGE RecordWildCards #-}
146{-# LANGUAGE RoleAnnotations #-}
15−{-# LANGUAGE ScopedTypeVariables #-}
16−{-# LANGUAGE StandaloneDeriving #-}
177{-# LANGUAGE TemplateHaskellQuotes #-}
188{-# LANGUAGE TypeFamilies #-}
199{-# LANGUAGE UndecidableInstances #-}
@@ -213,7 +203,7 @@ module Network.HTTP.Req
213203 )
214204where
215205
216−import qualified Blaze.ByteString.Builder as BB
206+import Blaze.ByteString.Builder qualified as BB
217207import Control.Applicative
218208import Control.Arrow (first, second)
219209import Control.Exception hiding (Handler (..), TypeError)
@@ -229,55 +219,56 @@ import Control.Monad.Trans.Control
229219import Control.Monad.Trans.Except (ExceptT)
230220import Control.Monad.Trans.Identity (IdentityT)
231221import Control.Monad.Trans.Maybe (MaybeT)
232−import qualified Control.Monad.Trans.RWS.CPS as RWS.CPS
233−import qualified Control.Monad.Trans.RWS.Lazy as RWS.Lazy
234−import qualified Control.Monad.Trans.RWS.Strict as RWS.Strict
222+import Control.Monad.Trans.RWS.CPS qualified as RWS.CPS
223+import Control.Monad.Trans.RWS.Lazy qualified as RWS.Lazy
224+import Control.Monad.Trans.RWS.Strict qualified as RWS.Strict
235225import Control.Monad.Trans.Select (SelectT)
236−import qualified Control.Monad.Trans.State.Lazy as State.Lazy
237−import qualified Control.Monad.Trans.State.Strict as State.Strict
238−import qualified Control.Monad.Trans.Writer.CPS as Writer.CPS
239−import qualified Control.Monad.Trans.Writer.Lazy as Writer.Lazy
240−import qualified Control.Monad.Trans.Writer.Strict as Writer.Strict
226+import Control.Monad.Trans.State.Lazy qualified as State.Lazy
227+import Control.Monad.Trans.State.Strict qualified as State.Strict
228+import Control.Monad.Trans.Writer.CPS qualified as Writer.CPS
229+import Control.Monad.Trans.Writer.Lazy qualified as Writer.Lazy
230+import Control.Monad.Trans.Writer.Strict qualified as Writer.Strict
241231import Control.Retry
242232import Data.Aeson (FromJSON (..), ToJSON (..))
243−import qualified Data.Aeson as A
233+import Data.Aeson qualified as A
244234import Data.ByteString (ByteString)
245−import qualified Data.ByteString as B
246−import qualified Data.ByteString.Lazy as BL
247−import qualified Data.CaseInsensitive as CI
235+import Data.ByteString qualified as B
236+import Data.ByteString.Lazy qualified as BL
237+import Data.CaseInsensitive qualified as CI
248238import Data.Data (Data)
239+import Data.Default.Class (def)
249240import Data.Function (on)
250241import Data.IORef
251242import Data.Kind (Constraint, Type)
252243import Data.List (foldl', nubBy)
253244import Data.List.NonEmpty (NonEmpty (..))
254−import qualified Data.List.NonEmpty as NE
245+import Data.List.NonEmpty qualified as NE
255246import Data.Maybe (fromMaybe)
256247import Data.Proxy
257248import Data.Semigroup (Endo (..))
258−import qualified Data.Set as S
249+import Data.Set qualified as S
259250import Data.Text (Text)
260−import qualified Data.Text as T
261−import qualified Data.Text.Encoding as T
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
262253import Data.Typeable (Typeable, cast)
263254import GHC.Generics
264255import GHC.TypeLits
265−import qualified Language.Haskell.TH as TH
266−import qualified Language.Haskell.TH.Quote as TH
267−import qualified Language.Haskell.TH.Syntax as TH
268−import qualified Network.Connection as NC
269−import qualified Network.HTTP.Client as L
270−import qualified Network.HTTP.Client.Internal as LI
271−import qualified Network.HTTP.Client.MultipartFormData as LM
272−import qualified Network.HTTP.Client.TLS as L
273−import qualified Network.HTTP.Types as Y
256+import Language.Haskell.TH qualified as TH
257+import Language.Haskell.TH.Quote qualified as TH
258+import Language.Haskell.TH.Syntax qualified as TH
259+import Network.Connection qualified as NC
260+import Network.HTTP.Client qualified as L
261+import Network.HTTP.Client.Internal qualified as LI
262+import Network.HTTP.Client.MultipartFormData qualified as LM
263+import Network.HTTP.Client.TLS qualified as L
264+import Network.HTTP.Types qualified as Y
274265import System.IO.Unsafe (unsafePerformIO)
275266import Text.URI (URI)
276−import qualified Text.URI as URI
277−import qualified Text.URI.QQ as QQ
278−import qualified Web.Authenticate.OAuth as OAuth
267+import Text.URI qualified as URI
268+import Text.URI.QQ qualified as QQ
269+import Web.Authenticate.OAuth qualified as OAuth
279270import Web.FormUrlEncoded (FromForm (..), ToForm (..))
280−import qualified Web.FormUrlEncoded as Form
271+import Web.FormUrlEncoded qualified as Form
281272import Web.HttpApiData (ToHttpApiData (..))
282273
283274----------------------------------------------------------------------------
@@ -498,7 +489,7 @@ reqCb method url body responseProxy options adjustRequest =
498489--
499490-- @since 3.7.0
500491reqHandler ::
501− MonadHttp m =>
492+ (MonadHttp m) =>
502493 -- | How to get final result from a 'L.Response'
503494 (L.Response L.BodyReader -> IO b) ->
504495 -- | 'L.Request' to perform
@@ -594,10 +585,10 @@ req' method url body options m = do
594585 withReqManager (m request)
595586
596587-- | Perform an action using the global implicit 'L.Manager' that the rest
597−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
598589-- 'L.Manager' controls.
599−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
600−withReqManager m = liftIO (readIORef globalManager) >>= m
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
601592
602593-- | The global 'L.Manager' that 'req' uses. Here we just go with the
603594-- default settings, so users don't need to deal with this manager stuff at
@@ -610,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
610601-- manager. From that moment on the 'IORef' will be just reused—exactly the
611602-- behavior we want here in order to maximize connection sharing. GHC could
612603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
613−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
614605globalManager = unsafePerformIO $ do
615606 context <- NC.initConnectionContext
616607 let settings =
617608 L.mkManagerSettingsContext
618609 (Just context)
619− (NC.TLSSettingsSimple False False False)
610+ def
620611 Nothing
621612 manager <- L.newManager settings
622− newIORef manager
613+ return manager
623614{-# NOINLINE globalManager #-}
624615
625616----------------------------------------------------------------------------
@@ -639,7 +630,7 @@ globalManager = unsafePerformIO $ do
639630-- | A type class for monads that support performing HTTP requests.
640631-- Typically, you only need to define the 'handleHttpException' method
641632-- unless you want to tweak 'HttpConfig'.
642−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
643634 -- | This method describes how to deal with 'HttpException' that was
644635 -- caught by the library. One option is to re-throw it if you are OK with
645636 -- exceptions, but if you prefer working with something like
@@ -723,9 +714,8 @@ data HttpConfig = HttpConfig
723714 -- | Max length of preview fragment of response body.
724715 --
725716 -- @since 3.6.0
726− httpConfigBodyPreviewLength :: forall a. Num a => a
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
727718 }
728− deriving (Typeable)
729719
730720-- | The default value of 'HttpConfig'.
731721--
@@ -813,27 +803,27 @@ instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
813803 getHttpConfig = lift getHttpConfig
814804
815805-- | @since 3.10.0
816−instance MonadHttp m => MonadHttp (ContT r m) where
806+instance (MonadHttp m) => MonadHttp (ContT r m) where
817807 handleHttpException = lift . handleHttpException
818808 getHttpConfig = lift getHttpConfig
819809
820810-- | @since 3.10.0
821−instance MonadHttp m => MonadHttp (ExceptT e m) where
811+instance (MonadHttp m) => MonadHttp (ExceptT e m) where
822812 handleHttpException = lift . handleHttpException
823813 getHttpConfig = lift getHttpConfig
824814
825815-- | @since 3.10.0
826−instance MonadHttp m => MonadHttp (IdentityT m) where
816+instance (MonadHttp m) => MonadHttp (IdentityT m) where
827817 handleHttpException = lift . handleHttpException
828818 getHttpConfig = lift getHttpConfig
829819
830820-- | @since 3.10.0
831−instance MonadHttp m => MonadHttp (MaybeT m) where
821+instance (MonadHttp m) => MonadHttp (MaybeT m) where
832822 handleHttpException = lift . handleHttpException
833823 getHttpConfig = lift getHttpConfig
834824
835825-- | @since 3.10.0
836−instance MonadHttp m => MonadHttp (ReaderT r m) where
826+instance (MonadHttp m) => MonadHttp (ReaderT r m) where
837827 handleHttpException = lift . handleHttpException
838828 getHttpConfig = lift getHttpConfig
839829
@@ -853,17 +843,17 @@ instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
853843 getHttpConfig = lift getHttpConfig
854844
855845-- | @since 3.10.0
856−instance MonadHttp m => MonadHttp (SelectT r m) where
846+instance (MonadHttp m) => MonadHttp (SelectT r m) where
857847 handleHttpException = lift . handleHttpException
858848 getHttpConfig = lift getHttpConfig
859849
860850-- | @since 3.10.0
861−instance MonadHttp m => MonadHttp (State.Lazy.StateT s m) where
851+instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
862852 handleHttpException = lift . handleHttpException
863853 getHttpConfig = lift getHttpConfig
864854
865855-- | @since 3.10.0
866−instance MonadHttp m => MonadHttp (State.Strict.StateT s m) where
856+instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
867857 handleHttpException = lift . handleHttpException
868858 getHttpConfig = lift getHttpConfig
869859
@@ -887,7 +877,7 @@ instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
887877--
888878-- @since 0.4.0
889879runReq ::
890− MonadIO m =>
880+ (MonadIO m) =>
891881 -- | 'HttpConfig' to use
892882 HttpConfig ->
893883 -- | Computation to run
@@ -992,7 +982,7 @@ class HttpMethod a where
992982 -- | Return name of the method as a 'ByteString'.
993983 httpMethodName :: Proxy a -> ByteString
994984
995−instance HttpMethod method => RequestComponent (Tagged "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
996986 getRequestMod _ = Endo $ \x ->
997987 x {L.method = httpMethodName (Proxy :: Proxy method)}
998988
@@ -1034,13 +1024,13 @@ instance HttpMethod method => RequestComponent (Tagged "method" method) where
10341024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
10351025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
10361026 -- NOTE The second value is the path segments in reversed order.
1037− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
10381028
10391029type role Url nominal
10401030
10411031-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
10421032-- the derived lift forgets the type of the scheme.
1043−instance Typeable scheme => TH.Lift (Url scheme) where
1033+instance (Typeable scheme) => TH.Lift (Url scheme) where
10441034 lift url =
10451035 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
10461036 Url Http _ -> [t|Url 'Http|]
@@ -1063,7 +1053,7 @@ https = Url Https . pure
10631053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
10641054infixl 5 /~
10651055
1066−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
10671057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
10681058
10691059-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
@@ -1251,7 +1241,7 @@ instance HttpBody NoReqBody where
12511241-- charset=utf-8\"@ value.
12521242newtype ReqBodyJson a = ReqBodyJson a
12531243
1254−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
12551245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
12561246 getRequestContentType _ = pure "application/json; charset=utf-8"
12571247
@@ -1350,7 +1340,7 @@ instance HttpBody ReqBodyMultipart where
13501340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
13511341--
13521342-- @since 0.2.0
1353−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
13541344reqBodyMultipart parts = liftIO $ do
13551345 boundary <- LM.webkitBoundary
13561346 body <- LM.renderParts boundary parts
@@ -1390,7 +1380,7 @@ type family
13901380 TypeError
13911381 ('Text "This HTTP method does not allow attaching a request body.")
13921382
1393−instance HttpBody body => RequestComponent (Tagged "body" body) where
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
13941384 getRequestMod (Tagged body) = Endo $ \x ->
13951385 x
13961386 { L.requestBody = getRequestBody body,
@@ -1460,7 +1450,7 @@ instance RequestComponent (Option scheme) where
14601450
14611451-- | Finalize given 'L.Request' by applying a finalizer from the given
14621452-- 'Option' (if it has any).
1463−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
14641454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
14651455
14661456----------------------------------------------------------------------------
@@ -1493,7 +1483,7 @@ name =: value = queryParam name (pure value)
14931483-- This operator is defined in terms of 'queryParam':
14941484--
14951485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1496−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
14971487queryFlag name = queryParam name (Nothing :: Maybe ())
14981488
14991489-- | Construct query parameters from a 'ToForm' instance. This function
@@ -1523,7 +1513,7 @@ class QueryParam param where
15231513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
15241514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
15251515 -- method, because they are easier to read.
1526− queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
15271517
15281518 -- | Get the query parameter names and values set by 'queryParam'.
15291519 --
@@ -1772,7 +1762,7 @@ ignoreResponse = Proxy
17721762newtype JsonResponse a = JsonResponse (L.Response a)
17731763 deriving (Show)
17741764
1775−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
17761766 type HttpResponseBody (JsonResponse a) = a
17771767 toVanillaResponse (JsonResponse r) = r
17781768 getHttpResponse r = do
@@ -1888,14 +1878,14 @@ brReadN br n = go 0 id id
18881878
18891879-- | Get the response body.
18901880responseBody ::
1891− HttpResponse response =>
1881+ (HttpResponse response) =>
18921882 response ->
18931883 HttpResponseBody response
18941884responseBody = L.responseBody . toVanillaResponse
18951885
18961886-- | Get the response status code.
18971887responseStatusCode ::
1898− HttpResponse response =>
1888+ (HttpResponse response) =>
18991889 response ->
19001890 Int
19011891responseStatusCode =
@@ -1903,7 +1893,7 @@ responseStatusCode =
19031893
19041894-- | Get the response status message.
19051895responseStatusMessage ::
1906− HttpResponse response =>
1896+ (HttpResponse response) =>
19071897 response ->
19081898 ByteString
19091899responseStatusMessage =
@@ -1911,7 +1901,7 @@ responseStatusMessage =
19111901
19121902-- | Lookup a particular header from a response.
19131903responseHeader ::
1914− HttpResponse response =>
1904+ (HttpResponse response) =>
19151905 -- | Response interpretation
19161906 response ->
19171907 -- | Header to lookup
@@ -1923,7 +1913,7 @@ responseHeader r h =
19231913
19241914-- | Get the response 'L.CookieJar'.
19251915responseCookieJar ::
1926− HttpResponse response =>
1916+ (HttpResponse response) =>
19271917 response ->
19281918 L.CookieJar
19291919responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -2021,7 +2011,7 @@ data HttpException
20212011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
20222012 -- failed
20232013 JsonHttpException String
2024− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
20252015
20262016instance Exception HttpException
20272017
@@ -2058,4 +2048,4 @@ data Scheme
20582048 Http
20592049 | -- | HTTPS
20602050 Https
2061− deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)
README.md+1−1
@@ -4,7 +4,7 @@
44[![Hackage](https://img.shields.io/hackage/v/req.svg?style=flat)](https://hackage.haskell.org/package/req)
55[![Stackage Nightly](http://stackage.org/package/req/badge/nightly)](http://stackage.org/nightly/package/req)
66[![Stackage LTS](http://stackage.org/package/req/badge/lts)](http://stackage.org/lts/package/req)
7−![CI](https://github.com/mrkkrp/req/workflows/CI/badge.svg?branch=master)
7+[![CI](https://github.com/mrkkrp/req/actions/workflows/ci.yaml/badge.svg)](https://github.com/mrkkrp/req/actions/workflows/ci.yaml)
88
99* [Related packages](#related-packages)
1010* [Blog posts](#blog-posts)
Setup.hsdeleted−6
@@ -1,6 +0,0 @@
1−module Main (main) where
2−
3−import Distribution.Simple
4−
5−main :: IO ()
6−main = defaultMain
cabal.projectnew file+4
@@ -0,0 +1,4 @@
1+packages: .
2+tests: True
3+benchmarks: True
4+constraints: req +dev
httpbin-tests/Network/HTTP/ReqSpec.hs+73−41
@@ -11,21 +11,22 @@ import Control.Exception
1111import Control.Monad (forM_)
1212import Control.Monad.Trans.Control
1313import Data.Aeson (ToJSON (..), Value (..), object, (.=))
14−import qualified Data.Aeson as A
15−import qualified Data.Aeson.KeyMap as Aeson.KeyMap
16−import qualified Data.ByteString as B
17−import qualified Data.ByteString.Lazy as BL
14+import Data.Aeson qualified as A
15+import Data.Aeson.KeyMap qualified as Aeson.KeyMap
16+import Data.ByteString qualified as B
17+import Data.ByteString.Lazy qualified as BL
1818import Data.Functor.Identity (runIdentity)
1919import Data.Maybe (fromJust)
2020import Data.Proxy
2121import Data.Text (Text)
22−import qualified Data.Text as T
23−import qualified Data.Text.Encoding as T
24−import qualified Data.Text.IO as TIO
25−import qualified Network.HTTP.Client as L
26−import qualified Network.HTTP.Client.MultipartFormData as LM
27−import Network.HTTP.Req
28−import qualified Network.HTTP.Types as Y
22+import Data.Text qualified as T
23+import Data.Text.Encoding qualified as T
24+import Data.Text.IO qualified as TIO
25+import Network.HTTP.Client qualified as L
26+import Network.HTTP.Client.MultipartFormData qualified as LM
27+import Network.HTTP.Req hiding (req)
28+import Network.HTTP.Req qualified as Req
29+import Network.HTTP.Types qualified as Y
2930import Test.Hspec
3031import Test.QuickCheck
3132
@@ -84,8 +85,7 @@ spec = do
8485 .= object
8586 [ "Accept-Encoding" .= ("gzip" :: Text),
8687 "Foo" .= ("bar" :: Text),
87− "Baz" .= ("quux" :: Text),
88− "Host" .= ("httpbin.org" :: Text)
88+ "Baz" .= ("quux" :: Text)
8989 ]
9090 ]
9191 responseStatusCode r `shouldBe` 200
@@ -97,11 +97,10 @@ spec = do
9797 (stripFunnyHeaders . stripOrigin) (responseBody r)
9898 `shouldBe` object
9999 [ "args" .= emptyObject,
100− "url" .= ("https://httpbin.org/get" :: Text),
100+ "url" .= ("http://localhost:1234/get" :: Text),
101101 "headers"
102102 .= object
103− [ "Accept-Encoding" .= ("gzip" :: Text),
104− "Host" .= ("httpbin.org" :: Text)
103+ [ "Accept-Encoding" .= ("gzip" :: Text)
105104 ]
106105 ]
107106 responseHeader r "Content-Type" `shouldBe` return "application/json"
@@ -118,12 +117,11 @@ spec = do
118117 [ "args" .= emptyObject,
119118 "json" .= text,
120119 "data" .= reflected,
121− "url" .= ("https://httpbin.org/post" :: Text),
120+ "url" .= ("http://localhost:1234/post" :: Text),
122121 "headers"
123122 .= object
124123 [ "Content-Type" .= ("application/json; charset=utf-8" :: Text),
125124 "Accept-Encoding" .= ("gzip" :: Text),
126− "Host" .= ("httpbin.org" :: Text),
127125 "Content-Length" .= show (T.length reflected)
128126 ],
129127 "files" .= emptyObject,
@@ -147,12 +145,11 @@ spec = do
147145 [ "args" .= emptyObject,
148146 "json" .= Null,
149147 "data" .= ("" :: Text),
150− "url" .= ("https://httpbin.org/post" :: Text),
148+ "url" .= ("http://localhost:1234/post" :: Text),
151149 "headers"
152150 .= object
153151 [ "Content-Type" .= T.decodeUtf8 contentType,
154152 "Accept-Encoding" .= ("gzip" :: Text),
155− "Host" .= ("httpbin.org" :: Text),
156153 "Content-Length" .= ("242" :: Text)
157154 ],
158155 "files" .= emptyObject,
@@ -177,11 +174,10 @@ spec = do
177174 [ "args" .= emptyObject,
178175 "json" .= Null,
179176 "data" .= contents,
180− "url" .= ("https://httpbin.org/patch" :: Text),
177+ "url" .= ("http://localhost:1234/patch" :: Text),
181178 "headers"
182179 .= object
183180 [ "Accept-Encoding" .= ("gzip" :: Text),
184− "Host" .= ("httpbin.org" :: Text),
185181 "Content-Length" .= show (T.length contents)
186182 ],
187183 "files" .= emptyObject,
@@ -203,12 +199,11 @@ spec = do
203199 [ "args" .= emptyObject,
204200 "json" .= Null,
205201 "data" .= ("" :: Text),
206− "url" .= ("https://httpbin.org/put" :: Text),
202+ "url" .= ("http://localhost:1234/put" :: Text),
207203 "headers"
208204 .= object
209205 [ "Content-Type" .= ("application/x-www-form-urlencoded" :: Text),
210206 "Accept-Encoding" .= ("gzip" :: Text),
211− "Host" .= ("httpbin.org" :: Text),
212207 "Content-Length" .= ("18" :: Text)
213208 ],
214209 "files" .= emptyObject,
@@ -306,7 +301,7 @@ spec = do
306301 (httpbin /: "basic-auth" /~ user /~ password)
307302 NoReqBody
308303 ignoreResponse
309− (basicAuth (T.encodeUtf8 user) (T.encodeUtf8 password))
304+ (basicAuthUnsafe (T.encodeUtf8 user) (T.encodeUtf8 password))
310305 responseStatusCode r `shouldBe` 200
311306 responseStatusMessage r `shouldBe` "OK"
312307
@@ -406,8 +401,28 @@ blindlyThrowing = runReq defaultHttpConfig {httpConfigCheckResponse = doit}
406401 doit _ _ = error "Oops!"
407402
408403-- | 'Url' representing <https://httpbin.org>.
409−httpbin :: Url 'Https
410−httpbin = https "httpbin.org"
404+httpbin :: Url 'Http
405+httpbin = http "localhost"
406+
407+req ::
408+ ( MonadHttp m,
409+ HttpMethod method,
410+ HttpBody body,
411+ HttpResponse response,
412+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
413+ ) =>
414+ method ->
415+ Url scheme ->
416+ body ->
417+ Proxy response ->
418+ Option scheme ->
419+ m response
420+req method url body responseProxy options =
421+ Req.req method url body responseProxy (options <> defaultOptions)
422+
423+-- | Options to apply by default.
424+defaultOptions :: Option scheme
425+defaultOptions = port 1234
411426
412427-- | Remove “origin” field from JSON value. Origin may change, we don't want
413428-- to depend on that.
@@ -417,19 +432,36 @@ stripOrigin value = value
417432
418433-- | Remove funny headers that might break the tests.
419434stripFunnyHeaders :: Value -> Value
420−stripFunnyHeaders (Object m) =
421− let f (Object p) = Object $ Aeson.KeyMap.filterWithKey (\k _ -> k `elem` hs) p
422− f value = value
423− hs =
424− [ "Content-Type",
425− "Accept-Encoding",
426− "Host",
427− "Content-Length",
428− "Foo",
429− "Baz"
430− ]
431− in Object (runIdentity (Aeson.KeyMap.alterF (pure . fmap f) "headers" m))
432−stripFunnyHeaders value = value
435+stripFunnyHeaders = \case
436+ Object m ->
437+ Object
438+ ( runIdentity
439+ ( Aeson.KeyMap.alterF
440+ (pure . fmap stripFunnyHeaders')
441+ "headers"
442+ m
443+ )
444+ )
445+ value -> value
446+
447+-- | Similar to 'stripFunnyHeaders', but acts directly on the argument
448+-- without trying to access its "headers" field.
449+stripFunnyHeaders' :: Value -> Value
450+stripFunnyHeaders' = \case
451+ Object p ->
452+ Object $
453+ Aeson.KeyMap.filterWithKey
454+ (\k _ -> k `elem` whitelistedHeaders)
455+ p
456+ value -> value
457+ where
458+ whitelistedHeaders =
459+ [ "Content-Type",
460+ "Accept-Encoding",
461+ "Content-Length",
462+ "Foo",
463+ "Baz"
464+ ]
433465
434466-- | This is a complete test case that makes use of <https://httpbin.org> to
435467-- get various response status codes.
@@ -471,7 +503,7 @@ emptyObject :: Value
471503emptyObject = Object Aeson.KeyMap.empty
472504
473505-- | Get a rendered JSON value as 'Text'.
474−reflectJSON :: ToJSON a => a -> Text
506+reflectJSON :: (ToJSON a) => a -> Text
475507reflectJSON = T.decodeUtf8 . BL.toStrict . A.encode
476508
477509-- | Clarify to the type checker that the inner computation is in the 'IO'
pure-tests/Network/HTTP/ReqSpec.hs+18−18
@@ -13,41 +13,41 @@
1313
1414module Network.HTTP.ReqSpec (spec) where
1515
16−import qualified Blaze.ByteString.Builder as BB
16+import Blaze.ByteString.Builder qualified as BB
1717import Control.Exception (throwIO)
1818import Control.Monad
1919import Control.Retry
2020import Data.Aeson (ToJSON (..))
21−import qualified Data.Aeson as A
21+import Data.Aeson qualified as A
2222import Data.ByteString (ByteString)
23−import qualified Data.ByteString as B
24−import qualified Data.ByteString.Char8 as B8
25−import qualified Data.ByteString.Lazy as BL
26−import qualified Data.CaseInsensitive as CI
23+import Data.ByteString qualified as B
24+import Data.ByteString.Char8 qualified as B8
25+import Data.ByteString.Lazy qualified as BL
26+import Data.CaseInsensitive qualified as CI
2727import Data.Either (isRight)
28−import qualified Data.List.NonEmpty as NE
28+import Data.List.NonEmpty qualified as NE
2929import Data.Maybe (fromJust, fromMaybe, isJust, isNothing)
3030import Data.Proxy
3131import Data.Text (Text)
32−import qualified Data.Text as T
33−import qualified Data.Text.Encoding as T
32+import Data.Text qualified as T
33+import Data.Text.Encoding qualified as T
3434import Data.Time
3535import Data.Typeable (Typeable, eqT)
3636import GHC.Exts (IsList (..))
3737import GHC.Generics
38−import qualified Language.Haskell.TH as TH
39−import qualified Language.Haskell.TH.Quote as TH
40−import qualified Network.HTTP.Client as L
38+import Language.Haskell.TH qualified as TH
39+import Language.Haskell.TH.Quote qualified as TH
40+import Network.HTTP.Client qualified as L
4141import Network.HTTP.Req
42−import qualified Network.HTTP.Types as Y
43−import qualified Network.HTTP.Types.Header as Y
42+import Network.HTTP.Types qualified as Y
43+import Network.HTTP.Types.Header qualified as Y
4444import Test.Hspec
4545import Test.Hspec.Core.Spec (SpecM)
4646import Test.QuickCheck
4747import Text.URI (URI)
48−import qualified Text.URI as URI
49−import qualified Text.URI.QQ as QQ
50−import qualified Web.FormUrlEncoded as F
48+import Text.URI qualified as URI
49+import Text.URI.QQ qualified as QQ
50+import Web.FormUrlEncoded qualified as F
5151
5252spec :: Spec
5353spec = do
@@ -413,7 +413,7 @@ spec = do
413413 -- 'Https, Option _) type checks, so we can catch if the type of scheme
414414 -- is unspecified.
415415 let testTypeOfQuoterResult ::
416− forall a s. Typeable a => (a, Option s) -> Bool
416+ forall a s. (Typeable a) => (a, Option s) -> Bool
417417 testTypeOfQuoterResult _ = isJust $ eqT @a @(Url 'Https)
418418 in property $ testTypeOfQuoterResult [urlQ|https://example.org/|]
419419 it "doesn't work for invalid urls" $
req.cabal+40−41
@@ -1,11 +1,11 @@
11cabal-version: 2.4
22name: req
3−version: 3.13.0
3+version: 3.13.4
44license: BSD-3-Clause
55license-file: LICENSE.md
66maintainer: Mark Karpov <markkarpov92@gmail.com>
77author: Mark Karpov <markkarpov92@gmail.com>
8−tested-with: ghc ==9.0.2 ghc ==9.2.4 ghc ==9.4.1
8+tested-with: ghc ==9.6.3 ghc ==9.8.2 ghc ==9.10.1
99homepage: https://github.com/mrkkrp/req
1010bug-reports: https://github.com/mrkkrp/req/issues
1111synopsis: HTTP client library
@@ -31,72 +31,70 @@ flag dev
3131
3232library
3333 exposed-modules: Network.HTTP.Req
34− default-language: Haskell2010
34+ default-language: GHC2021
3535 build-depends:
3636 aeson >=0.9 && <3,
3737 authenticate-oauth >=1.5 && <1.8,
38− base >=4.15 && <5.0,
38+ base >=4.15 && <5,
3939 blaze-builder >=0.3 && <0.5,
40− bytestring >=0.10.8 && <0.12,
40+ bytestring >=0.10.8 && <0.13,
4141 case-insensitive >=0.2 && <1.3,
42− connection >=0.2.2 && <0.4,
43− containers >=0.5 && <0.7,
42+ containers >=0.5 && <0.8,
43+ crypton-connection >=0.4.2 && <0.5,
44+ data-default-class >=0.2.0.0,
4445 exceptions >=0.6 && <0.11,
45− http-api-data >=0.2 && <0.6,
46+ http-api-data >=0.2 && <0.7,
4647 http-client >=0.7.13.1 && <0.8,
4748 http-client-tls >=0.3.2 && <0.4,
48− http-types >=0.8 && <10.0,
49+ http-types >=0.8 && <10,
4950 modern-uri >=0.3 && <0.4,
5051 monad-control >=1.0 && <1.1,
5152 mtl >=2.0 && <3.0,
5253 retry >=0.8 && <0.10,
53− template-haskell >=2.14 && <2.20,
54− text >=0.2 && <2.1,
55− time >=1.2 && <1.13,
54+ template-haskell >=2.19 && <2.23,
55+ text >=0.2 && <2.2,
5656 transformers >=0.5.3.0 && <0.7,
5757 transformers-base,
5858 unliftio-core >=0.1.1 && <0.3
5959
6060 if flag(dev)
61− ghc-options: -O0 -Wall -Werror
61+ ghc-options:
62+ -Wall -Werror -Wpartial-fields -Wunused-packages
63+ -Wno-unused-imports
6264
6365 else
6466 ghc-options: -O2 -Wall
6567
66− if flag(dev)
67− ghc-options:
68− -Wcompat -Wincomplete-record-updates -Wincomplete-uni-patterns
69− -Wnoncanonical-monad-instances
70−
7168test-suite pure-tests
7269 type: exitcode-stdio-1.0
7370 main-is: Spec.hs
74− build-tool-depends: hspec-discover:hspec-discover >=2.0 && <3.0
71+ build-tool-depends: hspec-discover:hspec-discover >=2 && <3
7572 hs-source-dirs: pure-tests
7673 other-modules: Network.HTTP.ReqSpec
77− default-language: Haskell2010
74+ default-language: GHC2021
7875 build-depends:
79− QuickCheck >=2.7 && <3.0,
76+ QuickCheck >=2.7 && <3,
8077 aeson >=0.9 && <3,
8178 base >=4.15 && <5.0,
8279 blaze-builder >=0.3 && <0.5,
83− bytestring >=0.10.8 && <0.12,
80+ bytestring >=0.10.8 && <0.13,
8481 case-insensitive >=0.2 && <1.3,
85− hspec >=2.0 && <3.0,
86− hspec-core >=2.0 && <3.0,
87− http-api-data >=0.2 && <0.6,
82+ hspec >=2.0 && <3,
83+ hspec-core >=2.0 && <3,
84+ http-api-data >=0.2 && <0.7,
8885 http-client >=0.7 && <0.8,
89− http-types >=0.8 && <10.0,
86+ http-types >=0.8 && <10,
9087 modern-uri >=0.3 && <0.4,
91− mtl >=2.0 && <3.0,
9288 req,
9389 retry >=0.8 && <0.10,
94− template-haskell >=2.14 && <2.20,
95− text >=0.2 && <2.1,
96− time >=1.2 && <1.13
90+ template-haskell >=2.19 && <2.23,
91+ text >=0.2 && <2.2,
92+ time >=1.2 && <1.15
9793
9894 if flag(dev)
99− ghc-options: -O0 -Wall -Werror
95+ ghc-options:
96+ -Wall -Werror -Wredundant-constraints -Wpartial-fields
97+ -Wunused-packages
10098
10199 else
102100 ghc-options: -O2 -Wall
@@ -104,25 +102,26 @@ test-suite pure-tests
104102test-suite httpbin-tests
105103 type: exitcode-stdio-1.0
106104 main-is: Spec.hs
107− build-tool-depends: hspec-discover:hspec-discover >=2.0 && <3.0
105+ build-tool-depends: hspec-discover:hspec-discover >=2 && <3
108106 hs-source-dirs: httpbin-tests
109107 other-modules: Network.HTTP.ReqSpec
110− default-language: Haskell2010
108+ default-language: GHC2021
111109 build-depends:
112− QuickCheck >=2.7 && <3.0,
110+ QuickCheck >=2.7 && <3,
113111 aeson >=2 && <3,
114− base >=4.15 && <5.0,
115− bytestring >=0.10.8 && <0.12,
112+ base >=4.15 && <5,
113+ bytestring >=0.10.8 && <0.13,
116114 hspec >=2.0 && <3.0,
117115 http-client >=0.7 && <0.8,
118− http-types >=0.8 && <10.0,
116+ http-types >=0.8 && <10,
119117 monad-control >=1.0 && <1.1,
120− mtl >=2.0 && <3.0,
121118 req,
122− text >=0.2 && <2.1
119+ text >=0.2 && <2.2
123120
124121 if flag(dev)
125− ghc-options: -O0 -Wall -Werror
122+ ghc-options:
123+ -Wall -Werror -Wredundant-constraints -Wpartial-fields
124+ -Wunused-packages
126125
127126 else
128− ghc-options: -O2 -Wall
127+ buildable: False