remove panic from read node configs

Author: Cmdv

cardano-db-sync/src/Cardano/DbSync/Config.hs

@@ -27,10 +27,9 @@ import qualified Cardano.BM.Setup as Logging
 import Cardano.BM.Trace (Trace)
 import qualified Cardano.BM.Trace as Logging
 import Cardano.DbSync.Config.Cardano
-import Cardano.DbSync.Config.Node
+import Cardano.DbSync.Config.Node (NodeConfig(..), parseSyncPreConfig, readByteStringFromFile, parseNodeConfig)
 import Cardano.DbSync.Config.Shelley
 import Cardano.DbSync.Config.Types
-import Cardano.DbSync.Error (runOrThrowIO)
 import Cardano.Prelude
 import System.FilePath (takeDirectory, (</>))
 
@@ -45,14 +44,14 @@ configureLogging params loggingName = do
 
 readSyncNodeConfig :: ConfigFile -> IO SyncNodeConfig
 readSyncNodeConfig (ConfigFile fp) = do
-  pcfg <- runOrThrowIO . parseSyncPreConfig =<< runOrThrowIO (readByteStringFromFile fp "DbSync")
-  let afp = adjustNodeFilePath pcfg
-  ncfg <- runOrThrowIO . parseNodeConfig =<< runOrThrowIO (readByteStringFromFile (pcNodeConfigFilePath afp) "node")
-  coalesceConfig afp ncfg (mkAdjustPath pcfg)
+  pcfg <- (adjustNodeFilePath . parseSyncPreConfig) =<< readByteStringFromFile fp "DbSync"
+  ncfg <- parseNodeConfig =<< readByteStringFromFile (pcNodeConfigFilePath pcfg) "node"
+  coalesceConfig pcfg ncfg (mkAdjustPath pcfg)
   where
-    adjustNodeFilePath :: SyncPreConfig -> SyncPreConfig
-    adjustNodeFilePath cfg =
-      cfg {pcNodeConfigFile = adjustNodeConfigFilePath (takeDirectory fp </>) (pcNodeConfigFile cfg)}
+    adjustNodeFilePath :: IO SyncPreConfig -> IO SyncPreConfig
+    adjustNodeFilePath spc = do
+      cfg <- spc
+      pure $ cfg {pcNodeConfigFile = adjustNodeConfigFilePath (takeDirectory fp </>) (pcNodeConfigFile cfg)}
 
 coalesceConfig ::
   SyncPreConfig ->

cardano-db-sync/src/Cardano/DbSync/Config/Node.hs

@@ -18,12 +18,12 @@ module Cardano.DbSync.Config.Node (
 import qualified Cardano.Chain.Update as Byron
 import Cardano.Crypto (RequiresNetworkMagic (..))
 import Cardano.DbSync.Config.Types
+import Cardano.DbSync.Error (NodeConfigError (..), SyncNodeError (..))
 import Cardano.Prelude
 import Data.Aeson (FromJSON (..), Object, (.:), (.:?))
 import qualified Data.Aeson as Aeson
 import Data.Aeson.Types (Parser)
 import qualified Data.ByteString.Char8 as BS
-import Data.String (String)
 import qualified Data.Yaml as Yaml
 import qualified Ouroboros.Consensus.Cardano.CanHardFork as Shelley
 
@@ -52,32 +52,22 @@ data NodeConfig = NodeConfig
     ncConwayHardFork :: !Shelley.TriggerHardFork
   }
 
-data NodeConfigParseError
-  = NodeConfigParseError String
-  | ParseSyncPreConfigError String
-  | ReadByteStringFromFileError String
-  deriving (Show)
-
-instance Exception NodeConfigParseError
-
-parseNodeConfig :: ByteString -> IO (Either NodeConfigParseError NodeConfig)
+parseNodeConfig :: ByteString -> IO NodeConfig
 parseNodeConfig bs =
   case Yaml.decodeEither' bs of
-    Left err -> pure $ Left $ NodeConfigParseError ("Error parsing node config: " <> show err)
-    Right nc -> pure $ Right nc
+    Left err -> throwIO $ SNErrNodeConfig $ NodeConfigParseError (show err)
+    Right nc -> pure nc
 
-parseSyncPreConfig :: ByteString -> IO (Either NodeConfigParseError SyncPreConfig)
+parseSyncPreConfig :: ByteString -> IO SyncPreConfig
 parseSyncPreConfig bs =
