Break Idling into its own module

Author: agustinmista

ouroboros-consensus/bench/ChainSync-client-bench/Main.hs

@@ -37,6 +37,7 @@ import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.InFutureCheck
 import Ouroboros.Consensus.MiniProtocol.ChainSync.Server
   ( chainSyncServerForFollower
   )
+import qualified Ouroboros.Consensus.MiniProtocol.Util.Idling as Idling
 import Ouroboros.Consensus.Node.NetworkProtocolVersion
   ( NodeToNodeVersion
   )
@@ -158,7 +159,7 @@ oneBenchRun
           , CSClient.headerMetricsTracer = nullTracer
           , CSClient.setCandidate = writeTVar varCandidate
           , CSClient.setLatestSlot = \_ -> pure ()
-          , CSClient.idling = CSClient.noIdling
+          , CSClient.idling = Idling.noIdling
           , CSClient.loPBucket = CSClient.noLoPBucket
           , CSClient.jumping = CSClient.noJumping
           }

ouroboros-consensus/ouroboros-consensus.cabal

@@ -196,6 +196,8 @@ library
     Ouroboros.Consensus.MiniProtocol.ObjectDiffusion.ObjectPool.PerasCert
     Ouroboros.Consensus.MiniProtocol.ObjectDiffusion.Outbound
     Ouroboros.Consensus.MiniProtocol.ObjectDiffusion.PerasCert
+    Ouroboros.Consensus.MiniProtocol.Util
+    Ouroboros.Consensus.MiniProtocol.Util.Idling
     Ouroboros.Consensus.Node.GsmState
     Ouroboros.Consensus.Node.InitStorage
     Ouroboros.Consensus.Node.NetworkProtocolVersion

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/ChainSync/Client.hs

@@ -73,7 +73,6 @@ module Ouroboros.Consensus.MiniProtocol.ChainSync.Client
   , Jumping.noJumping
   , chainSyncStateFor
   , newChainSyncClientHandleCollection
-  , noIdling
   , noLoPBucket
   , viewChainSyncState
   ) where
@@ -122,6 +121,7 @@ import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.HistoricityCh
 import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.InFutureCheck as InFutureCheck
 import qualified Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping as Jumping
 import Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State
+import Ouroboros.Consensus.MiniProtocol.Util.Idling (Idling (..))
 import Ouroboros.Consensus.Node.GsmState (GsmState (..))
 import Ouroboros.Consensus.Node.NetworkProtocolVersion
 import Ouroboros.Consensus.Peras.Weight (emptyPerasWeightSnapshot)
@@ -272,26 +272,6 @@ chainSyncStateFor ::
 chainSyncStateFor varHandles peer =
   readTVar . cschState . (Map.! peer) =<< readTVar varHandles
 
--- | Interface for the ChainSync client to manipulate the idling flag in
--- 'ChainSyncState'.
-data Idling m = Idling
-  { idlingStart :: !(m ())
-  -- ^ Mark the peer as being idle.
-  , idlingStop :: !(m ())
-  -- ^ Mark the peer as not being idle.
-  }
-  deriving stock Generic
-
-deriving anyclass instance IOLike m => NoThunks (Idling m)
-
--- | No-op implementation, for tests.
-noIdling :: Applicative m => Idling m
-noIdling =
-  Idling
-    { idlingStart = pure ()
-    , idlingStop = pure ()
-    }
-
 -- | Interface to the LoP implementation for the ChainSync client.
 data LoPBucket m = LoPBucket
   { lbPause :: !(m ())

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/Util.hs

@@ -0,0 +1,5 @@
+module Ouroboros.Consensus.MiniProtocol.Util
+  ( module Ouroboros.Consensus.MiniProtocol.Util.Idling
+  ) where
+
+import Ouroboros.Consensus.MiniProtocol.Util.Idling

ouroboros-consensus/src/ouroboros-consensus/Ouroboros/Consensus/MiniProtocol/Util/Idling.hs

@@ -0,0 +1,31 @@
+{-# LANGUAGE DeriveAnyClass #-}
+{-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE DerivingStrategies #-}
+{-# LANGUAGE StandaloneDeriving #-}
+
+module Ouroboros.Consensus.MiniProtocol.Util.Idling
+  ( Idling (..)
+  , noIdling
+  ) where
+
+import GHC.Generics (Generic)
+import Ouroboros.Consensus.Util.IOLike (IOLike, NoThunks)
+
+-- | Interface to manipulate the idling flag in the client state of a peer.
+data Idling m = Idling
+  { idlingStart :: !(m ())
+  -- ^ Mark the peer as being idle.
+  , idlingStop :: !(m ())
+  -- ^ Mark the peer as not being idle.
+  }
+  deriving stock Generic
+
+deriving anyclass instance IOLike m => NoThunks (Idling m)
+
+-- | No-op implementation, for tests.
+noIdling :: Applicative m => Idling m
+noIdling =
+  Idling
+    { idlingStart = pure ()
+    , idlingStop = pure ()
+    }