naming things is important (#7895)

BesuContext was not a helpful name for an interface that only manipulates services to be used by plugins.

---------

Signed-off-by: jflo <justin+github@florentine.us>

CHANGELOG.md

@@ -6,6 +6,7 @@
 - Removed Retesteth rpc service and commands [#7833](https://github.com/hyperledger/besu/pull/7783)
 
 ### Upcoming Breaking Changes
+- Plugin API will be deprecating the BesuContext interface to be replaced with the ServiceManager interface.
 - `MetricSystem::createLabelledGauge` is deprecated and will be removed in a future release, replace it with `MetricSystem::createLabelledSuppliedGauge`
 
 ### Additions and Improvements

acceptance-tests/test-plugins/src/main/java/org/hyperledger/besu/tests/acceptance/plugins/BadCLIOptionsPlugin.java

@@ -16,8 +16,8 @@
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 
-import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.services.PicoCLIOptions;
 
 import java.io.File;
@@ -39,7 +39,7 @@ public class BadCLIOptionsPlugin implements BesuPlugin {
   private File callbackDir;
 
   @Override
-  public void register(final BesuContext context) {
+  public void register(final ServiceManager context) {
     LOG.info("Registering BadCliOptionsPlugin");
     callbackDir = new File(System.getProperty("besu.plugins.dir", "plugins"));
     writeStatus("init");

acceptance-tests/test-plugins/src/main/java/org/hyperledger/besu/tests/acceptance/plugins/TestBesuEventsPlugin.java

@@ -14,8 +14,8 @@
  */
 package org.hyperledger.besu.tests.acceptance.plugins;
 
-import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.data.BlockHeader;
 import org.hyperledger.besu.plugin.data.PropagatedBlockContext;
 import org.hyperledger.besu.plugin.services.BesuEvents;
@@ -35,14 +35,14 @@
 public class TestBesuEventsPlugin implements BesuPlugin {
   private static final Logger LOG = LoggerFactory.getLogger(TestBesuEventsPlugin.class);
 
-  private BesuContext context;
+  private ServiceManager context;
 
   private Optional<Long> subscriptionId;
   private final AtomicInteger blockCounter = new AtomicInteger();
   private File callbackDir;
 
   @Override
-  public void register(final BesuContext context) {
+  public void register(final ServiceManager context) {
     this.context = context;
     LOG.info("Registered");
     callbackDir = new File(System.getProperty("besu.plugins.dir", "plugins"));

acceptance-tests/test-plugins/src/main/java/org/hyperledger/besu/tests/acceptance/plugins/TestBlockchainServiceFinalizedPlugin.java

@@ -17,8 +17,8 @@
 import org.hyperledger.besu.datatypes.Hash;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.JsonRpcParameter;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.RpcErrorType;
-import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.data.BlockContext;
 import org.hyperledger.besu.plugin.services.BlockchainService;
 import org.hyperledger.besu.plugin.services.RpcEndpointService;
@@ -40,19 +40,19 @@ public class TestBlockchainServiceFinalizedPlugin implements BesuPlugin {
   private static final String RPC_METHOD_SAFE_BLOCK = "updateSafeBlockV1";
 
   @Override
-  public void register(final BesuContext besuContext) {
+  public void register(final ServiceManager serviceManager) {
     LOG.trace("Registering plugin ...");
 
     final RpcEndpointService rpcEndpointService =
-        besuContext
+        serviceManager
             .getService(RpcEndpointService.class)
             .orElseThrow(
                 () ->
                     new RuntimeException(
                         "Failed to obtain RpcEndpointService from the BesuContext."));
 
     final BlockchainService blockchainService =
-        besuContext
+        serviceManager
             .getService(BlockchainService.class)
             .orElseThrow(
                 () ->

acceptance-tests/test-plugins/src/main/java/org/hyperledger/besu/tests/acceptance/plugins/TestInProcessRpcServicePlugin.java

@@ -15,8 +15,8 @@
 package org.hyperledger.besu.tests.acceptance.plugins;
 
 import org.hyperledger.besu.datatypes.Wei;
-import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.services.PicoCLIOptions;
 import org.hyperledger.besu.plugin.services.RpcEndpointService;
 import org.hyperledger.besu.plugin.services.rpc.RpcResponseType;
@@ -36,7 +36,7 @@ public class TestInProcessRpcServicePlugin implements BesuPlugin {
   long minGasPrice = -1;
 
   @Override
-  public void register(final BesuContext context) {
+  public void register(final ServiceManager context) {
     final PicoCLIOptions cmdlineOptions =
         context
             .getService(PicoCLIOptions.class)

acceptance-tests/test-plugins/src/main/java/org/hyperledger/besu/tests/acceptance/plugins/TestMetricsPlugin.java

@@ -14,8 +14,8 @@
  */
 package org.hyperledger.besu.tests.acceptance.plugins;
 
-import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.services.MetricsSystem;
 import org.hyperledger.besu.plugin.services.metrics.MetricCategory;
 import org.hyperledger.besu.plugin.services.metrics.MetricCategoryRegistry;
@@ -30,12 +30,12 @@
 @AutoService(BesuPlugin.class)
 public class TestMetricsPlugin implements BesuPlugin {
   private static final Logger LOG = LoggerFactory.getLogger(TestMetricsPlugin.class);
-  private BesuContext besuContext;
+  private ServiceManager serviceManager;
 
   @Override
-  public void register(final BesuContext context) {
+  public void register(final ServiceManager context) {
     LOG.info("Registering TestMetricsPlugin");
-    besuContext = context;
+    serviceManager = context;
     context
         .getService(MetricCategoryRegistry.class)
         .orElseThrow()
@@ -45,7 +45,7 @@ public void register(final BesuContext context) {
   @Override
   public void start() {
     LOG.info("Starting TestMetricsPlugin");
-    besuContext
+    serviceManager
         .getService(MetricsSystem.class)
         .orElseThrow()
         .createGauge(

acceptance-tests/test-plugins/src/main/java/org/hyperledger/besu/tests/acceptance/plugins/TestPermissioningPlugin.java

@@ -14,8 +14,8 @@
  */
 package org.hyperledger.besu.tests.acceptance.plugins;
 
-import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.services.PermissioningService;
 import org.hyperledger.besu.plugin.services.PicoCLIOptions;
 
@@ -40,7 +40,7 @@ public class TestPermissioningPlugin implements BesuPlugin {
   PermissioningService service;
 
   @Override
-  public void register(final BesuContext context) {
+  public void register(final ServiceManager context) {
     context.getService(PicoCLIOptions.class).orElseThrow().addPicoCLIOptions("permissioning", this);
     service = context.getService(PermissioningService.class).orElseThrow();
   }

acceptance-tests/test-plugins/src/main/java/org/hyperledger/besu/tests/acceptance/plugins/TestPicoCLIPlugin.java

@@ -14,8 +14,8 @@
  */
 package org.hyperledger.besu.tests.acceptance.plugins;
 
-import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.services.PicoCLIOptions;
 
 import java.io.File;
@@ -57,7 +57,7 @@ public class TestPicoCLIPlugin implements BesuPlugin {
   private File callbackDir;
 
   @Override
-  public void register(final BesuContext context) {
+  public void register(final ServiceManager context) {
     LOG.info("Registering.  Test Option is '{}'", testOption);
     state = "registering";
 

acceptance-tests/test-plugins/src/main/java/org/hyperledger/besu/tests/acceptance/plugins/TestPrivacyServicePlugin.java

@@ -14,8 +14,8 @@
  */
 package org.hyperledger.besu.tests.acceptance.plugins;
 
-import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.services.PicoCLIOptions;
 import org.hyperledger.besu.plugin.services.PrivacyPluginService;
 import org.hyperledger.besu.tests.acceptance.plugins.privacy.TestPrivacyGroupGenesisProvider;
@@ -32,15 +32,15 @@ public class TestPrivacyServicePlugin implements BesuPlugin {
   private static final Logger LOG = LoggerFactory.getLogger(TestPrivacyServicePlugin.class);
 
   PrivacyPluginService pluginService;
-  BesuContext context;
+  ServiceManager context;
 
   TestPrivacyGroupGenesisProvider privacyGroupGenesisProvider =
       new TestPrivacyGroupGenesisProvider();
   TestSigningPrivateMarkerTransactionFactory privateMarkerTransactionFactory =
       new TestSigningPrivateMarkerTransactionFactory();
 
   @Override
-  public void register(final BesuContext context) {
+  public void register(final ServiceManager context) {
     this.context = context;
 
     context

acceptance-tests/test-plugins/src/main/java/org/hyperledger/besu/tests/acceptance/plugins/TestRpcEndpointServicePlugin.java

@@ -16,8 +16,8 @@
 
 import static com.google.common.base.Preconditions.checkArgument;
 
-import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.services.RpcEndpointService;
 import org.hyperledger.besu.plugin.services.rpc.PluginRpcRequest;
 
@@ -51,7 +51,7 @@ private String throwException(final PluginRpcRequest request) {
   }
 
   @Override
-  public void register(final BesuContext context) {
+  public void register(final ServiceManager context) {
     context
         .getService(RpcEndpointService.class)
         .ifPresent(

besu/src/main/java/org/hyperledger/besu/services/BesuPluginContextImpl.java

@@ -18,8 +18,8 @@
 import static com.google.common.base.Preconditions.checkState;
 
 import org.hyperledger.besu.ethereum.core.plugins.PluginConfiguration;
-import org.hyperledger.besu.plugin.BesuContext;
 import org.hyperledger.besu.plugin.BesuPlugin;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.services.BesuService;
 import org.hyperledger.besu.plugin.services.PluginVersionsProvider;
 
@@ -49,7 +49,7 @@
 import org.slf4j.LoggerFactory;
 
 /** The Besu plugin context implementation. */
-public class BesuPluginContextImpl implements BesuContext, PluginVersionsProvider {
+public class BesuPluginContextImpl implements ServiceManager, PluginVersionsProvider {
 
   private static final Logger LOG = LoggerFactory.getLogger(BesuPluginContextImpl.class);
 

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/trie/diffbased/bonsai/BonsaiWorldStateProvider.java

@@ -28,7 +28,7 @@
 import org.hyperledger.besu.ethereum.trie.patricia.StoredMerklePatriciaTrie;
 import org.hyperledger.besu.ethereum.worldstate.StateTrieAccountValue;
 import org.hyperledger.besu.evm.internal.EvmConfiguration;
-import org.hyperledger.besu.plugin.BesuContext;
+import org.hyperledger.besu.plugin.ServiceManager;
 
 import java.util.HashSet;
 import java.util.Optional;
@@ -52,7 +52,7 @@ public BonsaiWorldStateProvider(
       final Blockchain blockchain,
       final Optional<Long> maxLayersToLoad,
       final BonsaiCachedMerkleTrieLoader bonsaiCachedMerkleTrieLoader,
-      final BesuContext pluginContext,
+      final ServiceManager pluginContext,
       final EvmConfiguration evmConfiguration,
       final Supplier<WorldStateHealer> worldStateHealerSupplier) {
     super(worldStateKeyValueStorage, blockchain, maxLayersToLoad, pluginContext);

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/trie/diffbased/common/DiffBasedWorldStateProvider.java

@@ -31,7 +31,7 @@
 import org.hyperledger.besu.ethereum.worldstate.WorldStateArchive;
 import org.hyperledger.besu.ethereum.worldstate.WorldStateStorageCoordinator;
 import org.hyperledger.besu.evm.worldstate.WorldState;
-import org.hyperledger.besu.plugin.BesuContext;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.services.trielogs.TrieLog;
 
 import java.util.ArrayList;
@@ -61,7 +61,7 @@ public DiffBasedWorldStateProvider(
       final DiffBasedWorldStateKeyValueStorage worldStateKeyValueStorage,
       final Blockchain blockchain,
       final Optional<Long> maxLayersToLoad,
-      final BesuContext pluginContext) {
+      final ServiceManager pluginContext) {
 
     this.worldStateKeyValueStorage = worldStateKeyValueStorage;
     // TODO: de-dup constructors

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/trie/diffbased/common/trielog/TrieLogManager.java

@@ -21,7 +21,7 @@
 import org.hyperledger.besu.ethereum.trie.diffbased.common.storage.DiffBasedWorldStateKeyValueStorage;
 import org.hyperledger.besu.ethereum.trie.diffbased.common.worldview.DiffBasedWorldState;
 import org.hyperledger.besu.ethereum.trie.diffbased.common.worldview.accumulator.DiffBasedWorldStateUpdateAccumulator;
-import org.hyperledger.besu.plugin.BesuContext;
+import org.hyperledger.besu.plugin.ServiceManager;
 import org.hyperledger.besu.plugin.services.TrieLogService;
 import org.hyperledger.besu.plugin.services.trielogs.TrieLog;
 import org.hyperledger.besu.plugin.services.trielogs.TrieLogEvent;
@@ -53,7 +53,7 @@ public TrieLogManager(
       final Blockchain blockchain,
       final DiffBasedWorldStateKeyValueStorage worldStateKeyValueStorage,
       final long maxLayersToLoad,
-      final BesuContext pluginContext) {
+      final ServiceManager pluginContext) {
     this.blockchain = blockchain;
     this.rootWorldStateStorage = worldStateKeyValueStorage;
     this.maxLayersToLoad = maxLayersToLoad;
@@ -133,7 +133,7 @@ public synchronized void unsubscribe(final long id) {
     trieLogObservers.unsubscribe(id);
   }
 
-  private TrieLogFactory setupTrieLogFactory(final BesuContext pluginContext) {
+  private TrieLogFactory setupTrieLogFactory(final ServiceManager pluginContext) {
     // if we have a TrieLogService from pluginContext, use it.
     var trieLogServicez =
         Optional.ofNullable(pluginContext)

plugin-api/build.gradle

@@ -71,7 +71,7 @@ Calculated : ${currentHash}
 tasks.register('checkAPIChanges', FileStateChecker) {
   description = "Checks that the API for the Plugin-API project does not change without deliberate thought"
   files = sourceSets.main.allJava.files
-  knownHash = 'ktVrmQXU7LMQi1ieb9OQ2vJNqZ0SVQ7Usauh1LMvUXY='
+  knownHash = 'wOjR3/uPElPs1GonuLMBWStn1zukFMyy/GfQ9OYChpI='
 }
 check.dependsOn('checkAPIChanges')
 

plugin-api/src/main/java/org/hyperledger/besu/plugin/BesuContext.java

@@ -14,42 +14,6 @@
  */
 package org.hyperledger.besu.plugin;
 
-import org.hyperledger.besu.plugin.services.BesuService;
-
-import java.util.Optional;
-
-/** Allows plugins to access Besu services. */
-public interface BesuContext {
-
-  /**
-   * Add service.
-   *
-   * @param <T> the type parameter
-   * @param serviceType the service type
-   * @param service the service
-   */
-  <T extends BesuService> void addService(final Class<T> serviceType, final T service);
-
-  /**
-   * Get the requested service, if it is available. There are a number of reasons that a service may
-   * not be available:
-   *
-   * <ul>
-   *   <li>The service may not have started yet. Most services are not available before the {@link
-   *       BesuPlugin#start()} method is called
-   *   <li>The service is not supported by this version of Besu
-   *   <li>The service may not be applicable to the current configuration. For example some services
-   *       may only be available when a proof of authority network is in use
-   * </ul>
-   *
-   * <p>Since plugins are automatically loaded, unless the user has specifically requested
-   * functionality provided by the plugin, no error should be raised if required services are
-   * unavailable.
-   *
-   * @param serviceType the class defining the requested service.
-   * @param <T> the service type
-   * @return an optional containing the instance of the requested service, or empty if the service
-   *     is unavailable
-   */
-  <T extends BesuService> Optional<T> getService(Class<T> serviceType);
-}
+/** Deprecated in favor of the more precisely named ServiceManager interface. */
+@Deprecated(since = "24.11.0", forRemoval = true)
+public interface BesuContext extends ServiceManager {}

plugin-api/src/main/java/org/hyperledger/besu/plugin/BesuPlugin.java

@@ -48,7 +48,7 @@ default Optional<String> getName() {
    *
    * @param context the context that provides access to Besu services.
    */
-  void register(BesuContext context);
+  void register(ServiceManager context);
 
   /**
    * Called once when besu has loaded configuration but before external services have been started