Merge pull request #5627 from IntersectMBO/jordan/bubble-up-exceptions

Bubble up exceptions in runNode
IntersectMBO · Jan 9, 2024 · b480540 · b480540
2 parents 1697b3a + d01fbb1
commit b480540
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 6 deletions.
diff --git a/cardano-node/src/Cardano/Node/Protocol.hs b/cardano-node/src/Cardano/Node/Protocol.hs
@@ -4,10 +4,12 @@ module Cardano.Node.Protocol
   , ProtocolInstantiationError(..)
   ) where
 
+import           Control.Exception
 import           Control.Monad.Trans.Except (ExceptT)
 import           Control.Monad.Trans.Except.Extra (firstExceptT)
 
 import           Cardano.Api
+import           Cardano.Api.Pretty
 
 import           Cardano.Node.Types
 
@@ -53,6 +55,8 @@ data ProtocolInstantiationError =
   | CardanoProtocolInstantiationError CardanoProtocolInstantiationError
   deriving Show
 
+instance Exception ProtocolInstantiationError where
+  displayException = docToString . prettyError
 
 instance Error ProtocolInstantiationError where
   prettyError (ByronProtocolInstantiationError   err) = prettyError err

diff --git a/cardano-node/src/Cardano/Node/Run.hs b/cardano-node/src/Cardano/Node/Run.hs
@@ -33,6 +33,7 @@ import           Data.IP (toSockAddr)
 import           Control.Concurrent (killThread, mkWeakThreadId, myThreadId)
 import           Control.Concurrent.Class.MonadSTM.Strict
 import           Control.Exception (try)
+import qualified Control.Exception as Exception
 import           Control.Monad (forM_, unless, void, when)
 import           Control.Monad.Class.MonadThrow (MonadThrow (..))
 import           Control.Monad.IO.Class (MonadIO (..))
@@ -56,7 +57,6 @@ import           Network.HostName (getHostName)
 import           Network.Socket (Socket)
 import           System.Directory (canonicalizePath, createDirectoryIfMissing, makeAbsolute)
 import           System.Environment (lookupEnv)
-import           System.Exit (exitFailure)
 #ifdef UNIX
 import           GHC.Weak (deRefWeak)
 import           System.Posix.Files
@@ -148,8 +148,7 @@ runNode cmdPc = do
     case shelleyVRFFile $ ncProtocolFiles nc of
       Just vrfFp -> do vrf <- runExceptT $ checkVRFFilePermissions (File vrfFp)
                        case vrf of
-                         Left err ->
-                           Text.putStrLn (renderVRFPrivateKeyFilePermissionError err) >> exitFailure
+                         Left err -> Exception.throwIO err
                          Right () ->
                            pure ()
       Nothing -> pure ()
@@ -162,7 +161,7 @@ runNode cmdPc = do
 
     p :: SomeConsensusProtocol <-
       case eitherSomeProtocol of
-        Left err -> putStrLn (docToString (Api.prettyError err)) >> exitFailure
+        Left err -> Exception.throwIO err
         Right p  -> pure p
 
     let networkMagic :: Api.NetworkMagic =
@@ -244,7 +243,7 @@ handleNodeWithTracers cmdPc nc0 p networkMagic blockType runP = do
             p
 
           loggingLayer <- case eLoggingLayer of
-            Left err  -> Text.putStrLn (Text.pack $ show err) >> exitFailure
+            Left err  -> Exception.throwIO err
             Right res -> return res
           !trace <- setupTrace loggingLayer
           let tracer = contramap pack $ toLogObject trace
@@ -367,7 +366,7 @@ handleSimpleNode blockType runP p2pMode tracers nc onKernel = do
       Left err -> do
         traceWith (startupTracer tracers)
                 $ StartupSocketConfigError err
-        throwIO err
+        Exception.throwIO err
 
   dbPath <- canonDbPath nc
 

diff --git a/cardano-node/src/Cardano/Node/Types.hs b/cardano-node/src/Cardano/Node/Types.hs
@@ -31,6 +31,7 @@ module Cardano.Node.Types
   , renderVRFPrivateKeyFilePermissionError
   ) where
 
+import           Control.Exception
 import           Data.Aeson
 import           Data.ByteString (ByteString)
 import           Data.Monoid (Last)
@@ -42,6 +43,7 @@ import           Data.Word (Word16, Word8)
 import           Control.Monad (MonadPlus (..))
 
 import           Cardano.Api
+import           Cardano.Api.Pretty
 import           Cardano.Crypto (RequiresNetworkMagic (..))
 import qualified Cardano.Crypto.Hash as Crypto
 import           Cardano.Node.Configuration.Socket (SocketConfig (..))
@@ -57,6 +59,14 @@ data ConfigError =
   | ConfigErrorNoEKG
     deriving Show
 
+instance Exception ConfigError where
+  displayException = docToString . prettyError
+
+instance Error ConfigError where
+  prettyError ConfigErrorNoEKG = "ConfigErrorNoEKG"
+  prettyError (ConfigErrorFileNotFound fp) =
+    mconcat ["ConfigErrorFileNotFound: ", pretty fp]
+
 -- | Filepath of the configuration yaml file. This file determines
 -- all the configuration settings required for the cardano node
 -- (logging, tracing, protocol, slot length etc)
@@ -352,6 +362,12 @@ data VRFPrivateKeyFilePermissionError
   | GenericPermissionsExist FilePath
   deriving Show
 
+instance Exception VRFPrivateKeyFilePermissionError where
+  displayException = Text.unpack . renderVRFPrivateKeyFilePermissionError
+
+instance Error VRFPrivateKeyFilePermissionError where
+  prettyError = pretty . renderVRFPrivateKeyFilePermissionError
+
 renderVRFPrivateKeyFilePermissionError :: VRFPrivateKeyFilePermissionError -> Text
 renderVRFPrivateKeyFilePermissionError err =
   case err of