refactor(simulation): migrate Chan modules into Chan hierarchy

wenkokke · wenkokke · commit 1b915aba318b · 2025-02-11T13:20:53.000Z
diff --git a/simulation/ouroboros-leios-sim.cabal b/simulation/ouroboros-leios-sim.cabal
@@ -42,9 +42,10 @@ library
 
   exposed-modules:
     Chan
-    ChanDriver
-    ChanMux
-    ChanTCP
+    Chan.Core
+    Chan.Driver
+    Chan.Mux
+    Chan.TCP
     Diffusion
     ExamplesLayout
     ExamplesRelay
diff --git a/simulation/src/Chan.hs b/simulation/src/Chan.hs
@@ -1,6 +1,11 @@
-module Chan where
+module Chan (
+  module Chan.Core,
+  module Chan.Driver,
+  module Chan.Mux,
+  module Chan.TCP,
+) where
 
-data Chan m a = Chan
-  { readChan :: m a
-  , writeChan :: a -> m ()
-  }
+import Chan.Core
+import Chan.Driver
+import Chan.Mux
+import Chan.TCP
diff --git a/simulation/src/Chan/Core.hs b/simulation/src/Chan/Core.hs
@@ -0,0 +1,6 @@
+module Chan.Core where
+
+data Chan m a = Chan
+  { readChan :: m a
+  , writeChan :: a -> m ()
+  }
diff --git a/simulation/src/Chan/Driver.hs b/simulation/src/Chan/Driver.hs
@@ -9,10 +9,10 @@
 {-# LANGUAGE UndecidableInstances #-}
 {-# OPTIONS_GHC -Wno-name-shadowing #-}
 
-module ChanDriver where
+module Chan.Driver where
 
-import Chan
-import ChanTCP
+import Chan.Core
+import Chan.TCP
 import Data.Type.Equality
 import Network.TypedProtocol (
   ActiveState,
diff --git a/simulation/src/Chan/Mux.hs b/simulation/src/Chan/Mux.hs
@@ -9,7 +9,7 @@
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE TypeFamilies #-}
 
-module ChanMux (
+module Chan.Mux (
   newMuxChan,
   Chan (..),
   ToFromMuxMsg (..),
@@ -20,8 +20,8 @@ module ChanMux (
   newConnectionBundleTCP,
 ) where
 
-import Chan
-import ChanTCP
+import Chan.Core
+import Chan.TCP
 import qualified Control.Category as Cat
 import Control.Concurrent.Class.MonadMVar (
   MonadMVar (MVar, newMVar, withMVar),
diff --git a/simulation/src/Chan/TCP.hs b/simulation/src/Chan/TCP.hs
@@ -2,7 +2,7 @@
 {-# LANGUAGE NamedFieldPuns #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 
-module ChanTCP (
+module Chan.TCP (
   newConnectionTCP,
   MessageSize (..),
   Bytes,
@@ -11,7 +11,7 @@ module ChanTCP (
   TcpConnProps (..),
 ) where
 
-import Chan (Chan (..))
+import Chan.Core (Chan (..))
 import Control.Exception (assert)
 import Control.Monad (when)
 import Control.Monad.Class.MonadAsync (MonadAsync (async))
diff --git a/simulation/src/LeiosProtocol/Common.hs b/simulation/src/LeiosProtocol/Common.hs
@@ -39,7 +39,7 @@ module LeiosProtocol.Common (
 )
 where
 
-import ChanTCP
+import Chan.TCP
 import Control.Exception (assert)
 import Control.Monad (guard)
 import Data.Aeson
diff --git a/simulation/src/LeiosProtocol/Relay.hs b/simulation/src/LeiosProtocol/Relay.hs
@@ -25,7 +25,7 @@
 module LeiosProtocol.Relay where
 
 import Chan
-import ChanDriver (ProtocolMessage, chanDriver)
+import Chan.Driver (ProtocolMessage, chanDriver)
 import Control.DeepSeq (NFData)
 import Control.Exception (Exception, assert, throw)
 import Control.Monad (forM_, join, unless, void, when)
diff --git a/simulation/src/LeiosProtocol/Short/Node.hs b/simulation/src/LeiosProtocol/Short/Node.hs
@@ -13,7 +13,7 @@
 
 module LeiosProtocol.Short.Node where
 
-import ChanMux
+import Chan.Mux
 import Control.Category ((>>>))
 import Control.Concurrent.Class.MonadMVar
 import Control.Concurrent.Class.MonadSTM.TSem
diff --git a/simulation/src/LeiosProtocol/Short/Sim.hs b/simulation/src/LeiosProtocol/Short/Sim.hs
@@ -12,9 +12,9 @@
 
 module LeiosProtocol.Short.Sim where
 
-import ChanDriver
-import ChanMux
-import ChanTCP
+import Chan.Driver
+import Chan.Mux
+import Chan.TCP
 import Control.Exception (assert)
 import Control.Monad (forever)
 import Control.Monad.Class.MonadFork (MonadFork (forkIO))
diff --git a/simulation/src/LeiosProtocol/Short/SimP2P.hs b/simulation/src/LeiosProtocol/Short/SimP2P.hs
@@ -6,8 +6,8 @@
 
 module LeiosProtocol.Short.SimP2P where
 
-import ChanMux (newConnectionBundleTCP)
-import ChanTCP
+import Chan.Mux (newConnectionBundleTCP)
+import Chan.TCP
 import Control.Monad (forever)
 import Control.Monad.Class.MonadFork (MonadFork (forkIO))
 import Control.Monad.IOSim as IOSim (IOSim, runSimTrace)
diff --git a/simulation/src/LeiosProtocol/Short/VizSim.hs b/simulation/src/LeiosProtocol/Short/VizSim.hs
@@ -9,7 +9,7 @@
 
 module LeiosProtocol.Short.VizSim where
 
-import ChanDriver
+import Chan.Driver
 import Control.Exception (assert)
 import Data.Coerce (coerce)
 import qualified Data.Foldable as Foldable
diff --git a/simulation/src/LeiosProtocol/Short/VizSimP2P.hs b/simulation/src/LeiosProtocol/Short/VizSimP2P.hs
@@ -16,7 +16,7 @@
 
 module LeiosProtocol.Short.VizSimP2P where
 
-import ChanDriver
+import Chan.Driver
 import Control.Arrow ((&&&))
 import Control.Exception
 import Data.Aeson
diff --git a/simulation/src/LeiosProtocol/SimTestRelay.hs b/simulation/src/LeiosProtocol/SimTestRelay.hs
@@ -11,8 +11,8 @@
 module LeiosProtocol.SimTestRelay where
 
 import Chan
-import ChanMux
-import ChanTCP
+import Chan.Mux
+import Chan.TCP
 import Control.Category ((>>>))
 import Control.Exception (assert)
 import Control.Monad (forever, when)
diff --git a/simulation/src/LeiosProtocol/VizSimTestRelay.hs b/simulation/src/LeiosProtocol/VizSimTestRelay.hs
@@ -4,7 +4,7 @@
 
 module LeiosProtocol.VizSimTestRelay where
 
-import ChanDriver (ProtocolMessage (..))
+import Chan.Driver (ProtocolMessage (..))
 import Control.Exception (assert)
 import Data.Map (Map)
 import qualified Data.Map.Strict as Map
diff --git a/simulation/src/PraosProtocol/BlockFetch.hs b/simulation/src/PraosProtocol/BlockFetch.hs
@@ -23,7 +23,7 @@
 module PraosProtocol.BlockFetch where
 
 import Chan (Chan)
-import ChanDriver (ProtocolMessage, chanDriver)
+import Chan.Driver (ProtocolMessage, chanDriver)
 import Control.Exception (assert)
 import Control.Monad (forM, forever, guard, join, unless, void, when, (<=<))
 import Control.Tracer (Tracer, traceWith)
diff --git a/simulation/src/PraosProtocol/ChainSync.hs b/simulation/src/PraosProtocol/ChainSync.hs
@@ -14,7 +14,7 @@
 module PraosProtocol.ChainSync where
 
 import Chan (Chan)
-import ChanDriver (ProtocolMessage, chanDriver)
+import Chan.Driver (ProtocolMessage, chanDriver)
 import Control.Exception (assert)
 import Control.Monad (void)
 import Control.Tracer (Tracer)
diff --git a/simulation/src/PraosProtocol/Common.hs b/simulation/src/PraosProtocol/Common.hs
@@ -40,7 +40,7 @@ module PraosProtocol.Common (
   mkScheduler,
 ) where
 
-import ChanTCP (Bytes, MessageSize (..))
+import Chan.TCP (Bytes, MessageSize (..))
 import Control.Exception (assert)
 import Control.Monad.State
 import Data.Coerce (coerce)
diff --git a/simulation/src/PraosProtocol/Common/ConcreteBlock.hs b/simulation/src/PraosProtocol/Common/ConcreteBlock.hs
@@ -49,7 +49,7 @@ module PraosProtocol.Common.ConcreteBlock (
   fixupAnchoredFragmentFrom,
 ) where
 
-import ChanTCP (Bytes)
+import Chan.TCP (Bytes)
 import Data.ByteString (ByteString)
 import Data.Coerce
 import Data.Function (fix)
diff --git a/simulation/src/PraosProtocol/ExamplesPraosP2P.hs b/simulation/src/PraosProtocol/ExamplesPraosP2P.hs
@@ -12,8 +12,8 @@
 
 module PraosProtocol.ExamplesPraosP2P where
 
-import ChanDriver
-import ChanTCP
+import Chan.Driver
+import Chan.TCP
 import Control.Monad
 import Data.Aeson
 import Data.Aeson.Types
diff --git a/simulation/src/PraosProtocol/PraosNode.hs b/simulation/src/PraosProtocol/PraosNode.hs
@@ -10,8 +10,8 @@ module PraosProtocol.PraosNode (
 )
 where
 
-import ChanDriver (protocolMessage)
-import ChanMux
+import Chan.Driver (protocolMessage)
+import Chan.Mux
 import Control.Exception (assert)
 import Control.Monad.Class.MonadAsync (Concurrently (..), MonadAsync (..))
 import Control.Monad.Class.MonadFork
diff --git a/simulation/src/PraosProtocol/SimBlockFetch.hs b/simulation/src/PraosProtocol/SimBlockFetch.hs
@@ -3,8 +3,8 @@
 module PraosProtocol.SimBlockFetch where
 
 import Chan (Chan)
-import ChanDriver (ProtocolMessage)
-import ChanTCP
+import Chan.Driver (ProtocolMessage)
+import Chan.TCP
 import Control.Monad
 import Control.Monad.Class.MonadAsync (
   MonadAsync (..),
diff --git a/simulation/src/PraosProtocol/SimChainSync.hs b/simulation/src/PraosProtocol/SimChainSync.hs
@@ -2,8 +2,8 @@
 
 module PraosProtocol.SimChainSync where
 
-import ChanDriver (ProtocolMessage)
-import ChanTCP (
+import Chan.Driver (ProtocolMessage)
+import Chan.TCP (
   LabelTcpDir,
   TcpConnProps,
   TcpEvent,
diff --git a/simulation/src/PraosProtocol/SimPraos.hs b/simulation/src/PraosProtocol/SimPraos.hs
@@ -8,8 +8,8 @@
 
 module PraosProtocol.SimPraos where
 
-import ChanMux
-import ChanTCP
+import Chan.Mux
+import Chan.TCP
 import Control.Monad.Class.MonadAsync (MonadAsync (..))
 import Control.Monad.IOSim as IOSim (IOSim, runSimTrace)
 import Control.Tracer as Tracer (
diff --git a/simulation/src/PraosProtocol/SimPraosP2P.hs b/simulation/src/PraosProtocol/SimPraosP2P.hs
@@ -5,8 +5,8 @@
 
 module PraosProtocol.SimPraosP2P where
 
-import ChanMux (newConnectionBundleTCP)
-import ChanTCP
+import Chan.Mux (newConnectionBundleTCP)
+import Chan.TCP
 import Control.Monad (forever)
 import Control.Monad.Class.MonadFork (MonadFork (forkIO))
 import Control.Monad.IOSim as IOSim (IOSim, runSimTrace)
diff --git a/simulation/src/PraosProtocol/VizSimBlockFetch.hs b/simulation/src/PraosProtocol/VizSimBlockFetch.hs
@@ -4,7 +4,7 @@
 
 module PraosProtocol.VizSimBlockFetch where
 
-import ChanDriver
+import Chan.Driver
 import Data.Map (Map)
 import qualified Data.Map.Strict as Map
 import Data.PQueue.Min (MinQueue)
diff --git a/simulation/src/PraosProtocol/VizSimChainSync.hs b/simulation/src/PraosProtocol/VizSimChainSync.hs
@@ -4,7 +4,7 @@
 
 module PraosProtocol.VizSimChainSync where
 
-import ChanDriver
+import Chan.Driver
 import Data.Coerce (coerce)
 import Data.Map (Map)
 import qualified Data.Map.Strict as Map
diff --git a/simulation/src/PraosProtocol/VizSimPraos.hs b/simulation/src/PraosProtocol/VizSimPraos.hs
@@ -5,7 +5,7 @@
 
 module PraosProtocol.VizSimPraos where
 
-import ChanDriver
+import Chan.Driver
 import Control.Exception (assert)
 import Data.Coerce (coerce)
 import Data.IntMap (IntMap)
diff --git a/simulation/src/RelayProtocol.hs b/simulation/src/RelayProtocol.hs
@@ -26,8 +26,7 @@ module RelayProtocol (
   relayClient,
 ) where
 
-import Chan (Chan (readChan, writeChan))
-import ChanTCP (MessageSize (..))
+import Chan (Chan (readChan, writeChan), MessageSize (..))
 import Control.Exception (assert)
 import Control.Monad (when)
 import Data.FingerTree (FingerTree)
diff --git a/simulation/src/SimRelay.hs b/simulation/src/SimRelay.hs
@@ -30,7 +30,6 @@ import STMCompat
 import System.Random (StdGen, uniform, uniformR)
 
 import Chan
-import ChanTCP
 import RelayProtocol
 import SimTCPLinks (labelDirToLabelLink, selectTimedEvents, simTracer)
 import SimTypes
diff --git a/simulation/src/SimRelayP2P.hs b/simulation/src/SimRelayP2P.hs
@@ -19,7 +19,7 @@ import qualified Data.Map.Strict as Map
 import System.Random (StdGen, split)
 import TimeCompat
 
-import ChanTCP
+import Chan
 import SimRelay
 import SimTCPLinks (labelDirToLabelLink, selectTimedEvents, simTracer)
 import SimTypes
diff --git a/simulation/src/SimTCPLinks.hs b/simulation/src/SimTCPLinks.hs
@@ -4,7 +4,6 @@
 module SimTCPLinks where
 
 import Chan
-import ChanTCP
 import Control.Monad (replicateM_)
 import Control.Monad.Class.MonadAsync (
   Concurrently (Concurrently, runConcurrently),

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ module LeiosProtocol.Common (`
`39`	`39`	`)`
`40`	`40`	`where`
`41`	`41`
`42`		`-import ChanTCP`
	`42`	`+import Chan.TCP`
`43`	`43`	`import Control.Exception (assert)`
`44`	`44`	`import Control.Monad (guard)`
`45`	`45`	`import Data.Aeson`