unixsoc depend on handshake-only

cardano-cli/src/Cardano/CLI/Run/Ping.hs

@@ -40,6 +40,8 @@ newtype PingClientCmdError = PingClientCmdError [(AddrInfo, SomeException)]
 
 data EndPoint = HostEndPoint String | UnixSockEndPoint String deriving (Eq, Show)
 
+type EndPointWithHanshake = (Bool, EndPoint)
+
 maybeHostEndPoint :: EndPoint -> Maybe String
 maybeHostEndPoint = \case
   HostEndPoint host -> Just host
@@ -52,7 +54,7 @@ maybeUnixSockEndPoint = \case
 
 data PingCmd = PingCmd
   { pingCmdCount           :: !Word32
-  , pingCmdEndPoint        :: !EndPoint
+  , pingCmdEndPoint        :: !EndPointWithHanshake
   , pingCmdPort            :: !String
   , pingCmdMagic           :: !Word32
   , pingCmdJson            :: !Bool
@@ -62,12 +64,14 @@ data PingCmd = PingCmd
 
 pingClient :: Tracer IO CNP.LogMsg -> Tracer IO String -> PingCmd -> [CNP.NodeVersion] -> AddrInfo -> IO ()
 pingClient stdout stderr cmd = CNP.pingClient stdout stderr opts
-  where opts = CNP.PingOpts
+  where
+    (handshakeOnly, endPoint) = pingCmdEndPoint cmd
+    opts = CNP.PingOpts
           { CNP.pingOptsQuiet          = pingCmdQuiet cmd
           , CNP.pingOptsJson           = pingCmdJson cmd
-          , CNP.pingOptsCount          = pingCmdCount cmd
-          , CNP.pingOptsHost           = maybeHostEndPoint (pingCmdEndPoint cmd)
-          , CNP.pingOptsUnixSock       = maybeUnixSockEndPoint (pingCmdEndPoint cmd)
+          , CNP.pingOptsCount          = if handshakeOnly then 0 else pingCmdCount cmd
+          , CNP.pingOptsHost           = maybeHostEndPoint endPoint
+          , CNP.pingOptsUnixSock       = maybeUnixSockEndPoint endPoint
           , CNP.pingOptsPort           = pingCmdPort cmd
           , CNP.pingOptsMagic          = pingCmdMagic cmd
           , CNP.pingOptsHandshakeQuery = pingOptsHandshakeQuery cmd
@@ -81,7 +85,8 @@ runPingCmd options = do
 
   -- 'addresses' are all the endpoints to connect to and 'versions' are the node protocol versions
   -- to ping with.
-  (addresses, versions) <- case pingCmdEndPoint options of
+  let (_, endPoint) = pingCmdEndPoint options
+  (addresses, versions) <- case endPoint of
     HostEndPoint host -> do
       addrs <- liftIO $ Socket.getAddrInfo (Just hints) (Just host) (Just (pingCmdPort options))
       return (addrs, CNP.supportedNodeToNodeVersions $ pingCmdMagic options)
@@ -136,26 +141,43 @@ parsePingCmd = Opt.hsubparser $ mconcat
     ]
   ]
 
-pHost :: Opt.Parser String
-pHost =
-  Opt.strOption $ mconcat
+pHost :: Bool -> Opt.Parser String
+pHost internal =
+  ( Opt.strOption $ mconcat
     [ Opt.long "host"
     , Opt.short 'h'
     , Opt.metavar "HOST"
     , Opt.help "Hostname/IP, e.g. relay.iohk.example."
-    ]
+    , if internal then Opt.internal else mempty
+    ])
+
+pHandshakeOnlyFlag :: Opt.Parser (EndPoint -> EndPointWithHanshake)
+pHandshakeOnlyFlag =
+  ( Opt.flag' ((,) True) $ mconcat
+    [ Opt.long "handshake-only"
+    , Opt.help "Perform only the handshake process without sending a ping."
+    ])
 
 pUnixSocket :: Opt.Parser String
 pUnixSocket =
-  Opt.strOption $ mconcat
+  ( Opt.strOption $ mconcat
     [ Opt.long "unixsock"
     , Opt.short 'u'
     , Opt.metavar "SOCKET"
     , Opt.help "Unix socket, e.g. file.socket."
-    ]
+    ])
+
+
+-- pEndPoint :: Opt.Parser EndPoint
+-- pEndPoint = fmap UnixSockEndPoint pUnixSocket <|> fmap HostEndPoint pHost 
+
+
+pEndPoint :: Opt.Parser EndPointWithHanshake
+pEndPoint = 
+  (fmap ((,) False) $ fmap HostEndPoint (pHost False))
+  <|> (pHandshakeOnlyFlag <*> ((fmap UnixSockEndPoint pUnixSocket) <|> (fmap HostEndPoint (pHost True)))) 
+
 
-pEndPoint :: Opt.Parser EndPoint
-pEndPoint = fmap HostEndPoint pHost <|> fmap UnixSockEndPoint pUnixSocket
 
 pPing :: Opt.Parser PingCmd
 pPing = PingCmd
@@ -202,6 +224,9 @@ pPing = PingCmd
   <*> ( Opt.switch $ mconcat
         [ Opt.long "query-versions"
         , Opt.short 'Q'
-        , Opt.help "Query the supported protocol versions using the handshake protocol and terminate the connection."
+        , Opt.help $ mconcat
+          [ "Query the supported protocol versions using the handshake protocol and terminate the connection. "
+          , "(deprecated; use under --handshake-only instead)."
+          ]
         ]
       )