fix for txpool inSync listener to honor initial sync state (hyperledg…

…er#6696) Signed-off-by: garyschulte <[email protected]>
jflo · Mar 7, 2024 · 6109275 · 6109275
1 parent 854d35b
commit 6109275
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 4 deletions.
diff --git a/.../src/main/java/org/hyperledger/besu/ethereum/eth/transactions/TransactionPoolFactory.java b/.../src/main/java/org/hyperledger/besu/ethereum/eth/transactions/TransactionPoolFactory.java
@@ -174,17 +174,19 @@ public void onInitialSyncRestart() {
     syncState.subscribeInSync(
         isInSync -> {
           if (isInSync != transactionPool.isEnabled()) {
-            if (isInSync) {
+            if (isInSync && syncState.isInitialSyncPhaseDone()) {
               LOG.info("Node is in sync, enabling transaction handling");
               enableTransactionHandling(
                   transactionTracker,
                   transactionPool,
                   transactionsMessageHandler,
                   pooledTransactionsMessageHandler);
             } else {
-              LOG.info("Node out of sync, disabling transaction handling");
-              disableTransactionHandling(
-                  transactionPool, transactionsMessageHandler, pooledTransactionsMessageHandler);
+              if (transactionPool.isEnabled()) {
+                LOG.info("Node out of sync, disabling transaction handling");
+                disableTransactionHandling(
+                    transactionPool, transactionsMessageHandler, pooledTransactionsMessageHandler);
+              }
             }
           }
         });

diff --git a/.../test/java/org/hyperledger/besu/ethereum/eth/transactions/TransactionPoolFactoryTest.java b/.../test/java/org/hyperledger/besu/ethereum/eth/transactions/TransactionPoolFactoryTest.java
@@ -22,6 +22,7 @@
 import static org.mockito.Mockito.atLeast;
 import static org.mockito.Mockito.atLeastOnce;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
@@ -34,6 +35,7 @@
 import org.hyperledger.besu.ethereum.core.BlockHeaderTestFixture;
 import org.hyperledger.besu.ethereum.core.MiningParameters;
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
+import org.hyperledger.besu.ethereum.core.Synchronizer;
 import org.hyperledger.besu.ethereum.eth.EthProtocolConfiguration;
 import org.hyperledger.besu.ethereum.eth.manager.EthContext;
 import org.hyperledger.besu.ethereum.eth.manager.EthMessages;
@@ -129,6 +131,37 @@ public void notRegisteredToBlockAddedEventBeforeInitialSyncIsDone() {
     assertThat(pool.isEnabled()).isFalse();
   }
 
+  @Test
+  public void assertPoolDisabledIfChainInSyncWithoutInitialSync() {
+    SyncState syncSpy = spy(new SyncState(blockchain, ethPeers, true, Optional.empty()));
+    ArgumentCaptor<Synchronizer.InSyncListener> chainSyncCaptor =
+        ArgumentCaptor.forClass(Synchronizer.InSyncListener.class);
+
+    setupInitialSyncPhase(syncSpy);
+    // verify that we are registered to the sync state
+    verify(syncSpy).subscribeInSync(chainSyncCaptor.capture());
+    // Retrieve the captured InSyncListener
+    Synchronizer.InSyncListener chainSyncListener = chainSyncCaptor.getValue();
+
+    // mock chain being in sync:
+    chainSyncListener.onInSyncStatusChange(true);
+
+    // assert pool is disabled if chain in sync and initial sync not done
+    assertThat(pool.isEnabled()).isFalse();
+
+    // mock initial sync done (avoid triggering initial sync listener)
+    when(syncSpy.isInitialSyncPhaseDone()).thenReturn(true);
+
+    // assert pool is enabled when chain in sync and initial sync done
+    chainSyncListener.onInSyncStatusChange(true);
+    assertThat(pool.isEnabled()).isTrue();
+
+    // assert pool is re-disabled when initial sync is incomplete but chain reaches head:
+    when(syncSpy.isInitialSyncPhaseDone()).thenCallRealMethod();
+    chainSyncListener.onInSyncStatusChange(false);
+    assertThat(pool.isEnabled()).isFalse();
+  }
+
   @Test
   public void registeredToBlockAddedEventAfterInitialSyncIsDone() {
     setupInitialSyncPhase(true);
@@ -231,7 +264,10 @@ public void incomingTransactionMessageHandlersRegisteredIfNoInitialSync() {
 
   private void setupInitialSyncPhase(final boolean hasInitialSyncPhase) {
     syncState = new SyncState(blockchain, ethPeers, hasInitialSyncPhase, Optional.empty());
+    setupInitialSyncPhase(syncState);
+  }
 
+  private void setupInitialSyncPhase(final SyncState syncState) {
     pool =
         TransactionPoolFactory.createTransactionPool(
             schedule,