Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
649 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| {-# LANGUAGE BangPatterns #-} | ||
| {-# LANGUAGE DataKinds #-} | ||
| {-# LANGUAGE InstanceSigs #-} | ||
| {-# LANGUAGE LambdaCase #-} | ||
| {-# LANGUAGE NamedFieldPuns #-} | ||
| {-# LANGUAGE RankNTypes #-} | ||
| {-# LANGUAGE RecordWildCards #-} | ||
| {-# LANGUAGE TypeApplications #-} | ||
|
|
||
| module Cardano.CLI.Ping | ||
| ( PingCmd(..) | ||
| , PingClientCmdError(..) | ||
| , renderPingClientCmdError | ||
| , runPingCmd | ||
| , parsePingCmd | ||
| ) where | ||
|
|
||
| import Cardano.CLI.Ping.Lib | ||
|
|
||
| import Control.Applicative (Applicative (..), optional) | ||
| import Control.Exception (SomeException) | ||
| import Control.Monad (Monad (..), forM, mapM, mapM_, unless, when) | ||
| import Control.Monad.Class.MonadAsync (MonadAsync (async, wait, waitCatch)) | ||
| import Control.Monad.Class.MonadSTM.Strict | ||
| import Control.Monad.IO.Class (liftIO) | ||
| import Control.Monad.Trans.Except (ExceptT, throwE) | ||
| import Control.Tracer (Tracer (..)) | ||
| import Data.Bool ((&&)) | ||
| import Data.Either (Either (..)) | ||
| import Data.Function (($), (.)) | ||
| import Data.Functor ((<$>)) | ||
| import Data.List (foldl') | ||
| import Data.Maybe (Maybe (..), isNothing) | ||
| import Data.Monoid (mconcat) | ||
| import Data.Semigroup ((<>)) | ||
| import Data.String (String) | ||
| import Data.Text (Text) | ||
| import GHC.Enum (Bounded (..)) | ||
| import Network.Socket (AddrInfo) | ||
| import System.IO (IO) | ||
| import Text.Show (Show(..)) | ||
|
|
||
| import qualified Data.List as L | ||
| import qualified Data.Text as T | ||
| import qualified Network.Socket as Socket | ||
| import qualified Options.Applicative as Opt | ||
| import qualified Prettyprinter as PP | ||
| import qualified System.Exit as IO | ||
| import qualified System.IO as IO | ||
|
|
||
| data PingClientCmdError | ||
| = PingClientCmdErrorOfInvalidHostIp | ||
| | PingClientCmdErrorOfExceptions ![(AddrInfo, SomeException)] | ||
|
|
||
| runPingCmd :: PingCmd -> ExceptT PingClientCmdError IO () | ||
| runPingCmd options = do | ||
| let hints = Socket.defaultHints { Socket.addrSocketType = Socket.Stream } | ||
|
|
||
| msgQueue <- liftIO newEmptyTMVarIO | ||
|
|
||
| when (isNothing (pingCmdHost options) && isNothing (pingCmdUnixSock options)) $ | ||
| throwE PingClientCmdErrorOfInvalidHostIp | ||
|
|
||
| (addresses, versions) <- case pingCmdUnixSock options of | ||
| Nothing -> do | ||
| addrs <- liftIO $ Socket.getAddrInfo (Just hints) (pingCmdHost options) (Just (pingCmdPort options)) | ||
| return (addrs, supportedNodeToNodeVersions $ pingCmdMagic options) | ||
| Just fname -> | ||
| return | ||
| ( [ Socket.AddrInfo [] Socket.AF_UNIX Socket.Stream | ||
| Socket.defaultProtocol (Socket.SockAddrUnix fname) | ||
| Nothing | ||
| ] | ||
| , supportedNodeToClientVersions $ pingCmdMagic options | ||
| ) | ||
|
|
||
| laid <- liftIO . async $ logger msgQueue $ pingCmdJson options | ||
| caids <- forM addresses $ liftIO . async . pingClient (Tracer $ doLog msgQueue) options versions | ||
| res <- L.zip addresses <$> mapM (liftIO . waitCatch) caids | ||
| liftIO $ doLog msgQueue LogEnd | ||
| liftIO $ wait laid | ||
| case foldl' partition ([],[]) res of | ||
| ([], _) -> liftIO IO.exitSuccess | ||
| (es, []) -> throwE $ PingClientCmdErrorOfExceptions es | ||
| (es, _) -> do | ||
| unless (pingCmdQuiet options) $ mapM_ (liftIO . IO.hPrint IO.stderr) es | ||
| liftIO IO.exitSuccess | ||
|
|
||
| where | ||
| partition :: ([(AddrInfo, SomeException)], [AddrInfo]) | ||
| -> (AddrInfo, Either SomeException ()) | ||
| -> ([(AddrInfo, SomeException)], [AddrInfo]) | ||
| partition (es, as) (a, Left e) = ((a, e) : es, as) | ||
| partition (es, as) (a, Right _) = (es, a : as) | ||
|
|
||
| doLog :: StrictTMVar IO LogMsg -> LogMsg -> IO () | ||
| doLog msgQueue msg = atomically $ putTMVar msgQueue msg | ||
|
|
||
| renderPingClientCmdError :: PingClientCmdError -> Text | ||
| renderPingClientCmdError = \case | ||
| PingClientCmdErrorOfInvalidHostIp -> "Specify host/ip with '-h <hostname>' or a unix socket with -u <file name>" | ||
| PingClientCmdErrorOfExceptions es -> T.intercalate "\n" $ T.pack . show <$> es | ||
|
|
||
| parsePingCmd :: Opt.Parser PingCmd | ||
| parsePingCmd = Opt.hsubparser $ mconcat | ||
| [ Opt.metavar "ping" | ||
| , Opt.command "ping" $ Opt.info pPing $ Opt.progDescDoc $ Just $ mconcat | ||
| [ PP.pretty @String "Ping a cardano node either using node-to-node or node-to-client protocol. " | ||
| , PP.pretty @String "It negotiates a handshake and keep sending keep alive messages." | ||
| ] | ||
| ] | ||
|
|
||
| pPing :: Opt.Parser PingCmd | ||
| pPing = PingCmd | ||
| <$> Opt.option Opt.auto | ||
| ( Opt.long "count" | ||
| <> Opt.short 'c' | ||
| <> Opt.metavar "COUNT" | ||
| <> Opt.help | ||
| ( "Stop after sending count requests and receiving count responses. " | ||
| <> "If this option is not specified, ping will operate until interrupted. " | ||
| ) | ||
| <> Opt.value maxBound | ||
| ) | ||
| <*> optional | ||
| ( Opt.option Opt.auto | ||
| ( Opt.long "host" | ||
| <> Opt.short 'h' | ||
| <> Opt.metavar "HOST" | ||
| <> Opt.help "Hostname/IP, e.g. relay.iohk.example." | ||
| ) | ||
| ) | ||
| <*> optional | ||
| ( Opt.option Opt.auto | ||
| ( Opt.long "unixsock" | ||
| <> Opt.short 'u' | ||
| <> Opt.metavar "SOCKET" | ||
| <> Opt.help "Unix socket, e.g. file.socket." | ||
| ) | ||
| ) | ||
| <*> Opt.option Opt.auto | ||
| ( Opt.long "port" | ||
| <> Opt.short 'p' | ||
| <> Opt.metavar "PORT" | ||
| <> Opt.help "Port number, e.g. 1234." | ||
| <> Opt.value "3001" | ||
| ) | ||
| <*> Opt.option Opt.auto | ||
| ( Opt.long "magic" | ||
| <> Opt.short 'm' | ||
| <> Opt.metavar "MAGIC" | ||
| <> Opt.help "Network magic." | ||
| <> Opt.value mainnetMagic | ||
| ) | ||
| <*> Opt.switch | ||
| ( Opt.long "json" | ||
| <> Opt.short 'j' | ||
| <> Opt.help "JSON output flag." | ||
| ) | ||
| <*> Opt.switch | ||
| ( Opt.long "quiet" | ||
| <> Opt.short 'q' | ||
| <> Opt.help "Quiet flag, CSV/JSON only output" | ||
| ) |
Oops, something went wrong.