Merge pull request #6178 from IntersectMBO/coot/get-addr-refactoring

getSocketOrSocketInfoAddr refactoring

Author: coot

cardano-node/src/Cardano/Node/Configuration/Socket.hs

@@ -5,7 +5,9 @@
 module Cardano.Node.Configuration.Socket
   ( SocketConfig (..)
   , gatherConfiguredSockets
-  , SocketOrSocketInfo(..)
+  , SocketOrSocketInfo' (..)
+  , SocketOrSocketInfo
+  , LocalSocketOrSocketInfo
   , getSocketOrSocketInfoAddr
   , SocketConfigError(..)
   , renderSocketConfigError
@@ -19,7 +21,7 @@ import qualified Prelude
 import           Control.Monad.Trans.Except.Extra (handleIOExceptT)
 import           Generic.Data.Orphans ()
 import           Network.Socket (AddrInfo (..), AddrInfoFlag (..), Family (AF_INET, AF_INET6),
-                   SockAddr, Socket, SocketType (..))
+                   Socket, SocketType (..))
 import qualified Network.Socket as Socket
 
 import           Cardano.Node.Configuration.NodeAddress
@@ -42,18 +44,21 @@ import           System.Systemd.Daemon (getActivatedSockets)
 -- given actual already-constructed sockets, or the info needed to make new
 -- sockets later.
 --
-data SocketOrSocketInfo socket info =
+data SocketOrSocketInfo' socket info =
        ActualSocket socket
      | SocketInfo   info
   deriving Show
 
+type SocketOrSocketInfo = SocketOrSocketInfo' Socket Socket.SockAddr
+type LocalSocketOrSocketInfo = SocketOrSocketInfo' LocalSocket LocalAddress
 
-getSocketOrSocketInfoAddr :: SocketOrSocketInfo Socket Socket.SockAddr
-                          -> IO (SocketOrSocketInfo Socket.SockAddr Socket.SockAddr)
+
+getSocketOrSocketInfoAddr :: SocketOrSocketInfo
+                          -> IO Socket.SockAddr
 getSocketOrSocketInfoAddr (ActualSocket sock) =
-    ActualSocket <$> Socket.getSocketName sock
+    Socket.getSocketName sock
 getSocketOrSocketInfoAddr (SocketInfo sockAddr)  =
-    return $ SocketInfo sockAddr
+    return sockAddr
 
 
 -- | Errors for the current module.
@@ -122,9 +127,9 @@ data SocketConfig
 --
 gatherConfiguredSockets :: SocketConfig
                         -> ExceptT SocketConfigError IO
