feature(cardano-db-sync): Add optional "enable_conway" config flag

IntersectMBO · Apr 16, 2024 · 8c1d6c4 · 8c1d6c4
1 parent 2158eb8
commit 8c1d6c4
Show file tree

Hide file tree

Showing 7 changed files with 295 additions and 2 deletions.
diff --git a/cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Conway.hs b/cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Conway.hs
@@ -33,6 +33,9 @@ unitTests iom knownMigrations =
         , testCase "mismatched conway genesis hash" Config.wrongConwayGenesisHash
         , testCase "default insert config" Config.defaultInsertConfig
         , testCase "insert config" Config.insertConfig
+        , testCase "disable conway" Config.disableConway
+        , testCase "enable conway" Config.enableConway
+        , testCase "enable conway by default" Config.enableConwayDefault
         , testGroup
             "tx-out"
             [ test "consumed_by_tx_id column check" MigrateConsumedPruneTxOut.txConsumedColumnCheck

diff --git a/cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Conway/Config/Parse.hs b/cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Conway/Config/Parse.hs
@@ -8,6 +8,9 @@ module Test.Cardano.Db.Mock.Unit.Conway.Config.Parse (
   wrongConwayGenesisHash,
   insertConfig,
   defaultInsertConfig,
+  disableConway,
+  enableConway,
+  enableConwayDefault,
 ) where
 
 import Cardano.DbSync.Config
@@ -106,3 +109,52 @@ insertConfig = do
   dncInsertOptions cfg @?= expected
   where
     configDir = "config-conway-insert-options"
+
+disableConway :: Assertion
+disableConway = do
+  cfg <- mkSyncNodeConfig configDir args
+
+  -- Make the conway genesis invalid
+  hash <- Aeson.throwDecode "\"0000000000000000000000000000000000000000000000000000000000000000\""
+  let cfg' = cfg {dncConwayGenesisHash = Just hash}
+  -- Should not throw
+  void $ mkConfig configDir mutableDir args cfg'
+  where
+    configDir = "config-conway"
+    mutableDir = mkMutableDir "configDisableConway"
+    args =
+      initCommandLineArgs
+        { claConfigFilename = "test-db-sync-config-disable-conway.json"
+        }
+
+enableConway :: Assertion
+enableConway = do
+  cfg <- mkSyncNodeConfig configDir args
+
+  -- There's no way to verify the file was actually loaded
+  isJust (dncConwayGenesisHash cfg) @?= True
+  isJust (dncConwayGenesisFile cfg) @?= True
+
+  -- Should not throw
+  void $ mkConfig configDir mutableDir args cfg
+  where
+    configDir = "config-conway"
+    mutableDir = mkMutableDir "configDisableConway"
+    args =
+      initCommandLineArgs
+        { claConfigFilename = "test-db-sync-config-enable-conway.json"
+        }
+
+enableConwayDefault :: Assertion
+enableConwayDefault = do
+  cfg <- mkSyncNodeConfig configDir initCommandLineArgs
+
+  -- There's no way to verify the file was actually loaded
+  isJust (dncConwayGenesisHash cfg) @?= True
+  isJust (dncConwayGenesisFile cfg) @?= True
+
+  -- Should not throw
+  void $ mkConfig configDir mutableDir initCommandLineArgs cfg
+  where
+    configDir = "config-conway"
+    mutableDir = mkMutableDir "configDisableConway"
diff --git a/cardano-chain-gen/test/testfiles/config-conway/test-db-sync-config-disable-conway.json b/cardano-chain-gen/test/testfiles/config-conway/test-db-sync-config-disable-conway.json
@@ -0,0 +1,115 @@
+{
+  "EnableLogMetrics": false,
+  "EnableLogging": true,
+  "NetworkName": "testing",
+  "NodeConfigFile": "test-config.json",
+  "PrometheusPort": 8080,
+  "RequiresNetworkMagic": "RequiresMagic",
+  "defaultBackends": [
+    "KatipBK"
+  ],
+  "defaultScribes": [
+    [
+      "StdoutSK",
+      "stdout"
+    ]
+  ],
+  "minSeverity": "Info",
+  "options": {
+    "cfokey": {
+      "value": "Release-1.0.0"
+    },
+    "mapBackends": {},
+    "mapSeverity": {
+      "db-sync-node": "Info",
+      "db-sync-node.Mux": "Error",
+      "db-sync-node.Subscription": "Error"
+    },
+    "mapSubtrace": {
+      "#ekgview": {
+        "contents": [
+          [
+            {
+              "contents": "cardano.epoch-validation.benchmark",
+              "tag": "Contains"
+            },
+            [
+              {
+                "contents": ".monoclock.basic.",
+                "tag": "Contains"
+              }
+            ]
+          ],
+          [
+            {
+              "contents": "cardano.epoch-validation.benchmark",
+              "tag": "Contains"
+            },
+            [
+              {
+                "contents": "diff.RTS.cpuNs.timed.",
+                "tag": "Contains"
+              }
+            ]
+          ],
+          [
+            {
+              "contents": "#ekgview.#aggregation.cardano.epoch-validation.benchmark",
+              "tag": "StartsWith"
+            },
+            [
+              {
+                "contents": "diff.RTS.gcNum.timed.",
+                "tag": "Contains"
+              }
+            ]
+          ]
+        ],
+        "subtrace": "FilterTrace"
+      },
+      "#messagecounters.aggregation": {
+        "subtrace": "NoTrace"
+      },
+      "#messagecounters.ekgview": {
+        "subtrace": "NoTrace"
+      },
+      "#messagecounters.katip": {
+        "subtrace": "NoTrace"
+      },
+      "#messagecounters.monitoring": {
+        "subtrace": "NoTrace"
+      },
+      "#messagecounters.switchboard": {
+        "subtrace": "NoTrace"
+      },
+      "benchmark": {
+        "contents": [
+          "GhcRtsStats",
+          "MonotonicClock"
+        ],
+        "subtrace": "ObservableTrace"
+      },
+      "cardano.epoch-validation.utxo-stats": {
+        "subtrace": "NoTrace"
+      }
+    }
+  },
+  "rotation": {
+    "rpKeepFilesNum": 10,
+    "rpLogLimitBytes": 5000000,
+    "rpMaxAgeHours": 24
+  },
+  "setupBackends": [
+    "AggregationBK",
+    "KatipBK"
+  ],
+  "setupScribes": [
+    {
+      "scFormat": "ScText",
+      "scKind": "StdoutSK",
+      "scName": "stdout",
+      "scRotation": null
+    }
+  ],
+  "enable_conway": false
+}
diff --git a/cardano-chain-gen/test/testfiles/config-conway/test-db-sync-config-enable-conway.json b/cardano-chain-gen/test/testfiles/config-conway/test-db-sync-config-enable-conway.json
@@ -0,0 +1,115 @@
+{
+  "EnableLogMetrics": false,
+  "EnableLogging": true,
+  "NetworkName": "testing",
+  "NodeConfigFile": "test-config.json",
+  "PrometheusPort": 8080,
+  "RequiresNetworkMagic": "RequiresMagic",
+  "defaultBackends": [
+    "KatipBK"
+  ],
+  "defaultScribes": [
+    [
+      "StdoutSK",
+      "stdout"
+    ]
+  ],
+  "minSeverity": "Info",
+  "options": {
+    "cfokey": {
+      "value": "Release-1.0.0"
+    },
+    "mapBackends": {},
+    "mapSeverity": {
+      "db-sync-node": "Info",
+      "db-sync-node.Mux": "Error",
+      "db-sync-node.Subscription": "Error"
+    },
+    "mapSubtrace": {
+      "#ekgview": {
+        "contents": [
+          [
+            {
+              "contents": "cardano.epoch-validation.benchmark",
+              "tag": "Contains"
+            },
+            [
+              {
+                "contents": ".monoclock.basic.",
+                "tag": "Contains"
+              }
+            ]
+          ],
+          [
+            {
+              "contents": "cardano.epoch-validation.benchmark",
+              "tag": "Contains"
+            },
+            [
+              {
+                "contents": "diff.RTS.cpuNs.timed.",
+                "tag": "Contains"
+              }
+            ]
+          ],
+          [
+            {
+              "contents": "#ekgview.#aggregation.cardano.epoch-validation.benchmark",
+              "tag": "StartsWith"
+            },
+            [
+              {
+                "contents": "diff.RTS.gcNum.timed.",
+                "tag": "Contains"
+              }
+            ]
+          ]
+        ],
+        "subtrace": "FilterTrace"
+      },
+      "#messagecounters.aggregation": {
+        "subtrace": "NoTrace"
+      },
+      "#messagecounters.ekgview": {
+        "subtrace": "NoTrace"
+      },
+      "#messagecounters.katip": {
+        "subtrace": "NoTrace"
+      },
+      "#messagecounters.monitoring": {
+        "subtrace": "NoTrace"
+      },
+      "#messagecounters.switchboard": {
+        "subtrace": "NoTrace"
+      },
+      "benchmark": {
+        "contents": [
+          "GhcRtsStats",
+          "MonotonicClock"
+        ],
+        "subtrace": "ObservableTrace"
+      },
+      "cardano.epoch-validation.utxo-stats": {
+        "subtrace": "NoTrace"
+      }
+    }
+  },
+  "rotation": {
+    "rpKeepFilesNum": 10,
+    "rpLogLimitBytes": 5000000,
+    "rpMaxAgeHours": 24
+  },
+  "setupBackends": [
+    "AggregationBK",
+    "KatipBK"
+  ],
+  "setupScribes": [
+    {
+      "scFormat": "ScText",
+      "scKind": "StdoutSK",
+      "scName": "stdout",
+      "scRotation": null
+    }
+  ],
+  "enable_conway": true
+}
diff --git a/cardano-db-sync/src/Cardano/DbSync/Config.hs b/cardano-db-sync/src/Cardano/DbSync/Config.hs
@@ -58,6 +58,11 @@ coalesceConfig ::
   IO SyncNodeConfig
 coalesceConfig pcfg ncfg adjustGenesisPath = do
   lc <- Logging.setupFromRepresentation $ pcLoggingConfig pcfg
+
+  let (conwayGenesisFile', conwayGenesisHash')
+        | pcEnableConway pcfg = (ncConwayGenesisFile ncfg, ncConwayGenesisHash ncfg)
+        | otherwise = (Nothing, Nothing)
+
   pure $
     SyncNodeConfig
       { dncNetworkName = pcNetworkName pcfg
@@ -76,8 +81,8 @@ coalesceConfig pcfg ncfg adjustGenesisPath = do
       , dncAlonzoGenesisFile = adjustGenesisFilePath adjustGenesisPath (ncAlonzoGenesisFile ncfg)
       , dncAlonzoGenesisHash = ncAlonzoGenesisHash ncfg
       , dncConwayGenesisFile =
-          adjustGenesisFilePath adjustGenesisPath <$> ncConwayGenesisFile ncfg
-      , dncConwayGenesisHash = ncConwayGenesisHash ncfg
+          adjustGenesisFilePath adjustGenesisPath <$> conwayGenesisFile'
+      , dncConwayGenesisHash = conwayGenesisHash'
       , dncByronProtocolVersion = ncByronProtocolVersion ncfg
       , dncShelleyHardFork = ncShelleyHardFork ncfg
       , dncAllegraHardFork = ncAllegraHardFork ncfg

diff --git a/cardano-db-sync/src/Cardano/DbSync/Config/Types.hs b/cardano-db-sync/src/Cardano/DbSync/Config/Types.hs
@@ -143,6 +143,7 @@ data SyncPreConfig = SyncPreConfig
   , pcEnableMetrics :: !Bool
   , pcPrometheusPort :: !Int
   , pcInsertConfig :: !SyncInsertConfig
+  , pcEnableConway :: !Bool
   }
   deriving (Show)
 
@@ -356,6 +357,7 @@ parseGenSyncNodeConfig o =
     <*> o .: "EnableLogMetrics"
     <*> fmap (fromMaybe 8080) (o .:? "PrometheusPort")
     <*> o .:? "insert_options" .!= def
+    <*> o .:? "enable_conway" .!= True
 
 instance FromJSON SyncProtocol where
   parseJSON o =

diff --git a/cardano-db-sync/test/Cardano/DbSync/Gen.hs b/cardano-db-sync/test/Cardano/DbSync/Gen.hs
@@ -54,6 +54,7 @@ syncPreConfig =
     <*> Gen.bool
     <*> Gen.int (Range.linear 0 10000)
     <*> syncInsertConfig
+    <*> Gen.bool
 
 syncNodeParams :: MonadGen m => m SyncNodeParams
 syncNodeParams =