remove original request from Response

Deliver it instead by way of the Manager's response modifier.

See #464

This patch accomplishes the same thing as that one in essentially the
same way, but improves upon it by not requiring a request to exist in
order to construct a response. This can be useful in e.g. testing /
mocking definitions in which we want to express a base fixed response.
In other wrods, it is "less breaky" and easier to adopt.

Author: avieth

http-client/Network/HTTP/Client.hs

@@ -181,7 +181,6 @@ module Network.HTTP.Client
     , responseHeaders
     , responseBody
     , responseCookieJar
-    , getOriginalRequest
     , throwErrorStatusCodes
       -- ** Response body
     , BodyReader

http-client/Network/HTTP/Client/Core.hs

@@ -206,7 +206,7 @@ responseOpen inputReq manager' = do
   wrapExc req0 $ mWrapException manager req0 $ do
     (req, res) <- go manager (redirectCount req0) req0
     checkResponse req req res
-    mModifyResponse manager res
+    mModifyResponse manager (req { requestBody = "" }) res
         { responseBody = wrapExc req0 (responseBody res)
         }
   where

http-client/Network/HTTP/Client/Manager.hs

@@ -89,7 +89,7 @@ defaultManagerSettings = ManagerSettings
          in handle wrapper
     , managerIdleConnectionCount = 512
     , managerModifyRequest = return
-    , managerModifyResponse = return
+    , managerModifyResponse = const return
     , managerProxyInsecure = defaultProxy
     , managerProxySecure = defaultProxy
     }

http-client/Network/HTTP/Client/Response.hs

@@ -4,7 +4,6 @@ module Network.HTTP.Client.Response
     ( getRedirectedRequest
     , getResponse
     , lbsResponse
-    , getOriginalRequest
     ) where
 
 import Data.ByteString (ByteString)
@@ -124,7 +123,6 @@ getResponse timeout' req@(Request {..}) mconn cont = do
         , responseBody = body
         , responseCookieJar = Data.Monoid.mempty
         , responseClose' = ResponseClose (cleanup False)
-        , responseOriginalRequest = req {requestBody = ""}
         }
 
 -- | Does this response have no body?
@@ -135,11 +133,3 @@ hasNoBody "HEAD" _ = True
 hasNoBody _ 204 = True
 hasNoBody _ 304 = True
 hasNoBody _ i = 100 <= i && i < 200
-
--- | Retrieve the orignal 'Request' from a 'Response'
---
--- Note that the 'requestBody' is not available and always set to empty.
---
--- @since 0.7.8
-getOriginalRequest :: Response a -> Request
-getOriginalRequest = responseOriginalRequest

http-client/Network/HTTP/Client/Types.hs

@@ -693,12 +693,6 @@ data Response body = Response
     -- be impossible.
     --
     -- Since 0.1.0
-    , responseOriginalRequest :: Request
-    -- ^ Holds original @Request@ related to this @Response@ (with an empty body).
-    -- This field is intentionally not exported directly, but made availble
-    -- via @getOriginalRequest@ instead.
-    --
-    -- Since 0.7.8
     }
     deriving (Show, T.Typeable, Functor, Data.Foldable.Foldable, Data.Traversable.Traversable)
 
@@ -776,9 +770,12 @@ data ManagerSettings = ManagerSettings
     -- Default: no modification
     --
     -- Since 0.4.4
-    , managerModifyResponse :: Response BodyReader -> IO (Response BodyReader)
+    , managerModifyResponse :: Request -> Response BodyReader -> IO (Response BodyReader)
     -- ^ Perform the given modification to a @Response@ after receiving it.
     --
+    -- The Request is the corresponding original request (before any redirects)
+    -- but its body is always discarded.
+    --
     -- Default: no modification
     --
     -- @since 0.5.5
@@ -818,7 +815,7 @@ data Manager = Manager
     , mWrapException :: forall a. Request -> IO a -> IO a
     , mModifyRequest :: Request -> IO Request
     , mSetProxy :: Request -> Request
-    , mModifyResponse      :: Response BodyReader -> IO (Response BodyReader)
+    , mModifyResponse :: Request -> Response BodyReader -> IO (Response BodyReader)
     -- ^ See 'managerProxy'
     }
     deriving T.Typeable

http-client/test/Network/HTTP/ClientSpec.hs

@@ -63,8 +63,8 @@ spec = describe "Client" $ do
 
     context "managerModifyResponse" $ do
       it "allows to modify the response status code" $ do
-        let modify :: Response BodyReader -> IO (Response BodyReader)
-            modify res = do
+        let modify :: Request -> Response BodyReader -> IO (Response BodyReader)
+            modify _req res = do
               return res {
                 responseStatus = (responseStatus res) {
                   statusCode = 201
@@ -76,8 +76,8 @@ spec = describe "Client" $ do
         (statusCode.responseStatus) res `shouldBe` 201
 
       it "modifies the response body" $ do
-        let modify :: Response BodyReader -> IO (Response BodyReader)
-            modify res = do
+        let modify :: Request -> Response BodyReader -> IO (Response BodyReader)
+            modify _req res = do
               reader <- constBodyReader [BS.pack "modified response body"]
               return res {
                 responseBody = reader