Merge pull request #1131 from phadej/error-renaming

Rename ServantError to ClientError, ServantErr to ServerError

Author: phadej

.travis.yml

@@ -87,9 +87,7 @@ install:
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/db-sqlite-simple\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/file-upload\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/generic\"\\n' >> cabal.project ; fi"
-  - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/hoist-server-with-context\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/https\"\\n' >> cabal.project ; fi"
-  - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/jwt-and-basic-auth\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/testing\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/structuring-apis\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"doc/cookbook/using-custom-monad\"\\n' >> cabal.project ; fi"
@@ -106,7 +104,7 @@ install:
   - "echo 'reorder-goals: True' >> cabal.project"
   - "echo 'optimization: False' >> cabal.project "
   - touch cabal.project.local
-  - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | grep -vE -- '^(cookbook-basic-auth|cookbook-basic-streaming|cookbook-curl-mock|cookbook-db-postgres-pool|cookbook-db-sqlite-simple|cookbook-file-upload|cookbook-generic|cookbook-hoist-server-with-context|cookbook-https|cookbook-jwt-and-basic-auth|cookbook-structuring-apis|cookbook-testing|cookbook-using-custom-monad|cookbook-using-free-client|servant|servant-client|servant-client-core|servant-conduit|servant-docs|servant-foreign|servant-http-streams|servant-machines|servant-pipes|servant-server|tutorial)$' | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
+  - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | grep -vE -- '^(cookbook-basic-auth|cookbook-basic-streaming|cookbook-curl-mock|cookbook-db-postgres-pool|cookbook-db-sqlite-simple|cookbook-file-upload|cookbook-generic|cookbook-https|cookbook-structuring-apis|cookbook-testing|cookbook-using-custom-monad|cookbook-using-free-client|servant|servant-client|servant-client-core|servant-conduit|servant-docs|servant-foreign|servant-http-streams|servant-machines|servant-pipes|servant-server|tutorial)$' | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
   - cat cabal.project || true
   - cat cabal.project.local || true
   - if [ -f "servant/configure.ac" ]; then (cd "servant" && autoreconf -i); fi
@@ -127,15 +125,13 @@ install:
   - if [ -f "doc/cookbook/db-sqlite-simple/configure.ac" ]; then (cd "doc/cookbook/db-sqlite-simple" && autoreconf -i); fi
   - if [ -f "doc/cookbook/file-upload/configure.ac" ]; then (cd "doc/cookbook/file-upload" && autoreconf -i); fi
   - if [ -f "doc/cookbook/generic/configure.ac" ]; then (cd "doc/cookbook/generic" && autoreconf -i); fi
-  - if [ -f "doc/cookbook/hoist-server-with-context/configure.ac" ]; then (cd "doc/cookbook/hoist-server-with-context" && autoreconf -i); fi
   - if [ -f "doc/cookbook/https/configure.ac" ]; then (cd "doc/cookbook/https" && autoreconf -i); fi
-  - if [ -f "doc/cookbook/jwt-and-basic-auth/configure.ac" ]; then (cd "doc/cookbook/jwt-and-basic-auth" && autoreconf -i); fi
   - if [ -f "doc/cookbook/testing/configure.ac" ]; then (cd "doc/cookbook/testing" && autoreconf -i); fi
   - if [ -f "doc/cookbook/structuring-apis/configure.ac" ]; then (cd "doc/cookbook/structuring-apis" && autoreconf -i); fi
   - if [ -f "doc/cookbook/using-custom-monad/configure.ac" ]; then (cd "doc/cookbook/using-custom-monad" && autoreconf -i); fi
   - if [ -f "doc/cookbook/using-free-client/configure.ac" ]; then (cd "doc/cookbook/using-free-client" && autoreconf -i); fi
   - rm -f cabal.project.freeze
-  - rm -rf .ghc.environment.* "servant"/dist "servant-client"/dist "servant-client-core"/dist "servant-http-streams"/dist "servant-docs"/dist "servant-foreign"/dist "servant-server"/dist "doc/tutorial"/dist "servant-machines"/dist "servant-conduit"/dist "servant-pipes"/dist "doc/cookbook/basic-auth"/dist "doc/cookbook/curl-mock"/dist "doc/cookbook/basic-streaming"/dist "doc/cookbook/db-postgres-pool"/dist "doc/cookbook/db-sqlite-simple"/dist "doc/cookbook/file-upload"/dist "doc/cookbook/generic"/dist "doc/cookbook/hoist-server-with-context"/dist "doc/cookbook/https"/dist "doc/cookbook/jwt-and-basic-auth"/dist "doc/cookbook/testing"/dist "doc/cookbook/structuring-apis"/dist "doc/cookbook/using-custom-monad"/dist "doc/cookbook/using-free-client"/dist
+  - rm -rf .ghc.environment.* "servant"/dist "servant-client"/dist "servant-client-core"/dist "servant-http-streams"/dist "servant-docs"/dist "servant-foreign"/dist "servant-server"/dist "doc/tutorial"/dist "servant-machines"/dist "servant-conduit"/dist "servant-pipes"/dist "doc/cookbook/basic-auth"/dist "doc/cookbook/curl-mock"/dist "doc/cookbook/basic-streaming"/dist "doc/cookbook/db-postgres-pool"/dist "doc/cookbook/db-sqlite-simple"/dist "doc/cookbook/file-upload"/dist "doc/cookbook/generic"/dist "doc/cookbook/https"/dist "doc/cookbook/testing"/dist "doc/cookbook/structuring-apis"/dist "doc/cookbook/using-custom-monad"/dist "doc/cookbook/using-free-client"/dist
   - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)
 
 # Here starts the actual work to be performed for the package under test;
