Disable limit trie logs for trie log subcommand (hyperledger#7366)

This avoids executing TrieLogPruner.preload Signed-off-by: Simon Dudley <[email protected]> Signed-off-by: gconnect <[email protected]>
gconnect · Aug 17, 2024 · b47487b · b47487b
1 parent 7e4a25a
commit b47487b
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,7 @@
 
 ### Bug fixes
 - Fix `eth_call` deserialization to correctly ignore unknown fields in the transaction object. [#7323](https://github.com/hyperledger/besu/pull/7323)
+- Avoid executing pruner preload during trie log subcommands [#7366](https://github.com/hyperledger/besu/pull/7366)
 
 ## 24.7.0
 

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java b/besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java
@@ -2246,7 +2246,12 @@ private MiningParameters getMiningParameters() {
     return miningParameters;
   }
 
-  private DataStorageConfiguration getDataStorageConfiguration() {
+  /**
+   * Get the data storage configuration
+   *
+   * @return the data storage configuration
+   */
+  public DataStorageConfiguration getDataStorageConfiguration() {
     if (dataStorageConfiguration == null) {
       dataStorageConfiguration = dataStorageOptions.toDomainObject();
     }

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/subcommands/storage/TrieLogSubCommand.java b/besu/src/main/java/org/hyperledger/besu/cli/subcommands/storage/TrieLogSubCommand.java
@@ -28,6 +28,7 @@
 import org.hyperledger.besu.ethereum.trie.diffbased.bonsai.storage.BonsaiWorldStateKeyValueStorage;
 import org.hyperledger.besu.ethereum.trie.diffbased.common.trielog.TrieLogPruner;
 import org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration;
+import org.hyperledger.besu.ethereum.worldstate.ImmutableDataStorageConfiguration;
 import org.hyperledger.besu.plugin.services.storage.DataStorageFormat;
 
 import java.io.IOException;
@@ -82,7 +83,14 @@ public void run() {
   }
 
   private static BesuController createBesuController() {
-    return parentCommand.besuCommand.buildController();
+    final DataStorageConfiguration config = parentCommand.besuCommand.getDataStorageConfiguration();
+    // disable limit trie logs to avoid preloading during subcommand execution
+    return parentCommand
+        .besuCommand
+        .getControllerBuilder()
+        .dataStorageConfiguration(
+            ImmutableDataStorageConfiguration.copyOf(config).withBonsaiLimitTrieLogsEnabled(false))
+        .build();
   }
 
   @Command(

diff --git a/besu/src/test/java/org/hyperledger/besu/cli/subcommands/storage/TrieLogSubCommandTest.java b/besu/src/test/java/org/hyperledger/besu/cli/subcommands/storage/TrieLogSubCommandTest.java
@@ -0,0 +1,74 @@
+/*
+ * Copyright contributors to Hyperledger Besu.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.besu.cli.subcommands.storage;
+
+import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat;
+import static org.mockito.Mockito.atLeastOnce;
+import static org.mockito.Mockito.verify;
+
+import org.hyperledger.besu.cli.CommandTestAbstract;
+import org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration;
+
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+
+class TrieLogSubCommandTest extends CommandTestAbstract {
+
+  @Test
+  void limitTrieLogsDefaultDisabledForAllSubcommands() {
+    assertTrieLogSubcommand("prune");
+    assertTrieLogSubcommand("count");
+    assertTrieLogSubcommand("import");
+    assertTrieLogSubcommand("export");
+  }
+
+  @Test
+  void limitTrieLogsDisabledForAllSubcommands() {
+    assertTrieLogSubcommandWithExplicitLimitEnabled("prune");
+    assertTrieLogSubcommandWithExplicitLimitEnabled("count");
+    assertTrieLogSubcommandWithExplicitLimitEnabled("import");
+    assertTrieLogSubcommandWithExplicitLimitEnabled("export");
+  }
+
+  private void assertTrieLogSubcommand(final String trieLogSubcommand) {
+    parseCommand("storage", "trie-log", trieLogSubcommand);
+    assertConfigurationIsDisabledBySubcommand();
+  }
+
+  private void assertTrieLogSubcommandWithExplicitLimitEnabled(final String trieLogSubcommand) {
+    parseCommand("--bonsai-limit-trie-logs-enabled=true", "storage", "trie-log", trieLogSubcommand);
+    assertConfigurationIsDisabledBySubcommand();
+  }
+
+  private void assertConfigurationIsDisabledBySubcommand() {
+    verify(mockControllerBuilder, atLeastOnce())
+        .dataStorageConfiguration(dataStorageConfigurationArgumentCaptor.capture());
+    final List<DataStorageConfiguration> configs =
+        dataStorageConfigurationArgumentCaptor.getAllValues();
+    assertThat(configs.get(0).getBonsaiLimitTrieLogsEnabled()).isTrue();
+    assertThat(configs.get(1).getBonsaiLimitTrieLogsEnabled()).isFalse();
+  }
+
+  @Test
+  void limitTrieLogsDefaultEnabledForBesuMainCommand() {
+    parseCommand();
+    verify(mockControllerBuilder, atLeastOnce())
+        .dataStorageConfiguration(dataStorageConfigurationArgumentCaptor.capture());
+    final List<DataStorageConfiguration> configs =
+        dataStorageConfigurationArgumentCaptor.getAllValues();
+    assertThat(configs).allMatch(DataStorageConfiguration::getBonsaiLimitTrieLogsEnabled);
+  }
+}