convert jsonb removal to be an opt in feature

Author: Cmdv

cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Alonzo/Config.hs

@@ -31,7 +31,7 @@ insertConfig = do
           , sioGovernance = GovernanceConfig False
           , sioOffchainPoolData = OffchainPoolDataConfig False
           , sioJsonType = JsonTypeDisable
-          , sioAddJsonbToSchema = AddJsonbToSchemaConfig False
+          , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False
           }
 
   dncInsertOptions cfg @?= expected

cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Babbage/Config/Parse.hs

@@ -31,7 +31,7 @@ insertConfig = do
           , sioGovernance = GovernanceConfig False
           , sioOffchainPoolData = OffchainPoolDataConfig False
           , sioJsonType = JsonTypeDisable
-          , sioAddJsonbToSchema = AddJsonbToSchemaConfig False
+          , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False
           }
 
   dncInsertOptions cfg @?= expected

cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Conway.hs

@@ -37,11 +37,11 @@ unitTests iom knownMigrations =
         , testCase "insert config" Config.insertConfig
         , testGroup
             "jsonb-in-schema"
-            [ test "jsonb in schema true" Config.configJsonbInSchemaTrue
-            , test "jsonb in schema false" Config.configJsonbInSchemaFalse
+            [ test "jsonb in schema true" Config.configRemoveJsonbFromSchemaEnabled
+            , test "jsonb in schema false" Config.configRemoveJsonbFromSchemaDisabled
             , test
-                "jsonb true then false should remove datatype from db"
-                Config.configJsonbInSchemaShouldAddThenRemove
+                "remove jsonb from schema and add back"
+                Config.configJsonbInSchemaShouldRemoveThenAdd
             ]
         , testGroup
             "tx-out"

cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Conway/Config/JsonbInSchema.hs

@@ -2,22 +2,22 @@
 {-# LANGUAGE OverloadedStrings #-}
 
 module Test.Cardano.Db.Mock.Unit.Conway.Config.JsonbInSchema (
-  configJsonbInSchemaTrue,
-  configJsonbInSchemaFalse,
-  configJsonbInSchemaShouldAddThenRemove,
+  configRemoveJsonbFromSchemaEnabled,
+  configRemoveJsonbFromSchemaDisabled,
+  configJsonbInSchemaShouldRemoveThenAdd,
 ) where
 
 import qualified Cardano.Db as DB
 import Cardano.DbSync.Config (SyncNodeConfig (..))
-import Cardano.DbSync.Config.Types (AddJsonbToSchemaConfig (..), SyncInsertOptions (..))
+import Cardano.DbSync.Config.Types (RemoveJsonbFromSchemaConfig (..), SyncInsertOptions (..))
 import Cardano.Mock.ChainSync.Server (IOManager ())
 import Cardano.Prelude hiding (head)
 import Test.Cardano.Db.Mock.Config
 import Test.Cardano.Db.Mock.Validate
 import Test.Tasty.HUnit (Assertion ())
 
-configJsonbInSchemaTrue :: IOManager -> [(Text, Text)] -> Assertion
-configJsonbInSchemaTrue ioManager metadata = do
+configRemoveJsonbFromSchemaEnabled :: IOManager -> [(Text, Text)] -> Assertion
+configRemoveJsonbFromSchemaEnabled ioManager metadata = do
   syncNodeConfig <- mksNodeConfig
   withCustomConfigAndDropDB args (Just syncNodeConfig) cfgDir testLabel action ioManager metadata
   where
@@ -27,12 +27,12 @@ configJsonbInSchemaTrue ioManager metadata = do
       assertEqQuery
         dbSync
         DB.queryJsonbInSchemaExists
-        True
-        "There should be jsonb data types in database if option is active"
+        False
+        "There should be no jsonb data types in database if option is enabled"
       checkStillRuns dbSync
 
     args = initCommandLineArgs {claFullMode = False}
-    testLabel = "conwayConfigJsonbInSchemaTrue"
+    testLabel = "conwayConfigRemoveJsonbFromSchemaEnabled"
 
     cfgDir = conwayConfigDir
 
@@ -42,11 +42,11 @@ configJsonbInSchemaTrue ioManager metadata = do
       let dncInsertOptions' = dncInsertOptions initConfigFile
       pure $
         initConfigFile
-          { dncInsertOptions = dncInsertOptions' {sioAddJsonbToSchema = AddJsonbToSchemaConfig True}
+          { dncInsertOptions = dncInsertOptions' {sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig True}
           }
 
-configJsonbInSchemaFalse :: IOManager -> [(Text, Text)] -> Assertion
-configJsonbInSchemaFalse ioManager metadata = do
+configRemoveJsonbFromSchemaDisabled :: IOManager -> [(Text, Text)] -> Assertion
+configRemoveJsonbFromSchemaDisabled ioManager metadata = do
   syncNodeConfig <- mksNodeConfig
   withCustomConfigAndDropDB args (Just syncNodeConfig) cfgDir testLabel action ioManager metadata
   where
@@ -56,12 +56,12 @@ configJsonbInSchemaFalse ioManager metadata = do
       assertEqQuery
         dbSync
         DB.queryJsonbInSchemaExists
-        False
-        "There should be no jsonb types in database if option isn't active"
+        True
+        "There should be jsonb types in database if option is disabled"
       checkStillRuns dbSync
 
     args = initCommandLineArgs {claFullMode = False}
-    testLabel = "conwayConfigJsonbInSchemaFalse"
+    testLabel = "conwayConfigRemoveJsonbFromSchemaDisabled"
 
     cfgDir = conwayConfigDir
 
@@ -71,25 +71,30 @@ configJsonbInSchemaFalse ioManager metadata = do
       let dncInsertOptions' = dncInsertOptions initConfigFile
       pure $
         initConfigFile
-          { dncInsertOptions = dncInsertOptions' {sioAddJsonbToSchema = AddJsonbToSchemaConfig False}
+          { dncInsertOptions = dncInsertOptions' {sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False}
           }
 
-configJsonbInSchemaShouldAddThenRemove :: IOManager -> [(Text, Text)] -> Assertion
-configJsonbInSchemaShouldAddThenRemove ioManager metadata = do
+configJsonbInSchemaShouldRemoveThenAdd :: IOManager -> [(Text, Text)] -> Assertion
+configJsonbInSchemaShouldRemoveThenAdd ioManager metadata = do
   syncNodeConfig <- mksNodeConfig
   withCustomConfigAndDropDB args (Just syncNodeConfig) cfgDir testLabel action ioManager metadata
   where
     action = \_interpreter _mockServer dbSync -> do
       startDBSync dbSync
       threadDelay 7_000_000
+      assertEqQuery
+        dbSync
+        DB.queryJsonbInSchemaExists
+        False
+        "There should be no jsonb types in database if option has been enabled"
       stopDBSync dbSync
       let newDbSyncEnv =
             dbSync
               { dbSyncConfig =
                   (dbSyncConfig dbSync)
                     { dncInsertOptions =
                         (dncInsertOptions $ dbSyncConfig dbSync)
-                          { sioAddJsonbToSchema = AddJsonbToSchemaConfig False
+                          { sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False
                           }
                     }
               }
@@ -98,13 +103,13 @@ configJsonbInSchemaShouldAddThenRemove ioManager metadata = do
       assertEqQuery
         dbSync
         DB.queryJsonbInSchemaExists
-        False
-        "There should be no jsonb types in database if option has been set to False"
+        True
+        "There should be jsonb types in database if option has been disabled"
       -- Expected to fail
       checkStillRuns dbSync
 
     args = initCommandLineArgs {claFullMode = False}
-    testLabel = "configJsonbInSchemaShouldAddThenRemove"
+    testLabel = "configJsonbInSchemaShouldRemoveThenAdd"
 
     cfgDir = conwayConfigDir
 
@@ -114,5 +119,5 @@ configJsonbInSchemaShouldAddThenRemove ioManager metadata = do
       let dncInsertOptions' = dncInsertOptions initConfigFile
       pure $
         initConfigFile
-          { dncInsertOptions = dncInsertOptions' {sioAddJsonbToSchema = AddJsonbToSchemaConfig True}
+          { dncInsertOptions = dncInsertOptions' {sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig True}
           }

cardano-chain-gen/test/Test/Cardano/Db/Mock/Unit/Conway/Config/Parse.hs

@@ -101,7 +101,7 @@ insertConfig = do
           , sioGovernance = GovernanceConfig False
           , sioOffchainPoolData = OffchainPoolDataConfig False
           , sioJsonType = JsonTypeDisable
-          , sioAddJsonbToSchema = AddJsonbToSchemaConfig False
+          , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False
           }
 
   dncInsertOptions cfg @?= expected

cardano-chain-gen/test/testfiles/fingerprint/configJsonbInSchemaShouldAddThenRemove renamed to cardano-chain-gen/test/testfiles/fingerprint/configJsonbInSchemaShouldRemoveThenAdd

@@ -43,7 +43,7 @@ import Cardano.DbSync.Rollback (unsafeRollback)
 import Cardano.DbSync.Sync (runSyncNodeClient)
 import Cardano.DbSync.Tracing.ToObjectOrphans ()
 import Cardano.DbSync.Types
-import Cardano.DbSync.Util.Constraint (dbJsonbInSchema)
+import Cardano.DbSync.Util.Constraint (queryIsJsonbInSchema)
 import Cardano.Prelude hiding (Nat, (%))
 import Cardano.Slotting.Slot (EpochNo (..))
 import Control.Concurrent.Async
@@ -174,7 +174,7 @@ runSyncNode metricsSetters trce iomgr dbConnString ranMigrations runMigrationFnc
       \backend -> liftIO $ do
         runOrThrowIO $ runExceptT $ do
           genCfg <- readCardanoGenesisConfig syncNodeConfigFromFile
-          resJsonbInSchema <- dbJsonbInSchema backend
+          isJsonbInSchema <- queryIsJsonbInSchema backend
           logProtocolMagicId trce $ genesisProtocolMagicId genCfg
           syncEnv <-
             ExceptT $
@@ -189,15 +189,15 @@ runSyncNode metricsSetters trce iomgr dbConnString ranMigrations runMigrationFnc
                 ranMigrations
                 runMigrationFnc
 
-          -- if the database has jsonb datatypes and the configuration does not have add_jsonb_to_schema enabled, then warn the user
-          when (resJsonbInSchema && not isJsonBInSchemaConfig) $ do
+          -- Warn the user that jsonb datatypes are being removed from the database schema.
+          when (isJsonbInSchema && removeJsonbFromSchemaConfig) $ do
             liftIO $ logWarning trce "Removing jsonb datatypes from the database. This can take time."
-            liftIO $ runDisableJsonbInSchema syncEnv
+            liftIO $ runRemoveJsonbFromSchema syncEnv
 
-          -- if the database doesn't have jsonb datatypes and the configuration does have add_jsonb_to_schema enabled, then add jsonb datatypes to the database
-          when (not resJsonbInSchema && isJsonBInSchemaConfig) $ do
-            liftIO $ logWarning trce "Adding jsonb datatypes to the database. This can take time."
-            liftIO $ runEnableJsonbInSchema syncEnv
+          -- Warn the user that jsonb datatypes are being added to the database schema.
+          when (not isJsonbInSchema && not removeJsonbFromSchemaConfig) $ do
+            liftIO $ logWarning trce "Adding jsonb datatypes back to the database. This can take time."
+            liftIO $ runAddJsonbToSchema syncEnv
           liftIO $ runExtraMigrationsMaybe syncEnv
           unless useLedger $ liftIO $ do
             logInfo trce "Migrating to a no ledger schema"
@@ -221,7 +221,7 @@ runSyncNode metricsSetters trce iomgr dbConnString ranMigrations runMigrationFnc
       case dncShelleyHardFork cfg of
         HardFork.TriggerHardForkAtEpoch (EpochNo 0) -> True
         _other -> False
-    isJsonBInSchemaConfig = ioAddJsonbToSchema $ soptInsertOptions syncOptions
+    removeJsonbFromSchemaConfig = ioRemoveJsonbFromSchema $ soptInsertOptions syncOptions
     maybeLedgerDir = enpMaybeLedgerStateDir syncNodeParams
 
 logProtocolMagicId :: Trace IO Text -> Crypto.ProtocolMagicId -> ExceptT SyncNodeError IO ()
@@ -276,7 +276,7 @@ extractSyncOptions snp aop snc =
         , ioPlutusExtra = isPlutusEnabled (sioPlutus (dncInsertOptions snc))
         , ioOffChainPoolData = useOffchainPoolData
         , ioGov = useGovernance
-        , ioAddJsonbToSchema = isAddJsonbToSchemaEnabled (sioAddJsonbToSchema (dncInsertOptions snc))
+        , ioRemoveJsonbFromSchema = isRemoveJsonbFromSchemaEnabled (sioRemoveJsonbFromSchema (dncInsertOptions snc))
         }
 
     useLedger = sioLedger (dncInsertOptions snc) == LedgerEnable

cardano-chain-gen/test/testfiles/fingerprint/conwayConfigJsonbInSchemaFalse renamed to cardano-chain-gen/test/testfiles/fingerprint/conwayConfigRemoveJsonbFromSchemaDisabled

@@ -26,8 +26,8 @@ module Cardano.DbSync.Api (
   runIndexMigrations,
   initPruneConsumeMigration,
   runExtraMigrationsMaybe,
-  runEnableJsonbInSchema,
-  runDisableJsonbInSchema,
+  runAddJsonbToSchema,
+  runRemoveJsonbFromSchema,
   getSafeBlockNoDiff,
   getPruneInterval,
   whenConsumeOrPruneTxOut,
@@ -177,12 +177,12 @@ runExtraMigrationsMaybe syncEnv = do
       (getSafeBlockNoDiff syncEnv)
       pcm
 
-runEnableJsonbInSchema :: SyncEnv -> IO ()
-runEnableJsonbInSchema syncEnv =
+runAddJsonbToSchema :: SyncEnv -> IO ()
+runAddJsonbToSchema syncEnv =
   void $ DB.runDbIohkNoLogging (envBackend syncEnv) DB.enableJsonbInSchema
 
-runDisableJsonbInSchema :: SyncEnv -> IO ()
-runDisableJsonbInSchema syncEnv =
+runRemoveJsonbFromSchema :: SyncEnv -> IO ()
+runRemoveJsonbFromSchema syncEnv =
   void $ DB.runDbIohkNoLogging (envBackend syncEnv) DB.disableJsonbInSchema
 
 getSafeBlockNoDiff :: SyncEnv -> Word64
@@ -233,7 +233,7 @@ fullInsertOptions =
     , sioGovernance = GovernanceConfig True
     , sioOffchainPoolData = OffchainPoolDataConfig True
     , sioJsonType = JsonTypeText
-    , sioAddJsonbToSchema = AddJsonbToSchemaConfig False
+    , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False
     }
 
 onlyUTxOInsertOptions :: SyncInsertOptions
@@ -249,7 +249,7 @@ onlyUTxOInsertOptions =
     , sioGovernance = GovernanceConfig False
     , sioOffchainPoolData = OffchainPoolDataConfig False
     , sioJsonType = JsonTypeText
-    , sioAddJsonbToSchema = AddJsonbToSchemaConfig False
+    , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False
     }
 
 onlyGovInsertOptions :: SyncInsertOptions
@@ -272,7 +272,7 @@ disableAllInsertOptions =
     , sioOffchainPoolData = OffchainPoolDataConfig False
     , sioGovernance = GovernanceConfig False
     , sioJsonType = JsonTypeText
-    , sioAddJsonbToSchema = AddJsonbToSchemaConfig False
+    , sioRemoveJsonbFromSchema = RemoveJsonbFromSchemaConfig False
     }
 
 initCurrentEpochNo :: CurrentEpochNo