-                                   (Maybe (SocketOrSocketInfo Socket      SockAddr),
-                                    Maybe (SocketOrSocketInfo Socket      SockAddr),
-                                    Maybe (SocketOrSocketInfo LocalSocket LocalAddress))
+                                   (Maybe SocketOrSocketInfo,
+                                    Maybe SocketOrSocketInfo,
+                                    Maybe LocalSocketOrSocketInfo)
 gatherConfiguredSockets SocketConfig { ncNodeIPv4Addr,
                                        ncNodeIPv6Addr,
                                        ncNodePortNumber,

cardano-node/src/Cardano/Node/Run.hs

@@ -38,7 +38,7 @@ import           Cardano.Node.Configuration.NodeAddress
 import           Cardano.Node.Configuration.POM (NodeConfiguration (..),
                    PartialNodeConfiguration (..), SomeNetworkP2PMode (..), TimeoutOverride (..),
                    defaultPartialNodeConfiguration, makeNodeConfiguration, parseNodeConfigurationFP, getForkPolicy)
-import           Cardano.Node.Configuration.Socket (SocketOrSocketInfo (..),
+import           Cardano.Node.Configuration.Socket (SocketOrSocketInfo' (..),
                    gatherConfiguredSockets, getSocketOrSocketInfoAddr)
 import qualified Cardano.Node.Configuration.Topology as TopologyNonP2P
 import           Cardano.Node.Configuration.TopologyP2P

cardano-node/src/Cardano/Node/Startup.hs

@@ -33,8 +33,7 @@ import           Ouroboros.Consensus.Node.NetworkProtocolVersion (BlockNodeToCli
                    BlockNodeToNodeVersion)
 import           Ouroboros.Consensus.Shelley.Ledger.Ledger (shelleyLedgerGenesis)
 import           Ouroboros.Network.Magic (NetworkMagic (..))
-import           Ouroboros.Network.NodeToClient (LocalAddress (..), LocalSocket,
-                   NodeToClientVersion)
+import           Ouroboros.Network.NodeToClient (NodeToClientVersion)
 import           Ouroboros.Network.NodeToNode (DiffusionMode (..), NodeToNodeVersion, PeerAdvertise)
 import           Ouroboros.Network.PeerSelection.LedgerPeers.Type (UseLedgerPeers)
 import           Ouroboros.Network.PeerSelection.RelayAccessPoint (RelayAccessPoint)
@@ -62,9 +61,9 @@ data StartupTrace blk =
   -- | Log startup information.
   --
     StartupInfo
-      [SocketOrSocketInfo Socket.SockAddr Socket.SockAddr]
+      [Socket.SockAddr]
       -- ^ node-to-node addresses
-      (Maybe (SocketOrSocketInfo LocalSocket LocalAddress))
+      (Maybe LocalSocketOrSocketInfo)
       -- ^ node-to-client socket path
       (Map NodeToNodeVersion (BlockNodeToNodeVersion blk))
       -- ^ supported node-to-node versions
@@ -165,7 +164,7 @@ data BasicInfoByron = BasicInfoByron {
   }
 
 data BasicInfoNetwork = BasicInfoNetwork {
-    niAddresses     :: [SocketOrSocketInfo Socket.SockAddr Socket.SockAddr]
+    niAddresses     :: [SocketOrSocketInfo]
   , niDiffusionMode :: DiffusionMode
   , niDnsProducers  :: [DnsSubscriptionTarget]
   , niIpProducers   :: IPSubscriptionTarget

cardano-node/src/Cardano/Node/Tracing/Tracers/Startup.hs

@@ -40,7 +40,7 @@ import           Ouroboros.Consensus.HardFork.Combinator.Degenerate (HardForkLed
 import           Ouroboros.Consensus.Node.NetworkProtocolVersion
 import           Ouroboros.Consensus.Node.ProtocolInfo (ProtocolInfo (..))
 import           Ouroboros.Consensus.Shelley.Ledger.Ledger (shelleyLedgerGenesis)
-import           Ouroboros.Network.NodeToClient (LocalAddress (..), LocalSocket (..))
+import           Ouroboros.Network.NodeToClient (LocalAddress (..))
 import           Ouroboros.Network.NodeToNode (DiffusionMode (..))
 import           Ouroboros.Network.PeerSelection.LedgerPeers.Type (AfterSlot (..),
                    UseLedgerPeers (..))
@@ -55,7 +55,6 @@ import           Data.Text (Text, pack)
 import           Data.Time (getCurrentTime)
 import           Data.Time.Clock.POSIX (POSIXTime, utcTimeToPOSIXSeconds)
 import           Data.Version (showVersion)
-import           Network.Socket (SockAddr)
 
 import           Paths_cardano_node (version)
 
@@ -156,7 +155,7 @@ instance ( Show (BlockNodeToNodeVersion blk)
                                  supportedNodeToClientVersions)
       = mconcat (
         [ "kind" .= String "StartupInfo"
-        , "nodeAddresses" .= toJSON (map ppN2NSocketInfo addresses)
+        , "nodeAddresses" .= toJSON (map show addresses)
         , "localSocket" .= case localSocket of
               Nothing -> Null
               Just a  -> String (pack . ppN2CSocketInfo $ a)
@@ -473,7 +472,7 @@ ppStartupInfoTrace (StartupInfo addresses
                                 supportedNodeToClientVersions)
   = pack
   $ "\n" ++ intercalate "\n"
-    [ "node addresses:          " ++ intercalate ", " (map ppN2NSocketInfo addresses)
+    [ "node addresses:          " ++ intercalate ", " (map show addresses)
     , "local socket:            " ++ maybe "NONE" ppN2CSocketInfo localSocket
     , "node-to-node versions:   " ++ show (fmap nodeToNodeVersionToInt (Map.keys supportedNodeToNodeVersions))
     , "node-to-client versions: " ++ show (fmap nodeToClientVersionToInt (Map.keys supportedNodeToClientVersions))
@@ -601,14 +600,11 @@ nonP2PWarningMessage =
 --
 ppSocketInfo :: Show sock
              => (info -> String)
-             -> SocketOrSocketInfo sock info -> String
+             -> SocketOrSocketInfo' sock info
+             -> String
 ppSocketInfo  ppInfo (SocketInfo addr)   = ppInfo addr
 ppSocketInfo _ppInfo (ActualSocket sock) = show sock
 
-ppN2CSocketInfo :: SocketOrSocketInfo LocalSocket LocalAddress
+ppN2CSocketInfo :: LocalSocketOrSocketInfo
                 -> String
 ppN2CSocketInfo = ppSocketInfo getFilePath
-
-ppN2NSocketInfo :: SocketOrSocketInfo SockAddr SockAddr
-                -> String
-ppN2NSocketInfo = ppSocketInfo show