-  case Yaml.decodeEither' bs of
-    Left err -> pure $ Left $ ParseSyncPreConfigError ("Error parseSyncPreConfig: Error parsing config: " <> show err)
-    Right res -> pure $ Right res
-
-readByteStringFromFile :: FilePath -> Text -> IO (Either NodeConfigParseError ByteString)
-readByteStringFromFile fp cfgType = do
-  result <- try (BS.readFile fp) :: IO (Either SomeException BS.ByteString)
-  case result of
-    Left _ -> pure $ Left $ ReadByteStringFromFileError ("Error Cannot find the " <> show cfgType <> " configuration file at : " <> show fp)
-    Right res -> pure $ Right res
+    case Yaml.decodeEither' bs of
+        Left err -> throwIO $ SNErrNodeConfig $ ParseSyncPreConfigError ("Error parsing config: " <> show err)
+        Right res -> pure res
+
+readByteStringFromFile :: FilePath -> Text -> IO ByteString
+readByteStringFromFile fp cfgType =
+  catch (BS.readFile fp) $ \(_ :: IOException) ->
+    throwIO $ SNErrNodeConfig $ NodeConfigParseError ("Cannot find the " <> show cfgType <> " configuration file at : " <> show fp)
 
 -- -------------------------------------------------------------------------------------------------
 

cardano-db-sync/src/Cardano/DbSync/Error.hs

@@ -6,6 +6,7 @@
 module Cardano.DbSync.Error (
   SyncInvariant (..),
   SyncNodeError (..),
+  NodeConfigError(..),
   annotateInvariantTx,
   bsBase16Encode,
   dbSyncNodeError,
@@ -50,17 +51,19 @@ data SyncNodeError
   | SNErrCardanoConfig !Text
   | SNErrInsertGenesis !String
   | SNErrLedgerState !String
+  | SNErrNodeConfig NodeConfigError
 
 instance Exception SyncNodeError
 
 instance Show SyncNodeError where
   show =
     \case
-      SNErrDefault t -> "Error: " <> Text.show t
-      SNErrInvariant loc i -> Text.show loc <> ": " <> Text.show (renderSyncInvariant i)
+      SNErrDefault t -> "Error SNErrDefault: " <> Text.show t
+      SNErrInvariant loc i -> "Error SNErrInvariant: " <> Text.show loc <> ": " <> Text.show (renderSyncInvariant i)
       SNEErrBlockMismatch blkNo hashDb hashBlk ->
         mconcat
-          [ "Block mismatch for block number "
+          [ "Error SNEErrBlockMismatch: "
+          , "Block mismatch for block number "
           , show blkNo
           , ", db has "
           , Text.show $ bsBase16Encode hashDb
@@ -69,38 +72,60 @@ instance Show SyncNodeError where
           ]
       SNErrIgnoreShelleyInitiation ->
         mconcat
-          [ "Node configs that don't fork to Shelley directly and initiate"
+          [ "Error SNErrIgnoreShelleyInitiation: "
+          , "Node configs that don't fork to Shelley directly and initiate"
           , " funds or stakes in Shelley Genesis are not supported."
           ]
       SNErrByronConfig fp ce ->
         mconcat
-          [ "Failed reading Byron genesis file "
+          [ "Error SNErrByronConfig: "
+          , "Failed reading Byron genesis file "
           , Text.show $ textShow fp
           , ": "
           , Text.show $ textShow ce
           ]
       SNErrShelleyConfig fp txt ->
         mconcat
-          [ "Failed reading Shelley genesis file "
+          [ "Error SNErrShelleyConfig: "
+          , "Failed reading Shelley genesis file "
           , Text.show $ textShow fp
           , ": "
           , show txt
           ]
       SNErrAlonzoConfig fp txt ->
         mconcat
-          [ "Failed reading Alonzo genesis file "
+          ["Error SNErrAlonzoConfig: "
+          , "Failed reading Alonzo genesis file "
           , Text.show $ textShow fp
           , ": "
           , show txt
           ]
       SNErrCardanoConfig err ->
         mconcat
-          [ "With Cardano protocol, Byron/Shelley config mismatch:\n"
+          [ "Error SNErrCardanoConfig: "
+          , "With Cardano protocol, Byron/Shelley config mismatch:\n"
           , "   "
           , show err
           ]
-      SNErrInsertGenesis err -> "Error InsertGenesis: " <> err
-      SNErrLedgerState err -> "Error Ledger State: " <> err
+      SNErrInsertGenesis err -> "Error SNErrInsertGenesis: " <> err
+      SNErrLedgerState err -> "Error SNErrLedgerState: " <> err
+      SNErrNodeConfig err -> "Error SNErrNodeConfig: " <> show err
+
+data NodeConfigError
+  = NodeConfigParseError String
+  | ParseSyncPreConfigError String
+  | ReadByteStringFromFileError String
+
+instance Exception NodeConfigError
+
+instance Show NodeConfigError where
+  show =
+    \case
+      NodeConfigParseError err -> "NodeConfigParseError - " <> err
+      ParseSyncPreConfigError err -> "ParseSyncPreConfigError - " <> err
+      ReadByteStringFromFileError err -> "ReadByteStringFromFileError - " <> err
+
+
 
 annotateInvariantTx :: Byron.Tx -> SyncInvariant -> SyncInvariant
 annotateInvariantTx tx ei =