@@ -169,9 +165,7 @@ script:
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-db-sqlite-simple-*/*.cabal\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-file-upload-*/*.cabal\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-generic-*/*.cabal\"\\n' >> cabal.project ; fi"
-  - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-hoist-server-with-context-*/*.cabal\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-https-*/*.cabal\"\\n' >> cabal.project ; fi"
-  - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-jwt-and-basic-auth-*/*.cabal\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-testing-*/*.cabal\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-structuring-apis-*/*.cabal\"\\n' >> cabal.project ; fi"
   - "if [ $HCNUMVER -eq 80404 ]  ||  [ $HCNUMVER -eq 80603 ] ; then printf 'packages: \"cookbook-using-custom-monad-*/*.cabal\"\\n' >> cabal.project ; fi"
@@ -188,7 +182,7 @@ script:
   - "echo 'reorder-goals: True' >> cabal.project"
   - "echo 'optimization: False' >> cabal.project "
   - touch cabal.project.local
-  - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | grep -vE -- '^(cookbook-basic-auth|cookbook-basic-streaming|cookbook-curl-mock|cookbook-db-postgres-pool|cookbook-db-sqlite-simple|cookbook-file-upload|cookbook-generic|cookbook-hoist-server-with-context|cookbook-https|cookbook-jwt-and-basic-auth|cookbook-structuring-apis|cookbook-testing|cookbook-using-custom-monad|cookbook-using-free-client|servant|servant-client|servant-client-core|servant-conduit|servant-docs|servant-foreign|servant-http-streams|servant-machines|servant-pipes|servant-server|tutorial)$' | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
+  - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | grep -vE -- '^(cookbook-basic-auth|cookbook-basic-streaming|cookbook-curl-mock|cookbook-db-postgres-pool|cookbook-db-sqlite-simple|cookbook-file-upload|cookbook-generic|cookbook-https|cookbook-structuring-apis|cookbook-testing|cookbook-using-custom-monad|cookbook-using-free-client|servant|servant-client|servant-client-core|servant-conduit|servant-docs|servant-foreign|servant-http-streams|servant-machines|servant-pipes|servant-server|tutorial)$' | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
   - cat cabal.project || true
   - cat cabal.project.local || true
   - echo -en 'travis_fold:end:unpack\\r'

cabal.project

@@ -21,11 +21,11 @@ packages:
   doc/cookbook/db-sqlite-simple
   doc/cookbook/file-upload
   doc/cookbook/generic
-  doc/cookbook/hoist-server-with-context
+  -- doc/cookbook/hoist-server-with-context
   doc/cookbook/https
-  doc/cookbook/jwt-and-basic-auth/
+  -- doc/cookbook/jwt-and-basic-auth/
   -- doc/cookbook/pagination
-  --  doc/cookbook/sentry
+  -- doc/cookbook/sentry
   doc/cookbook/testing
   doc/cookbook/structuring-apis
   doc/cookbook/using-custom-monad

doc/cookbook/testing/Testing.lhs

@@ -234,7 +234,7 @@ clientEnv esHost esPort = do
   manager <- newManager defaultManagerSettings
   pure $ mkClientEnv manager baseUrl
 
