patch: Fix application not starting due to wrong usage of loggerContext (#149)

Author: JohannesRiegler

platform-spring-bom/platform-spring-logging-server-config/src/main/java/com/latch/LengthSplittingAppender.java

@@ -34,13 +34,6 @@
  * SOFTWARE.
  */
 public class LengthSplittingAppender extends SplittingAppenderBase<ILoggingEvent> {
-    private final LoggingEventCloner loggingEventCloner;
-
-    public LengthSplittingAppender() {
-        super();
-        LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
-        this.loggingEventCloner = new LoggingEventCloner(loggerContext);
-    }
 
     private int maxLength;
     private String sequenceKey;
@@ -76,7 +69,7 @@ public List<ILoggingEvent> split(ILoggingEvent event) {
             Map<String, String> seqMDCPropertyMap = new HashMap<>(event.getMDCPropertyMap());
             seqMDCPropertyMap.put(getSequenceKey(), Integer.toString(i));
 
-            LoggingEvent clonedEvent = loggingEventCloner.clone(event, message, seqMDCPropertyMap);
+            LoggingEvent clonedEvent = LoggingEventCloner.clone(event, message, seqMDCPropertyMap);
 
             splitLogEvents.add(clonedEvent);
         }

platform-spring-bom/platform-spring-logging-server-config/src/main/java/com/latch/LoggingEventCloner.java

@@ -3,6 +3,7 @@
 import ch.qos.logback.classic.LoggerContext;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.classic.spi.LoggingEvent;
+import org.slf4j.LoggerFactory;
 import org.slf4j.Marker;
 
 import java.util.List;
@@ -32,20 +33,16 @@
  * SOFTWARE.
  */
 class LoggingEventCloner {
-    private final LoggerContext loggerContext;
+    private static LoggerContext loggerContext;
 
-    public LoggingEventCloner(LoggerContext loggerContext) {
-        this.loggerContext = loggerContext;
-    }
-
-    public LoggingEvent clone(ILoggingEvent event, String message, Map<String, String> mdcValueMap) {
+    public static LoggingEvent clone(ILoggingEvent event, String message, Map<String, String> mdcValueMap) {
         LoggingEvent newEvent = new LoggingEvent();
 
         newEvent.setLevel(event.getLevel());
         newEvent.setLoggerName(event.getLoggerName());
         newEvent.setTimeStamp(event.getTimeStamp());
         newEvent.setLoggerContextRemoteView(event.getLoggerContextVO());
-        newEvent.setLoggerContext(this.loggerContext);
+        newEvent.setLoggerContext(getLoggerContext());
         newEvent.setThreadName(event.getThreadName());
         newEvent.setMessage(message);
         newEvent.setMDCPropertyMap(mdcValueMap);
@@ -61,4 +58,15 @@ public LoggingEvent clone(ILoggingEvent event, String message, Map<String, Strin
 
         return newEvent;
     }
+
+    /**
+     * We can't set the logger context directly because that would cause issues if the logger context is not initialized yet.
+     */
+    private static LoggerContext getLoggerContext() {
+        if (loggerContext == null) {
+            loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
+        }
+
+        return loggerContext;
+    }
 }

platform-spring-bom/platform-spring-logging-server-config/src/test/java/com/latch/LoggingEventClonerTest.java

@@ -13,14 +13,6 @@
 import java.util.Map;
 
 public class LoggingEventClonerTest {
-    private final LoggerContext loggerContext;
-    private final LoggingEventCloner loggingEventCloner;
-
-    public LoggingEventClonerTest() {
-        this.loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
-        this.loggingEventCloner = new LoggingEventCloner(loggerContext);
-    }
-
     @Test
     public void correctlyClonesBasicEventProperties() {
         LoggingEvent event = createLoggingEventWithContext();
@@ -29,7 +21,7 @@ public void correctlyClonesBasicEventProperties() {
         event.setThreadName("testThread");
         event.setTimeStamp(System.currentTimeMillis());
 
-        LoggingEvent clonedEvent = loggingEventCloner.clone(event, "", Collections.emptyMap());
+        LoggingEvent clonedEvent = LoggingEventCloner.clone(event, "", Collections.emptyMap());
 
         Assertions.assertNotNull(clonedEvent);
         Assertions.assertEquals(event.getLevel(), clonedEvent.getLevel());
@@ -43,7 +35,7 @@ public void correctlyClonesMessage() {
         LoggingEvent event = createLoggingEventWithContext();
         String message = "Test message";
 
-        LoggingEvent clonedEvent = loggingEventCloner.clone(event, message, Collections.emptyMap());
+        LoggingEvent clonedEvent = LoggingEventCloner.clone(event, message, Collections.emptyMap());
 
         Assertions.assertNotNull(clonedEvent);
         Assertions.assertEquals(message, clonedEvent.getMessage());
@@ -54,7 +46,7 @@ public void correctlyClonesMDCProperties() {
         LoggingEvent event = createLoggingEventWithContext();
         Map<String, String> mdcProperties = Map.of("key1", "value1", "key2", "value2");
 
-        LoggingEvent clonedEvent = loggingEventCloner.clone(event, "", mdcProperties);
+        LoggingEvent clonedEvent = LoggingEventCloner.clone(event, "", mdcProperties);
 
         Assertions.assertNotNull(clonedEvent);
         Map<String, String> clonedMDCProperties = clonedEvent.getMDCPropertyMap();
@@ -69,7 +61,7 @@ public void correctlyClonesMarker() {
         Marker marker = new BasicMarkerFactory().getMarker("TestMarker");
         event.addMarker(marker);
 
-        LoggingEvent clonedEvent = loggingEventCloner.clone(event, "", Collections.emptyMap());
+        LoggingEvent clonedEvent = LoggingEventCloner.clone(event, "", Collections.emptyMap());
 
         Assertions.assertNotNull(clonedEvent);
         Assertions.assertEquals(marker.getName(), clonedEvent.getMarkerList().get(0).getName());
@@ -83,7 +75,7 @@ public void correctlyClonesCallerData() {
         };
         event.setCallerData(callerData);
 
-        LoggingEvent clonedEvent = loggingEventCloner.clone(event, "", Collections.emptyMap());
+        LoggingEvent clonedEvent = LoggingEventCloner.clone(event, "", Collections.emptyMap());
 
         Assertions.assertTrue(clonedEvent.hasCallerData());
         StackTraceElement[] clonedCallerData = clonedEvent.getCallerData();
@@ -93,6 +85,7 @@ public void correctlyClonesCallerData() {
 
     private LoggingEvent createLoggingEventWithContext() {
         LoggingEvent event = new LoggingEvent();
+        LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
         event.setLoggerContext(loggerContext);
         return event;
     }

platform-spring-bom/platform-spring-logging-server-config/src/test/java/io/cloudflight/platform/spring/logging/LoggingJsonSplitterTest.java

@@ -49,7 +49,7 @@ void logWithCloudbackConfig() {
     }
 
     @Test
-    void logLongMessageWithJsonSplitterFails() {
+    void logLongMessageWithJsonSplitterDoesNotFail() {
         Assertions.assertDoesNotThrow(() -> LOG.info(TEST_MARKER, "This is a long message. ".repeat(1000)));
     }
 }