diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,163 @@ [The latest version of this document is on GitHub.](https://github.com/haskell-servant/servant/blob/master/servant-client-core/CHANGELOG.md) [Changelog for `servant` package contains significant entries for all core packages.](https://github.com/haskell-servant/servant/blob/master/servant/CHANGELOG.md) +Package versions follow the [Package Versioning Policy](https://pvp.haskell.org/): in A.B.C, bumps to either A or B represent major versions. + +0.20.3.0 +-------- + +- Server-sent events (SSE) for client-side [#1811](https://github.com/haskell-servant/servant/issues/1811) + + Implement Server-sent events (SSE) for the Servant client using a new + combinator "ServerSentEvents". The raw event messages, accumulated events and + JSON-processed events can be exposed. + +- Integrate MultiVerb [#1766](https://github.com/haskell-servant/servant/pull/1766) [#1804](https://github.com/haskell-servant/servant/pull/1804) + + Expose MultiVerb, a more ergonomic way of defining endpoints that return + many kinds of responses. Read the cookbook https://docs.servant.dev/en/master/cookbook/multiverb/MultiVerb.html + +- Add public re-export of renderCurlBasePath lens [#1706](https://github.com/haskell-servant/servant/pull/1706) +- Remove GHC <= 8.10.7 from the support window [#1778](https://github.com/haskell-servant/servant/pull/1778) +- Add Servant.API.Range type [#1805](https://github.com/haskell-servant/servant/pull/1805) +- Add missing HasLink instance for DeepQuery [#1784](https://github.com/haskell-servant/servant/issues/1784) +- Add Host API combinator [#1800](https://github.com/haskell-servant/servant/pull/1800) + + Adding a Host combinator allows servant users to select APIs according + to the Host header provided by clients. + +0.20.2 +---- + +- Full query string helpers [#1604](https://github.com/haskell-servant/servant/pull/1604) + This involves exporting `setQueryString` from Servant.Client.Core.Request. + +0.20 +---- + +- Escape special chars in QueryParams. [#1584](https://github.com/haskell-servant/servant/issues/1584) [#1597](https://github.com/haskell-servant/servant/pull/1597) + + Escape special chars in QueryParam (`:@&=+$`) in servant-client. Note that this + mean binary data will not work as is, and so reverts the functionality in + [#1432](https://github.com/haskell-servant/servant/pull/1432). + +- Handle Cookies correctly for RunStreamingClient [#1605](https://github.com/haskell-servant/servant/issues/1605) [#1606](https://github.com/haskell-servant/servant/pull/1606) + + Makes `performWithStreamingRequest` take into consideration the + CookieJar, which it previously didn't. + +- Fix the handling of multiple headers with the same name. [#1666](https://github.com/haskell-servant/servant/pull/1666) + + servant-client no longer concatenates the values of response headers with the same name. + This fixes an issue with parsing multiple `Set-Cookie` headers. + +0.19 +---- + +### Significant changes + +- Drop support for GHC < 8.6. +- Support GHC 9.0 (GHC 9.2 should work as well, but isn't fully tested yet). +- Support Aeson 2 ([#1475](https://github.com/haskell-servant/servant/pull/1475)), + which fixes a [DOS vulnerability](https://github.com/haskell/aeson/issues/864) + related to hash collisions. +- Add `NamedRoutes` combinator, making support for records first-class in Servant + ([#1388](https://github.com/haskell-servant/servant/pull/1388)). +- Add custom type errors for partially applied combinators + ([#1289](https://github.com/haskell-servant/servant/pull/1289), + [#1486](https://github.com/haskell-servant/servant/pull/1486)). +- *servant-client* / *servant-client-core* / *servant-http-streams*: Fix + erroneous behavior, where only 2XX status codes would be considered + successful, irrelevant of the status parameter specified by the verb + combinator. ([#1469](https://github.com/haskell-servant/servant/pull/1469)) +- *servant-client* / *servant-client-core*: Fix `Show` instance for + `Servant.Client.Core.Request`. +- *servant-client* / *servant-client-core*: Allow passing arbitrary binary data + in Query parameters. + ([#1432](https://github.com/haskell-servant/servant/pull/1432)). + +### Other changes + +- Various version bumps. + +0.18.3 +------ + +### Significant changes + +- Add response header support to UVerb (#1420) + +### Other changes + +- Support GHC-9.0.1. +- Bump `bytestring`, `hspec`, `base64-bytestring` and `QuickCheck` dependencies. + +0.18.2 +------ + +### Significant changes + +- Support `Fragment` combinator. + +0.18.1 +------ + +### Significant changes + +- Union verbs + +### Other changes + +- Bump "tested-with" ghc versions +- Loosen bound on base16-bytestring + +0.18 +---- + +### Significant changes + +- Support for ghc8.8 (#1318, #1326, #1327) + + +0.17 +---- + +### Significant changes + +- Add NoContentVerb [#1028](https://github.com/haskell-servant/servant/issues/1028) [#1219](https://github.com/haskell-servant/servant/pull/1219) [#1228](https://github.com/haskell-servant/servant/pull/1228) + + The `NoContent` API endpoints should now use `NoContentVerb` combinator. + The API type changes are usually of the kind + + ```diff + - :<|> PostNoContent '[JSON] NoContent + + :<|> PostNoContent + ``` + + i.e. one doesn't need to specify the content-type anymore. There is no content. + +- `Capture` can be `Lenient` [#1155](https://github.com/haskell-servant/servant/issues/1155) [#1156](https://github.com/haskell-servant/servant/pull/1156) + + You can specify a lenient capture as + + ```haskell + :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET + ``` + + which will make the capture always succeed. Handlers will be of the + type `Either String CapturedType`, where `Left err` represents + the possible parse failure. + +### Other changes + +- *servant-client* *servant-client-core* *servant-http-streams* Fix Verb with headers checking content type differently [#1200](https://github.com/haskell-servant/servant/issues/1200) [#1204](https://github.com/haskell-servant/servant/pull/1204) + + For `Verb`s with response `Headers`, the implementation didn't check + for the content-type of the response. Now it does. + +- *servant-client* *servant-http-streams* `HasClient` instance for `Stream` with `Headers` [#1170](https://github.com/haskell-servant/servant/issues/1170) [#1197](https://github.com/haskell-servant/servant/pull/1197) +- *servant-client* Redact the authorization header in Show and exceptions [#1238](https://github.com/haskell-servant/servant/pull/1238) + 0.16 ---- @@ -166,9 +323,9 @@ - *servant-client-core* Add `hoistClient` to `HasClient`. Just like `hoistServer` allows us to change the monad in which request handlers - of a web application live in, we also have `hoistClient` for changing the monad + of a web application live, we also have `hoistClient` for changing the monad in which *client functions* live. - Read [tutorial section for more information](https://haskell-servant.readthedocs.io/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in). + Read [tutorial section for more information](https://docs.servant.dev/en/release-0.14/tutorial/Client.html#changing-the-monad-the-client-functions-live-in). ([#936](https://github.com/haskell-servant/servant/pull/936)) iF you have own combinators, you'll need to define a new method of diff --git a/servant-client-core.cabal b/servant-client-core.cabal --- a/servant-client-core.cabal +++ b/servant-client-core.cabal @@ -1,111 +1,160 @@ -cabal-version: >=1.10 -name: servant-client-core -version: 0.16 +cabal-version: 3.0 +name: servant-client-core +version: 0.20.3.0 +synopsis: + Core functionality and class for client function generation for servant APIs -synopsis: Core functionality and class for client function generation for servant APIs -category: Servant, Web +category: Servant, Web description: This library provides backend-agnostic generation of client functions. For more information, see the README. -homepage: http://haskell-servant.readthedocs.org/ -bug-reports: http://github.com/haskell-servant/servant/issues -license: BSD3 -license-file: LICENSE -author: Servant Contributors -maintainer: haskell-servant-maintainers@googlegroups.com -copyright: 2014-2016 Zalora South East Asia Pte Ltd, 2016-2019 Servant Contributors -build-type: Simple -tested-with: - GHC ==8.0.2 - || ==8.2.2 - || ==8.4.4 - || ==8.6.3 +homepage: http://docs.servant.dev/ +bug-reports: http://github.com/haskell-servant/servant/issues +license: BSD-3-Clause +license-file: LICENSE +author: Servant Contributors +maintainer: haskell-servant-maintainers@googlegroups.com +copyright: + 2014-2016 Zalora South East Asia Pte Ltd, 2016-2019 Servant Contributors +build-type: Simple +tested-with: GHC ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.4 || ==9.10.1 || ==9.12.1 + extra-source-files: CHANGELOG.md README.md source-repository head - type: git - location: http://github.com/haskell-servant/servant.git + type: git + location: http://github.com/haskell-servant/servant.git +common extensions + default-extensions: + AllowAmbiguousTypes + ConstraintKinds + DataKinds + DeriveAnyClass + DeriveDataTypeable + DeriveFunctor + DeriveGeneric + DerivingStrategies + DerivingVia + DuplicateRecordFields + ExplicitNamespaces + FlexibleContexts + FlexibleInstances + FunctionalDependencies + GADTs + InstanceSigs + KindSignatures + LambdaCase + MultiParamTypeClasses + NoStarIsType + OverloadedLabels + OverloadedStrings + PackageImports + PolyKinds + RankNTypes + RecordWildCards + QuantifiedConstraints + ScopedTypeVariables + StrictData + TupleSections + TypeApplications + TypeFamilies + TypeOperators + UndecidableInstances + ViewPatterns + + default-language: Haskell2010 + +common ghc-options + ghc-options: + -Wall -Wcompat -Widentities -Wincomplete-record-updates + -Wincomplete-uni-patterns -Wpartial-fields -Wredundant-constraints + -fhide-source-paths -Wno-unused-do-bind -fdicts-strict + -Wno-unticked-promoted-constructors -Werror=unused-imports + -Wunused-packages + library + import: extensions + import: ghc-options exposed-modules: - Servant.Client.Core - Servant.Client.Free - Servant.Client.Generic - Servant.Client.Core.Reexport - Servant.Client.Core.Auth - Servant.Client.Core.BaseUrl - Servant.Client.Core.BasicAuth - Servant.Client.Core.ClientError - Servant.Client.Core.HasClient - Servant.Client.Core.Request - Servant.Client.Core.Response - Servant.Client.Core.RunClient + Servant.Client.Core + Servant.Client.Core.Auth + Servant.Client.Core.BaseUrl + Servant.Client.Core.BasicAuth + Servant.Client.Core.ClientError + Servant.Client.Core.HasClient + Servant.Client.Core.Reexport + Servant.Client.Core.Request + Servant.Client.Core.Response + Servant.Client.Core.MultiVerb.ResponseUnrender + Servant.Client.Core.RunClient + Servant.Client.Core.ServerSentEvents + Servant.Client.Free + Servant.Client.Generic - other-modules: - Servant.Client.Core.Internal + other-modules: Servant.Client.Core.Internal -- Bundled with GHC: Lower bound to not force re-installs -- text and mtl are bundled starting with GHC-8.4 -- -- note: mtl lower bound is so low because of GHC-7.8 build-depends: - base >= 4.9 && < 4.13 - , bytestring >= 0.10.8.1 && < 0.11 - , containers >= 0.5.7.1 && < 0.7 - , deepseq >= 1.4.2.0 && < 1.5 - , text >= 1.2.3.0 && < 1.3 - , transformers >= 0.5.2.0 && < 0.6 - , template-haskell >= 2.11.1.0 && < 2.15 - - if !impl(ghc >= 8.2) - build-depends: - bifunctors >= 5.5.3 && < 5.6 + , attoparsec >= 0.13.2.2 && < 0.15 + , base >= 4.16.4.0 && < 4.22 + , bytestring >=0.11 && <0.13 + , constraints >=0.2 && <0.15 + , containers >=0.6.5.1 && <0.9 + , deepseq >=1.4.2.0 && <1.6 + , template-haskell >=2.11.1.0 && <2.24 + , text >=1.2.3.0 && <2.2 -- Servant dependencies - build-depends: - servant >= 0.16 && <0.17 + build-depends: servant >=0.20.2 -- Other dependencies: Lower bound around what is in the latest Stackage LTS. -- Here can be exceptions if we really need features from the newer versions. build-depends: - aeson >= 1.4.1.0 && < 1.5 - , base-compat >= 0.10.5 && < 0.11 - , base64-bytestring >= 1.0.0.1 && < 1.1 - , exceptions >= 0.10.0 && < 0.11 - , free >= 5.1 && < 5.2 - , http-media >= 0.7.1.3 && < 0.8 - , http-types >= 0.12.2 && < 0.13 - , network-uri >= 2.6.1.0 && < 2.7 - , safe >= 0.3.17 && < 0.4 + , aeson >=1.4.1.0 && <3 + , base-compat >=0.10.5 && <0.15 + , base64-bytestring >=1.0.0.1 && <1.3 + , exceptions >=0.10.0 && <0.11 + , free >=5.1 && <5.3 + , http-media >=0.7.1.3 && <0.9 + , http-types >=0.12.2 && <0.13 + , network-uri >=2.6.1.0 && <2.7 + , safe >=0.3.17 && <0.4 + , sop-core >=0.4.0.0 && <0.6 - hs-source-dirs: src - default-language: Haskell2010 - ghc-options: -Wall + hs-source-dirs: src test-suite spec - type: exitcode-stdio-1.0 - ghc-options: -Wall - default-language: Haskell2010 - hs-source-dirs: test - main-is: Spec.hs + import: extensions + import: ghc-options + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: Spec.hs other-modules: - Servant.Client.Core.Internal.BaseUrlSpec + Servant.Client.Core.Internal.BaseUrlSpec + Servant.Client.Core.RequestSpec + Servant.Client.Core.ServerSentEventsSpec -- Dependencies inherited from the library. No need to specify bounds. build-depends: - base + , base , base-compat + , bytestring + , transformers + , servant , servant-client-core - -- Additonal dependencies + -- Additional dependencies build-depends: - deepseq >= 1.4.2.0 && < 1.5 - , hspec >= 2.6.0 && < 2.8 - , QuickCheck >= 2.12.6.1 && < 2.13 + , deepseq >=1.4.2.0 && <1.6 + , hspec >=2.6.0 && <2.12 + , QuickCheck >=2.12.6.1 && <2.16 - build-tool-depends: - hspec-discover:hspec-discover >= 2.6.0 && <2.8 + build-tool-depends: hspec-discover:hspec-discover >=2.6.0 && <2.12 diff --git a/src/Servant/Client/Core.hs b/src/Servant/Client/Core.hs --- a/src/Servant/Client/Core.hs +++ b/src/Servant/Client/Core.hs @@ -18,6 +18,8 @@ -- * Client generation clientIn , HasClient(..) + , foldMapUnion + , matchUnion -- * Request , Request @@ -57,6 +59,7 @@ , appendToPath , setRequestBodyLBS , setRequestBody + , encodeQueryParamValue ) where import Servant.Client.Core.Auth import Servant.Client.Core.BaseUrl diff --git a/src/Servant/Client/Core/Auth.hs b/src/Servant/Client/Core/Auth.hs --- a/src/Servant/Client/Core/Auth.hs +++ b/src/Servant/Client/Core/Auth.hs @@ -1,4 +1,3 @@ -{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE TypeSynonymInstances #-} @@ -10,6 +9,8 @@ mkAuthenticatedRequest, ) where +import Data.Kind (Type) + import Servant.Client.Core.Request (Request) @@ -18,7 +19,7 @@ -- to a request -- -- NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE -type family AuthClientData a :: * +type family AuthClientData a :: Type -- | For better type inference and to avoid usage of a data family, we newtype -- wrap the combination of some 'AuthClientData' and a function to add authentication diff --git a/src/Servant/Client/Core/BaseUrl.hs b/src/Servant/Client/Core/BaseUrl.hs --- a/src/Servant/Client/Core/BaseUrl.hs +++ b/src/Servant/Client/Core/BaseUrl.hs @@ -1,7 +1,4 @@ -{-# LANGUAGE DeriveDataTypeable #-} -{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DeriveLift #-} -{-# LANGUAGE ViewPatterns #-} module Servant.Client.Core.BaseUrl ( BaseUrl (..), Scheme (..), @@ -21,7 +18,7 @@ withText) import Data.Data (Data) -import Data.List +import qualified Data.List as List import qualified Data.Text as T import GHC.Generics import Language.Haskell.TH.Syntax @@ -57,7 +54,7 @@ where s ('/':x) = x s x = x --- | >>> traverse_ (LBS8.putStrLn . encode) $ parseBaseUrl "api.example.com" +-- | >>> traverse_ (LBS8.putStrLn . encode) (parseBaseUrl "api.example.com" :: [BaseUrl]) -- "http://api.example.com" instance ToJSON BaseUrl where toJSON = toJSON . showBaseUrl @@ -72,8 +69,8 @@ -- | >>> :{ -- traverse_ (LBS8.putStrLn . encode) $ do --- u1 <- parseBaseUrl "api.example.com" --- u2 <- parseBaseUrl "example.com" +-- u1 <- parseBaseUrl "api.example.com" :: [BaseUrl] +-- u2 <- parseBaseUrl "example.com" :: [BaseUrl] -- return $ Map.fromList [(u1, 'x'), (u2, 'y')] -- :} -- {"http://api.example.com":"x","http://example.com":"y"} @@ -91,7 +88,7 @@ showBaseUrl (BaseUrl urlscheme host port path) = schemeString ++ "//" ++ host ++ (portString path) where - a b = if "/" `isPrefixOf` b || null b then a ++ b else a ++ '/':b + a b = if "/" `List.isPrefixOf` b || null b then a ++ b else a ++ '/':b schemeString = case urlscheme of Http -> "http:" Https -> "https:" @@ -128,7 +125,7 @@ return (BaseUrl Https host port path) Just (URI "https:" (Just (URIAuth "" host "")) path "" "") -> return (BaseUrl Https host 443 path) - _ -> if "://" `isInfixOf` s + _ -> if "://" `List.isInfixOf` s then throwM (InvalidBaseUrlException $ "Invalid base URL: " ++ s) else parseBaseUrl ("http://" ++ s) where diff --git a/src/Servant/Client/Core/BasicAuth.hs b/src/Servant/Client/Core/BasicAuth.hs --- a/src/Servant/Client/Core/BasicAuth.hs +++ b/src/Servant/Client/Core/BasicAuth.hs @@ -9,8 +9,6 @@ import Data.ByteString.Base64 (encode) -import Data.Monoid - ((<>)) import Data.Text.Encoding (decodeUtf8) import Servant.API.BasicAuth diff --git a/src/Servant/Client/Core/HasClient.hs b/src/Servant/Client/Core/HasClient.hs --- a/src/Servant/Client/Core/HasClient.hs +++ b/src/Servant/Client/Core/HasClient.hs @@ -1,68 +1,103 @@ -{-# LANGUAGE DataKinds #-} -{-# LANGUAGE FlexibleContexts #-} -{-# LANGUAGE FlexibleInstances #-} -{-# LANGUAGE InstanceSigs #-} -{-# LANGUAGE MultiParamTypeClasses #-} -{-# LANGUAGE OverloadedStrings #-} -{-# LANGUAGE PolyKinds #-} -{-# LANGUAGE RankNTypes #-} -{-# LANGUAGE ScopedTypeVariables #-} -{-# LANGUAGE TypeFamilies #-} -{-# LANGUAGE TypeOperators #-} -{-# LANGUAGE UndecidableInstances #-} - +{-# LANGUAGE CPP #-} +{-# LANGUAGE ApplicativeDo #-} +{-# OPTIONS_GHC -Wno-missing-methods #-} module Servant.Client.Core.HasClient ( clientIn, HasClient (..), EmptyClient (..), + AsClientT, + (//), + (/:), + foldMapUnion, + matchUnion, + fromSomeClientResponse ) where import Prelude () import Prelude.Compat +import Control.Arrow + (left, (+++)) +import qualified Data.Text as Text import Control.Monad (unless) -import qualified Data.ByteString.Lazy as BL +import qualified Data.ByteString.Lazy as BSL +import Data.Either + (partitionEithers) +import Data.Constraint (Dict(..)) import Data.Foldable (toList) -import Data.List - (foldl') -import Data.Proxy - (Proxy (Proxy)) +import Data.Kind + (Type) +import qualified Data.List as List import Data.Sequence (fromList) import qualified Data.Text as T +import Data.Text.Encoding (encodeUtf8) import Network.HTTP.Media - (MediaType, matches, parseAccept, (//)) + (MediaType, matches, parseAccept) +import qualified Network.HTTP.Media as Media +import qualified Data.Sequence as Seq +import Data.SOP.BasicFunctors + (I (I), (:.:) (Comp)) +import Data.SOP.Constraint + (All) +import Data.SOP.NP + (NP (..), cpure_NP) +import Data.SOP.NS + (NS (..)) import Data.String (fromString) import Data.Text (Text, pack) import GHC.TypeLits - (KnownSymbol, symbolVal) + (KnownNat, KnownSymbol, TypeError, symbolVal) +import Network.HTTP.Types + (Status) import qualified Network.HTTP.Types as H import Servant.API - ((:<|>) ((:<|>)), (:>), AuthProtect, BasicAuth, BasicAuthData, - BuildHeadersTo (..), Capture', CaptureAll, Description, - EmptyAPI, FramingRender (..), FramingUnrender (..), - FromSourceIO (..), Header', Headers (..), HttpVersion, - IsSecure, MimeRender (mimeRender), - MimeUnrender (mimeUnrender), NoContent (NoContent), QueryFlag, - QueryParam', QueryParams, Raw, ReflectMethod (..), RemoteHost, - ReqBody', SBoolI, Stream, StreamBody', Summary, ToHttpApiData, - ToSourceIO (..), Vault, Verb, WithNamedContext, contentType, - getHeadersHList, getResponse, toQueryParam, toUrlPiece) + ((:<|>) ((:<|>)), (:>), + BuildHeadersTo (..), + EmptyAPI, + FromSourceIO (..), + IsSecure, + MimeUnrender (mimeUnrender), + NoContentVerb, + ReflectMethod (..), + StreamBody', + Verb, + getResponse, AuthProtect, BasicAuth, BasicAuthData, Capture', CaptureAll, DeepQuery, Description, Fragment, FramingRender (..), FramingUnrender (..), Header', Headers (..), HttpVersion, MimeRender (mimeRender), NoContent (NoContent), QueryFlag, QueryParam', QueryParams, QueryString, Raw, RawM, RemoteHost, ReqBody', SBoolI, Stream, Summary, ToHttpApiData, ToSourceIO (..), Vault, WithNamedContext, WithResource, WithStatus (..), contentType, getHeadersHList, toEncodedUrlPiece, NamedRoutes, Host) +import Servant.API.Generic + (GenericMode(..), ToServant, ToServantApi + , GenericServant, toServant, fromServant) import Servant.API.ContentTypes - (contentTypes) + (contentTypes, AllMime (allMime), AllMimeUnrender (allMimeUnrender), EventStream) +import Servant.API.QueryString (ToDeepQuery(..), generateDeepParam) +import Servant.API.Status + (statusFromNat) +import Servant.API.TypeLevel (FragmentUnique, AtMostOneFragment) import Servant.API.Modifiers (FoldRequired, RequiredArgument, foldRequiredArgument) +import Servant.API.TypeErrors +import Servant.API.UVerb + (HasStatus, HasStatuses (Statuses, statuses), UVerb, Union, Unique, inject, statusOf, foldMapUnion, matchUnion) +import Servant.API.ServerSentEvents + (EventKind (JsonEvent, RawEvent), ServerSentEvents') +import Servant.API.Stream + (NoFraming) import Servant.Client.Core.Auth import Servant.Client.Core.BasicAuth import Servant.Client.Core.ClientError import Servant.Client.Core.Request import Servant.Client.Core.Response +import Servant.Client.Core.MultiVerb.ResponseUnrender +import qualified Servant.Client.Core.Response as Response import Servant.Client.Core.RunClient +import Servant.Client.Core.ServerSentEvents +import Servant.API.MultiVerb +import qualified Network.HTTP.Media as M +import Data.Typeable -- * Accessing APIs as a Client @@ -84,7 +119,6 @@ clientIn :: HasClient m api => Proxy api -> Proxy m -> Client m api clientIn p pm = clientWithRoute pm p defaultRequest - -- | This class lets us define how each API combinator influences the creation -- of an HTTP request. -- @@ -92,7 +126,7 @@ -- combinators that you want to support client-generation, you can ignore this -- class. class RunClient m => HasClient m api where - type Client (m :: * -> *) (api :: *) :: * + type Client (m :: Type -> Type) (api :: Type) :: Type clientWithRoute :: Proxy m -> Proxy api -> Request -> Client m api hoistClientMonad :: Proxy m @@ -101,7 +135,6 @@ -> Client mon api -> Client mon' api - -- | A client querying function for @a ':<|>' b@ will actually hand you -- one function for querying @a@ and another one for querying @b@, -- stitching them together with ':<|>', which really is just like a pair. @@ -162,7 +195,7 @@ -- > getBook :: Text -> ClientM Book -- > getBook = client myApi -- > -- then you can just use "getBook" to query that endpoint -instance (KnownSymbol capture, ToHttpApiData a, HasClient m api) +instance (ToHttpApiData a, HasClient m api) => HasClient m (Capture' mods capture a :> api) where type Client m (Capture' mods capture a :> api) = @@ -172,7 +205,7 @@ clientWithRoute pm (Proxy :: Proxy api) (appendToPath p req) - where p = (toUrlPiece val) + where p = toEncodedUrlPiece val hoistClientMonad pm _ f cl = \a -> hoistClientMonad pm (Proxy :: Proxy api) f (cl a) @@ -197,7 +230,7 @@ -- > getSourceFile :: [Text] -> ClientM SourceFile -- > getSourceFile = client myApi -- > -- then you can use "getSourceFile" to query that endpoint -instance (KnownSymbol capture, ToHttpApiData a, HasClient m sublayout) +instance (ToHttpApiData a, HasClient m sublayout) => HasClient m (CaptureAll capture a :> sublayout) where type Client m (CaptureAll capture a :> sublayout) = @@ -205,9 +238,9 @@ clientWithRoute pm Proxy req vals = clientWithRoute pm (Proxy :: Proxy sublayout) - (foldl' (flip appendToPath) req ps) + (List.foldl' (flip appendToPath) req ps) - where ps = map (toUrlPiece) vals + where ps = map toEncodedUrlPiece vals hoistClientMonad pm _ f cl = \as -> hoistClientMonad pm (Proxy :: Proxy sublayout) f (cl as) @@ -215,10 +248,11 @@ instance {-# OVERLAPPABLE #-} -- Note [Non-Empty Content Types] ( RunClient m, MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts) + , KnownNat status ) => HasClient m (Verb method status cts' a) where type Client m (Verb method status cts' a) = m a clientWithRoute _pm Proxy req = do - response <- runRequest req + response <- runRequestAcceptStatus (Just [status]) req { requestAccept = fromList $ toList accept , requestMethod = method } @@ -226,15 +260,28 @@ where accept = contentTypes (Proxy :: Proxy ct) method = reflectMethod (Proxy :: Proxy method) + status = statusFromNat (Proxy :: Proxy status) hoistClientMonad _ _ f ma = f ma instance {-# OVERLAPPING #-} - ( RunClient m, ReflectMethod method + ( RunClient m, ReflectMethod method, KnownNat status ) => HasClient m (Verb method status cts NoContent) where type Client m (Verb method status cts NoContent) = m NoContent clientWithRoute _pm Proxy req = do + _response <- runRequestAcceptStatus (Just [status]) req { requestMethod = method } + return NoContent + where method = reflectMethod (Proxy :: Proxy method) + status = statusFromNat (Proxy :: Proxy status) + + hoistClientMonad _ _ f ma = f ma + +instance (RunClient m, ReflectMethod method) => + HasClient m (NoContentVerb method) where + type Client m (NoContentVerb method) + = m NoContent + clientWithRoute _pm Proxy req = do _response <- runRequest req { requestMethod = method } return NoContent where method = reflectMethod (Proxy :: Proxy method) @@ -243,41 +290,127 @@ instance {-# OVERLAPPING #-} -- Note [Non-Empty Content Types] - ( RunClient m, MimeUnrender ct a, BuildHeadersTo ls + ( RunClient m, MimeUnrender ct a, BuildHeadersTo ls, KnownNat status , ReflectMethod method, cts' ~ (ct ': cts) ) => HasClient m (Verb method status cts' (Headers ls a)) where type Client m (Verb method status cts' (Headers ls a)) = m (Headers ls a) clientWithRoute _pm Proxy req = do - response <- runRequest req + response <- runRequestAcceptStatus (Just [status]) req { requestMethod = method , requestAccept = fromList $ toList accept } - case mimeUnrender (Proxy :: Proxy ct) $ responseBody response of - Left err -> throwClientError $ DecodeFailure (pack err) response - Right val -> return $ Headers - { getResponse = val - , getHeadersHList = buildHeadersTo . toList $ responseHeaders response - } - where method = reflectMethod (Proxy :: Proxy method) - accept = contentTypes (Proxy :: Proxy ct) + val <- response `decodedAs` (Proxy :: Proxy ct) + return $ Headers { getResponse = val + , getHeadersHList = buildHeadersTo . toList $ responseHeaders response + } + where + method = reflectMethod (Proxy :: Proxy method) + accept = contentTypes (Proxy :: Proxy ct) + status = statusFromNat (Proxy :: Proxy status) hoistClientMonad _ _ f ma = f ma instance {-# OVERLAPPING #-} - ( RunClient m, BuildHeadersTo ls, ReflectMethod method + ( RunClient m, BuildHeadersTo ls, ReflectMethod method, KnownNat status ) => HasClient m (Verb method status cts (Headers ls NoContent)) where type Client m (Verb method status cts (Headers ls NoContent)) = m (Headers ls NoContent) clientWithRoute _pm Proxy req = do - let method = reflectMethod (Proxy :: Proxy method) - response <- runRequest req { requestMethod = method } + response <- runRequestAcceptStatus (Just [status]) req { requestMethod = method } return $ Headers { getResponse = NoContent , getHeadersHList = buildHeadersTo . toList $ responseHeaders response } + where + method = reflectMethod (Proxy :: Proxy method) + status = statusFromNat (Proxy :: Proxy status) hoistClientMonad _ _ f ma = f ma +data ClientParseError = ClientParseError MediaType String | ClientStatusMismatch | ClientNoMatchingStatus + deriving (Eq, Show) + +class UnrenderResponse (cts :: [Type]) (a :: Type) where + unrenderResponse :: Seq.Seq H.Header -> BSL.ByteString -> Proxy cts + -> [Either (MediaType, String) a] + +instance {-# OVERLAPPABLE #-} AllMimeUnrender cts a => UnrenderResponse cts a where + unrenderResponse _ body = map parse . allMimeUnrender + where parse (mediaType, parser) = left ((,) mediaType) (parser body) + +instance {-# OVERLAPPING #-} forall cts a h . (UnrenderResponse cts a, BuildHeadersTo h) + => UnrenderResponse cts (Headers h a) where + unrenderResponse hs body = (map . fmap) setHeaders . unrenderResponse hs body + where + setHeaders :: a -> Headers h a + setHeaders x = Headers x (buildHeadersTo (toList hs)) + +instance {-# OVERLAPPING #-} UnrenderResponse cts a + => UnrenderResponse cts (WithStatus n a) where + unrenderResponse hs body = (map . fmap) WithStatus . unrenderResponse hs body + +instance {-# OVERLAPPING #-} + ( RunClient m, + contentTypes ~ (contentType ': otherContentTypes), + -- ('otherContentTypes' should be '_', but even -XPartialTypeSignatures does not seem + -- allow this in instance types as of 8.8.3.) + as ~ (a ': as'), + AllMime contentTypes, + ReflectMethod method, + All (UnrenderResponse contentTypes) as, + All HasStatus as, HasStatuses as', + Unique (Statuses as) + ) => + HasClient m (UVerb method contentTypes as) + where + type Client m (UVerb method contentTypes as) = m (Union as) + + clientWithRoute _ _ request = do + let accept = Seq.fromList . allMime $ Proxy @contentTypes + -- offering to accept all mime types listed in the api gives best compatibility. eg., + -- we might not own the server implementation, and the server may choose to support + -- only part of the api. + + method = reflectMethod $ Proxy @method + acceptStatus = statuses (Proxy @as) + response@Response{responseBody=body, responseStatusCode=status, responseHeaders=headers} + <- runRequestAcceptStatus (Just acceptStatus) (request {requestMethod = method, requestAccept = accept}) + responseContentType <- checkContentTypeHeader response + unless (any (matches responseContentType) accept) $ do + throwClientError $ UnsupportedContentType responseContentType response + + let res = tryParsers status $ mimeUnrenders (Proxy @contentTypes) headers body + case res of + Left errors -> throwClientError $ DecodeFailure (T.pack (show errors)) response + Right x -> return x + where + -- | Given a list of parsers of 'mkres', returns the first one that succeeds and all the + -- failures it encountered along the way + -- TODO; better name, rewrite haddocs. + tryParsers :: forall xs. All HasStatus xs => Status -> NP ([] :.: Either (MediaType, String)) xs -> Either [ClientParseError] (Union xs) + tryParsers _ Nil = Left [ClientNoMatchingStatus] + tryParsers status (Comp x :* xs) + | status == statusOf (Comp x) = + case partitionEithers x of + (err', []) -> (map (uncurry ClientParseError) err' ++) +++ S $ tryParsers status xs + (_, (res : _)) -> Right . inject . I $ res + | otherwise = -- no reason to parse in the first place. This ain't the one we're looking for + (ClientStatusMismatch :) +++ S $ tryParsers status xs + + -- | Given a list of types, parses the given response body as each type + mimeUnrenders :: + forall cts xs. + All (UnrenderResponse cts) xs => + Proxy cts -> + Seq.Seq H.Header -> + BSL.ByteString -> + NP ([] :.: Either (MediaType, String)) xs + mimeUnrenders ctp headers body = cpure_NP + (Proxy @(UnrenderResponse cts)) + (Comp . unrenderResponse headers body $ ctp) + + hoistClientMonad _ _ nt s = nt s + instance {-# OVERLAPPABLE #-} ( RunStreamingClient m, MimeUnrender ct chunk, ReflectMethod method, FramingUnrender framing, FromSourceIO chunk a @@ -287,16 +420,99 @@ hoistClientMonad _ _ f ma = f ma - clientWithRoute _pm Proxy req = withStreamingRequest req' $ \gres -> do - let mimeUnrender' = mimeUnrender (Proxy :: Proxy ct) :: BL.ByteString -> Either String chunk + clientWithRoute _pm Proxy req = withStreamingRequest req' $ \Response{responseBody=body} -> do + let mimeUnrender' = mimeUnrender (Proxy :: Proxy ct) :: BSL.ByteString -> Either String chunk framingUnrender' = framingUnrender (Proxy :: Proxy framing) mimeUnrender' - return $ fromSourceIO $ framingUnrender' $ responseBody gres + fromSourceIO $ framingUnrender' body where req' = req { requestAccept = fromList [contentType (Proxy :: Proxy ct)] , requestMethod = reflectMethod (Proxy :: Proxy method) } +instance {-# OVERLAPPING #-} + ( RunStreamingClient m, MimeUnrender ct chunk, ReflectMethod method, + FramingUnrender framing, FromSourceIO chunk a, + BuildHeadersTo hs + ) => HasClient m (Stream method status framing ct (Headers hs a)) where + + type Client m (Stream method status framing ct (Headers hs a)) = m (Headers hs a) + + hoistClientMonad _ _ f ma = f ma + + clientWithRoute _pm Proxy req = withStreamingRequest req' $ + \Response{responseBody=body, responseHeaders=headers} -> do + let mimeUnrender' = mimeUnrender (Proxy :: Proxy ct) :: BSL.ByteString -> Either String chunk + framingUnrender' = framingUnrender (Proxy :: Proxy framing) mimeUnrender' + val <- fromSourceIO $ framingUnrender' body + return $ Headers + { getResponse = val + , getHeadersHList = buildHeadersTo $ toList headers + } + + where + req' = req + { requestAccept = fromList [contentType (Proxy :: Proxy ct)] + , requestMethod = reflectMethod (Proxy :: Proxy method) + } + +type SseClientDelegate method status = + Stream method status NoFraming EventStream + +instance + ( RunClient m + , HasClient m (SseClientDelegate method status (EventMessageStreamT IO)) + ) + => HasClient m (ServerSentEvents' method status 'RawEvent EventMessage) where + type Client m (ServerSentEvents' method status 'RawEvent EventMessage) = + Client m (SseClientDelegate method status (EventMessageStreamT IO)) + + hoistClientMonad p _ = + hoistClientMonad + p + (Proxy :: Proxy (SseClientDelegate method status (EventMessageStreamT IO))) + + clientWithRoute p _ = + clientWithRoute + p + (Proxy :: Proxy (SseClientDelegate method status (EventMessageStreamT IO))) + +instance + ( RunClient m + , HasClient m (SseClientDelegate method status (EventStreamT IO)) + ) + => HasClient m (ServerSentEvents' method status 'RawEvent (Event a)) where + type Client m (ServerSentEvents' method status 'RawEvent (Event a)) = + Client m (SseClientDelegate method status (EventStreamT IO)) + + hoistClientMonad p _ = + hoistClientMonad + p + (Proxy :: Proxy (SseClientDelegate method status (EventStreamT IO))) + + clientWithRoute p _ = + clientWithRoute + p + (Proxy :: Proxy (SseClientDelegate method status (EventStreamT IO))) + +instance + ( RunClient m + , HasClient m (SseClientDelegate method status (JsonEventStreamT IO a)) + ) + => HasClient m (ServerSentEvents' method status 'JsonEvent a) where + type Client m (ServerSentEvents' method status 'JsonEvent a) = + Client m (SseClientDelegate method status (JsonEventStreamT IO a)) + + hoistClientMonad p _ = + hoistClientMonad + p + (Proxy :: Proxy (SseClientDelegate method status (JsonEventStreamT IO a))) + + clientWithRoute p _ = + clientWithRoute + p + (Proxy :: Proxy (SseClientDelegate method status (JsonEventStreamT IO a))) + -- | If you use a 'Header' in one of your endpoints in your API, -- the corresponding querying function will automatically take -- an additional argument of the type specified by your 'Header', @@ -340,6 +556,15 @@ hoistClientMonad pm _ f cl = \arg -> hoistClientMonad pm (Proxy :: Proxy api) f (cl arg) +instance (KnownSymbol sym, HasClient m api) => HasClient m (Host sym :> api) where + type Client m (Host sym :> api) = Client m api + + clientWithRoute pm Proxy req = + clientWithRoute pm (Proxy :: Proxy api) $ + addHeader "Host" (symbolVal (Proxy :: Proxy sym)) req + + hoistClientMonad pm _ = hoistClientMonad pm (Proxy :: Proxy api) + -- | Using a 'HttpVersion' combinator in your API doesn't affect the client -- functions. instance HasClient m api @@ -406,7 +631,7 @@ (Proxy :: Proxy mods) add (maybe req add) mparam where add :: a -> Request - add param = appendToQueryString pname (Just $ toQueryParam param) req + add param = appendToQueryString pname (Just $ encodeQueryParamValue param) req pname :: Text pname = pack $ symbolVal (Proxy :: Proxy sym) @@ -449,13 +674,13 @@ clientWithRoute pm Proxy req paramlist = clientWithRoute pm (Proxy :: Proxy api) - (foldl' (\ req' -> maybe req' (flip (appendToQueryString pname) req' . Just)) + (List.foldl' (\ req' -> maybe req' (flip (appendToQueryString pname) req' . Just)) req paramlist' ) where pname = pack $ symbolVal (Proxy :: Proxy sym) - paramlist' = map (Just . toQueryParam) paramlist + paramlist' = map (Just . encodeQueryParamValue) paramlist hoistClientMonad pm _ f cl = \as -> hoistClientMonad pm (Proxy :: Proxy api) f (cl as) @@ -499,6 +724,36 @@ hoistClientMonad pm _ f cl = \b -> hoistClientMonad pm (Proxy :: Proxy api) f (cl b) +instance (HasClient m api) + => HasClient m (QueryString :> api) where + type Client m (QueryString :> api) = + H.Query -> Client m api + + clientWithRoute pm Proxy req query = + clientWithRoute pm (Proxy :: Proxy api) + (setQueryString query req) + + hoistClientMonad pm _ f cl = \b -> + hoistClientMonad pm (Proxy :: Proxy api) f (cl b) + +instance (KnownSymbol sym, ToDeepQuery a, HasClient m api) + => HasClient m (DeepQuery sym a :> api) where + type Client m (DeepQuery sym a :> api) = + a -> Client m api + + clientWithRoute pm Proxy req deepObject = + let params = toDeepQuery deepObject + withParams = List.foldl' addDeepParam req params + addDeepParam r' kv = + let (k, textV) = generateDeepParam paramname kv + in appendToQueryString k (encodeUtf8 <$> textV) r' + paramname = pack $ symbolVal (Proxy :: Proxy sym) + in clientWithRoute pm (Proxy :: Proxy api) + withParams + + hoistClientMonad pm _ f cl = \b -> + hoistClientMonad pm (Proxy :: Proxy api) f (cl b) + -- | Pick a 'Method' and specify where the server you want to query is. You get -- back the full `Response`. instance RunClient m => HasClient m Raw where @@ -511,6 +766,16 @@ hoistClientMonad _ _ f cl = \meth -> f (cl meth) +instance RunClient m => HasClient m RawM where + type Client m RawM + = H.Method -> m Response + + clientWithRoute :: Proxy m -> Proxy RawM -> Request -> Client m RawM + clientWithRoute _pm Proxy req httpMethod = do + runRequest req { requestMethod = httpMethod } + + hoistClientMonad _ _ f cl = \meth -> f (cl meth) + -- | If you use a 'ReqBody' in one of your endpoints in your API, -- the corresponding querying function will automatically take -- an additional argument of the type specified by your 'ReqBody'. @@ -566,7 +831,7 @@ sourceIO = framingRender framingP - (mimeRender ctypeP :: chunk -> BL.ByteString) + (mimeRender ctypeP :: chunk -> BSL.ByteString) (toSourceIO body) -- | Make the querying function append @path@ to the request path. @@ -577,7 +842,7 @@ clientWithRoute pm (Proxy :: Proxy api) (appendToPath p req) - where p = pack $ symbolVal (Proxy :: Proxy path) + where p = toEncodedUrlPiece $ pack $ symbolVal (Proxy :: Proxy path) hoistClientMonad pm _ f cl = hoistClientMonad pm (Proxy :: Proxy api) f cl @@ -613,6 +878,14 @@ hoistClientMonad pm _ f cl = hoistClientMonad pm (Proxy :: Proxy subapi) f cl +instance HasClient m subapi => + HasClient m (WithResource res :> subapi) where + + type Client m (WithResource res :> subapi) = Client m subapi + clientWithRoute pm Proxy = clientWithRoute pm (Proxy :: Proxy subapi) + + hoistClientMonad pm _ f cl = hoistClientMonad pm (Proxy :: Proxy subapi) f cl + instance ( HasClient m api ) => HasClient m (AuthProtect tag :> api) where type Client m (AuthProtect tag :> api) @@ -624,6 +897,29 @@ hoistClientMonad pm _ f cl = \authreq -> hoistClientMonad pm (Proxy :: Proxy api) f (cl authreq) +-- | Ignore @'Fragment'@ in client functions. +-- See for more details. +-- +-- Example: +-- +-- > type MyApi = "books" :> Fragment Text :> Get '[JSON] [Book] +-- > +-- > myApi :: Proxy MyApi +-- > myApi = Proxy +-- > +-- > getBooks :: ClientM [Book] +-- > getBooks = client myApi +-- > -- then you can just use "getBooksBy" to query that endpoint. +-- > -- 'getBooks' for all books. +instance (AtMostOneFragment api, FragmentUnique (Fragment a :> api), HasClient m api + ) => HasClient m (Fragment a :> api) where + + type Client m (Fragment a :> api) = Client m api + + clientWithRoute pm _ = clientWithRoute pm (Proxy :: Proxy api) + + hoistClientMonad pm _ = hoistClientMonad pm (Proxy :: Proxy api) + -- * Basic Authentication instance HasClient m api => HasClient m (BasicAuth realm usr :> api) where @@ -635,8 +931,167 @@ hoistClientMonad pm _ f cl = \bauth -> hoistClientMonad pm (Proxy :: Proxy api) f (cl bauth) +-- | A type that specifies that an API record contains a client implementation. +data AsClientT (m :: Type -> Type) +instance GenericMode (AsClientT m) where + type AsClientT m :- api = Client m api +type GClientConstraints api m = + ( GenericServant api (AsClientT m) + , Client m (ToServantApi api) ~ ToServant api (AsClientT m) + ) +class GClient (api :: Type -> Type) m where + gClientProof :: Dict (GClientConstraints api m) + +instance GClientConstraints api m => GClient api m where + gClientProof = Dict + +instance + ( forall n. GClient api n + , HasClient m (ToServantApi api) + , RunClient m + , ErrorIfNoGeneric api + ) + => HasClient m (NamedRoutes api) where + type Client m (NamedRoutes api) = api (AsClientT m) + + clientWithRoute :: Proxy m -> Proxy (NamedRoutes api) -> Request -> Client m (NamedRoutes api) + clientWithRoute pm _ request = + case gClientProof @api @m of + Dict -> fromServant $ clientWithRoute pm (Proxy @(ToServantApi api)) request + + hoistClientMonad + :: forall ma mb. + Proxy m + -> Proxy (NamedRoutes api) + -> (forall x. ma x -> mb x) + -> Client ma (NamedRoutes api) + -> Client mb (NamedRoutes api) + hoistClientMonad _ _ nat clientA = + case (gClientProof @api @ma, gClientProof @api @mb) of + (Dict, Dict) -> + fromServant @api @(AsClientT mb) $ + hoistClientMonad @m @(ToServantApi api) @ma @mb Proxy Proxy nat $ + toServant @api @(AsClientT ma) clientA + +infixl 1 // +infixl 2 /: + +-- | Helper to make code using records of clients more readable. +-- +-- Can be mixed with (/:) for supplying arguments. +-- +-- Example: +-- +-- @ +-- type Api = NamedRoutes RootApi +-- +-- data RootApi mode = RootApi +-- { subApi :: mode :- NamedRoutes SubApi +-- , … +-- } deriving Generic +-- +-- data SubApi mode = SubApi +-- { endpoint :: mode :- Get '[JSON] Person +-- , … +-- } deriving Generic +-- +-- api :: Proxy API +-- api = Proxy +-- +-- rootClient :: RootApi (AsClientT ClientM) +-- rootClient = client api +-- +-- endpointClient :: ClientM Person +-- endpointClient = client \/\/ subApi \/\/ endpoint +-- @ +(//) :: a -> (a -> b) -> b +x // f = f x + +-- | Convenience function for supplying arguments to client functions when +-- working with records of clients. +-- +-- Intended to be used in conjunction with '(//)'. +-- +-- Example: +-- +-- @ +-- type Api = NamedRoutes RootApi +-- +-- data RootApi mode = RootApi +-- { subApi :: mode :- Capture "token" String :> NamedRoutes SubApi +-- , hello :: mode :- Capture "name" String :> Get '[JSON] String +-- , … +-- } deriving Generic +-- +-- data SubApi mode = SubApi +-- { endpoint :: mode :- Get '[JSON] Person +-- , … +-- } deriving Generic +-- +-- api :: Proxy API +-- api = Proxy +-- +-- rootClient :: RootApi (AsClientT ClientM) +-- rootClient = client api +-- +-- hello :: String -> ClientM String +-- hello name = rootClient \/\/ hello \/: name +-- +-- endpointClient :: ClientM Person +-- endpointClient = client \/\/ subApi \/: "foobar123" \/\/ endpoint +-- @ +(/:) :: (a -> b -> c) -> b -> a -> c +(/:) = flip + +instance + ( ResponseListUnrender cs as, + AllMime cs, + ReflectMethod method, + AsUnion as r, + RunClient m + ) => + HasClient m (MultiVerb method cs as r) + where + type Client m (MultiVerb method cs as r) = m r + + clientWithRoute _ _ req = do + response@Response{responseBody=body} <- + runRequestAcceptStatus + (Just (responseListStatuses @cs @as)) + req + { requestMethod = method, + requestAccept = Seq.fromList accept + } + + c <- getResponseContentType response + unless (any (M.matches c) accept) $ do + throwClientError $ UnsupportedContentType c response + + -- NOTE: support streaming in the future + let sresp = + if BSL.null body + then SomeClientResponse $ response {Response.responseBody = ()} + else SomeClientResponse response + case responseListUnrender @cs @as c sresp of + StatusMismatch -> throwClientError (DecodeFailure "Status mismatch" response) + UnrenderError e -> throwClientError (DecodeFailure (Text.pack e) response) + UnrenderSuccess x -> pure (fromUnion @as x) + where + accept = allMime (Proxy @cs) + method = reflectMethod (Proxy @method) + + hoistClientMonad _ _ f = f + +getResponseContentType :: (RunClient m) => Response -> m M.MediaType +getResponseContentType response = + case lookup "Content-Type" (toList (responseHeaders response)) of + Nothing -> pure $ "application" M.// "octet-stream" + Just t -> case M.parseAccept t of + Nothing -> throwClientError $ InvalidContentTypeHeader response + Just t' -> pure t' + {- Note [Non-Empty Content Types] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Rather than have @@ -660,19 +1115,35 @@ checkContentTypeHeader :: RunClient m => Response -> m MediaType checkContentTypeHeader response = case lookup "Content-Type" $ toList $ responseHeaders response of - Nothing -> return $ "application"//"octet-stream" + Nothing -> return $ "application" Media.// "octet-stream" Just t -> case parseAccept t of 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 +decodedAs response@Response{responseBody=body} ct = do responseContentType <- checkContentTypeHeader response unless (any (matches responseContentType) accept) $ throwClientError $ UnsupportedContentType responseContentType response - case mimeUnrender ct $ responseBody response of + case mimeUnrender ct body of Left err -> throwClientError $ DecodeFailure (T.pack err) response Right val -> return val where - accept = toList $ contentTypes ct + accept = toList $ contentTypes ct + +------------------------------------------------------------------------------- +-- Custom type errors +------------------------------------------------------------------------------- + +-- Erroring instance for HasClient' when a combinator is not fully applied +instance (RunClient m, TypeError (PartialApplication HasClient arr)) => HasClient m ((arr :: a -> b) :> sub) + where + type Client m (arr :> sub) = TypeError (PartialApplication HasClient arr) + clientWithRoute _ _ _ = error "unreachable" + hoistClientMonad _ _ _ _ = error "unreachable" + +-- Erroring instances for 'HasClient' for unknown API combinators +instance {-# OVERLAPPABLE #-} (RunClient m, TypeError (NoInstanceForSub (HasClient m) ty)) => HasClient m (ty :> sub) + +instance {-# OVERLAPPABLE #-} (RunClient m, TypeError (NoInstanceFor (HasClient m api))) => HasClient m api diff --git a/src/Servant/Client/Core/MultiVerb/ResponseUnrender.hs b/src/Servant/Client/Core/MultiVerb/ResponseUnrender.hs new file mode 100644 --- /dev/null +++ b/src/Servant/Client/Core/MultiVerb/ResponseUnrender.hs @@ -0,0 +1,131 @@ +{-# LANGUAGE ApplicativeDo #-} +module Servant.Client.Core.MultiVerb.ResponseUnrender where + +import Control.Applicative +import Control.Monad +import Data.Kind (Type) +import Data.SOP +import Data.Typeable +import GHC.TypeLits +import Network.HTTP.Types.Status (Status) +import qualified Data.ByteString.Lazy as BSL +import qualified Network.HTTP.Media as M + +import Servant.API.ContentTypes +import Servant.API.MultiVerb +import Servant.API.Status +import Servant.API.UVerb.Union (Union) +import Servant.Client.Core.Response (ResponseF(..)) +import qualified Servant.Client.Core.Response as Response +import Servant.API.Stream (SourceIO) +import Data.ByteString (ByteString) + +data SomeClientResponse = forall a. Typeable a => SomeClientResponse (ResponseF a) + +fromSomeClientResponse + :: forall a m. (Alternative m, Typeable a) + => SomeClientResponse + -> m (ResponseF a) +fromSomeClientResponse (SomeClientResponse Response {..}) = do + body <- maybe empty pure $ cast @_ @a responseBody + pure $ + Response + { responseBody = body, + .. + } + +class ResponseUnrender cs a where + type ResponseBody a :: Type + type ResponseStatus a :: Nat + responseUnrender + :: M.MediaType + -> ResponseF (ResponseBody a) + -> UnrenderResult (ResponseType a) + +class (Typeable as) => ResponseListUnrender cs as where + responseListUnrender + :: M.MediaType + -> SomeClientResponse + -> UnrenderResult (Union (ResponseTypes as)) + + responseListStatuses :: [Status] + +instance ResponseListUnrender cs '[] where + responseListUnrender _ _ = StatusMismatch + responseListStatuses = [] + +instance + ( Typeable a, + Typeable (ResponseBody a), + ResponseUnrender cs a, + ResponseListUnrender cs as, + KnownStatus (ResponseStatus a) + ) => + ResponseListUnrender cs (a ': as) + where + responseListUnrender c output = + Z . I <$> (responseUnrender @cs @a c =<< fromSomeClientResponse output) + <|> S <$> responseListUnrender @cs @as c output + + responseListStatuses = statusVal (Proxy @(ResponseStatus a)) : responseListStatuses @cs @as + +instance + ( KnownStatus s, + MimeUnrender ct a + ) => + ResponseUnrender cs (RespondAs (ct :: Type) s desc a) + where + type ResponseStatus (RespondAs ct s desc a) = s + type ResponseBody (RespondAs ct s desc a) = BSL.ByteString + + responseUnrender _ output = do + guard (responseStatusCode output == statusVal (Proxy @s)) + either UnrenderError UnrenderSuccess $ + mimeUnrender (Proxy @ct) (Response.responseBody output) + +instance (KnownStatus s) => ResponseUnrender cs (RespondAs '() s desc ()) where + type ResponseStatus (RespondAs '() s desc ()) = s + type ResponseBody (RespondAs '() s desc ()) = () + + responseUnrender _ output = + guard (responseStatusCode output == statusVal (Proxy @s)) + +instance + (KnownStatus s) + => ResponseUnrender cs (RespondStreaming s desc framing ct) + where + type ResponseStatus (RespondStreaming s desc framing ct) = s + type ResponseBody (RespondStreaming s desc framing ct) = SourceIO ByteString + + responseUnrender _ resp = do + guard (Response.responseStatusCode resp == statusVal (Proxy @s)) + pure $ Response.responseBody resp + +instance + (AllMimeUnrender cs a, KnownStatus s) + => ResponseUnrender cs (Respond s desc a) where + type ResponseStatus (Respond s desc a) = s + type ResponseBody (Respond s desc a) = BSL.ByteString + + responseUnrender c output = do + guard (responseStatusCode output == statusVal (Proxy @s)) + let results = allMimeUnrender (Proxy @cs) + case lookup c results of + Nothing -> empty + Just f -> either UnrenderError UnrenderSuccess (f (responseBody output)) + +instance + ( AsHeaders xs (ResponseType r) a, + ServantHeaders hs xs, + ResponseUnrender cs r + ) => + ResponseUnrender cs (WithHeaders hs a r) + where + type ResponseStatus (WithHeaders hs a r) = ResponseStatus r + type ResponseBody (WithHeaders hs a r) = ResponseBody r + + responseUnrender c output = do + x <- responseUnrender @cs @r c output + case extractHeaders @hs (responseHeaders output) of + Nothing -> UnrenderError "Failed to parse headers" + Just hs -> pure $ fromHeaders @xs (hs, x) diff --git a/src/Servant/Client/Core/Reexport.hs b/src/Servant/Client/Core/Reexport.hs --- a/src/Servant/Client/Core/Reexport.hs +++ b/src/Servant/Client/Core/Reexport.hs @@ -5,6 +5,11 @@ ( -- * HasClient HasClient(..) + , foldMapUnion + , matchUnion + , AsClientT + , (//) + , (/:) -- * Response (for @Raw@) , Response @@ -21,6 +26,7 @@ , showBaseUrl , parseBaseUrl , InvalidBaseUrlException + ) where diff --git a/src/Servant/Client/Core/Request.hs b/src/Servant/Client/Core/Request.hs --- a/src/Servant/Client/Core/Request.hs +++ b/src/Servant/Client/Core/Request.hs @@ -17,6 +17,8 @@ addHeader, appendToPath, appendToQueryString, + encodeQueryParamValue, + setQueryString, setRequestBody, setRequestBodyLBS, ) where @@ -33,10 +35,10 @@ import Data.Bitraversable (Bitraversable (..), bifoldMapDefault, bimapDefault) import qualified Data.ByteString as BS +import Data.ByteString.Builder + (Builder) import qualified Data.ByteString.Builder as Builder import qualified Data.ByteString.Lazy as LBS -import Data.Semigroup - ((<>)) import qualified Data.Sequence as Seq import Data.Text (Text) @@ -49,10 +51,10 @@ import Network.HTTP.Media (MediaType) import Network.HTTP.Types - (Header, HeaderName, HttpVersion (..), Method, QueryItem, - http11, methodGet) + (Header, HeaderName, HttpVersion (..), Method, Query, QueryItem, + http11, methodGet, urlEncodeBuilder) import Servant.API - (ToHttpApiData, toEncodedUrlPiece, toHeader, SourceIO) + (ToHttpApiData, toQueryParam, toHeader, SourceIO) import Servant.Client.Core.Internal (mediaTypeRnf) @@ -64,8 +66,33 @@ , requestHeaders :: Seq.Seq Header , requestHttpVersion :: HttpVersion , requestMethod :: Method - } deriving (Generic, Typeable, Eq, Show, Functor, Foldable, Traversable) + } deriving (Generic, Typeable, Eq, Functor, Foldable, Traversable) +instance (Show a, Show b) => + Show (Servant.Client.Core.Request.RequestF a b) where + showsPrec p req + = showParen + (p >= 11) + ( showString "Request {requestPath = " + . showsPrec 0 (requestPath req) + . showString ", requestQueryString = " + . showsPrec 0 (requestQueryString req) + . showString ", requestBody = " + . showsPrec 0 (requestBody req) + . showString ", requestAccept = " + . showsPrec 0 (requestAccept req) + . showString ", requestHeaders = " + . showsPrec 0 (redactSensitiveHeader <$> requestHeaders req) + . showString ", requestHttpVersion = " + . showsPrec 0 (requestHttpVersion req) + . showString ", requestMethod = " + . showsPrec 0 (requestMethod req) + . showString "}" + ) + where + redactSensitiveHeader :: Header -> Header + redactSensitiveHeader ("Authorization", _) = ("Authorization", "") + redactSensitiveHeader h = h instance Bifunctor RequestF where bimap = bimapDefault instance Bifoldable RequestF where bifoldMap = bifoldMapDefault instance Bitraversable RequestF where @@ -88,7 +115,7 @@ rnfB Nothing = () rnfB (Just (b, mt)) = rnf b `seq` mediaTypeRnf mt -type Request = RequestF RequestBody Builder.Builder +type Request = RequestF RequestBody Builder -- | The request body. R replica of the @http-client@ @RequestBody@. data RequestBody @@ -119,18 +146,37 @@ , requestMethod = methodGet } -appendToPath :: Text -> Request -> Request +-- | Append extra path to the request being constructed. +-- +-- Warning: This function assumes that the path fragment is already URL-encoded. +appendToPath :: Builder -> Request -> Request appendToPath p req - = req { requestPath = requestPath req <> "/" <> toEncodedUrlPiece p } + = req { requestPath = requestPath req <> "/" <> p } -appendToQueryString :: Text -- ^ param name - -> Maybe Text -- ^ param value +-- | Append a query parameter to the request being constructed. +-- +appendToQueryString :: Text -- ^ query param name + -> Maybe BS.ByteString -- ^ query param value -> Request -> Request appendToQueryString pname pvalue req = req { requestQueryString = requestQueryString req - Seq.|> (encodeUtf8 pname, encodeUtf8 <$> pvalue)} + Seq.|> (encodeUtf8 pname, pvalue)} +setQueryString :: Query + -> Request + -> Request +setQueryString query req + = req { requestQueryString = Seq.fromList query } + +-- | Encode a query parameter value. +-- +encodeQueryParamValue :: ToHttpApiData a => a -> BS.ByteString +encodeQueryParamValue = LBS.toStrict . Builder.toLazyByteString + . urlEncodeBuilder True . encodeUtf8 . toQueryParam + +-- | Add header to the request being constructed. +-- addHeader :: ToHttpApiData a => HeaderName -> a -> Request -> Request addHeader name val req = req { requestHeaders = requestHeaders req Seq.|> (name, toHeader val)} diff --git a/src/Servant/Client/Core/Response.hs b/src/Servant/Client/Core/Response.hs --- a/src/Servant/Client/Core/Response.hs +++ b/src/Servant/Client/Core/Response.hs @@ -1,17 +1,17 @@ {-# LANGUAGE DeriveDataTypeable #-} -{-# LANGUAGE DeriveFoldable #-} -{-# LANGUAGE DeriveFunctor #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DeriveTraversable #-} {-# LANGUAGE MultiParamTypeClasses #-} {-# LANGUAGE RankNTypes #-} {-# LANGUAGE ScopedTypeVariables #-} {-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE NamedFieldPuns #-} module Servant.Client.Core.Response ( Response, StreamingResponse, ResponseF (..), + responseToInternalResponse, ) where import Prelude () @@ -31,6 +31,7 @@ import Servant.API.Stream (SourceIO) +import Servant.Types.Internal.Response data ResponseF a = Response { responseStatusCode :: Status @@ -51,3 +52,7 @@ type Response = ResponseF LBS.ByteString type StreamingResponse = ResponseF (SourceIO BS.ByteString) + +responseToInternalResponse :: ResponseF a -> InternalResponse a +responseToInternalResponse Response{responseStatusCode, responseHeaders,responseBody} = + InternalResponse responseStatusCode responseHeaders responseBody diff --git a/src/Servant/Client/Core/RunClient.hs b/src/Servant/Client/Core/RunClient.hs --- a/src/Servant/Client/Core/RunClient.hs +++ b/src/Servant/Client/Core/RunClient.hs @@ -4,9 +4,11 @@ {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE ScopedTypeVariables #-} {-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} -- | Types for possible backends to run client-side `Request` queries module Servant.Client.Core.RunClient ( RunClient (..), + runRequest, RunStreamingClient (..), ClientF (..), ) where @@ -14,6 +16,8 @@ import Prelude () import Prelude.Compat +import Network.HTTP.Types.Status + (Status) import Control.Monad.Free (Free (..), liftF) @@ -22,10 +26,15 @@ import Servant.Client.Core.Response class Monad m => RunClient m where - -- | How to make a request. - runRequest :: Request -> m Response + -- | How to make a request, with an optional list of status codes to not throw exceptions + -- for (default: [200..299]). + runRequestAcceptStatus :: Maybe [Status] -> Request -> m Response throwClientError :: ClientError -> m a +-- | How to make a request. +runRequest :: RunClient m => Request -> m Response +runRequest = runRequestAcceptStatus Nothing + class RunClient m => RunStreamingClient m where withStreamingRequest :: Request -> (StreamingResponse -> IO a) -> m a @@ -41,6 +50,7 @@ | Throw ClientError deriving (Functor) +-- TODO: honour the accept-status argument. instance ClientF ~ f => RunClient (Free f) where - runRequest req = liftF (RunRequest req id) + runRequestAcceptStatus _ req = liftF (RunRequest req id) throwClientError = liftF . Throw diff --git a/src/Servant/Client/Core/ServerSentEvents.hs b/src/Servant/Client/Core/ServerSentEvents.hs new file mode 100644 --- /dev/null +++ b/src/Servant/Client/Core/ServerSentEvents.hs @@ -0,0 +1,304 @@ +{-# LANGUAGE DeriveFunctor #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# OPTIONS_GHC -Wno-error=unused-imports #-} + +-- | Server-sent events +-- +-- See for more details +-- on server-sent events (SSE). +-- +module Servant.Client.Core.ServerSentEvents ( + EventMessage (..), + EventIgnoreReason (..), + Event (..), + EventStreamT (..), + JsonEventStreamT (..), + EventMessageStreamT (..) +) where + +import Control.Applicative (Alternative ((<|>))) +import Control.Monad.IO.Class (MonadIO) +import qualified Data.Aeson as Aeson +import qualified Data.Attoparsec.ByteString as Attoparsec +import qualified Data.ByteString as ByteString +import qualified Data.ByteString.Char8 as ByteString.Char8 +import qualified Data.ByteString.Lazy as ByteString.Lazy +import Data.Char (chr) +import Data.Coerce (coerce) +import Data.Foldable (traverse_) +import Data.Functor (void) +import qualified Data.Text as Text +import Data.Text.Encoding (encodeUtf8) +import GHC.Generics (Generic) +import Numeric.Natural (Natural) +import Servant.API.ContentTypes (EventStreamChunk (..)) +import Servant.API.Stream (FromSourceIO (..)) +import Servant.Types.SourceT + (SourceT, StepT (..), foreachYieldStep, mapStepT, + transformStepWithAtto) + +-- For compatibility with GHC <= 8.2 +import Data.Semigroup (Semigroup (..)) + +-- | Line (or frame) of an event stream +newtype EventStreamLine = EventStreamLine + { unEventStreamLine :: ByteString.ByteString } + deriving Show + +-- | Consume chunks to produce event stream lines. +eventLinesFromRawChunks + :: Monad m + => StepT m ByteString.ByteString + -> StepT m EventStreamLine +eventLinesFromRawChunks = + transformStepWithAtto eventLine + +-- | Consume event stream chunks to produce event stream lines. +eventLinesFromChunks + :: Monad m + => StepT m EventStreamChunk + -> StepT m EventStreamLine +eventLinesFromChunks = + -- 'coerce' efficiently unpacks the 'EventStreamChunk' + eventLinesFromRawChunks . fmap (coerce ByteString.Lazy.toStrict) + +-- | Apply a 'Attoparsec.Parser' to each line of the event stream individually. +parseEventLines + :: Monad m + => Attoparsec.Parser a + -> StepT m EventStreamLine + -> StepT m a +parseEventLines parser = + foreachYieldStep $ \(EventStreamLine line) next -> + case Attoparsec.parseOnly parser line of + Left err -> Error err + Right value -> Yield value next + +-- | A line of an event stream +eventLine :: Attoparsec.Parser EventStreamLine +eventLine = do + Attoparsec.option () byteOrderMark -- A line may be prefixed with a byte order mark + EventStreamLine <$> untilLineEnd <* lineEnd + +-- | Byte order mark (U+FEFF) in UTF-8 representation +byteOrderMark :: Attoparsec.Parser () +byteOrderMark = + traverse_ Attoparsec.word8 + $ ByteString.unpack + $ encodeUtf8 + $ Text.singleton + $ chr 0xFEFF + +-- | Event stream line ending +lineEnd :: Attoparsec.Parser () +lineEnd = + (cr >> lf) <|> cr <|> lf <|> Attoparsec.endOfInput + where + cr = void (Attoparsec.word8 0x0D) + lf = void (Attoparsec.word8 0x0A) + +-- | Consume all contents until the end of the line. +untilLineEnd :: Attoparsec.Parser ByteString.ByteString +untilLineEnd = Attoparsec.takeWhile (\w8 -> w8 /= 0x0D && w8 /= 0x0A) + +-- | Structured variant of an event line of an event stream +data EventMessage + = EventDispatch + -- ^ Dispatch on the accumulated event. + | EventSetName ByteString.ByteString + -- ^ Set the name of the current event. + | EventSetLastId ByteString.ByteString + -- ^ Set the last event identifier. + | EventData ByteString.ByteString + -- ^ Append data to the event's data buffer. + | EventRetry Natural + -- ^ Set the event stream's reconnection time. + | EventIgnore EventIgnoreReason + -- ^ Ignored + deriving (Show, Eq, Ord) + +-- | Reason why a event line can be ignored +data EventIgnoreReason + = EventFieldNameUnknown ByteString.ByteString + | EventRetryNonNumeric ByteString.ByteString + | EventComment ByteString.ByteString + deriving (Show, Eq, Ord) + +-- | Parse the event stream lines into more structured messages. +eventMessagesFromLines + :: Monad m + => StepT m EventStreamLine + -> StepT m EventMessage +eventMessagesFromLines = + ensureLastDispatch False . parseEventLines eventMessage + where + -- | Make sure the last event message is a dispatch. + ensureLastDispatch didDispatch step = case step of + Stop -> + if not didDispatch then Yield EventDispatch Stop else Stop + Yield other next -> + Yield other $ ensureLastDispatch (other == EventDispatch) next + Skip next -> + Skip $ ensureLastDispatch didDispatch next + Effect eff -> + Effect $ ensureLastDispatch didDispatch <$> eff + err@Error{} -> + err + +-- | Event line parser for an event message. +eventMessage :: Attoparsec.Parser EventMessage +eventMessage = + ignore <|> field <|> dispatch + where + ignore = do + _ <- Attoparsec.word8 0x3A -- ':' + EventIgnore . EventComment <$> Attoparsec.takeByteString + + dispatch = do + Attoparsec.endOfInput + pure EventDispatch + + field = do + name <- Attoparsec.takeWhile1 (/= 0x3A) -- Up to ':' or the end + + value <- Attoparsec.option ByteString.empty $ do + _ <- Attoparsec.word8 0x3A -- ':' + _ <- Attoparsec.option 0x20 $ Attoparsec.word8 0x20 -- Optional ' ' + Attoparsec.takeByteString + + pure $ case name of + "event" -> EventSetName value + + "data" -> EventData value + + "id" -> EventSetLastId value + + "retry" -> + -- The retry value consist of digits. + if ByteString.all (\w8 -> 0x30 <= w8 && w8 <= 0x39) value then + EventRetry (read (ByteString.Char8.unpack value)) + else + EventIgnore (EventRetryNonNumeric value) + + _ -> EventIgnore (EventFieldNameUnknown name) + +-- | Event sent by the remote +data Event a = Event + { eventName :: Maybe ByteString.ByteString + , eventData :: a + } + deriving (Show, Eq, Ord, Functor, Generic) + +-- | Accumulate event messages to build individual 'Event's. +eventsFromMessages + :: Functor m + => StepT m EventMessage + -> StepT m (Event ByteString.ByteString) +eventsFromMessages = + initGo + where + initGo = go Nothing ByteString.Lazy.empty + + combineData dataBuffer newData = + if ByteString.Lazy.null dataBuffer then + ByteString.Lazy.fromStrict newData + else + ByteString.Lazy.concat + [ dataBuffer + , ByteString.Lazy.singleton 0x0A -- Line feed + , ByteString.Lazy.fromStrict newData + ] + + go name dataBuffer step = case step of + Stop -> + Stop + Skip next -> + go name dataBuffer next + Effect eff -> + Effect (go name dataBuffer <$> eff) + Error err -> + Error err + Yield message next -> case message of + EventSetName newName -> + go (Just newName) dataBuffer next + EventData newData -> + go name (combineData dataBuffer newData) next + EventDispatch -> + Yield + (Event name (ByteString.Lazy.toStrict dataBuffer)) + (initGo next) + _ -> + -- We ignore other message because they don't fit into + -- the 'Event' type. If a user needs more fine grained + -- control, the 'EventMessage' interface is better suited. + go name dataBuffer next + +-- | Server-sent event stream (SSE) +-- +-- See for more details. +-- +newtype EventMessageStreamT m = EventMessageStreamT + { unEventMessageStreamT :: SourceT m EventMessage } + deriving stock (Show) + deriving newtype (Semigroup, Monoid) + +-- | Server-sent event messages +-- +-- 'EventMessage' gives you more control over the communication with the server +-- than 'Event'. +-- +instance MonadIO m => FromSourceIO EventStreamChunk (EventMessageStreamT m) where + fromSourceIO src = + EventMessageStreamT + . mapStepT (eventMessagesFromLines . eventLinesFromChunks) + <$> fromSourceIO src + +-- | Server-sent event stream (SSE) +-- +-- See for more details. +-- +newtype EventStreamT m = EventStreamT + { unEventStreamT :: SourceT m (Event ByteString.ByteString) } + deriving stock (Show) + deriving newtype (Semigroup, Monoid) + +-- | Server-sent events +instance MonadIO m => FromSourceIO EventStreamChunk (EventStreamT m) where + fromSourceIO input = do + src :: EventMessageStreamT m <- fromSourceIO input + pure $ + -- 'coerce' is used in place of unpacking and repacking 'EventStreamT' + coerce (mapStepT eventsFromMessages) src + +-- | Try to parse event data to JSON. +jsonEventsFromEvents + :: (Functor m, Aeson.FromJSON a) + => StepT m (Event ByteString.ByteString) + -> StepT m (Event a) +jsonEventsFromEvents = + foreachYieldStep $ \(Event name datas) next -> + either + Error + (\value -> Yield (Event name value) next) + (Aeson.eitherDecode (ByteString.Lazy.fromStrict datas)) + +-- | Server-sent event stream (SSE) for JSON values +newtype JsonEventStreamT m a = JsonEventStreamT + { unJsonEventStreamT :: SourceT m (Event a) } + deriving stock (Show, Functor) + deriving newtype (Semigroup, Monoid) + +-- | Server-sent JSON event stream +instance (MonadIO m, Aeson.FromJSON a) => FromSourceIO EventStreamChunk (JsonEventStreamT m a) where + fromSourceIO input = do + src :: EventStreamT m <- fromSourceIO input + pure $ + -- The 'coerce' efficiently unwraps the 'EventStreamT' and wraps the + -- JsonEventStreamT. + coerce + (mapStepT jsonEventsFromEvents) + src diff --git a/src/Servant/Client/Generic.hs b/src/Servant/Client/Generic.hs --- a/src/Servant/Client/Generic.hs +++ b/src/Servant/Client/Generic.hs @@ -1,9 +1,11 @@ -{-# LANGUAGE ConstraintKinds #-} -{-# LANGUAGE FlexibleContexts #-} -{-# LANGUAGE KindSignatures #-} -{-# LANGUAGE RankNTypes #-} -{-# LANGUAGE ScopedTypeVariables #-} -{-# LANGUAGE TypeFamilies #-} +{-# OPTIONS_GHC -fno-warn-orphans #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE KindSignatures #-} +{-# LANGUAGE RankNTypes #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + module Servant.Client.Generic ( AsClientT, genericClient, @@ -15,11 +17,7 @@ import Servant.API.Generic import Servant.Client.Core - --- | A type that specifies that an API reocrd contains a client implementation. -data AsClientT (m :: * -> *) -instance GenericMode (AsClientT m) where - type AsClientT m :- api = Client m api +import Servant.Client.Core.HasClient (AsClientT) -- | Generate a record of client functions. genericClient diff --git a/test/Servant/Client/Core/RequestSpec.hs b/test/Servant/Client/Core/RequestSpec.hs new file mode 100644 --- /dev/null +++ b/test/Servant/Client/Core/RequestSpec.hs @@ -0,0 +1,31 @@ +{-# OPTIONS_GHC -fno-warn-orphans #-} +{-# LANGUAGE OverloadedStrings #-} +module Servant.Client.Core.RequestSpec (spec) where + + +import Prelude () +import Prelude.Compat +import Control.Monad +import Data.List (isInfixOf) +import Servant.Client.Core.Request +import Test.Hspec + +newtype DataWithRequest = DataWithRequest (RequestF RequestBody ()) + deriving Show + +spec :: Spec +spec = do + describe "Request" $ do + describe "show" $ do + it "has parenthesis correctly positioned" $ do + let d = DataWithRequest (void defaultRequest) + show d `shouldBe` "DataWithRequest (Request {requestPath = ()\ + \, requestQueryString = fromList []\ + \, requestBody = Nothing\ + \, requestAccept = fromList []\ + \, requestHeaders = fromList []\ + \, requestHttpVersion = HTTP/1.1\ + \, requestMethod = \"GET\"})" + it "redacts the authorization header" $ do + let request = void $ defaultRequest { requestHeaders = pure ("authorization", "secret") } + isInfixOf "secret" (show request) `shouldBe` False diff --git a/test/Servant/Client/Core/ServerSentEventsSpec.hs b/test/Servant/Client/Core/ServerSentEventsSpec.hs new file mode 100644 --- /dev/null +++ b/test/Servant/Client/Core/ServerSentEventsSpec.hs @@ -0,0 +1,100 @@ +{-# LANGUAGE OverloadedStrings #-} + +module Servant.Client.Core.ServerSentEventsSpec (spec) where + +import Control.Monad.Trans.Except (runExceptT) +import qualified Data.ByteString.Lazy as ByteString +import Data.Foldable (for_) +import Data.Int (Int64) +import Servant.API.ContentTypes (EventStreamChunk (..)) +import Servant.API.Stream + (FromSourceIO (fromSourceIO)) +import Servant.Client.Core.ServerSentEvents + (Event (..), EventIgnoreReason (EventComment), + EventMessage (..), unEventMessageStreamT, unEventStreamT) +import Servant.Types.SourceT (runSourceT, source) +import Test.Hspec + (Spec, describe, it, shouldBe) + +spec :: Spec +spec = describe "Servant.Client.Core.ServerSentEvent" $ do + describe "EventMessageStreamT" $ do + it "processes chunks correctly" $ do + let allMessages = ByteString.intercalate "\n" + [ "retry: 30" + , "data: Hello World" + , "id: 1" + , "" + , "event: my_event" + , "data" + , "id: 2" + , ":Just a comment" + , "" + , "data: Bye" + ] + + for_ [1, 10, 100] $ \chunkSize -> do + src <- + fromSourceIO + $ source + $ map EventStreamChunk + $ chunkify chunkSize allMessages + + result <- + runExceptT + $ runSourceT + $ unEventMessageStreamT src + + result `shouldBe` Right + [ EventRetry 30 + , EventData "Hello World" + , EventSetLastId "1" + , EventDispatch + , EventSetName "my_event" + , EventData "" + , EventSetLastId "2" + , EventIgnore (EventComment "Just a comment") + , EventDispatch + , EventData "Bye" + , EventDispatch + ] + + describe "EventStreamT" $ do + it "processes chunks correctly" $ do + let allMessages = ByteString.intercalate "\n" + [ "retry: 30" + , "data: Hello World" + , "id: 1" + , "" + , "event: my_event" + , "data" + , "id: 2" + , ":Just a comment" + , "" + , "data: Bye" + ] + + for_ [1, 10, 100] $ \chunkSize -> do + src <- + fromSourceIO + $ source + $ map EventStreamChunk + $ chunkify chunkSize allMessages + result <- + runExceptT + $ runSourceT + $ unEventStreamT src + + result `shouldBe` Right + [ Event Nothing "Hello World" + , Event (Just "my_event") "" + , Event Nothing "Bye" + ] + +chunkify :: Int64 -> ByteString.ByteString -> [ByteString.ByteString] +chunkify chunkSize input = + if ByteString.null input then + [] + else + let (h, t) = ByteString.splitAt chunkSize input + in h : chunkify chunkSize t