-runSearchClient :: Text -> Text -> ClientM a -> IO (Either ServantError a)
+runSearchClient :: Text -> Text -> ClientM a -> IO (Either ClientError a)
 runSearchClient esHost esPort = (clientEnv esHost esPort >>=) . runClientM
 ```
 
@@ -267,7 +267,7 @@ docServer esHost esPort = getDocById esHost esPort
 -- actions
 getDocById :: Text -> Text -> Integer -> Handler Value
 getDocById esHost esPort docId = do
-  -- Our Servant Client function returns Either ServantError Value here:
+  -- Our Servant Client function returns Either ClientError Value here:
   docRes <- liftIO $ runSearchClient esHost esPort (getDocument docId)
   case docRes of
     Left err -> throwError $ err404 { errBody = "Failed looking up content" }

doc/tutorial/Server.lhs

@@ -599,7 +599,7 @@ $ curl -H 'Accept: text/html' http://localhost:8081/persons
 
 ## The `Handler` monad
 
-At the heart of the handlers is the monad they run in, namely a newtype `Handler` around `ExceptT ServantErr IO`
+At the heart of the handlers is the monad they run in, namely a newtype `Handler` around `ExceptT ServerErroror IO`
 ([haddock documentation for `ExceptT`](http://hackage.haskell.org/package/mtl-2.2.1/docs/Control-Monad-Except.html#t:ExceptT)).
 One might wonder: why this monad? The answer is that it is the
 simplest monad with the following properties:
@@ -617,7 +617,7 @@ newtype ExceptT e m a = ExceptT (m (Either e a))
 ```
 
 In short, this means that a handler of type `Handler a` is simply
