#985 add config field to allow disabling ZMQ for block finalize download & fallback to TCP

Author: PropzSaladaz

blockfinalize/client/BlockFinalizeDownloader.cpp

@@ -299,7 +299,7 @@ void BlockFinalizeDownloader::downloadFragment(
     }
 
     // If ZMQ disabled - try TCP right away
-    if ( !getNode()->getTestConfig()->isBlockFinalizeZmqClientEnabled() ) {
+    if ( !getNode()->isBlockFinalizeZmqEnabled() ) {
         downloadFragmentTCP( _dstIndex, _fragmentIndex, header );
         return;
     }

chains/Schain.cpp

@@ -1507,7 +1507,7 @@ void Schain::constructServers(const ptr<Sockets> &_sockets) {
 
     catchupServerAgent = make_shared<CatchupServerAgent>(*this, _sockets->catchupSocket);
 
-    if ( getNode()->getTestConfig()->isBlockFinalizeZmqServerEnabled() ) {
+    if ( getNode()->isBlockFinalizeZmqEnabled() ) {
         blockFinalizeZmqServerAgent =
             make_shared<BlockFinalizeZmqServerAgent>(*this, _sockets->getBulkDataZMQSockets());
     }

chains/TestConfig.cpp

@@ -30,14 +30,6 @@ bool TestConfig::isFinalizationDownloadOnly() const {
     return finalizationDownloadOnly;
 }
 
-bool TestConfig::isBlockFinalizeZmqClientEnabled() const {
-    return blockFinalizeZmqClientEnabled;
-}
-
-bool TestConfig::isBlockFinalizeZmqServerEnabled() const {
-    return blockFinalizeZmqServerEnabled;
-}
-
 bool TestConfig::isBlockFinalizeTransportStatsEnabled() const {
     return blockFinalizeTransportStatsEnabled;
 }
@@ -47,10 +39,6 @@ TestConfig::TestConfig( nlohmann::json cgf ) {
     finalizationDownloadOnly = ( option != nullptr );
 
     if ( cgf.is_object() ) {
-        blockFinalizeZmqClientEnabled =
-            cgf.value( "testBlockFinalizeZmqClientEnabled", true );
-        blockFinalizeZmqServerEnabled =
-            cgf.value( "testBlockFinalizeZmqServerEnabled", true );
         blockFinalizeTransportStatsEnabled =
             cgf.value( "testBlockFinalizeTransportStatsEnabled", false );
     }
@@ -59,14 +47,6 @@ TestConfig::TestConfig( nlohmann::json cgf ) {
         CONS_LOG( info, "Testing the case of only finalization download" );
     }
 
-    if ( !blockFinalizeZmqClientEnabled ) {
-        CONS_LOG( info, "Testing BlockFinalize with ZMQ client disabled" );
-    }
-
-    if ( !blockFinalizeZmqServerEnabled ) {
-        CONS_LOG( info, "Testing BlockFinalize with ZMQ server disabled" );
-    }
-
     if ( blockFinalizeTransportStatsEnabled ) {
         CONS_LOG( info, "Testing BlockFinalize transport stats collection enabled" );
     }

chains/TestConfig.h

@@ -27,14 +27,10 @@
 
 class TestConfig {
     bool finalizationDownloadOnly = false;
-    bool blockFinalizeZmqClientEnabled = true;
-    bool blockFinalizeZmqServerEnabled = true;
     bool blockFinalizeTransportStatsEnabled = false;
 
 public:
     bool isFinalizationDownloadOnly() const;
-    bool isBlockFinalizeZmqClientEnabled() const;
-    bool isBlockFinalizeZmqServerEnabled() const;
     bool isBlockFinalizeTransportStatsEnabled() const;
 
     TestConfig( nlohmann::json cgf );

node/Node.cpp

@@ -294,6 +294,11 @@ void Node::initParamsFromConfig() {
     syncNodeReadJsonHeaderTimeoutSec =
         getParamUint64( "syncNodeReadJsonHeaderTimeoutSec", SYNC_NODE_READ_JSON_HEADER_TIMEOUT_SEC );
     testNet = ( getParamUint64( "isTestNet", 0 ) > 0 );
+    
+    if ( cfg.find( "blockFinalizeZmqEnabled" ) != cfg.end() ) {
+        blockFinalizeZmqEnabled =
+            cfg.at( "blockFinalizeZmqEnabled" ).get< bool >();
+    }
 
     blockDBSize = storageLimits->getBlockDbSize();
     proposalHashDBSize = storageLimits->getProposalHashDbSize();

node/Node.h

@@ -221,6 +221,8 @@ class Node {
 
     uint64_t blockFinalizeDownloadTcpFallbackMs = 0;
 
+    bool blockFinalizeZmqEnabled = true;
+
     uint64_t emptyBlockIntervalMs = 0;
 
     uint64_t emptyBlockIntervalAfterCatchupMs = 0;
@@ -333,6 +335,8 @@ class Node {
 
     bool isTestNet() const;
 
+    bool isBlockFinalizeZmqEnabled() const;
+
     [[nodiscard]] const ptr< TestConfig >& getTestConfig() const;
 
     ptr< BlockDB > getBlockDB() const;

node/NodeGettersSetters.cpp

@@ -463,6 +463,10 @@ bool Node::isTestNet() const {
     return testNet;
 }
 
+bool Node::isBlockFinalizeZmqEnabled() const {
+    return blockFinalizeZmqEnabled;
+}
+
 void Node::setExitOnBlockBoundaryRequested() {
     CONS_LOG( info, "Set exit on block boundary" );
     exitOnBlockBoundaryRequested = true;

test/twonodes_blockfinalize_both_new_zmq/node1/Node.json

@@ -5,7 +5,6 @@
   "basePort": 1231,
   "logLevel": "info",
   "simulateNetworkWriteDelayMs": 100,
-  "testBlockFinalizeZmqClientEnabled": true,
-  "testBlockFinalizeZmqServerEnabled": true,
+  "blockFinalizeZmqEnabled": true,
   "testBlockFinalizeTransportStatsEnabled": true
 }

test/twonodes_blockfinalize_both_new_zmq/node2/Node.json

@@ -5,7 +5,6 @@
   "basePort": 2231,
   "logLevel": "info",
   "simulateNetworkWriteDelayMs": 100,
-  "testBlockFinalizeZmqClientEnabled": true,
-  "testBlockFinalizeZmqServerEnabled": true,
+  "blockFinalizeZmqEnabled": true,
   "testBlockFinalizeTransportStatsEnabled": true
 }

test/twonodes_blockfinalize_new_client_old_server/node1/Node.json

@@ -5,7 +5,6 @@
   "basePort": 1231,
   "logLevel": "info",
   "simulateNetworkWriteDelayMs": 100,
-  "testBlockFinalizeZmqClientEnabled": true,
-  "testBlockFinalizeZmqServerEnabled": false,
+  "blockFinalizeZmqEnabled": true,
   "testBlockFinalizeTransportStatsEnabled": true
 }