@@ -1,20 +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 #-}
17−{-# LANGUAGE StandaloneDeriving #-}
187{-# LANGUAGE TemplateHaskellQuotes #-}
198{-# LANGUAGE TypeFamilies #-}
209{-# LANGUAGE UndecidableInstances #-}
@@ -161,6 +150,7 @@ module Network.HTTP.Req
161150 -- *** Headers
162151 header,
163152 attachHeader,
153+ headerRedacted,
164154
165155 -- *** Cookies
166156 -- $cookies
@@ -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,54 +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 (..))
249+import Data.Set qualified as S
258250import Data.Text (Text)
259−import qualified Data.Text as T
260−import qualified Data.Text.Encoding as T
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
261253import Data.Typeable (Typeable, cast)
262254import GHC.Generics
263255import GHC.TypeLits
264−import qualified Language.Haskell.TH as TH
265−import qualified Language.Haskell.TH.Quote as TH
266−import qualified Language.Haskell.TH.Syntax as TH
267−import qualified Network.Connection as NC
268−import qualified Network.HTTP.Client as L
269−import qualified Network.HTTP.Client.Internal as LI
270−import qualified Network.HTTP.Client.MultipartFormData as LM
271−import qualified Network.HTTP.Client.TLS as L
272−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
273265import System.IO.Unsafe (unsafePerformIO)
274266import Text.URI (URI)
275−import qualified Text.URI as URI
276−import qualified Text.URI.QQ as QQ
277−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
278270import Web.FormUrlEncoded (FromForm (..), ToForm (..))
279−import qualified Web.FormUrlEncoded as Form
271+import Web.FormUrlEncoded qualified as Form
280272import Web.HttpApiData (ToHttpApiData (..))
281273
282274----------------------------------------------------------------------------
@@ -497,7 +489,7 @@ reqCb method url body responseProxy options adjustRequest =
497489--
498490-- @since 3.7.0
499491reqHandler ::
500− MonadHttp m =>
492+ (MonadHttp m) =>
501493 -- | How to get final result from a 'L.Response'
502494 (L.Response L.BodyReader -> IO b) ->
503495 -- | 'L.Request' to perform
@@ -593,10 +585,10 @@ req' method url body options m = do
593585 withReqManager (m request)
594586
595587-- | Perform an action using the global implicit 'L.Manager' that the rest
596−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
597589-- 'L.Manager' controls.
598−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
599−withReqManager m = liftIO (readIORef globalManager) >>= m
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
600592
601593-- | The global 'L.Manager' that 'req' uses. Here we just go with the
602594-- default settings, so users don't need to deal with this manager stuff at
@@ -609,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
609601-- manager. From that moment on the 'IORef' will be just reused—exactly the
610602-- behavior we want here in order to maximize connection sharing. GHC could
611603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
612−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
613605globalManager = unsafePerformIO $ do
614606 context <- NC.initConnectionContext
615607 let settings =
616608 L.mkManagerSettingsContext
617609 (Just context)
618− (NC.TLSSettingsSimple False False False)
610+ def
619611 Nothing
620612 manager <- L.newManager settings
621− newIORef manager
613+ return manager
622614{-# NOINLINE globalManager #-}
623615
624616----------------------------------------------------------------------------
@@ -638,7 +630,7 @@ globalManager = unsafePerformIO $ do
638630-- | A type class for monads that support performing HTTP requests.
639631-- Typically, you only need to define the 'handleHttpException' method
640632-- unless you want to tweak 'HttpConfig'.
641−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
642634 -- | This method describes how to deal with 'HttpException' that was
643635 -- caught by the library. One option is to re-throw it if you are OK with
644636 -- exceptions, but if you prefer working with something like
@@ -722,9 +714,8 @@ data HttpConfig = HttpConfig
722714 -- | Max length of preview fragment of response body.
723715 --
724716 -- @since 3.6.0
725− httpConfigBodyPreviewLength :: forall a. Num a => a
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
726718 }
727− deriving (Typeable)
728719
729720-- | The default value of 'HttpConfig'.
730721--
@@ -812,27 +803,27 @@ instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
812803 getHttpConfig = lift getHttpConfig
813804
814805-- | @since 3.10.0
815−instance MonadHttp m => MonadHttp (ContT r m) where
806+instance (MonadHttp m) => MonadHttp (ContT r m) where
816807 handleHttpException = lift . handleHttpException
817808 getHttpConfig = lift getHttpConfig
818809
819810-- | @since 3.10.0
820−instance MonadHttp m => MonadHttp (ExceptT e m) where
811+instance (MonadHttp m) => MonadHttp (ExceptT e m) where
821812 handleHttpException = lift . handleHttpException
822813 getHttpConfig = lift getHttpConfig
823814
824815-- | @since 3.10.0
825−instance MonadHttp m => MonadHttp (IdentityT m) where
816+instance (MonadHttp m) => MonadHttp (IdentityT m) where
826817 handleHttpException = lift . handleHttpException
827818 getHttpConfig = lift getHttpConfig
828819
829820-- | @since 3.10.0
830−instance MonadHttp m => MonadHttp (MaybeT m) where
821+instance (MonadHttp m) => MonadHttp (MaybeT m) where
831822 handleHttpException = lift . handleHttpException
832823 getHttpConfig = lift getHttpConfig
833824
834825-- | @since 3.10.0
835−instance MonadHttp m => MonadHttp (ReaderT r m) where
826+instance (MonadHttp m) => MonadHttp (ReaderT r m) where
836827 handleHttpException = lift . handleHttpException
837828 getHttpConfig = lift getHttpConfig
838829
@@ -852,17 +843,17 @@ instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
852843 getHttpConfig = lift getHttpConfig
853844
854845-- | @since 3.10.0
855−instance MonadHttp m => MonadHttp (SelectT r m) where
846+instance (MonadHttp m) => MonadHttp (SelectT r m) where
856847 handleHttpException = lift . handleHttpException
857848 getHttpConfig = lift getHttpConfig
858849
859850-- | @since 3.10.0
860−instance MonadHttp m => MonadHttp (State.Lazy.StateT s m) where
851+instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
861852 handleHttpException = lift . handleHttpException
862853 getHttpConfig = lift getHttpConfig
863854
864855-- | @since 3.10.0
865−instance MonadHttp m => MonadHttp (State.Strict.StateT s m) where
856+instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
866857 handleHttpException = lift . handleHttpException
867858 getHttpConfig = lift getHttpConfig
868859
@@ -886,7 +877,7 @@ instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
886877--
887878-- @since 0.4.0
888879runReq ::
889− MonadIO m =>
880+ (MonadIO m) =>
890881 -- | 'HttpConfig' to use
891882 HttpConfig ->
892883 -- | Computation to run
@@ -991,7 +982,7 @@ class HttpMethod a where
991982 -- | Return name of the method as a 'ByteString'.
992983 httpMethodName :: Proxy a -> ByteString
993984
994−instance HttpMethod method => RequestComponent (Tagged "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
995986 getRequestMod _ = Endo $ \x ->
996987 x {L.method = httpMethodName (Proxy :: Proxy method)}
997988
@@ -1033,25 +1024,20 @@ instance HttpMethod method => RequestComponent (Tagged "method" method) where
10331024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
10341025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
10351026 -- NOTE The second value is the path segments in reversed order.
1036− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
10371028
10381029type role Url nominal
10391030
10401031-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
10411032-- the derived lift forgets the type of the scheme.
1042−instance Typeable scheme => TH.Lift (Url scheme) where
1033+instance (Typeable scheme) => TH.Lift (Url scheme) where
10431034 lift url =
10441035 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
10451036 Url Http _ -> [t|Url 'Http|]
10461037 Url Https _ -> [t|Url 'Https|]
10471038 where
10481039 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1049−
1050−#if MIN_VERSION_template_haskell(2,17,0)
10511040 liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
1052−#elif MIN_VERSION_template_haskell(2,16,0)
1053− liftTyped = TH.unsafeTExpCoerce . TH.lift
1054−#endif
10551041
10561042-- | Given host name, produce a 'Url' which has “http” as its scheme and
10571043-- empty path. This also sets port to @80@.
@@ -1067,7 +1053,7 @@ https = Url Https . pure
10671053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
10681054infixl 5 /~
10691055
1070−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
10711057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
10721058
10731059-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
@@ -1255,7 +1241,7 @@ instance HttpBody NoReqBody where
12551241-- charset=utf-8\"@ value.
12561242newtype ReqBodyJson a = ReqBodyJson a
12571243
1258−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
12591245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
12601246 getRequestContentType _ = pure "application/json; charset=utf-8"
12611247
@@ -1354,7 +1340,7 @@ instance HttpBody ReqBodyMultipart where
13541340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
13551341--
13561342-- @since 0.2.0
1357−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
13581344reqBodyMultipart parts = liftIO $ do
13591345 boundary <- LM.webkitBoundary
13601346 body <- LM.renderParts boundary parts
@@ -1394,7 +1380,7 @@ type family
13941380 TypeError
13951381 ('Text "This HTTP method does not allow attaching a request body.")
13961382
1397−instance HttpBody body => RequestComponent (Tagged "body" body) where
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
13981384 getRequestMod (Tagged body) = Endo $ \x ->
13991385 x
14001386 { L.requestBody = getRequestBody body,
@@ -1464,7 +1450,7 @@ instance RequestComponent (Option scheme) where
14641450
14651451-- | Finalize given 'L.Request' by applying a finalizer from the given
14661452-- 'Option' (if it has any).
1467−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
14681454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
14691455
14701456----------------------------------------------------------------------------
@@ -1497,7 +1483,7 @@ name =: value = queryParam name (pure value)
14971483-- This operator is defined in terms of 'queryParam':
14981484--
14991485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1500−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
15011487queryFlag name = queryParam name (Nothing :: Maybe ())
15021488
15031489-- | Construct query parameters from a 'ToForm' instance. This function
@@ -1527,7 +1513,7 @@ class QueryParam param where
15271513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
15281514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
15291515 -- method, because they are easier to read.
1530− queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
15311517
15321518 -- | Get the query parameter names and values set by 'queryParam'.
15331519 --
@@ -1561,6 +1547,14 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
15611547attachHeader name value x =
15621548 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
15631549
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+
15641558----------------------------------------------------------------------------
15651559-- Request—Optional parameters—Cookies
15661560
@@ -1768,7 +1762,7 @@ ignoreResponse = Proxy
17681762newtype JsonResponse a = JsonResponse (L.Response a)
17691763 deriving (Show)
17701764
1771−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
17721766 type HttpResponseBody (JsonResponse a) = a
17731767 toVanillaResponse (JsonResponse r) = r
17741768 getHttpResponse r = do
@@ -1884,14 +1878,14 @@ brReadN br n = go 0 id id
18841878
18851879-- | Get the response body.
18861880responseBody ::
1887− HttpResponse response =>
1881+ (HttpResponse response) =>
18881882 response ->
18891883 HttpResponseBody response
18901884responseBody = L.responseBody . toVanillaResponse
18911885
18921886-- | Get the response status code.
18931887responseStatusCode ::
1894− HttpResponse response =>
1888+ (HttpResponse response) =>
18951889 response ->
18961890 Int
18971891responseStatusCode =
@@ -1899,7 +1893,7 @@ responseStatusCode =
18991893
19001894-- | Get the response status message.
19011895responseStatusMessage ::
1902− HttpResponse response =>
1896+ (HttpResponse response) =>
19031897 response ->
19041898 ByteString
19051899responseStatusMessage =
@@ -1907,7 +1901,7 @@ responseStatusMessage =
19071901
19081902-- | Lookup a particular header from a response.
19091903responseHeader ::
1910− HttpResponse response =>
1904+ (HttpResponse response) =>
19111905 -- | Response interpretation
19121906 response ->
19131907 -- | Header to lookup
@@ -1919,7 +1913,7 @@ responseHeader r h =
19191913
19201914-- | Get the response 'L.CookieJar'.
19211915responseCookieJar ::
1922− HttpResponse response =>
1916+ (HttpResponse response) =>
19231917 response ->
19241918 L.CookieJar
19251919responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -2017,7 +2011,7 @@ data HttpException
20172011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
20182012 -- failed
20192013 JsonHttpException String
2020− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
20212015
20222016instance Exception HttpException
20232017
@@ -2054,4 +2048,4 @@ data Scheme
20542048 Http
20552049 | -- | HTTPS
20562050 Https
2057− deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)