-equivalent to a computation of type `IO (Either ServantErr a)`, that is, an IO
+equivalent to a computation of type `IO (Either ServerError a)`, that is, an IO
 action that either returns an error or a result.
 
 The module [`Control.Monad.Except`](https://hackage.haskell.org/package/mtl-2.2.1/docs/Control-Monad-Except.html#t:ExceptT)
@@ -660,16 +660,16 @@ server5 = do
   return (FileContent filecontent)
 ```
 
-### Failing, through `ServantErr`
+### Failing, through `ServerError`
 
 If you want to explicitly fail at providing the result promised by an endpoint
 using the appropriate HTTP status code (not found, unauthorized, etc) and some
 error message, all you have to do is use the `throwError` function mentioned above
-and provide it with the appropriate value of type `ServantErr`, which is
+and provide it with the appropriate value of type `ServerError`, which is
 defined as:
 
 ``` haskell ignore
-data ServantErr = ServantErr
+data ServerError = ServerError
     { errHTTPCode     :: Int
     , errReasonPhrase :: String
     , errBody         :: ByteString -- lazy bytestring
@@ -685,7 +685,7 @@ use record update syntax:
 failingHandler :: Handler ()
 failingHandler = throwError myerr
 
-  where myerr :: ServantErr
+  where myerr :: ServerError
         myerr = err503 { errBody = "Sorry dear user." }
 ```
 

servant-client-core/src/Servant/Client/Core.hs

@@ -32,7 +32,7 @@ module Servant.Client.Core
   , AuthClientData
 
   -- * Generic Client
-  , ServantError(..)
+  , ClientError(..)
   , EmptyClient(..)
 
   -- * Response

servant-client-core/src/Servant/Client/Core/ClientError.hs

@@ -9,7 +9,7 @@
 {-# LANGUAGE ScopedTypeVariables   #-}
 {-# LANGUAGE TypeFamilies          #-}
 module Servant.Client.Core.ClientError (
-    ServantError (..),
+    ClientError (..),
     ) where
 
 import           Prelude ()
@@ -42,7 +42,7 @@ import           Servant.Client.Core.Response
 -- | A type representing possible errors in a request
 --
 -- Note that this type substantially changed in 0.12.
-data ServantError =
+data ClientError =
   -- | The server returned an error response including the
   -- failing request. 'requestPath' includes the 'BaseUrl' and the
   -- path of the request.
@@ -57,7 +57,7 @@ data ServantError =
   | ConnectionError SomeException
   deriving (Show, Generic, Typeable)
 
-instance Eq ServantError where
+instance Eq ClientError where
   FailureResponse req res     == FailureResponse req' res'     = req == req' && res == res'
   DecodeFailure t r           == DecodeFailure t' r'           = t == t' && r == r'
   UnsupportedContentType mt r == UnsupportedContentType mt' r' = mt == mt' && r == r'
@@ -74,11 +74,11 @@ instance Eq ServantError where
   InvalidContentTypeHeader {} == _ = False
   ConnectionError          {} == _ = False
 
-instance Exception ServantError
+instance Exception ClientError
 
 -- | Note: an exception in 'ConnectionError' might not be evaluated fully,
 -- We only 'rnf' its 'show'ed value.
-instance NFData ServantError where
+instance NFData ClientError where
     rnf (FailureResponse req res)        = rnf req `seq` rnf res
     rnf (DecodeFailure err res)          = rnf err `seq` rnf res
     rnf (UnsupportedContentType mt' res) = mediaTypeRnf mt' `seq` rnf res

servant-client-core/src/Servant/Client/Core/HasClient.hs

@@ -254,7 +254,7 @@ instance {-# OVERLAPPING #-}
        , requestAccept = fromList $ toList accept
        }
     case mimeUnrender (Proxy :: Proxy ct) $ responseBody response of
-      Left err -> throwServantError $ DecodeFailure (pack err) response
+      Left err -> throwClientError $ DecodeFailure (pack err) response
       Right val -> return $ Headers
         { getResponse = val
         , getHeadersHList = buildHeadersTo . toList $ responseHeaders response
@@ -662,17 +662,17 @@ checkContentTypeHeader response =
   case lookup "Content-Type" $ toList $ responseHeaders response of
     Nothing -> return $ "application"//"octet-stream"
     Just t -> case parseAccept t of
-      Nothing -> throwServantError $ InvalidContentTypeHeader response
+      Nothing -> throwClientError $ InvalidContentTypeHeader response
       Just t' -> return t'
 
 decodedAs :: forall ct a m. (MimeUnrender ct a, RunClient m)
   => Response -> Proxy ct -> m a
 decodedAs response ct = do
   responseContentType <- checkContentTypeHeader response
   unless (any (matches responseContentType) accept) $
-    throwServantError $ UnsupportedContentType responseContentType response
+    throwClientError $ UnsupportedContentType responseContentType response
   case mimeUnrender ct $ responseBody response of
-    Left err -> throwServantError $ DecodeFailure (T.pack err) response
+    Left err -> throwClientError $ DecodeFailure (T.pack err) response
     Right val -> return val
   where
     accept = toList $ contentTypes ct 

servant-client-core/src/Servant/Client/Core/Reexport.hs

@@ -12,7 +12,7 @@ module Servant.Client.Core.Reexport
   , ResponseF(..)
 
   -- * Data types
-  , ServantError(..)
+  , ClientError(..)
   , EmptyClient(..)
 
   -- * BaseUrl

servant-client-core/src/Servant/Client/Core/RunClient.hs

@@ -24,7 +24,7 @@ import           Servant.Client.Core.Response
 class Monad m => RunClient m where
   -- | How to make a request.
   runRequest :: Request -> m Response
-  throwServantError :: ServantError -> m a
+  throwClientError :: ClientError -> m a
 
 class RunClient m =>  RunStreamingClient m where
     withStreamingRequest :: Request -> (StreamingResponse -> IO a) ->  m a
@@ -38,9 +38,9 @@ class RunClient m =>  RunStreamingClient m where
 -- Compare to 'RunClient'.
 data ClientF a
     = RunRequest Request (Response -> a)
-    | Throw ServantError
+    | Throw ClientError
   deriving (Functor)
 
 instance ClientF ~ f => RunClient (Free f) where
     runRequest req  = liftF (RunRequest req id)
-    throwServantError = liftF . Throw
+    throwClientError = liftF . Throw

servant-client-ghcjs/src/Servant/Client/Internal/XhrClient.hs

@@ -94,16 +94,16 @@ client api = api `clientIn` (Proxy :: Proxy ClientM)
 --
 -- NOTE: Does not support constant space streaming of the request body!
 newtype ClientM a = ClientM
-  { runClientM' :: ReaderT ClientEnv (ExceptT ServantError IO) a }
+  { runClientM' :: ReaderT ClientEnv (ExceptT ClientError IO) a }
   deriving ( Functor, Applicative, Monad, MonadIO, Generic
-           , MonadReader ClientEnv, MonadError ServantError, MonadThrow
+           , MonadReader ClientEnv, MonadError ClientError, MonadThrow
            , MonadCatch)
 
 instance MonadBase IO ClientM where
   liftBase = ClientM . liftBase
 
 instance MonadBaseControl IO ClientM where
-  type StM ClientM a = Either ServantError a
+  type StM ClientM a = Either ClientError a
 
   liftBaseWith f = ClientM (liftBaseWith (\g -> f (g . runClientM')))
 
@@ -121,12 +121,12 @@ instance Exception StreamingNotSupportedException where
 
 instance RunClient ClientM where
   runRequest = performRequest
-  throwServantError = throwError
+  throwClientError = throwError
 
-runClientMOrigin :: ClientM a -> ClientEnv -> IO (Either ServantError a)
+runClientMOrigin :: ClientM a -> ClientEnv -> IO (Either ClientError a)
 runClientMOrigin cm env = runExceptT $ flip runReaderT env $ runClientM' cm
 
-runClientM :: ClientM a -> IO (Either ServantError a)
+runClientM :: ClientM a -> IO (Either ClientError a)
 runClientM m = do
     curLoc <- getWindowLocation
 
@@ -298,7 +298,7 @@ foreign import javascript unsafe "$3.slice($1, $1 + $2)"
 -- * inspecting the xhr response
 
 -- This function is only supposed to handle 'ConnectionError's. Other
--- 'ServantError's are created in Servant.Client.Req.
+-- 'ClientError's are created in Servant.Client.Req.
 toResponse :: JSXMLHttpRequest -> ClientM Response
 toResponse xhr = do
   status <- liftIO $ getStatus xhr