fix: logger to LOGGER per code review

mattp-swirldslabs · mattp-swirldslabs · commit 191673268a59 · 2024-06-25T11:56:33.000-06:00
Signed-off-by: Matt Peterson &lt;matt.peterson@swirldslabs.com&gt;
diff --git a/server/src/main/java/com/hedera/block/server/BlockStreamService.java b/server/src/main/java/com/hedera/block/server/BlockStreamService.java
@@ -42,7 +42,7 @@
  */
 public class BlockStreamService implements GrpcService {
 
-    private final Logger logger = Logger.getLogger(getClass().getName());
+    private final Logger LOGGER = Logger.getLogger(getClass().getName());
 
     private final long timeoutThresholdMillis;
     private final StreamMediator<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> streamMediator;
@@ -100,7 +100,7 @@ public void update(Routing routing) {
      * via the streamMediator as well as sending responses back to the producer.
      */
     private StreamObserver<BlockStreamServiceGrpcProto.Block> streamSink(StreamObserver<BlockStreamServiceGrpcProto.BlockResponse> responseStreamObserver) {
-        logger.finer("Executing bidirectional streamSink method");
+        LOGGER.finer("Executing bidirectional streamSink method");
 
         return new ProducerBlockStreamObserver(streamMediator, responseStreamObserver);
     }
@@ -115,7 +115,7 @@ private StreamObserver<BlockStreamServiceGrpcProto.Block> streamSink(StreamObser
      * handling responses from the consumer.
      */
     private StreamObserver<BlockStreamServiceGrpcProto.BlockResponse> streamSource(StreamObserver<BlockStreamServiceGrpcProto.Block> responseStreamObserver) {
-        logger.finer("Executing bidirectional streamSource method");
+        LOGGER.finer("Executing bidirectional streamSource method");
 
         // Return a custom StreamObserver to handle streaming blocks from the producer.
         LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> streamObserver = new LiveStreamObserverImpl(
diff --git a/server/src/main/java/com/hedera/block/server/Server.java b/server/src/main/java/com/hedera/block/server/Server.java
@@ -47,7 +47,7 @@ public class Server {
     private static ServerCalls.BidiStreamingMethod<Stream<BlockStreamServiceGrpcProto.Block>, StreamObserver<BlockStreamServiceGrpcProto.Block>> clientBidiStreamingMethod;
     private static ServerCalls.BidiStreamingMethod<Stream<BlockStreamServiceGrpcProto.BlockResponse>, StreamObserver<BlockStreamServiceGrpcProto.Block>> serverBidiStreamingMethod;
 
-    private static final Logger logger = Logger.getLogger(Server.class.getName());
+    private static final Logger LOGGER = Logger.getLogger(Server.class.getName());
 
     private Server() {}
 
@@ -89,7 +89,7 @@ public static void main(String[] args) {
                     .start();
 
         } catch (IOException e) {
-            logger.severe("There was an exception starting the server: " + e.getMessage());
+            LOGGER.severe("There was an exception starting the server: " + e.getMessage());
             throw new RuntimeException(e);
         }
     }
diff --git a/server/src/main/java/com/hedera/block/server/consumer/LiveStreamObserverImpl.java b/server/src/main/java/com/hedera/block/server/consumer/LiveStreamObserverImpl.java
@@ -31,7 +31,7 @@
  */
 public class LiveStreamObserverImpl implements LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> {
 
-    private final Logger logger = Logger.getLogger(getClass().getName());
+    private final Logger LOGGER = Logger.getLogger(getClass().getName());
 
     private final StreamMediator<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> mediator;
     private final StreamObserver<BlockStreamServiceGrpcProto.Block> responseStreamObserver;
@@ -69,7 +69,7 @@ public void notify(BlockStreamServiceGrpcProto.Block block) {
 
         if (System.currentTimeMillis() - this.consumerLivenessMillis > timeoutThresholdMillis) {
             if (mediator.isSubscribed(this)) {
-                logger.info("Consumer timeout threshold exceeded.  Unsubscribing observer.");
+                LOGGER.info("Consumer timeout threshold exceeded.  Unsubscribing observer.");
                 mediator.unsubscribe(this);
             }
         } else {
@@ -88,11 +88,11 @@ public void onNext(BlockStreamServiceGrpcProto.BlockResponse blockResponse) {
 
         if (System.currentTimeMillis() - this.producerLivenessMillis > timeoutThresholdMillis) {
             if (mediator.isSubscribed(this)) {
-                logger.info("Producer timeout threshold exceeded.  Unsubscribing observer.");
+                LOGGER.info("Producer timeout threshold exceeded.  Unsubscribing observer.");
                 mediator.unsubscribe(this);
             }
         } else {
-            logger.finer("Received response block " + blockResponse);
+            LOGGER.finer("Received response block " + blockResponse);
             this.consumerLivenessMillis = System.currentTimeMillis();
         }
     }
@@ -105,7 +105,7 @@ public void onNext(BlockStreamServiceGrpcProto.BlockResponse blockResponse) {
      */
     @Override
     public void onError(Throwable t) {
-        logger.severe("onError: " + t.getMessage());
+        LOGGER.severe("onError: " + t.getMessage());
         mediator.unsubscribe(this);
     }
 
@@ -116,8 +116,8 @@ public void onError(Throwable t) {
      */
     @Override
     public void onCompleted() {
-        logger.finer("gRPC connection completed.  Unsubscribing observer.");
+        LOGGER.finer("gRPC connection completed.  Unsubscribing observer.");
         mediator.unsubscribe(this);
-        logger.finer("Unsubscribed observer.");
+        LOGGER.finer("Unsubscribed observer.");
     }
 }
diff --git a/server/src/main/java/com/hedera/block/server/mediator/LiveStreamMediatorImpl.java b/server/src/main/java/com/hedera/block/server/mediator/LiveStreamMediatorImpl.java
@@ -36,7 +36,7 @@
  */
 public class LiveStreamMediatorImpl implements StreamMediator<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> {
 
-    private final Logger logger = Logger.getLogger(getClass().getName());
+    private final Logger LOGGER = Logger.getLogger(getClass().getName());
     private final Set<LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse>> subscribers = Collections.synchronizedSet(new LinkedHashSet<>());
 
     private final BlockPersistenceHandler<BlockStreamServiceGrpcProto.Block> blockPersistenceHandler;
@@ -69,9 +69,9 @@ public void subscribe(LiveStreamObserver<BlockStreamServiceGrpcProto.Block, Bloc
     @Override
     public void unsubscribe(LiveStreamObserver<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> liveStreamObserver) {
         if (this.subscribers.remove(liveStreamObserver)) {
-            logger.finer("Successfully removed observer from subscription list");
+            LOGGER.finer("Successfully removed observer from subscription list");
         } else {
-            logger.finer("Failed to remove observer from subscription list");
+            LOGGER.finer("Failed to remove observer from subscription list");
         }
     }
 
diff --git a/server/src/main/java/com/hedera/block/server/persistence/cache/LRUCache.java b/server/src/main/java/com/hedera/block/server/persistence/cache/LRUCache.java
@@ -33,15 +33,15 @@
 public class LRUCache implements BlockCache<BlockStreamServiceGrpcProto.Block> {
 
     private final Map<Long, BlockStreamServiceGrpcProto.Block> m;
-    private final Logger logger = Logger.getLogger(getClass().getName());
+    private final Logger LOGGER = Logger.getLogger(getClass().getName());
 
     /**
      * Constructor for the LRUCache class.
      *
      * @param maxEntries the maximum number of entries in the cache
      */
     public LRUCache(long maxEntries) {
-        logger.finer("Creating LRUCache with maxEntries: " + maxEntries);
+        LOGGER.finer("Creating LRUCache with maxEntries: " + maxEntries);
         m = Collections.synchronizedMap(new BNLinkedHashMap<>(maxEntries));
     }
 
diff --git a/server/src/main/java/com/hedera/block/server/persistence/storage/FileSystemBlockStorage.java b/server/src/main/java/com/hedera/block/server/persistence/storage/FileSystemBlockStorage.java
@@ -40,7 +40,7 @@ public class FileSystemBlockStorage implements BlockStorage<BlockStreamServiceGr
     public static final String BLOCK_FILE_EXTENSION = ".blk";
 
     private final Path blockNodeRootPath;
-    private final Logger logger = Logger.getLogger(getClass().getName());
+    private final Logger LOGGER = Logger.getLogger(getClass().getName());
 
     /**
      * Constructs a FileSystemBlockStorage object.
@@ -51,15 +51,15 @@ public class FileSystemBlockStorage implements BlockStorage<BlockStreamServiceGr
      */
     public FileSystemBlockStorage(String key, Config config) throws IOException {
 
-        logger.info("Initializing FileSystemBlockStorage");
-        logger.info(config.toString());
+        LOGGER.info("Initializing FileSystemBlockStorage");
+        LOGGER.info(config.toString());
 
         blockNodeRootPath = Path.of(config
                 .get(key)
                 .asString()
                 .get());
 
-        logger.info("Block Node Root Path: " + blockNodeRootPath);
+        LOGGER.info("Block Node Root Path: " + blockNodeRootPath);
 
         if (!blockNodeRootPath.isAbsolute()) {
             throw new IllegalArgumentException(BLOCKNODE_STORAGE_ROOT_PATH_KEY+ " must be an absolute path");
@@ -68,9 +68,9 @@ public FileSystemBlockStorage(String key, Config config) throws IOException {
         // Initialize the block node root directory if it does not exist
         if (Files.notExists(blockNodeRootPath)) {
             Files.createDirectory(blockNodeRootPath);
-            logger.info("Created block node root directory: " + blockNodeRootPath);
+            LOGGER.info("Created block node root directory: " + blockNodeRootPath);
         } else {
-            logger.info("Block node root directory exists: " + blockNodeRootPath);
+            LOGGER.info("Block node root directory exists: " + blockNodeRootPath);
         }
     }
 
@@ -84,14 +84,14 @@ public FileSystemBlockStorage(String key, Config config) throws IOException {
     public Optional<Long> write(BlockStreamServiceGrpcProto.Block block) {
         Long id = block.getId();
         String fullPath = resolvePath(id);
-        logger.finer("Wrote the file: " + fullPath);
+        Logger.finer("Wrote the file: " + fullPath);
 
         try (FileOutputStream fos = new FileOutputStream(fullPath)) {
             block.writeTo(fos);
             return Optional.of(id);
         }
         catch (IOException e) {
-            logger.severe("Error writing string to file: " + e.getMessage());
+            LOGGER.severe("Error writing string to file: " + e.getMessage());
             return Optional.empty();
         }
     }
@@ -112,7 +112,7 @@ private Optional<BlockStreamServiceGrpcProto.Block> read(String filePath) {
         try (FileInputStream fis = new FileInputStream(filePath)) {
             return Optional.of(BlockStreamServiceGrpcProto.Block.parseFrom(fis));
         } catch (FileNotFoundException io) {
-            logger.severe("Error reading file: " + filePath);
+            LOGGER.severe("Error reading file: " + filePath);
             return Optional.empty();
         } catch (IOException io) {
             throw new RuntimeException("Error reading file: " + filePath, io);
@@ -123,7 +123,7 @@ private String resolvePath(Long id) {
 
         String fileName = id + BLOCK_FILE_EXTENSION;
         Path fullPath = blockNodeRootPath.resolve(fileName);
-        logger.finer("Resolved fullPath: " + fullPath);
+        LOGGER.finer("Resolved fullPath: " + fullPath);
 
         return fullPath.toString();
     }
diff --git a/server/src/main/java/com/hedera/block/server/producer/ProducerBlockStreamObserver.java b/server/src/main/java/com/hedera/block/server/producer/ProducerBlockStreamObserver.java
@@ -35,7 +35,7 @@ public class ProducerBlockStreamObserver implements StreamObserver<BlockStreamSe
 
     private final StreamMediator<BlockStreamServiceGrpcProto.Block, BlockStreamServiceGrpcProto.BlockResponse> streamMediator;
     private final StreamObserver<BlockStreamServiceGrpcProto.BlockResponse> responseStreamObserver;
-    private final Logger logger = Logger.getLogger(getClass().getName());
+    private final Logger LOGGER = Logger.getLogger(getClass().getName());
 
     /**
      * Constructor for the ProducerBlockStreamObserver class.  It is responsible for calling the mediator with blocks
@@ -60,8 +60,6 @@ public ProducerBlockStreamObserver(StreamMediator<BlockStreamServiceGrpcProto.Bl
      */
     @Override
     public void onNext(BlockStreamServiceGrpcProto.Block block) {
-        logger.finer("onNext called");
-
         streamMediator.notifyAll(block);
 
         BlockStreamServiceGrpcProto.BlockResponse blockResponse = BlockStreamServiceGrpcProto.BlockResponse.newBuilder().setId(block.getId()).build();
@@ -75,7 +73,7 @@ public void onNext(BlockStreamServiceGrpcProto.Block block) {
      */
     @Override
     public void onError(Throwable t) {
-        logger.severe("onError called with the exception: " + t.getMessage());
+        LOGGER.severe("onError called with the exception: " + t.getMessage());
     }
 
     /**
@@ -85,8 +83,8 @@ public void onError(Throwable t) {
      */
     @Override
     public void onCompleted() {
-        logger.finer("StreamObserver completed");
+        LOGGER.finer("ProducerBlockStreamObserver completed");
         this.streamMediator.unsubscribeAll();
-        logger.finer("Unsubscribed all downstream consumers");
+        LOGGER.finer("Unsubscribed all downstream consumers");
     }
 }
diff --git a/server/src/test/java/com/hedera/block/server/persistence/WriteThroughCacheHandlerTest.java b/server/src/test/java/com/hedera/block/server/persistence/WriteThroughCacheHandlerTest.java
@@ -50,7 +50,7 @@
 
 public class WriteThroughCacheHandlerTest {
 
-    private final Logger logger = Logger.getLogger(getClass().getName());
+    private final Logger LOGGER = Logger.getLogger(getClass().getName());
 
     private static final String TEMP_DIR = "block-node-unit-test-dir";
     private static final String JUNIT = "my-junit-test";
@@ -61,7 +61,7 @@ public class WriteThroughCacheHandlerTest {
     @BeforeEach
     public void setUp() throws IOException {
         testPath = Files.createTempDirectory(TEMP_DIR);
-        logger.info("Created temp directory: " + testPath.toString());
+        LOGGER.info("Created temp directory: " + testPath.toString());
 
         Map<String, String> testProperties = Map.of(JUNIT, testPath.toString());
         ConfigSource testConfigSource = MapConfigSource.builder().map(testProperties).build();

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public class Server {`
`47`	`47`	`private static ServerCalls.BidiStreamingMethod<Stream<BlockStreamServiceGrpcProto.Block>, StreamObserver<BlockStreamServiceGrpcProto.Block>> clientBidiStreamingMethod;`
`48`	`48`	`private static ServerCalls.BidiStreamingMethod<Stream<BlockStreamServiceGrpcProto.BlockResponse>, StreamObserver<BlockStreamServiceGrpcProto.Block>> serverBidiStreamingMethod;`
`49`	`49`
`50`		`- private static final Logger logger = Logger.getLogger(Server.class.getName());`
	`50`	`+ private static final Logger LOGGER = Logger.getLogger(Server.class.getName());`
`51`	`51`
`52`	`52`	`private Server() {}`
`53`	`53`
`@@ -89,7 +89,7 @@ public static void main(String[] args) {`
`89`	`89`	`.start();`
`90`	`90`
`91`	`91`	`} catch (IOException e) {`
`92`		`- logger.severe("There was an exception starting the server: " + e.getMessage());`
	`92`	`+ LOGGER.severe("There was an exception starting the server: " + e.getMessage());`
`93`	`93`	`throw new RuntimeException(e);`
`94`	`94`	`}`
`95`	`95`	`}`