remove Text from SyncInsertConfig

Author: Cmdv

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

@@ -22,6 +22,7 @@ module Cardano.DbSync.Config.Types (
   SyncNodeConfig (..),
   SyncPreConfig (..),
   SyncInsertConfig (..),
+  SyncInsertPreset (..),
   SyncInsertOptions (..),
   TxCBORConfig (..),
   PoolStatsConfig (..),
@@ -156,18 +157,17 @@ data SyncPreConfig = SyncPreConfig
   deriving (Show)
 
 data SyncInsertConfig = SyncInsertConfig
-  { sicPreset :: Maybe Text
+  { sicPreset :: Maybe SyncInsertPreset
   , sicOptions :: SyncInsertOptions
   }
   deriving (Eq, Show)
 
--- data SyncInsertConfig
---   = FullInsertOptions
---   | OnlyUTxOInsertOptions
---   | OnlyGovInsertOptions
---   | DisableAllInsertOptions
---   | SyncInsertConfig SyncInsertOptions
---   deriving (Eq, Show)
+data SyncInsertPreset
+  = FullInsertPreset
+  | OnlyUTxOInsertPreset
+  | OnlyGovInsertPreset
+  | DisableAllInsertPreset
+  deriving (Eq, Show)
 
 data SyncInsertOptions = SyncInsertOptions
   { sioTxCBOR :: TxCBORConfig
@@ -397,15 +397,28 @@ instance FromJSON SyncProtocol where
       String "Cardano" -> pure SyncProtocolCardano
       x -> typeMismatch "Protocol" x
 
+instance FromJSON SyncInsertPreset where
+  parseJSON = Aeson.withText "SyncInsertPreset" $ \case
+    "full" -> pure FullInsertPreset
+    "only_utxo" -> pure OnlyUTxOInsertPreset
+    "only_governance" -> pure OnlyGovInsertPreset
+    "disable_all" -> pure DisableAllInsertPreset
+    other -> fail $ "unexpected preset: " <> show other
+
+instance ToJSON SyncInsertPreset where
+  toJSON FullInsertPreset = "full"
+  toJSON OnlyUTxOInsertPreset = "only_utxo"
+  toJSON OnlyGovInsertPreset = "only_governance"
+  toJSON DisableAllInsertPreset = "disable_all"
+
 instance FromJSON SyncInsertConfig where
   parseJSON = Aeson.withObject "SyncInsertConfig" $ \obj -> do
     preset <- obj .:? "preset"
     baseOptions <- case preset of
-      Just "full" -> pure fullInsertOptions
-      Just "only_utxo" -> pure onlyUTxOInsertOptions
-      Just "only_gov" -> pure onlyGovInsertOptions
-      Just "disable_all" -> pure disableAllInsertOptions
-      Just other -> fail $ "unexpected preset: " <> show other
+      Just FullInsertPreset -> pure fullInsertOptions
+      Just OnlyUTxOInsertPreset -> pure onlyUTxOInsertOptions
+      Just OnlyGovInsertPreset -> pure onlyGovInsertOptions
+      Just DisableAllInsertPreset -> pure disableAllInsertOptions
       Nothing -> pure def -- Default options
     options <- parseOverrides obj baseOptions
     pure $ SyncInsertConfig preset options
@@ -738,6 +751,7 @@ onlyGovInsertOptions =
   disableAllInsertOptions
     { sioLedger = LedgerEnable
     , sioGovernance = GovernanceConfig True
+    , sioPoolStats = PoolStatsConfig True
     }
 
 disableAllInsertOptions :: SyncInsertOptions

cardano-db-sync/test/Cardano/DbSync/ApiTest.hs

@@ -7,7 +7,6 @@ import Cardano.DbSync.Api
 import Cardano.DbSync.Config.Types
 import qualified Cardano.DbSync.Gen as Gen
 import Cardano.Prelude
-import Control.Monad (MonadFail (..))
 import Hedgehog
 
 tests :: IO Bool
@@ -27,17 +26,16 @@ prop_extractInsertOptions = property $ do
   coverInsertCfg insertCfg
 
   case insertCfg of
-    SyncInsertConfig (Just "full") _ ->
+    SyncInsertConfig (Just FullInsertPreset) _ ->
       extractInsertOptions cfg === fullInsertOptions
-    SyncInsertConfig (Just "only_utxo") _ ->
+    SyncInsertConfig (Just OnlyUTxOInsertPreset) _ ->
       extractInsertOptions cfg === onlyUTxOInsertOptions
-    SyncInsertConfig (Just "only_gov") _ ->
+    SyncInsertConfig (Just OnlyGovInsertPreset) _ ->
       extractInsertOptions cfg === onlyGovInsertOptions
-    SyncInsertConfig (Just "disable_all") _ ->
+    SyncInsertConfig (Just DisableAllInsertPreset) _ ->
       extractInsertOptions cfg === disableAllInsertOptions
     SyncInsertConfig Nothing opts ->
       extractInsertOptions cfg === opts
-    _other -> fail "Unexpected SyncInsertConfig" -- This case should not happen if all presets are covered
 
 prop_extractInsertOptionsRewards :: Property
 prop_extractInsertOptionsRewards = property $ do
@@ -49,24 +47,22 @@ prop_extractInsertOptionsRewards = property $ do
   let areRewardsEnabled' = areRewardsEnabled $ sioRewards (extractInsertOptions cfg)
 
   case insertCfg of
-    SyncInsertConfig (Just "only_gov") _ ->
+    SyncInsertConfig (Just OnlyGovInsertPreset) _ ->
       assert $ not areRewardsEnabled'
-    SyncInsertConfig (Just "disable_all") _ ->
+    SyncInsertConfig (Just DisableAllInsertPreset) _ ->
       assert $ not areRewardsEnabled'
     _other -> assert areRewardsEnabled'
 
-coverInsertCfg :: SyncInsertConfig -> PropertyT IO ()
-coverInsertCfg cfg = do
-  cover 5 "full" $ isPreset "full" cfg
-  cover 5 "only utxo" $ isPreset "only_utxo" cfg
-  cover 5 "only gov" $ isPreset "only_gov" cfg
-  cover 5 "disable all" $ isPreset "disable_all" cfg
-  cover 5 "custom config" $ isCustomConfig cfg
+coverInsertCfg :: MonadTest m => SyncInsertConfig -> m ()
+coverInsertCfg insertOpts = do
+  let preset = sicPreset insertOpts
+  cover 5 "full" (preset == Just FullInsertPreset)
+  cover 5 "only utxo" (preset == Just OnlyUTxOInsertPreset)
+  cover 5 "only gov" (preset == Just OnlyGovInsertPreset)
+  cover 5 "disable all" (preset == Just DisableAllInsertPreset)
+  cover 5 "config" isSyncInsertConfig
   where
-    isPreset :: Text -> SyncInsertConfig -> Bool
-    isPreset preset (SyncInsertConfig (Just p) _) = p == preset
-    isPreset _ _ = False
-
-    isCustomConfig :: SyncInsertConfig -> Bool
-    isCustomConfig (SyncInsertConfig Nothing _) = True
-    isCustomConfig _ = False
+    isSyncInsertConfig =
+      case insertOpts of
+        (SyncInsertConfig Nothing _) -> True
+        _other -> False

cardano-db-sync/test/Cardano/DbSync/Config/TypesTest.hs

@@ -47,10 +47,10 @@ prop_syncInsertConfigRoundtrip = property $ do
         SyncInsertConfig Nothing _ -> True
         _other -> False
 
-  cover 5 "full" (isPreset "full")
-  cover 5 "only utxo" (isPreset "only_utxo")
-  cover 5 "only gov" (isPreset "only_gov")
-  cover 5 "disable all" (isPreset "disable_all")
+  cover 5 "full" (isPreset FullInsertPreset)
+  cover 5 "only utxo" (isPreset OnlyUTxOInsertPreset)
+  cover 5 "only gov" (isPreset OnlyGovInsertPreset)
+  cover 5 "disable all" (isPreset DisableAllInsertPreset)
   cover 5 "custom config" isCustomConfig
 
   tripping cfg Aeson.encode Aeson.decode

cardano-db-sync/test/Cardano/DbSync/Gen.hs

@@ -107,10 +107,10 @@ syncNodeConfig loggingCfg =
 syncInsertConfig :: Gen SyncInsertConfig
 syncInsertConfig =
   Gen.choice
-    [ pure $ SyncInsertConfig (Just "full") fullInsertOptions
-    , pure $ SyncInsertConfig (Just "only_utxo") onlyUTxOInsertOptions
-    , pure $ SyncInsertConfig (Just "only_gov") onlyGovInsertOptions
-    , pure $ SyncInsertConfig (Just "disable_all") disableAllInsertOptions
+    [ pure $ SyncInsertConfig (Just FullInsertPreset) fullInsertOptions
+    , pure $ SyncInsertConfig (Just OnlyUTxOInsertPreset) onlyUTxOInsertOptions
+    , pure $ SyncInsertConfig (Just OnlyGovInsertPreset) onlyGovInsertOptions
+    , pure $ SyncInsertConfig (Just DisableAllInsertPreset) disableAllInsertOptions
     , SyncInsertConfig Nothing <$> syncInsertOptions
     ]