Make ouroboros-network-api independent of `ouroboros-network-framew…

…ork` This way `ouroboros-network-protocols` does not contain `ouroboros-network-framework` as its transitive dependency.
IntersectMBO · Nov 25, 2022 · a9ab8d9 · a9ab8d9
1 parent 3a2c7c2
commit a9ab8d9
Show file tree

Hide file tree

Showing 11 changed files with 152 additions and 78 deletions.
diff --git a/ouroboros-network-api/ouroboros-network-api.cabal b/ouroboros-network-api/ouroboros-network-api.cabal
@@ -39,6 +39,8 @@ library
                        Ouroboros.Network.SizeInBytes
                        Ouroboros.Network.Util.ShowProxy
 
+                       Ouroboros.Network.Protocol.Limits
+
                        Ouroboros.Network.PeerSelection.LedgerPeers.Type
                        Ouroboros.Network.PeerSelection.PeerMetric.Type
                        Ouroboros.Network.PeerSelection.RelayAccessPoint
@@ -67,6 +69,7 @@ library
                        io-classes       ^>=0.3,
                        network-mux       >=0.1 && <1.0,
                        strict-stm       ^>=0.2,
+                       typed-protocols  ^>=0.1,
 
   ghc-options:         -Wall
                        -Wno-unticked-promoted-constructors

