Remove log4j2.enable.threadlocals property (#2171)

Author: vy

log4j-1.2-api/src/main/java/org/apache/log4j/layout/Log4j1SyslogLayout.java

@@ -146,7 +146,7 @@ public static <B extends Builder<B>> B newBuilder() {
      */
     private static final String[] dateFormatOptions = {"MMM dd HH:mm:ss", null, "en"};
 
-    private final LogEventPatternConverter dateConverter = DatePatternConverter.newInstance(dateFormatOptions);
+    private final LogEventPatternConverter dateConverter;
 
     private Log4j1SyslogLayout(
             final Configuration config,
@@ -160,6 +160,7 @@ private Log4j1SyslogLayout(
         this.facilityPrinting = facilityPrinting;
         this.header = header;
         this.messageLayout = messageLayout;
+        this.dateConverter = DatePatternConverter.newInstance(config, dateFormatOptions);
     }
 
     /**

log4j-api-test/src/test/java/org/apache/logging/log4j/AbstractLoggerTest.java

@@ -28,7 +28,7 @@
 import org.apache.logging.log4j.message.Message;
 import org.apache.logging.log4j.message.ObjectMessage;
 import org.apache.logging.log4j.message.ParameterizedMessage;
-import org.apache.logging.log4j.message.ParameterizedMessageFactory;
+import org.apache.logging.log4j.message.ReusableMessageFactory;
 import org.apache.logging.log4j.message.SimpleMessage;
 import org.apache.logging.log4j.spi.AbstractLogger;
 import org.apache.logging.log4j.status.StatusData;
@@ -964,7 +964,7 @@ private static class CountingLogger extends AbstractLogger {
         private int objectCount;
 
         CountingLogger() {
-            super("CountingLogger", ParameterizedMessageFactory.INSTANCE);
+            super("CountingLogger", new ReusableMessageFactory());
         }
 
         void setCurrentLevel(final Level currentLevel) {
@@ -1261,7 +1261,7 @@ private static class ThrowableExpectingLogger extends AbstractLogger {
         private final boolean expectingThrowables;
 
         ThrowableExpectingLogger(final boolean expectingThrowables) {
-            super("ThrowableExpectingLogger", ParameterizedMessageFactory.INSTANCE);
+            super("ThrowableExpectingLogger", new ReusableMessageFactory());
             this.expectingThrowables = expectingThrowables;
         }
 

log4j-api-test/src/test/java/org/apache/logging/log4j/LogManagerTest.java

@@ -21,7 +21,7 @@
 
 import java.io.Closeable;
 import java.io.IOException;
-import org.apache.logging.log4j.message.ParameterizedMessageFactory;
+import org.apache.logging.log4j.message.ReusableMessageFactory;
 import org.apache.logging.log4j.spi.LoggerContext;
 import org.junit.jupiter.api.Test;
 import org.junitpioneer.jupiter.ReadsSystemProperty;
@@ -52,25 +52,26 @@ public void testGetLogger() {
         Logger logger = LogManager.getLogger();
         assertNotNull(logger, "No Logger returned");
         assertEquals(LogManagerTest.class.getName(), logger.getName(), "Incorrect Logger name: " + logger.getName());
-        logger = LogManager.getLogger(ParameterizedMessageFactory.INSTANCE);
+        final ReusableMessageFactory messageFactory = new ReusableMessageFactory();
+        logger = LogManager.getLogger(messageFactory);
         assertNotNull(logger, "No Logger returned");
         assertEquals(LogManagerTest.class.getName(), logger.getName(), "Incorrect Logger name: " + logger.getName());
         logger = LogManager.getLogger((Class<?>) null);
         assertNotNull(logger, "No Logger returned");
         assertEquals(LogManagerTest.class.getName(), logger.getName(), "Incorrect Logger name: " + logger.getName());
-        logger = LogManager.getLogger((Class<?>) null, ParameterizedMessageFactory.INSTANCE);
+        logger = LogManager.getLogger((Class<?>) null, messageFactory);
         assertNotNull(logger, "No Logger returned");
         assertEquals(LogManagerTest.class.getName(), logger.getName(), "Incorrect Logger name: " + logger.getName());
         logger = LogManager.getLogger((String) null);
         assertNotNull(logger, "No Logger returned");
         assertEquals(LogManagerTest.class.getName(), logger.getName(), "Incorrect Logger name: " + logger.getName());
-        logger = LogManager.getLogger((String) null, ParameterizedMessageFactory.INSTANCE);
+        logger = LogManager.getLogger((String) null, messageFactory);
         assertNotNull(logger, "No Logger returned");
         assertEquals(LogManagerTest.class.getName(), logger.getName(), "Incorrect Logger name: " + logger.getName());
         logger = LogManager.getLogger((Object) null);
         assertNotNull(logger, "No Logger returned");
         assertEquals(LogManagerTest.class.getName(), logger.getName(), "Incorrect Logger name: " + logger.getName());
-        logger = LogManager.getLogger((Object) null, ParameterizedMessageFactory.INSTANCE);
+        logger = LogManager.getLogger((Object) null, messageFactory);
         assertNotNull(logger, "No Logger returned");
         assertEquals(LogManagerTest.class.getName(), logger.getName(), "Incorrect Logger name: " + logger.getName());
     }

log4j-api-test/src/test/java/org/apache/logging/log4j/LoggerTest.java

@@ -34,7 +34,7 @@
 import org.apache.logging.log4j.message.Message;
 import org.apache.logging.log4j.message.MessageFactory;
 import org.apache.logging.log4j.message.ObjectMessage;
-import org.apache.logging.log4j.message.ParameterizedMessageFactory;
+import org.apache.logging.log4j.message.ReusableMessageFactory;
 import org.apache.logging.log4j.message.SimpleMessage;
 import org.apache.logging.log4j.message.SimpleMessageFactory;
 import org.apache.logging.log4j.message.StringFormatterMessageFactory;
@@ -61,7 +61,7 @@ public class LoggerTest {
     public static final LoggerContextFactoryExtension EXTENSION =
             new LoggerContextFactoryExtension(new TestLoggerContextFactory());
 
-    private static class TestParameterizedMessageFactory {
+    private static class TestReusableMessageFactory {
         // empty
     }
 
@@ -344,12 +344,12 @@ public void getFormatterLogger_String() {
 
     @Test
     @ResourceLock("log4j2.TestLogger")
-    public void getLogger_Class_ParameterizedMessageFactory() {
+    public void getLogger_Class_ReusableMessageFactory() {
         // The TestLogger logger was already created in an instance variable for this class.
         // The message factory is only used when the logger is created.
-        final ParameterizedMessageFactory messageFactory = ParameterizedMessageFactory.INSTANCE;
+        final MessageFactory messageFactory = new ReusableMessageFactory();
         final TestLogger testLogger =
-                (TestLogger) LogManager.getLogger(TestParameterizedMessageFactory.class, messageFactory);
+                (TestLogger) LogManager.getLogger(TestReusableMessageFactory.class, messageFactory);
         assertNotNull(testLogger);
         assertEqualMessageFactory(messageFactory, testLogger);
         testLogger.debug("{}", Integer.MAX_VALUE);
@@ -375,12 +375,12 @@ public void getLogger_Class_StringFormatterMessageFactory() {
 
     @Test
     @ResourceLock("log4j2.TestLogger")
-    public void getLogger_Object_ParameterizedMessageFactory() {
+    public void getLogger_Object_ReusableMessageFactory() {
         // The TestLogger logger was already created in an instance variable for this class.
         // The message factory is only used when the logger is created.
-        final ParameterizedMessageFactory messageFactory = ParameterizedMessageFactory.INSTANCE;
+        final MessageFactory messageFactory = new ReusableMessageFactory();
         final TestLogger testLogger =
-                (TestLogger) LogManager.getLogger(new TestParameterizedMessageFactory(), messageFactory);
+                (TestLogger) LogManager.getLogger(new TestReusableMessageFactory(), messageFactory);
         assertNotNull(testLogger);
         assertEqualMessageFactory(messageFactory, testLogger);
         testLogger.debug("{}", Integer.MAX_VALUE);
@@ -419,7 +419,7 @@ public void getLogger_String_MessageFactoryMismatch() {
         assertNotNull(testLogger);
         assertEqualMessageFactory(messageFactory, testLogger);
         final TestLogger testLogger2 = (TestLogger)
-                LogManager.getLogger("getLogger_String_MessageFactoryMismatch", ParameterizedMessageFactory.INSTANCE);
+                LogManager.getLogger("getLogger_String_MessageFactoryMismatch", new ReusableMessageFactory());
         assertNotNull(testLogger2);
         // TODO: How to test?
         // This test context always creates new loggers, other test context impls I tried fail other tests.
@@ -433,10 +433,10 @@ public void getLogger_String_MessageFactoryMismatch() {
 
     @Test
     @ResourceLock("log4j2.TestLogger")
-    public void getLogger_String_ParameterizedMessageFactory() {
-        final ParameterizedMessageFactory messageFactory = ParameterizedMessageFactory.INSTANCE;
+    public void getLogger_String_ReusableMessageFactory() {
+        final MessageFactory messageFactory = new ReusableMessageFactory();
         final TestLogger testLogger =
-                (TestLogger) LogManager.getLogger("getLogger_String_ParameterizedMessageFactory", messageFactory);
+                (TestLogger) LogManager.getLogger("getLogger_String_ReusableMessageFactory", messageFactory);
         assertNotNull(testLogger);
         assertEqualMessageFactory(messageFactory, testLogger);
         testLogger.debug("{}", Integer.MAX_VALUE);

log4j-api-test/src/test/java/org/apache/logging/log4j/internal/recycler/RecyclerFactoryTestUtil.java

@@ -18,6 +18,7 @@
 
 import edu.umd.cs.findbugs.annotations.Nullable;
 import java.util.Properties;
+import org.apache.logging.log4j.spi.LoggingSystemProperty;
 import org.apache.logging.log4j.spi.recycler.RecyclerFactory;
 import org.apache.logging.log4j.spi.recycler.RecyclerFactoryRegistry;
 import org.apache.logging.log4j.util.PropertiesUtil;
@@ -29,16 +30,16 @@ private RecyclerFactoryTestUtil() {}
 
     @Nullable
     static RecyclerFactory createForEnvironment(
-            @Nullable Boolean threadLocalsEnabled, @Nullable final String factory, @Nullable final Integer capacity) {
+            @Nullable Boolean webApp, @Nullable final String factory, @Nullable final Integer capacity) {
         final Properties properties = new Properties();
-        if (threadLocalsEnabled != null) {
-            properties.setProperty("log4j2.*.ThreadLocals.enable", "" + threadLocalsEnabled);
+        if (webApp != null) {
+            properties.setProperty(LoggingSystemProperty.IS_WEBAPP.getSystemKey(), webApp + "");
         }
         if (factory != null) {
-            properties.setProperty("log4j2.*.Recycler.factory", factory);
+            properties.setProperty(LoggingSystemProperty.RECYCLER_FACTORY.getSystemKey(), factory);
         }
         if (capacity != null) {
-            properties.setProperty("log4j2.*.Recycler.capacity", "" + capacity);
+            properties.setProperty(LoggingSystemProperty.RECYCLER_CAPACITY.getSystemKey(), capacity + "");
         }
         final PropertyEnvironment env = new PropertiesUtil(properties);
         return RecyclerFactoryRegistry.findRecyclerFactory(env);

log4j-api-test/src/test/java/org/apache/logging/log4j/internal/recycler/ThreadLocalRecyclerFactoryProviderTest.java

@@ -44,16 +44,16 @@ private static class RecyclableObject {}
 
     @BeforeEach
     void setUp() {
-        final RecyclerFactory recyclerFactory = createForEnvironment(null, "threadLocal", CAPACITY);
+        final RecyclerFactory recyclerFactory = createForEnvironment(false, "threadLocal", CAPACITY);
         assertThat(recyclerFactory).isInstanceOf(ThreadLocalRecyclerFactory.class);
         assert recyclerFactory != null;
         recycler = (ThreadLocalRecycler<RecyclableObject>) recyclerFactory.create(RecyclableObject::new);
         recyclerQueue = recycler.queueRef.get();
     }
 
     @Test
-    void should_not_be_configured_when_TLs_are_disabled() {
-        assertThatThrownBy(() -> createForEnvironment(false, "threadLocal", null))
+    void should_not_be_configured_for_webapps() {
+        assertThatThrownBy(() -> createForEnvironment(true, "threadLocal", null))
                 .isInstanceOf(IllegalArgumentException.class)
                 .hasMessageStartingWith("failed to configure recycler");
     }