@@ -1,19 +1,9 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE CPP #-}
31{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE DeriveDataTypeable #-}
5−{-# LANGUAGE DeriveGeneric #-}
6−{-# LANGUAGE DeriveLift #-}
7−{-# LANGUAGE FlexibleInstances #-}
8−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
92{-# LANGUAGE LambdaCase #-}
10−{-# LANGUAGE MultiParamTypeClasses #-}
113{-# LANGUAGE OverloadedStrings #-}
124{-# LANGUAGE QuasiQuotes #-}
13−{-# LANGUAGE RankNTypes #-}
145{-# LANGUAGE RecordWildCards #-}
156{-# LANGUAGE RoleAnnotations #-}
16−{-# LANGUAGE ScopedTypeVariables #-}
177{-# LANGUAGE TemplateHaskellQuotes #-}
188{-# LANGUAGE TypeFamilies #-}
199{-# LANGUAGE UndecidableInstances #-}
@@ -29,61 +19,40 @@
2919--
3020-- The documentation below is structured in such a way that the most
3121-- important information is presented first: you learn how to do HTTP
32−-- requests, how to embed them in any monad you have, and then it gives you
22+-- requests, how to embed them in the monad you have, and then it gives you
3323-- details about less-common things you may want to know about. The
3424-- documentation is written with sufficient coverage of details and
3525-- examples, and it's designed to be a complete tutorial on its own.
3626--
37−-- /(A modest intro goes here, click on 'req' to start making requests.)/
38−--
3927-- === About the library
4028--
41−-- Req is an easy-to-use, type-safe, expandable, high-level HTTP client
42−-- library that just works without any fooling around.
43−--
44−-- What does the phrase “easy-to-use” mean? It means that the library is
45−-- designed to be beginner-friendly so it's simple to add to your monad
46−-- stack, intuitive to work with, well-documented, and does not get in your
47−-- way. Doing HTTP requests is a common task and Haskell library for this
48−-- should be very approachable and clear to beginners, thus certain
49−-- compromises were made. For example, one cannot currently modify
50−-- 'L.ManagerSettings' of the default manager because the library always
51−-- uses the same implicit global manager for simplicity and maximal
52−-- connection sharing. There is a way to use your own manager with different
53−-- settings, but it requires a bit more typing.
54−--
55−-- “Type-safe” means that the library is protective and eliminates certain
56−-- classes of errors. For example, we have correct-by-construction 'Url's,
57−-- it's guaranteed that the user does not send the request body when using
58−-- methods like 'GET' or 'OPTIONS', and the amount of implicit assumptions
59−-- is minimized by making the user specify his\/her intentions in an
60−-- explicit form (for example, it's not possible to avoid specifying the
61−-- body or method of request). Authentication methods that assume HTTPS
62−-- force the user to use HTTPS at the type level. The library also carefully
63−-- hides underlying types from the lower-level @http-client@ package because
64−-- those types are not safe enough (for example 'L.Request' is an instance
65−-- of 'Data.String.IsString' and, if it's malformed, it will blow up at
66−-- run-time).
67−--
68−-- “Expandable” refers to the ability of the library to be expanded without
69−-- having to resort to ugly hacking. For example, it's possible to define
70−-- your own HTTP methods, create new ways to construct the body of a
71−-- request, create new authorization options, perform a request in a
72−-- different way, and create your own methods to parse and represent a
73−-- response. As the user extends the library to satisfy his\/her special
74−-- needs, the new solutions will work just like the built-ins. However, all
75−-- of the common cases are also covered by the library out-of-the-box.
76−--
77−-- “High-level” means that there are less details to worry about. The
78−-- library is a result of my experiences as a Haskell consultant. Working
79−-- for several clients, who had very different projects, showed me that the
80−-- library should adapt easily to any particular style of writing Haskell
81−-- applications. For example, some people prefer throwing exceptions, while
82−-- others are concerned with purity. Just define 'handleHttpException'
83−-- accordingly when making your monad instance of 'MonadHttp' and it will
84−-- play together seamlessly. Finally, the library cuts down boilerplate
85−-- considerably, and helps you write concise, easy to read, and maintainable
86−-- code.
29+-- Req is an HTTP client library that attempts to be easy-to-use, type-safe,
30+-- and expandable.
31+--
32+-- “Easy-to-use” means that the library is designed to be beginner-friendly
33+-- so it's simple to add to your monad stack, intuitive to work with,
34+-- well-documented, and does not get in your way. Doing HTTP requests is a
35+-- common task and a Haskell library for this should be approachable and
36+-- clear to beginners, thus certain compromises were made. For example, one
37+-- cannot currently modify 'L.ManagerSettings' of the default manager
38+-- because the library always uses the same implicit global manager for
39+-- simplicity and maximal connection sharing. There is a way to use your own
40+-- manager with different settings, but it requires more typing.
41+--
42+-- “Type-safe” means that the library tries to eliminate certain classes of
43+-- errors. For example, we have correct-by-construction URLs; it is
44+-- guaranteed that the user does not send the request body when using
45+-- methods like GET or OPTIONS, and the amount of implicit assumptions is
46+-- minimized by making the user specify their intentions in an explicit
47+-- form. For example, it's not possible to avoid specifying the body or the
48+-- method of a request. Authentication methods that assume HTTPS force the
49+-- user to use HTTPS at the type level.
50+--
51+-- “Expandable” refers to the ability to create new components without
52+-- having to resort to hacking. For example, it's possible to define your
53+-- own HTTP methods, create new ways to construct the body of a request,
54+-- create new authorization options, perform a request in a different way,
55+-- and create your own methods to parse a response.
8756--
8857-- === Using with other libraries
8958--
@@ -112,6 +81,7 @@ module Network.HTTP.Req
11281 -- $making-a-request
11382 req,
11483 reqBr,
84+ reqCb,
11585 req',
11686 withReqManager,
11787
@@ -174,11 +144,13 @@ module Network.HTTP.Req
174144 -- $query-parameters
175145 (=:),
176146 queryFlag,
147+ formToQuery,
177148 QueryParam (..),
178149
179150 -- *** Headers
180151 header,
181152 attachHeader,
153+ headerRedacted,
182154
183155 -- *** Cookies
184156 -- $cookies
@@ -225,58 +197,78 @@ module Network.HTTP.Req
225197
226198 -- * Other
227199 HttpException (..),
200+ isStatusCodeException,
228201 CanHaveBody (..),
229202 Scheme (..),
230203 )
231204where
232205
233−import qualified Blaze.ByteString.Builder as BB
206+import Blaze.ByteString.Builder qualified as BB
234207import Control.Applicative
235208import Control.Arrow (first, second)
236209import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
237211import Control.Monad.Base
238−import Control.Monad.Catch (Handler (..))
212+import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
239213import Control.Monad.IO.Class
240214import Control.Monad.IO.Unlift
241−import Control.Monad.Reader
215+import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)
216+import Control.Monad.Trans.Accum (AccumT)
217+import Control.Monad.Trans.Cont (ContT)
242218import Control.Monad.Trans.Control
219+import Control.Monad.Trans.Except (ExceptT)
220+import Control.Monad.Trans.Identity (IdentityT)
221+import Control.Monad.Trans.Maybe (MaybeT)
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
225+import Control.Monad.Trans.Select (SelectT)
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
243231import Control.Retry
244232import Data.Aeson (FromJSON (..), ToJSON (..))
245−import qualified Data.Aeson as A
233+import Data.Aeson qualified as A
246234import Data.ByteString (ByteString)
247−import qualified Data.ByteString as B
248−import qualified Data.ByteString.Lazy as BL
249−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
250238import Data.Data (Data)
239+import Data.Default.Class (def)
251240import Data.Function (on)
252241import Data.IORef
253242import Data.Kind (Constraint, Type)
254243import Data.List (foldl', nubBy)
255244import Data.List.NonEmpty (NonEmpty (..))
256−import qualified Data.List.NonEmpty as NE
245+import Data.List.NonEmpty qualified as NE
257246import Data.Maybe (fromMaybe)
258247import Data.Proxy
259−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
260250import Data.Text (Text)
261−import qualified Data.Text as T
262−import qualified Data.Text.Encoding as T
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
263253import Data.Typeable (Typeable, cast)
264254import GHC.Generics
265255import GHC.TypeLits
266−import qualified Language.Haskell.TH as TH
267−import qualified Language.Haskell.TH.Quote as TH
268−import qualified Language.Haskell.TH.Syntax as TH
269−import qualified Network.Connection as NC
270−import qualified Network.HTTP.Client as L
271−import qualified Network.HTTP.Client.Internal as LI
272−import qualified Network.HTTP.Client.MultipartFormData as LM
273−import qualified Network.HTTP.Client.TLS as L
274−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
275265import System.IO.Unsafe (unsafePerformIO)
276266import Text.URI (URI)
277−import qualified Text.URI as URI
278−import qualified Text.URI.QQ as QQ
279−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
270+import Web.FormUrlEncoded (FromForm (..), ToForm (..))
271+import Web.FormUrlEncoded qualified as Form
280272import Web.HttpApiData (ToHttpApiData (..))
281273
282274----------------------------------------------------------------------------
@@ -301,7 +293,7 @@ import Web.HttpApiData (ToHttpApiData (..))
301293--
302294-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
303295-- tutorial has a section about HTTP bodies, but usage is very
304−-- straightforward and should be clear from the examples below.
296+-- straightforward and should be clear from the examples.
305297--
306298-- @response@ is a type hint how to make and interpret response of an HTTP
307299-- request. Out-of-the-box it can be the following:
@@ -429,12 +421,7 @@ req ::
429421 -- | Response
430422 m response
431423req method url body responseProxy options =
432− reqBr method url body (options <> extraOptions) getHttpResponse
433− where
434− extraOptions =
435− case acceptHeader responseProxy of
436− Nothing -> mempty
437− Just accept -> header "Accept" accept
424+ reqCb method url body responseProxy options pure
438425
439426-- | A version of 'req' that does not use one of the predefined instances of
440427-- 'HttpResponse' but instead allows the user to consume @'L.Response'
@@ -459,7 +446,58 @@ reqBr ::
459446 (L.Response L.BodyReader -> IO a) ->
460447 -- | Result
461448 m a
462−reqBr method url body options consume = req' method url body options $ \request manager -> do
449+reqBr method url body options consume =
450+ req' method url body options (reqHandler consume)
451+
452+-- | A version of 'req' that takes a callback to modify the 'L.Request', but
453+-- otherwise performs the request identically.
454+--
455+-- @since 3.7.0
456+reqCb ::
457+ ( MonadHttp m,
458+ HttpMethod method,
459+ HttpBody body,
460+ HttpResponse response,
461+ HttpBodyAllowed (AllowsBody method) (ProvidesBody body)
462+ ) =>
463+ -- | HTTP method
464+ method ->
465+ -- | 'Url'—location of resource
466+ Url scheme ->
467+ -- | Body of the request
468+ body ->
469+ -- | A hint how to interpret response
470+ Proxy response ->
471+ -- | Collection of optional parameters
472+ Option scheme ->
473+ -- | Callback to modify the request
474+ (L.Request -> m L.Request) ->
475+ -- | Response
476+ m response
477+reqCb method url body responseProxy options adjustRequest =
478+ req' method url body (options <> extraOptions) $ \request manager -> do
479+ request' <- adjustRequest request
480+ reqHandler getHttpResponse request' manager
481+ where
482+ extraOptions =
483+ case acceptHeader responseProxy of
484+ Nothing -> mempty
485+ Just accept -> header "Accept" accept
486+
487+-- | The default handler function that the higher-level request functions
488+-- pass to 'req''. Internal function.
489+--
490+-- @since 3.7.0
491+reqHandler ::
492+ (MonadHttp m) =>
493+ -- | How to get final result from a 'L.Response'
494+ (L.Response L.BodyReader -> IO b) ->
495+ -- | 'L.Request' to perform
496+ L.Request ->
497+ -- | 'L.Manager' to use
498+ L.Manager ->
499+ m b
500+reqHandler consume request manager = do
463501 HttpConfig {..} <- getHttpConfig
464502 let wrapVanilla = handle (throwIO . VanillaHttpException)
465503 wrapExc = handle (throwIO . LI.toHttpException request)
@@ -491,7 +529,7 @@ reqBr method url body options consume = req' method url body options $ \request
491529 (const openResponse)
492530 )
493531 )
494− (preview, r') <- grabPreview bodyPreviewLength r
532+ (preview, r') <- grabPreview httpConfigBodyPreviewLength r
495533 mapM_ LI.throwHttp (httpConfigCheckResponse request r' preview)
496534 consume r'
497535 )
@@ -540,22 +578,22 @@ req' method url body options m = do
540578 nubHeaders
541579 <> getRequestMod options
542580 <> getRequestMod config
543− <> getRequestMod (Womb body :: Womb "body" body)
581+ <> getRequestMod (Tagged body :: Tagged "body" body)
544582 <> getRequestMod url
545− <> getRequestMod (Womb method :: Womb "method" method)
583+ <> getRequestMod (Tagged method :: Tagged "method" method)
546584 request <- finalizeRequest options request'
547585 withReqManager (m request)
548586
549587-- | Perform an action using the global implicit 'L.Manager' that the rest
550−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
551589-- 'L.Manager' controls.
552−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
553−withReqManager m = liftIO (readIORef globalManager) >>= m
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
554592
555−-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
556−-- settings, so users don't need to deal with this manager stuff at all, but
557−-- when we create a request, instance 'HttpConfig' can affect the default
558−-- settings via 'getHttpConfig'.
593+-- | The global 'L.Manager' that 'req' uses. Here we just go with the
594+-- default settings, so users don't need to deal with this manager stuff at
595+-- all, but when we create a request, instance 'HttpConfig' can affect the
596+-- default settings via 'getHttpConfig'.
559597--
560598-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
561599-- The value of 'globalManager' is named and lives on top level. This means
@@ -563,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
563601-- manager. From that moment on the 'IORef' will be just reused—exactly the
564602-- behavior we want here in order to maximize connection sharing. GHC could
565603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
566−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
567605globalManager = unsafePerformIO $ do
568606 context <- NC.initConnectionContext
569607 let settings =
570608 L.mkManagerSettingsContext
571609 (Just context)
572− (NC.TLSSettingsSimple False False False)
610+ def
573611 Nothing
574612 manager <- L.newManager settings
575− newIORef manager
613+ return manager
576614{-# NOINLINE globalManager #-}
577615
578616----------------------------------------------------------------------------
@@ -586,13 +624,13 @@ globalManager = unsafePerformIO $ do
586624-- When writing a library, keep your API polymorphic in terms of
587625-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
588626-- Another option is to use a @newtype@-wrapped monad stack and define
589−-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
590−-- this strategy is provided out-of-the-box (see below).
627+-- 'MonadHttp' for it. As of the version /0.4.0/, the 'Req' monad that
628+-- follows this strategy is provided out-of-the-box (see below).
591629
592630-- | A type class for monads that support performing HTTP requests.
593631-- Typically, you only need to define the 'handleHttpException' method
594632-- unless you want to tweak 'HttpConfig'.
595−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
596634 -- | This method describes how to deal with 'HttpException' that was
597635 -- caught by the library. One option is to re-throw it if you are OK with
598636 -- exceptions, but if you prefer working with something like
@@ -600,17 +638,16 @@ class MonadIO m => MonadHttp m where
600638 -- 'Control.Monad.Except.throwError'.
601639 handleHttpException :: HttpException -> m a
602640
603− -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
604− -- implementation returns its 'def' value, which is described in the
605− -- documentation for the type. Common usage pattern with manually defined
606− -- 'getHttpConfig' is to return some hard-coded value, or a value
641+ -- | Return the 'HttpConfig' to be used when performing HTTP requests.
642+ -- Default implementation returns its 'def' value, which is described in
643+ -- the documentation for the type. Common usage pattern with manually
644+ -- defined 'getHttpConfig' is to return some hard-coded value, or a value
607645 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
608646 -- approach to configuration is desirable.
609647 getHttpConfig :: m HttpConfig
610648 getHttpConfig = return defaultHttpConfig
611649
612−-- | 'HttpConfig' contains general and default settings to be used when
613−-- making HTTP requests.
650+-- | 'HttpConfig' contains settings to be used when making HTTP requests.
614651data HttpConfig = HttpConfig
615652 { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
616653 -- environment variables are respected, this setting overwrites them.
@@ -654,8 +691,8 @@ data HttpConfig = HttpConfig
654691 -- | The retry policy to use for request retrying. By default 'def' is
655692 -- used (see 'RetryPolicyM').
656693 --
657− -- __Note__: signature of this function was changed in the version
658− -- /1.0.0/.
694+ -- __Note__: signature of this function was changed to disallow 'IO' in
695+ -- version /1.0.0/ and then changed back to its current form in /3.1.0/.
659696 --
660697 -- @since 0.3.0
661698 httpConfigRetryPolicy :: RetryPolicyM IO,
@@ -668,14 +705,19 @@ data HttpConfig = HttpConfig
668705 -- @since 0.3.0
669706 httpConfigRetryJudge :: forall b. RetryStatus -> L.Response b -> Bool,
670707 -- | Similar to 'httpConfigRetryJudge', but is used to decide when to
671− -- retry requests that resulted in an exception.
708+ -- retry requests that resulted in an exception. By default it retries
709+ -- on response timeout and connection timeout (changed in version
710+ -- /3.8.0/).
672711 --
673712 -- @since 3.4.0
674− httpConfigRetryJudgeException :: RetryStatus -> SomeException -> Bool
713+ httpConfigRetryJudgeException :: RetryStatus -> SomeException -> Bool,
714+ -- | Max length of preview fragment of response body.
715+ --
716+ -- @since 3.6.0
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
675718 }
676− deriving (Typeable)
677719
678−-- | Default value of 'HttpConfig'.
720+-- | The default value of 'HttpConfig'.
679721--
680722-- @since 2.0.0
681723defaultHttpConfig :: HttpConfig
@@ -698,7 +740,15 @@ defaultHttpConfig =
698740 598, -- (Informal convention) Network read timeout error
699741 599 -- (Informal convention) Network connect timeout error
700742 ],
701− httpConfigRetryJudgeException = \_ _ -> False
743+ httpConfigRetryJudgeException = \_ e ->
744+ case fromException e of
745+ Just (L.HttpExceptionRequest _ c) ->
746+ case c of
747+ L.ResponseTimeout -> True
748+ L.ConnectionTimeout -> True
749+ _ -> False
750+ _ -> False,
751+ httpConfigBodyPreviewLength = 1024
702752 }
703753 where
704754 statusCode = Y.statusCode . L.responseStatus
@@ -711,7 +761,7 @@ instance RequestComponent HttpConfig where
711761 LI.requestManagerOverride = httpConfigAltManager
712762 }
713763
714−-- | A monad that allows to run 'req' in any 'IO'-enabled monad without
764+-- | A monad that allows us to run 'req' in any 'IO'-enabled monad without
715765-- having to define new instances.
716766--
717767-- @since 0.4.0
@@ -724,6 +774,15 @@ newtype Req a = Req (ReaderT HttpConfig IO a)
724774 MonadUnliftIO
725775 )
726776
777+-- | @since 3.7.0
778+deriving instance MonadThrow Req
779+
780+-- | @since 3.7.0
781+deriving instance MonadCatch Req
782+
783+-- | @since 3.7.0
784+deriving instance MonadMask Req
785+
727786instance MonadBase IO Req where
728787 liftBase = liftIO
729788
@@ -738,12 +797,87 @@ instance MonadHttp Req where
738797 handleHttpException = Req . lift . throwIO
739798 getHttpConfig = Req ask
740799
800+-- | @since 3.10.0
801+instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
802+ handleHttpException = lift . handleHttpException
803+ getHttpConfig = lift getHttpConfig
804+
805+-- | @since 3.10.0
806+instance (MonadHttp m) => MonadHttp (ContT r m) where
807+ handleHttpException = lift . handleHttpException
808+ getHttpConfig = lift getHttpConfig
809+
810+-- | @since 3.10.0
811+instance (MonadHttp m) => MonadHttp (ExceptT e m) where
812+ handleHttpException = lift . handleHttpException
813+ getHttpConfig = lift getHttpConfig
814+
815+-- | @since 3.10.0
816+instance (MonadHttp m) => MonadHttp (IdentityT m) where
817+ handleHttpException = lift . handleHttpException
818+ getHttpConfig = lift getHttpConfig
819+
820+-- | @since 3.10.0
821+instance (MonadHttp m) => MonadHttp (MaybeT m) where
822+ handleHttpException = lift . handleHttpException
823+ getHttpConfig = lift getHttpConfig
824+
825+-- | @since 3.10.0
826+instance (MonadHttp m) => MonadHttp (ReaderT r m) where
827+ handleHttpException = lift . handleHttpException
828+ getHttpConfig = lift getHttpConfig
829+
830+-- | @since 3.10.0
831+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.CPS.RWST r w s m) where
832+ handleHttpException = lift . handleHttpException
833+ getHttpConfig = lift getHttpConfig
834+
835+-- | @since 3.10.0
836+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Lazy.RWST r w s m) where
837+ handleHttpException = lift . handleHttpException
838+ getHttpConfig = lift getHttpConfig
839+
840+-- | @since 3.10.0
841+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
842+ handleHttpException = lift . handleHttpException
843+ getHttpConfig = lift getHttpConfig
844+
845+-- | @since 3.10.0
846+instance (MonadHttp m) => MonadHttp (SelectT r m) where
847+ handleHttpException = lift . handleHttpException
848+ getHttpConfig = lift getHttpConfig
849+
850+-- | @since 3.10.0
851+instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
852+ handleHttpException = lift . handleHttpException
853+ getHttpConfig = lift getHttpConfig
854+
855+-- | @since 3.10.0
856+instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
857+ handleHttpException = lift . handleHttpException
858+ getHttpConfig = lift getHttpConfig
859+
860+-- | @since 3.10.0
861+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.CPS.WriterT w m) where
862+ handleHttpException = lift . handleHttpException
863+ getHttpConfig = lift getHttpConfig
864+
865+-- | @since 3.10.0
866+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Lazy.WriterT w m) where
867+ handleHttpException = lift . handleHttpException
868+ getHttpConfig = lift getHttpConfig
869+
870+-- | @since 3.10.0
871+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
872+ handleHttpException = lift . handleHttpException
873+ getHttpConfig = lift getHttpConfig
874+
741875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
742−-- case of exceptional situation an 'HttpException' will be thrown.
876+-- the case of an exceptional situation an 'HttpException' will be thrown.
743877--
744878-- @since 0.4.0
745879runReq ::
746− MonadIO m =>
880+ (MonadIO m) =>
747881 -- | 'HttpConfig' to use
748882 HttpConfig ->
749883 -- | Computation to run
@@ -848,7 +982,7 @@ class HttpMethod a where
848982 -- | Return name of the method as a 'ByteString'.
849983 httpMethodName :: Proxy a -> ByteString
850984
851−instance HttpMethod method => RequestComponent (Womb "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
852986 getRequestMod _ = Endo $ \x ->
853987 x {L.method = httpMethodName (Proxy :: Proxy method)}
854988
@@ -890,23 +1024,20 @@ instance HttpMethod method => RequestComponent (Womb "method" method) where
8901024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
8911025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
8921026 -- NOTE The second value is the path segments in reversed order.
893− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
8941028
8951029type role Url nominal
8961030
8971031-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
898−-- the derived lift forgets the type of scheme.
899−instance Typeable scheme => TH.Lift (Url scheme) where
1032+-- the derived lift forgets the type of the scheme.
1033+instance (Typeable scheme) => TH.Lift (Url scheme) where
9001034 lift url =
9011035 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
9021036 Url Http _ -> [t|Url 'Http|]
9031037 Url Https _ -> [t|Url 'Https|]
9041038 where
9051039 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
906−
907−#if MIN_VERSION_template_haskell(2,16,0)
908− liftTyped url = TH.TExp <$> TH.lift url
909−#endif
1040+ liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
9101041
9111042-- | Given host name, produce a 'Url' which has “http” as its scheme and
9121043-- empty path. This also sets port to @80@.
@@ -918,14 +1049,14 @@ http = Url Http . pure
9181049https :: Text -> Url 'Https
9191050https = Url Https . pure
9201051
921−-- | Grow given 'Url' appending a single path segment to it. Note that the
1052+-- | Grow a given 'Url' appending a single path segment to it. Note that the
9221053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
9231054infixl 5 /~
9241055
925−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
9261057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
9271058
928−-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
1059+-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
9291060-- when next URL piece is a 'Data.Text.Text' literal.
9301061infixl 5 /:
9311062
@@ -958,8 +1089,7 @@ useHttpURI uri = do
9581089 urlHead <- http <$> uriHost uri
9591090 let url = case URI.uriPath uri of
9601091 Nothing -> urlHead
961− Just (_, xs) ->
962− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1092+ Just uriPath -> uriPathToUrl uriPath urlHead
9631093 return (url, uriOptions uri)
9641094
9651095-- | Just like 'useHttpURI', but expects the “https” scheme.
@@ -971,10 +1101,21 @@ useHttpsURI uri = do
9711101 urlHead <- https <$> uriHost uri
9721102 let url = case URI.uriPath uri of
9731103 Nothing -> urlHead
974− Just (_, xs) ->
975− foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1104+ Just uriPath -> uriPathToUrl uriPath urlHead
9761105 return (url, uriOptions uri)
9771106
1107+-- | Convert URI path to a 'Url'. Internal.
1108+--
1109+-- @since 3.9.0
1110+uriPathToUrl ::
1111+ (Bool, NonEmpty (URI.RText 'URI.PathPiece)) ->
1112+ Url scheme ->
1113+ Url scheme
1114+uriPathToUrl (trailingSlash, xs) urlHead =
1115+ if trailingSlash then path /: T.empty else path
1116+ where
1117+ path = foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1118+
9781119-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
9791120-- is not known in advance.
9801121--
@@ -1091,21 +1232,21 @@ data NoReqBody = NoReqBody
10911232instance HttpBody NoReqBody where
10921233 getRequestBody NoReqBody = L.RequestBodyBS B.empty
10931234
1094−-- | This body option allows to use a JSON object as request body—probably
1095−-- the most popular format right now. Just wrap a data type that is an
1096−-- instance of 'ToJSON' type class and you are done: it will be converted to
1097−-- JSON and inserted as request body.
1235+-- | This body option allows us to use a JSON object as the request
1236+-- body—probably the most popular format right now. Just wrap a data type
1237+-- that is an instance of 'ToJSON' type class and you are done: it will be
1238+-- converted to JSON and inserted as request body.
10981239--
10991240-- This body option sets the @Content-Type@ header to @\"application/json;
11001241-- charset=utf-8\"@ value.
11011242newtype ReqBodyJson a = ReqBodyJson a
11021243
1103−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
11041245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
11051246 getRequestContentType _ = pure "application/json; charset=utf-8"
11061247
11071248-- | This body option streams request body from a file. It is expected that
1108−-- the file size does not change during the streaming.
1249+-- the file size does not change during streaming.
11091250--
11101251-- Using of this body option does not set the @Content-Type@ header.
11111252newtype ReqBodyFile = ReqBodyFile FilePath
@@ -1130,12 +1271,11 @@ newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
11301271instance HttpBody ReqBodyLbs where
11311272 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
11321273
1133−-- | Form URL-encoded body. This can hold a collection of parameters which
1134−-- are encoded similarly to query parameters at the end of query string,
1135−-- with the only difference that they are stored in request body. The
1136−-- similarity is reflected in the API as well, as you can use the same
1137−-- combinators you would use to add query parameters: @('=:')@ and
1138−-- 'queryFlag'.
1274+-- | URL-encoded body. This can hold a collection of parameters which are
1275+-- encoded similarly to query parameters at the end of query string, with
1276+-- the only difference that they are stored in request body. The similarity
1277+-- is reflected in the API as well, as you can use the same combinators you
1278+-- would use to add query parameters: @('=:')@ and 'queryFlag'.
11391279--
11401280-- This body option sets the @Content-Type@ header to
11411281-- @\"application/x-www-form-urlencoded\"@ value.
@@ -1154,6 +1294,13 @@ newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
11541294instance QueryParam FormUrlEncodedParam where
11551295 queryParam name mvalue =
11561296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1297+ queryParamToList (FormUrlEncodedParam p) = p
1298+
1299+-- | Use 'formToQuery'.
1300+--
1301+-- @since 3.11.0
1302+instance FromForm FormUrlEncodedParam where
1303+ fromForm = Right . formToQuery
11571304
11581305-- | Multipart form data. Please consult the
11591306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1193,7 +1340,7 @@ instance HttpBody ReqBodyMultipart where
11931340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
11941341--
11951342-- @since 0.2.0
1196−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
11971344reqBodyMultipart parts = liftIO $ do
11981345 boundary <- LM.webkitBoundary
11991346 body <- LM.renderParts boundary parts
@@ -1221,9 +1368,6 @@ type family ProvidesBody body :: CanHaveBody where
12211368-- | This type function allows any HTTP body if method says it
12221369-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
12231370-- body option to use is 'NoReqBody'.
1224−--
1225−-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1226−-- error message when method does not allow a body and body is provided.
12271371type family
12281372 HttpBodyAllowed
12291373 (allowsBody :: CanHaveBody)
@@ -1236,8 +1380,8 @@ type family
12361380 TypeError
12371381 ('Text "This HTTP method does not allow attaching a request body.")
12381382
1239−instance HttpBody body => RequestComponent (Womb "body" body) where
1240− getRequestMod (Womb body) = Endo $ \x ->
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1384+ getRequestMod (Tagged body) = Endo $ \x ->
12411385 x
12421386 { L.requestBody = getRequestBody body,
12431387 L.requestHeaders =
@@ -1266,8 +1410,8 @@ data Option (scheme :: Scheme)
12661410 = Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
12671411
12681412-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1269−-- Request to avoid appending to existing query string in request every
1270−-- time new parameter is added. Additional Maybe (L.Request -> IO
1413+-- Request to avoid appending to an existing query string in request every
1414+-- time new parameter is added. The additional Maybe (L.Request -> IO
12711415-- L.Request) is a finalizer that will be applied after all other
12721416-- transformations. This is for authentication methods that sign requests
12731417-- based on data in Request.
@@ -1282,6 +1426,12 @@ instance Monoid (Option scheme) where
12821426 mempty = Option mempty Nothing
12831427 mappend = (<>)
12841428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
12851435-- | A helper to create an 'Option' that modifies only collection of query
12861436-- parameters. This helper is not a part of the public API.
12871437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
@@ -1300,7 +1450,7 @@ instance RequestComponent (Option scheme) where
13001450
13011451-- | Finalize given 'L.Request' by applying a finalizer from the given
13021452-- 'Option' (if it has any).
1303−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
13041454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
13051455
13061456----------------------------------------------------------------------------
@@ -1324,7 +1474,7 @@ infix 7 =:
13241474(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
13251475name =: value = queryParam name (pure value)
13261476
1327−-- | Construct a flag, that is, valueless query parameter. For example, in
1477+-- | Construct a flag, that is, a valueless query parameter. For example, in
13281478-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
13291479-- with a value:
13301480--
@@ -1333,9 +1483,27 @@ name =: value = queryParam name (pure value)
13331483-- This operator is defined in terms of 'queryParam':
13341484--
13351485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1336−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
13371487queryFlag name = queryParam name (Nothing :: Maybe ())
13381488
1489+-- | Construct query parameters from a 'ToForm' instance. This function
1490+-- produces the same query params as 'Form.urlEncodeAsFormStable'.
1491+--
1492+-- Note that 'Form.Form' doesn't have the concept of parameters with the
1493+-- empty value (i.e. what you can get by @key =: ""@). If the value is
1494+-- empty, it will be encoded as a valueless parameter (i.e. what you can get
1495+-- by @queryFlag key@).
1496+--
1497+-- @since 3.11.0
1498+formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param
1499+formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1500+ where
1501+ toParam (key, val) =
1502+ queryParam key $
1503+ if val == ""
1504+ then Nothing
1505+ else Just val
1506+
13391507-- | A type class for query-parameter-like things. The reason to have an
13401508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
13411509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
@@ -1345,11 +1513,17 @@ class QueryParam param where
13451513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
13461514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
13471515 -- method, because they are easier to read.
1348− queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
1517+
1518+ -- | Get the query parameter names and values set by 'queryParam'.
1519+ --
1520+ -- @since 3.11.0
1521+ queryParamToList :: param -> [(Text, Maybe Text)]
13491522
13501523instance QueryParam (Option scheme) where
13511524 queryParam name mvalue =
13521525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
13531527
13541528----------------------------------------------------------------------------
13551529-- Request—Optional parameters—Headers
@@ -1373,6 +1547,14 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
13731547attachHeader name value x =
13741548 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
13751549
1550+-- | Same as 'header', but with redacted values on print.
1551+--
1552+-- @since 3.13.0
1553+headerRedacted :: ByteString -> ByteString -> Option scheme
1554+headerRedacted name value = withRequest $ \x ->
1555+ let y = attachHeader name value x
1556+ in y {L.redactHeaders = CI.mk name `S.insert` L.redactHeaders y}
1557+
13761558----------------------------------------------------------------------------
13771559-- Request—Optional parameters—Cookies
13781560
@@ -1514,7 +1696,7 @@ customAuth = Option mempty . pure
15141696
15151697-- | Specify the port to connect to explicitly. Normally, 'Url' you use
15161698-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1517−-- 'Option' allows to choose an arbitrary port overwriting the defaults.
1699+-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
15181700port :: Int -> Option scheme
15191701port n = withRequest $ \x ->
15201702 x {L.port = n}
@@ -1529,8 +1711,8 @@ port n = withRequest $ \x ->
15291711--
15301712-- > decompress (const True)
15311713decompress ::
1532− -- | Predicate that is given MIME type, it
1533− -- returns 'True' when content should be decompressed on the fly.
1714+ -- | Predicate that is given MIME type, it returns 'True' when content
1715+ -- should be decompressed on the fly.
15341716 (ByteString -> Bool) ->
15351717 Option scheme
15361718decompress f = withRequest $ \x ->
@@ -1580,7 +1762,7 @@ ignoreResponse = Proxy
15801762newtype JsonResponse a = JsonResponse (L.Response a)
15811763 deriving (Show)
15821764
1583−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
15841766 type HttpResponseBody (JsonResponse a) = a
15851767 toVanillaResponse (JsonResponse r) = r
15861768 getHttpResponse r = do
@@ -1632,7 +1814,7 @@ lbsResponse = Proxy
16321814----------------------------------------------------------------------------
16331815-- Helpers for response interpretations
16341816
1635−-- | Fetch beginning of response and return it together with new
1817+-- | Fetch beginning of the response and return it together with a new
16361818-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
16371819-- such.
16381820grabPreview ::
@@ -1696,14 +1878,14 @@ brReadN br n = go 0 id id
16961878
16971879-- | Get the response body.
16981880responseBody ::
1699− HttpResponse response =>
1881+ (HttpResponse response) =>
17001882 response ->
17011883 HttpResponseBody response
17021884responseBody = L.responseBody . toVanillaResponse
17031885
17041886-- | Get the response status code.
17051887responseStatusCode ::
1706− HttpResponse response =>
1888+ (HttpResponse response) =>
17071889 response ->
17081890 Int
17091891responseStatusCode =
@@ -1711,7 +1893,7 @@ responseStatusCode =
17111893
17121894-- | Get the response status message.
17131895responseStatusMessage ::
1714− HttpResponse response =>
1896+ (HttpResponse response) =>
17151897 response ->
17161898 ByteString
17171899responseStatusMessage =
@@ -1719,7 +1901,7 @@ responseStatusMessage =
17191901
17201902-- | Lookup a particular header from a response.
17211903responseHeader ::
1722− HttpResponse response =>
1904+ (HttpResponse response) =>
17231905 -- | Response interpretation
17241906 response ->
17251907 -- | Header to lookup
@@ -1731,7 +1913,7 @@ responseHeader r h =
17311913
17321914-- | Get the response 'L.CookieJar'.
17331915responseCookieJar ::
1734− HttpResponse response =>
1916+ (HttpResponse response) =>
17351917 response ->
17361918 L.CookieJar
17371919responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -1744,9 +1926,9 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
17441926-- To create a new response interpretation you just need to make your data
17451927-- type an instance of the 'HttpResponse' type class.
17461928
1747−-- | A type class for response interpretations. It allows to describe how to
1748−-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1749−-- final result that is to be returned to the user.
1929+-- | A type class for response interpretations. It allows us to describe how
1930+-- to consume the response from a @'L.Response' 'L.BodyReader'@ and produce
1931+-- the final result that is to be returned to the user.
17501932class HttpResponse response where
17511933 -- | The associated type is the type of body that can be extracted from an
17521934 -- instance of 'HttpResponse'.
@@ -1785,6 +1967,16 @@ class HttpResponse response where
17851967 acceptHeader :: Proxy response -> Maybe ByteString
17861968 acceptHeader Proxy = Nothing
17871969
1970+-- | This instance has been added to make it easier to inspect 'L.Response'
1971+-- using Req's functions like 'responseStatusCode', 'responseStatusMessage',
1972+-- etc.
1973+--
1974+-- @since 3.12.0
1975+instance HttpResponse (L.Response ()) where
1976+ type HttpResponseBody (L.Response ()) = ()
1977+ toVanillaResponse = id
1978+ getHttpResponse = return . void
1979+
17881980----------------------------------------------------------------------------
17891981-- Other
17901982
@@ -1810,7 +2002,7 @@ class RequestComponent a where
18102002-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
18112003-- which instance to use (i.e. the constraints are taken into account later,
18122004-- when instance is already chosen).
1813−newtype Womb (tag :: Symbol) a = Womb a
2005+newtype Tagged (tag :: Symbol) a = Tagged a
18142006
18152007-- | Exceptions that this library throws.
18162008data HttpException
@@ -1819,10 +2011,24 @@ data HttpException
18192011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
18202012 -- failed
18212013 JsonHttpException String
1822− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
18232015
18242016instance Exception HttpException
18252017
2018+-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
2019+-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
2020+--
2021+-- @since 3.12.0
2022+isStatusCodeException :: HttpException -> Maybe (L.Response ())
2023+isStatusCodeException
2024+ ( VanillaHttpException
2025+ ( L.HttpExceptionRequest
2026+ _
2027+ (L.StatusCodeException r _)
2028+ )
2029+ ) = Just r
2030+isStatusCodeException _ = Nothing
2031+
18262032-- | A simple type isomorphic to 'Bool' that we only have for better error
18272033-- messages. We use it as a kind and its data constructors as type-level
18282034-- tags.
@@ -1842,11 +2048,4 @@ data Scheme
18422048 Http
18432049 | -- | HTTPS
18442050 Https
1845− deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)
1846−
1847−----------------------------------------------------------------------------
1848−-- Constants
1849−
1850−-- | Max length of preview fragment of response body.
1851−bodyPreviewLength :: Num a => a
1852−bodyPreviewLength = 1024
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)