remove panic from smash server and remove comments

Author: Cmdv

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

@@ -127,8 +127,6 @@ instance Show NodeConfigError where
       ParseSyncPreConfigError err -> "ParseSyncPreConfigError - " <> err
       ReadByteStringFromFileError err -> "ReadByteStringFromFileError - " <> err
 
-
-
 annotateInvariantTx :: Byron.Tx -> SyncInvariant -> SyncInvariant
 annotateInvariantTx tx ei =
   case ei of

cardano-db-tool/src/Cardano/DbTool/Validate/Ledger.hs

@@ -55,7 +55,6 @@ validate params genCfg slotNo ledgerFiles =
           when logFailure . putStrLn $ redText "Ledger is newer than DB. Trying an older ledger."
           go rest False
 
--- TODO: Vince - Should this throwIO when there is an error as it just prints right now
 validateBalance :: SlotNo -> Text -> CardanoLedgerState -> IO ()
 validateBalance slotNo addr st = do
   balanceDB <- DB.runDbNoLoggingEnv $ DB.queryAddressBalanceAtSlot addr (unSlotNo slotNo)

cardano-smash-server/src/Cardano/SMASH/Server/Config.hs

@@ -22,6 +22,7 @@ import qualified Data.Text as Text
 import qualified Data.Text.IO as Text
 import qualified Data.Yaml as Yaml
 import System.IO.Error
+import Cardano.SMASH.Server.Types (DBFail(..))
 
 -- | SMASH Server cli parameters
 data SmashServerParams = SmashServerParams
@@ -106,7 +107,7 @@ configureLogging :: FilePath -> Text -> IO (Trace IO Text)
 configureLogging fp loggingName = do
   bs <- readByteString fp "DbSync" -- only uses the db-sync config
   case Yaml.decodeEither' bs of
-    Left err -> panic $ "readSyncNodeConfig: Error parsing config: " <> textShow err
+    Left err -> throwIO $ ConfigError ("readSyncNodeConfig: Error parsing config: " <> textShow err)
     Right representation -> do
       -- Logging.Configuration
       logConfig <- Logging.setupFromRepresentation representation
@@ -115,4 +116,4 @@ configureLogging fp loggingName = do
 readByteString :: FilePath -> Text -> IO ByteString
 readByteString fp cfgType =
   catch (BS.readFile fp) $ \(_ :: IOException) ->
-    panic $ mconcat ["Cannot find the ", cfgType, " configuration file at : ", Text.pack fp]
+    throwIO $ ConfigError $ mconcat ["Cannot find the ", cfgType, " configuration file at : ", Text.pack fp]

cardano-smash-server/src/Cardano/SMASH/Server/PoolDataLayer.hs

@@ -21,6 +21,7 @@ import qualified Data.Text.Encoding as Text
 import Data.Time.Clock (UTCTime)
 import Data.Time.Clock.POSIX (utcTimeToPOSIXSeconds)
 import Database.Persist.Postgresql
+import GHC.Err (error)
 
 {- HLINT ignore "Reduce duplication" -}
 
@@ -52,7 +53,7 @@ postgresqlPoolDataLayer tracer conn =
         case mMeta of
           Just (tickerName, metadata) -> pure $ Right (TickerName tickerName, PoolMetadataRaw metadata)
           Nothing -> pure $ Left $ DbLookupPoolMetadataHash poolId poolMetadataHash
-    , dlAddPoolMetadata = panic "dlAddPoolMetadata not defined. Will be used only for testing."
+    , dlAddPoolMetadata = error "dlAddPoolMetadata not defined. Will be used only for testing."
     , dlGetReservedTickers = do
         tickers <- Db.runPoolDbIohkLogging conn tracer Db.queryReservedTickers
         pure $ fmap (\ticker -> (TickerName $ Db.reservedPoolTickerName ticker, dbToServantPoolId $ Db.reservedPoolTickerPoolHash ticker)) tickers
@@ -87,7 +88,7 @@ postgresqlPoolDataLayer tracer conn =
         if deleted
           then pure $ Right poolHash
           else pure $ Left RecordDoesNotExist
-    , dlAddRetiredPool = \_ _ -> panic "dlAddRetiredPool not defined. Will be used only for testing"
+    , dlAddRetiredPool = \_ _ -> throwIO $ PoolDataLayerError "dlAddRetiredPool not defined. Will be used only for testing"
     , dlCheckRetiredPool = \poolId -> do
         actions <- getCertActions tracer conn (Just poolId)
         pure $ not <$> isRegistered (servantToDbPoolId poolId) actions

cardano-smash-server/src/Cardano/SMASH/Server/Types.hs

@@ -370,12 +370,16 @@ data DBFail
   | TickerAlreadyReserved !TickerName
   | RecordDoesNotExist
   | DBFail LookupFail
+  | PoolDataLayerError !Text
+  | ConfigError !Text
   deriving (Eq)
 
 instance ToSchema DBFail where
   declareNamedSchema _ =
     pure (NamedSchema (Just "DBFail") mempty)
 
+instance Exception DBFail
+
 instance Show DBFail where
   show =
     \case
@@ -387,6 +391,8 @@ instance Show DBFail where
       TickerAlreadyReserved ticker -> "Ticker name " <> Text.show (getTickerName ticker) <> " is already reserved"
       RecordDoesNotExist -> "The requested record does not exist."
       DBFail lookupFail -> Text.show lookupFail
+      PoolDataLayerError err -> Text.show err
+      ConfigError err -> "Config Error: " <> Text.show err
 
 {-
 
@@ -430,6 +436,16 @@ instance ToJSON DBFail where
       [ "code" .= Aeson.String "DBFail"
       , "description" .= Aeson.String (Cardano.Prelude.show err)
       ]
+  toJSON (PoolDataLayerError err) =
+    object
+      [ "code" .= Aeson.String "PoolDataLayerError"
+      , "description" .= Aeson.String (Cardano.Prelude.show err)
+      ]
+  toJSON (ConfigError err) =
+    object
+      [ "code" .= Aeson.String "ConfigError"
+      , "description" .= Aeson.String (Cardano.Prelude.show err)
+      ]
 
 -- renderDBFail :: DBFail -> Text
 -- renderDBFail (UnknownError err) = "Unknown error. Context: " <> err

doc/validation.md

@@ -72,8 +72,6 @@ the fees associated with the transaction are recorded in the database.
 
 ## Runtime Reward Validations
 
--- TODO: Vince - probably too late unless we deprecate, but could this be a command line argument?
-
 Due to recent issues with reward related tables, extra validation was added. When that validation
 fails, there are now two options. `db-sync` can abort or continue running. The behaviour is
 specified by the presence or absence of the `DbSyncAbortOnPanic` environemnt variable. If the