addressing some of the feedback during PR Review

Signed-off-by: Alfredo Gutierrez <[email protected]>
hashgraph · Aug 7, 2024 · 77fb265 · 77fb265
1 parent 3057f7c
commit 77fb265
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 6 deletions.
diff --git a/server/src/main/java/com/hedera/block/server/config/BlockNodeConfigExtension.java b/server/src/main/java/com/hedera/block/server/config/BlockNodeConfigExtension.java
@@ -23,9 +23,16 @@
 import com.swirlds.config.api.ConfigurationExtension;
 import java.util.Set;
 
+/** Registers configuration types for the server. */
 @AutoService(ConfigurationExtension.class)
 public class BlockNodeConfigExtension implements ConfigurationExtension {
 
+    /**
+     * {@inheritDoc}
+     *
+     * @return Set of configuration data types for the server
+     */
+    @Override
     public Set<Class<? extends Record>> getConfigDataTypes() {
         return Set.of(BasicCommonConfig.class, MetricsConfig.class, PrometheusConfig.class);
     }

diff --git a/server/src/main/java/com/hedera/block/server/config/BlockNodeContext.java b/server/src/main/java/com/hedera/block/server/config/BlockNodeContext.java
@@ -20,5 +20,13 @@
 import com.swirlds.config.api.Configuration;
 import com.swirlds.metrics.api.Metrics;
 
+/**
+ * Context for the block node. This record is returned by the BlockNodeContextFactory when a new
+ * configuration is created.
+ *
+ * @param metrics the metrics used for monitoring and reporting
+ * @param metricsService the service responsible for handling metrics
+ * @param configuration the configuration settings for the block node
+ */
 public record BlockNodeContext(
         Metrics metrics, MetricsService metricsService, Configuration configuration) {}
diff --git a/server/src/main/java/com/hedera/block/server/config/BlockNodeContextFactory.java b/server/src/main/java/com/hedera/block/server/config/BlockNodeContextFactory.java
@@ -27,6 +27,7 @@
 import java.io.IOException;
 import java.nio.file.Path;
 
+/** Static factory that creates {@link BlockNodeContext} */
 public class BlockNodeContextFactory {
     private static final System.Logger logger =
             System.getLogger(BlockNodeContextFactory.class.getName());
@@ -35,6 +36,10 @@ public class BlockNodeContextFactory {
 
     private BlockNodeContextFactory() {}
 
+    /**
+     * @return an instance of {@link BlockNodeContext} which holds {@link Configuration}, {@link
+     *     Metrics} and {@link MetricsService} for the rest of the application to use.
+     */
     public static BlockNodeContext create() {
         final Configuration configuration = getConfiguration();
         final Metrics metrics = getMetrics(configuration);

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -33,16 +33,19 @@ gradleEnterprise {
 dependencyResolutionManagement {
     versionCatalogs {
         create("libs") {
+            // define a constant for the com.swirlds version, since they are all in lockstep
+            val swirldsVersion = "0.51.5"
+
             // Compile time dependencies
             version("com.google.protobuf", "3.24.0")
             version("io.helidon.webserver.http2", "4.0.10")
             version("io.helidon.webserver.grpc", "4.0.10")
-            version("com.swirlds.metrics.api","0.51.5")
-            version("com.swirlds.metrics.impl","0.51.5")
-            version("com.swirlds.common", "0.51.5")
-            version("com.swirlds.config.impl", "0.51.5")
-            version("com.swirlds.config.processor", "0.51.5")
-            version("com.swirlds.config.extensions", "0.51.5")
+            version("com.swirlds.metrics.api", swirldsVersion)
+            version("com.swirlds.metrics.impl", swirldsVersion)
+            version("com.swirlds.common", swirldsVersion)
+            version("com.swirlds.config.impl", swirldsVersion)
+            version("com.swirlds.config.processor", swirldsVersion)
+            version("com.swirlds.config.extensions", swirldsVersion)
             version("com.google.auto.service.processor", "1.1.1")
             version("com.google.auto.service", "1.1.1")
             version("org.hyperledger.besu.nativelib.secp256k1", "0.8.2")