From 731ce162ea130bc925557c1f3bb6e06c124c1622 Mon Sep 17 00:00:00 2001
From: Manfred Riem <mriem@manorrock.com>
Date: Wed, 27 Nov 2024 14:12:11 -0600
Subject: [PATCH] Fixes #4292 - Refactor LoggingFeature to do async logging
 (#4293)

---
 .mvn/maven.config                             |   2 +-
 .../feature/logging/LoggingFeature.java       |  25 ++++-
 .../feature/logging/LoggingHandler.java       | 105 ++++++++++++++++++
 .../logging/src/main/java/module-info.java    |   2 +-
 .../feature/logging/LoggingFeatureTest.java   |   5 +-
 5 files changed, 133 insertions(+), 6 deletions(-)
 create mode 100644 feature/logging/src/main/java/cloud/piranha/feature/logging/LoggingHandler.java

diff --git a/.mvn/maven.config b/.mvn/maven.config
index ca9905f00d..202d48fe7e 100644
--- a/.mvn/maven.config
+++ b/.mvn/maven.config
@@ -1,3 +1,3 @@
 --show-version
 -T
-8
\ No newline at end of file
+4
\ No newline at end of file
diff --git a/feature/logging/src/main/java/cloud/piranha/feature/logging/LoggingFeature.java b/feature/logging/src/main/java/cloud/piranha/feature/logging/LoggingFeature.java
index 6369145c56..ee239b8a9e 100644
--- a/feature/logging/src/main/java/cloud/piranha/feature/logging/LoggingFeature.java
+++ b/feature/logging/src/main/java/cloud/piranha/feature/logging/LoggingFeature.java
@@ -27,12 +27,14 @@
  */
 package cloud.piranha.feature.logging;
 
-import cloud.piranha.feature.impl.DefaultFeature;
+import java.util.logging.ConsoleHandler;
 import java.util.logging.Handler;
 import java.util.logging.Level;
 import java.util.logging.LogManager;
 import java.util.logging.Logger;
 
+import cloud.piranha.feature.impl.DefaultFeature;
+
 /**
  * The Logging feature.
  *
@@ -61,10 +63,29 @@ public String getLevel() {
 
     @Override
     public void init() {
+        /*
+         * Remote the default console handler.
+         */
+        Logger rootLogger = Logger.getLogger("");
+        Handler[] handlers = rootLogger.getHandlers();
+        if (handlers[0] instanceof ConsoleHandler) {
+            rootLogger.removeHandler(handlers[0]);
+        }
+
+        /*
+         * Add our custom console handler.
+         */
+        LoggingHandler loggingHandler = new LoggingHandler();
+        rootLogger.addHandler(loggingHandler);
+        rootLogger.setLevel(Level.ALL);
+
+        /**
+         * Set the log level (if set).
+         */
         if (level != null) {
             Logger logger = LogManager.getLogManager().getLogger("");
             logger.setLevel(Level.parse(level));
-            Handler[] handlers = logger.getHandlers();
+            handlers = logger.getHandlers();
             for(int i=0; i<handlers.length; i++) {
                 handlers[i].setLevel(Level.parse(level));
             }
diff --git a/feature/logging/src/main/java/cloud/piranha/feature/logging/LoggingHandler.java b/feature/logging/src/main/java/cloud/piranha/feature/logging/LoggingHandler.java
new file mode 100644
index 0000000000..5945d40c85
--- /dev/null
+++ b/feature/logging/src/main/java/cloud/piranha/feature/logging/LoggingHandler.java
@@ -0,0 +1,105 @@
+/*
+ * Copyright (c) 2002-2024 Manorrock.com. All Rights Reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *   1. Redistributions of source code must retain the above copyright notice,
+ *      this list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *   3. Neither the name of the copyright holder nor the names of its
+ *      contributors may be used to endorse or promote products derived from
+ *      this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package cloud.piranha.feature.logging;
+
+import java.util.logging.Handler;
+import java.util.logging.LogRecord;
+import java.util.logging.ConsoleHandler;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+import java.util.concurrent.TimeoutException;
+import java.util.concurrent.TimeUnit;
+
+public class LoggingHandler extends Handler {
+
+    /**
+     * Stores the executor service for handling log records.
+     */
+    private final ExecutorService executorService = Executors.newSingleThreadExecutor();
+
+    /**
+     * Stores the original ConsoleHandler.
+     */
+    private final ConsoleHandler consoleHandler = new ConsoleHandler();
+
+    /**
+     * Constructor.
+     */
+    public LoggingHandler() {
+        consoleHandler.setLevel(getLevel());
+    }
+
+    @Override
+    public void publish(LogRecord record) {
+        executorService.submit(new LogRecordPublisher(record));
+    }
+
+    /**
+     * The LogRecordPublisher class.
+     */
+    private class LogRecordPublisher implements Runnable {
+
+        /**
+         * Stores the LogRecord.
+         */
+        private final LogRecord record;
+
+        /**
+         * Constructor.
+         * 
+         * @param record the log record.
+         */
+        LogRecordPublisher(LogRecord record) {
+            this.record = record;
+        }
+
+        @Override
+        public void run() {
+            Future<?> future = executorService.submit(() -> consoleHandler.publish(record));
+            try {
+                future.get(10, TimeUnit.SECONDS);
+            } catch (TimeoutException e) {
+                future.cancel(true);
+            } catch (Exception e) {
+                // Handle other exceptions
+            }
+        }
+    }
+
+    @Override
+    public void flush() {
+        consoleHandler.flush();
+    }
+
+    @Override
+    public void close() throws SecurityException {
+        consoleHandler.close();
+        executorService.shutdown();
+    }
+}
diff --git a/feature/logging/src/main/java/module-info.java b/feature/logging/src/main/java/module-info.java
index cbb1e27716..881bcbaec7 100644
--- a/feature/logging/src/main/java/module-info.java
+++ b/feature/logging/src/main/java/module-info.java
@@ -36,5 +36,5 @@
     exports cloud.piranha.feature.logging;
     opens cloud.piranha.feature.logging;
     requires transitive cloud.piranha.feature.impl;
-    requires java.logging;
+    requires transitive java.logging;
 }
diff --git a/feature/logging/src/test/java/cloud/piranha/feature/logging/LoggingFeatureTest.java b/feature/logging/src/test/java/cloud/piranha/feature/logging/LoggingFeatureTest.java
index d6d30d6617..16d8fad90e 100644
--- a/feature/logging/src/test/java/cloud/piranha/feature/logging/LoggingFeatureTest.java
+++ b/feature/logging/src/test/java/cloud/piranha/feature/logging/LoggingFeatureTest.java
@@ -27,9 +27,10 @@
  */
 package cloud.piranha.feature.logging;
 
-import static java.util.logging.Level.INFO;
+import static java.util.logging.Level.ALL;
 import static java.util.logging.Level.SEVERE;
 import java.util.logging.LogManager;
+
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import org.junit.jupiter.api.Test;
@@ -59,7 +60,7 @@ void testGetLevel() {
     void testInit() {
         LoggingFeature feature = new LoggingFeature();
         feature.init();
-        assertEquals(INFO, LogManager.getLogManager().getLogger("").getLevel());
+        assertEquals(ALL, LogManager.getLogManager().getLogger("").getLevel());
         feature = new LoggingFeature();
         feature.setLevel("SEVERE");
         feature.init();