http2-grpc-types 0.2.0.0 → 0.3.0.0

raw patch · 2 files changed

+72/−22 lines, 2 filesdep +case-insensitivedep ~proto-lensdep ~zlibPVP ok

version bump matches the API change (PVP)

Dependencies added: case-insensitive

Dependency ranges changed: proto-lens, zlib

API changes (from Hackage documentation)

Files

• http2-grpc-types.cabal +4/−3
• src/Network/GRPC/HTTP2/Types.hs +68/−19

@@ -2,10 +2,10 @@ -- -- see: https://github.com/sol/hpack ----- hash: b69cc858a2d802606efae0a96ca6853e07cf06e31173a75330bb02c6f7ee5e1d+-- hash: 349f90f95352c0c528c813322451365c2dfeb1e8190fa26e94759fa4261cf16e  name:           http2-grpc-types-version:        0.2.0.0+version:        0.3.0.0 synopsis:       Types for gRPC over HTTP2 common for client and servers. description:    Please see the README on GitHub at <https://github.com/lucasdicioccio/http2-grpc-types#readme> category:       Network@@ -38,6 +38,7 @@       base >=4.7 && <5     , binary >=0.8.5 && <0.11     , bytestring >=0.10.8 && <0.11+    , case-insensitive >=1.2.0 && <1.3     , proto-lens >=0.3.1 && <0.4-    , zlib+    , zlib >=0.6.2 && <0.7   default-language: Haskell2010

@@ -7,14 +7,16 @@ module Network.GRPC.HTTP2.Types where  import           Control.Exception (Exception)+import           Data.Maybe (fromMaybe) import           Data.ProtoLens.Service.Types (Service(..), HasMethod, HasMethodImpl(..)) import           Data.Proxy (Proxy(..)) import           Data.ByteString.Char8 (ByteString) import qualified Data.ByteString.Char8 as ByteString+import           Data.CaseInsensitive (CI) import           GHC.TypeLits (Symbol, symbolVal)  -- | HTTP2 Header Key.-type HeaderKey = ByteString+type HeaderKey = CI ByteString  -- | HTTP2 Header Value. type HeaderValue = ByteString@@ -40,12 +42,6 @@ grpcContentTypeHV :: HeaderValue grpcContentTypeHV = "application/grpc+proto" -grpcStatusHV :: HeaderValue-grpcStatusHV = "Grpc-Status"--grpcMessageHV :: HeaderValue-grpcMessageHV = "Grpc-Message"- -- https://grpc.io/grpc/core/impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb data GRPCStatusCode =     OK@@ -67,7 +63,7 @@   | DATA_LOSS   deriving (Show, Eq, Ord) -trailerForStatusCode :: GRPCStatusCode -> ByteString+trailerForStatusCode :: GRPCStatusCode -> HeaderValue trailerForStatusCode = \case     OK       -> "0"@@ -104,43 +100,96 @@     DATA_LOSS       -> "15" -type GRPCStatusMessage = ByteString+type GRPCStatusMessage = HeaderValue  data GRPCStatus = GRPCStatus !GRPCStatusCode !GRPCStatusMessage   deriving (Show, Eq, Ord)  instance Exception GRPCStatus -trailers :: GRPCStatus -> [(ByteString, ByteString)]+statusCodeForTrailer :: HeaderValue -> Maybe GRPCStatusCode+statusCodeForTrailer = \case+    "0"+      -> Just OK+    "1"+      -> Just CANCELLED+    "2"+      -> Just UNKNOWN+    "3"+      -> Just INVALID_ARGUMENT+    "4"+      -> Just DEADLINE_EXCEEDED+    "5"+      -> Just NOT_FOUND+    "6"+      -> Just ALREADY_EXISTS+    "7"+      -> Just PERMISSION_DENIED+    "16"+      -> Just UNAUTHENTICATED+    "8"+      -> Just RESOURCE_EXHAUSTED+    "9"+      -> Just FAILED_PRECONDITION+    "10"+      -> Just ABORTED+    "11"+      -> Just OUT_OF_RANGE+    "12"+      -> Just UNIMPLEMENTED+    "13"+      -> Just INTERNAL+    "14"+      -> Just UNAVAILABLE+    "15"+      -> Just DATA_LOSS+    _+      -> Nothing++-- | Trailers for a GRPCStatus.+trailers :: GRPCStatus -> [(HeaderKey, HeaderValue)] trailers (GRPCStatus s msg) =     if ByteString.null msg then [status] else [status, message]   where-    status = ("grpc-status", trailerForStatusCode s)-    message = ("grpc-message", msg)+    status = (grpcStatusH, trailerForStatusCode s)+    message = (grpcMessageH, msg) +-- | In case a server replies with a gRPC status/message pair un-understood by this library.+data InvalidGRPCStatus = InvalidGRPCStatus [(HeaderKey, HeaderValue)]+  deriving (Show, Eq, Ord)++instance Exception InvalidGRPCStatus++-- | Read a 'GRPCStatus' from HTTP2 trailers.+readTrailers :: [(HeaderKey, HeaderValue)] -> Either InvalidGRPCStatus GRPCStatus+readTrailers pairs = maybe (Left $ InvalidGRPCStatus pairs) Right $ do+    status <- statusCodeForTrailer =<< lookup grpcStatusH pairs+    return $ GRPCStatus status message+  where+    message = fromMaybe "" (lookup grpcMessageH pairs)+ -- | A proxy type for giving static information about RPCs. data RPC (s :: *) (m :: Symbol) = RPC  -- | Returns the HTTP2 :path for a given RPC.-path :: (Service s, HasMethod s m) => RPC s m -> ByteString+path :: (Service s, HasMethod s m) => RPC s m -> HeaderValue {-# INLINE path #-} path rpc = "/" <> pkg rpc Proxy <> "." <> srv rpc Proxy <> "/" <> meth rpc Proxy   where-    pkg :: (Service s) => RPC s m -> Proxy (ServicePackage s) -> ByteString+    pkg :: (Service s) => RPC s m -> Proxy (ServicePackage s) -> HeaderValue     pkg _ p = ByteString.pack $ symbolVal p -    srv :: (Service s) => RPC s m -> Proxy (ServiceName s) -> ByteString+    srv :: (Service s) => RPC s m -> Proxy (ServiceName s) -> HeaderValue     srv _ p = ByteString.pack $ symbolVal p -    meth :: (Service s, HasMethod s m) => RPC s m -> Proxy (MethodName s m) -> ByteString+    meth :: (Service s, HasMethod s m) => RPC s m -> Proxy (MethodName s m) -> HeaderValue     meth _ p = ByteString.pack $ symbolVal p  -- | Timeout in seconds. newtype Timeout = Timeout Int -showTimeout :: Timeout -> ByteString+showTimeout :: Timeout -> HeaderValue showTimeout (Timeout n) = ByteString.pack $ show n ++ "S"  -- | The HTTP2-Authority portion of an URL (e.g., "dicioccio.fr:7777").-type Authority = ByteString.ByteString-+type Authority = HeaderValue