diff --git a/ouroboros-network-api/src/Ouroboros/Network/Protocol/Limits.hs b/ouroboros-network-api/src/Ouroboros/Network/Protocol/Limits.hs
@@ -0,0 +1,84 @@
+{-# LANGUAGE DataKinds             #-}
+{-# LANGUAGE FlexibleContexts      #-}
+{-# LANGUAGE GADTs                 #-}
+{-# LANGUAGE PolyKinds             #-}
+{-# LANGUAGE QuantifiedConstraints #-}
+{-# LANGUAGE RankNTypes            #-}
+{-# LANGUAGE ScopedTypeVariables   #-}
+
+module Ouroboros.Network.Protocol.Limits where
+
+import           Control.Exception
+import           Control.Monad.Class.MonadTime
+
+import           Network.TypedProtocol.Core
+
+import           Ouroboros.Network.Util.ShowProxy
+
+
+data ProtocolSizeLimits ps bytes = ProtocolSizeLimits {
+       sizeLimitForState :: forall (pr :: PeerRole) (st :: ps).
+                            PeerHasAgency pr st -> Word,
+
+       dataSize          :: bytes -> Word
+     }
+
+data ProtocolTimeLimits ps = ProtocolTimeLimits {
+       timeLimitForState :: forall (pr :: PeerRole) (st :: ps).
+                            PeerHasAgency pr st -> Maybe DiffTime
+     }
+
+data ProtocolLimitFailure where
+    ExceededSizeLimit :: forall (pr :: PeerRole) ps (st :: ps).
+                         ( forall (st' :: ps). Show (ClientHasAgency st')
+                         , forall (st' :: ps). Show (ServerHasAgency st')
+                         , ShowProxy ps
+                         )
+                      => PeerHasAgency pr st
+                      -> ProtocolLimitFailure
+    ExceededTimeLimit :: forall (pr :: PeerRole) ps (st :: ps).
+                         ( forall (st' :: ps). Show (ClientHasAgency st')
+                         , forall (st' :: ps). Show (ServerHasAgency st')
+                         , ShowProxy ps
+                         )
+                      => PeerHasAgency pr st
+                      -> ProtocolLimitFailure
+
+instance Show ProtocolLimitFailure where
+    show (ExceededSizeLimit (stok :: PeerHasAgency pr (st :: ps))) =
+      concat
+        [ "ExceededSizeLimit ("
+        , showProxy (Proxy :: Proxy ps)
+        , ") ("
+        , show stok
+        , ")"
+        ]
+    show (ExceededTimeLimit (stok :: PeerHasAgency pr (st :: ps))) =
+      concat
+        [ "ExceededTimeLimit ("
+        , showProxy (Proxy :: Proxy ps)
+        , ") ("
+        , show stok
+        , ")"
+        ]
+
+instance Exception ProtocolLimitFailure where
+
+
+-- TODO: better limits
+
+largeByteLimit :: Word
+largeByteLimit = 2500000
+
+smallByteLimit :: Word
+smallByteLimit = 0xffff
+
+shortWait :: Maybe DiffTime
+shortWait = Just 10
+
+longWait :: Maybe DiffTime
+longWait = Just 60
+
+waitForever :: Maybe DiffTime
+waitForever = Nothing
+
diff --git a/ouroboros-network-api/src/Ouroboros/Network/Protocol/Type.hs b/ouroboros-network-api/src/Ouroboros/Network/Protocol/Type.hs
@@ -0,0 +1,64 @@
+{-# LANGUAGE DataKinds             #-}
+{-# LANGUAGE GADTs                 #-}
+{-# LANGUAGE PolyKinds             #-}
+{-# LANGUAGE QuantifiedConstraints #-}
+{-# LANGUAGE RankNTypes            #-}
+{-# LANGUAGE ScopedTypeVariables   #-}
+
+module Ouroboros.Network.Protocol.Type where
+
+import           Control.Exception
+import           Control.Monad.Class.MonadTime
+
+import           Network.TypedProtocol.Core
+
+import           Ouroboros.Network.Util.ShowProxy
+
+
+data ProtocolSizeLimits ps bytes = ProtocolSizeLimits {
+       sizeLimitForState :: forall (pr :: PeerRole) (st :: ps).
+                            PeerHasAgency pr st -> Word,
+
+       dataSize          :: bytes -> Word
+     }
+
+data ProtocolTimeLimits ps = ProtocolTimeLimits {
+       timeLimitForState :: forall (pr :: PeerRole) (st :: ps).
+                            PeerHasAgency pr st -> Maybe DiffTime
+     }
+
+data ProtocolLimitFailure where
+    ExceededSizeLimit :: forall (pr :: PeerRole) ps (st :: ps).
+                         ( forall (st' :: ps). Show (ClientHasAgency st')
+                         , forall (st' :: ps). Show (ServerHasAgency st')
+                         , ShowProxy ps
+                         )
+                      => PeerHasAgency pr st
+                      -> ProtocolLimitFailure
+    ExceededTimeLimit :: forall (pr :: PeerRole) ps (st :: ps).
+                         ( forall (st' :: ps). Show (ClientHasAgency st')
+                         , forall (st' :: ps). Show (ServerHasAgency st')
+                         , ShowProxy ps
+                         )
+                      => PeerHasAgency pr st
+                      -> ProtocolLimitFailure
+
+instance Show ProtocolLimitFailure where
+    show (ExceededSizeLimit (stok :: PeerHasAgency pr (st :: ps))) =
+      concat
+        [ "ExceededSizeLimit ("
+        , showProxy (Proxy :: Proxy ps)
+        , ") ("
+        , show stok
+        , ")"
+        ]
+    show (ExceededTimeLimit (stok :: PeerHasAgency pr (st :: ps))) =
+      concat
+        [ "ExceededTimeLimit ("
+        , showProxy (Proxy :: Proxy ps)
+        , ") ("
+        , show stok
+        , ")"
+        ]
+
+instance Exception ProtocolLimitFailure where
diff --git a/ouroboros-network-framework/ouroboros-network-framework.cabal b/ouroboros-network-framework/ouroboros-network-framework.cabal
@@ -44,7 +44,6 @@ library
                        Ouroboros.Network.Protocol.Handshake.Server
                        Ouroboros.Network.Protocol.Handshake.Version
                        Ouroboros.Network.Protocol.Handshake.Unversioned
-                       Ouroboros.Network.Protocol.Limits
 
                        Ouroboros.Network.ConnectionId
                        Ouroboros.Network.ConnectionHandler

diff --git a/ouroboros-network-framework/src/Ouroboros/Network/Driver/Limits.hs b/ouroboros-network-framework/src/Ouroboros/Network/Driver/Limits.hs
@@ -46,58 +46,10 @@ import           Network.TypedProtocol.Pipelined
 import           Ouroboros.Network.Channel
 import           Ouroboros.Network.Driver.Simple (DecoderFailure (..),
                      TraceSendRecv (..))
+import           Ouroboros.Network.Protocol.Limits
 import           Ouroboros.Network.Util.ShowProxy
 
 
-data ProtocolSizeLimits ps bytes = ProtocolSizeLimits {
-       sizeLimitForState :: forall (pr :: PeerRole) (st :: ps).
-                            PeerHasAgency pr st -> Word,
-
-       dataSize          :: bytes -> Word
-     }
-
-data ProtocolTimeLimits ps = ProtocolTimeLimits {
-       timeLimitForState :: forall (pr :: PeerRole) (st :: ps).
-                            PeerHasAgency pr st -> Maybe DiffTime
-     }
-
-data ProtocolLimitFailure where
-    ExceededSizeLimit :: forall (pr :: PeerRole) ps (st :: ps).
-                         ( forall (st' :: ps). Show (ClientHasAgency st')
-                         , forall (st' :: ps). Show (ServerHasAgency st')
-                         , ShowProxy ps
-                         )
-                      => PeerHasAgency pr st
-                      -> ProtocolLimitFailure
-    ExceededTimeLimit :: forall (pr :: PeerRole) ps (st :: ps).
-                         ( forall (st' :: ps). Show (ClientHasAgency st')
-                         , forall (st' :: ps). Show (ServerHasAgency st')
-                         , ShowProxy ps
-                         )
-                      => PeerHasAgency pr st
-                      -> ProtocolLimitFailure
-
-instance Show ProtocolLimitFailure where
-    show (ExceededSizeLimit (stok :: PeerHasAgency pr (st :: ps))) =
-      concat
-        [ "ExceededSizeLimit ("
-        , showProxy (Proxy :: Proxy ps)
-        , ") ("
-        , show stok
-        , ")"
-        ]
-    show (ExceededTimeLimit (stok :: PeerHasAgency pr (st :: ps))) =
-      concat
-        [ "ExceededTimeLimit ("
-        , showProxy (Proxy :: Proxy ps)
-        , ") ("
-        , show stok
-        , ")"
-        ]
-
-instance Exception ProtocolLimitFailure where
-
-
 driverWithLimits :: forall ps failure bytes m.
                     ( MonadThrow m
                     , Show failure

diff --git a/ouroboros-network-framework/src/Ouroboros/Network/Protocol/Limits.hs b/ouroboros-network-framework/src/Ouroboros/Network/Protocol/Limits.hs
diff --git a/ouroboros-network-protocols/ouroboros-network-protocols.cabal b/ouroboros-network-protocols/ouroboros-network-protocols.cabal
@@ -102,7 +102,6 @@ library
 
                        io-classes       ^>=0.3,
                        ouroboros-network-api,
-                       ouroboros-network-framework,
                        typed-protocols   >=0.1 && <1.0,
                        typed-protocols-cborg
                                          >=0.1 && <1.0

diff --git a/ouroboros-network-protocols/src/Ouroboros/Network/Protocol/BlockFetch/Codec.hs b/ouroboros-network-protocols/src/Ouroboros/Network/Protocol/BlockFetch/Codec.hs
@@ -26,7 +26,6 @@ import           Text.Printf
 
 import           Network.TypedProtocol.Codec.CBOR
 
-import           Ouroboros.Network.Driver.Limits
 import           Ouroboros.Network.Protocol.BlockFetch.Type
 import           Ouroboros.Network.Protocol.Limits
 

diff --git a/ouroboros-network-protocols/src/Ouroboros/Network/Protocol/ChainSync/Codec.hs b/ouroboros-network-protocols/src/Ouroboros/Network/Protocol/ChainSync/Codec.hs
@@ -18,7 +18,6 @@ import           Control.Monad.Class.MonadTime
 
 import           Network.TypedProtocol.Codec.CBOR
 
-import           Ouroboros.Network.Driver.Limits
 import           Ouroboros.Network.Protocol.ChainSync.Type
 import           Ouroboros.Network.Protocol.Limits
 

diff --git a/ouroboros-network-protocols/src/Ouroboros/Network/Protocol/KeepAlive/Codec.hs b/ouroboros-network-protocols/src/Ouroboros/Network/Protocol/KeepAlive/Codec.hs
@@ -28,7 +28,6 @@ import qualified Codec.CBOR.Read as CBOR
 import           Network.TypedProtocol.Codec.CBOR
 import           Network.TypedProtocol.Core
 
-import           Ouroboros.Network.Driver.Limits
 import           Ouroboros.Network.Protocol.KeepAlive.Type
 import           Ouroboros.Network.Protocol.Limits
 

diff --git a/ouroboros-network-protocols/src/Ouroboros/Network/Protocol/TxSubmission2/Codec.hs b/ouroboros-network-protocols/src/Ouroboros/Network/Protocol/TxSubmission2/Codec.hs
@@ -27,7 +27,6 @@ import           Text.Printf
 
 import           Network.TypedProtocol.Codec.CBOR
 
-import           Ouroboros.Network.Driver.Limits
 import           Ouroboros.Network.Protocol.Limits
 import           Ouroboros.Network.Protocol.TxSubmission2.Type