Merge branch '2.24.x' into 2.x

ppkarwasz · ppkarwasz · commit 546e4fac4ed2 · 2024-11-21T23:33:59.000+01:00
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/LoggerRegistry.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/LoggerRegistry.java
@@ -28,6 +28,7 @@
 import java.util.concurrent.locks.Lock;
 import java.util.concurrent.locks.ReadWriteLock;
 import java.util.concurrent.locks.ReentrantReadWriteLock;
+import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.message.MessageFactory;
 import org.apache.logging.log4j.message.ParameterizedMessageFactory;
 import org.jspecify.annotations.NullMarked;
@@ -246,7 +247,10 @@ public boolean hasLogger(final String name, final Class<? extends MessageFactory
 
     /**
      * Registers the provided logger.
-     * <b>Logger name and message factory parameters are ignored</b>, those will be obtained from the logger instead.
+     * <p>
+     *   The logger will be registered using the keys provided by the {@code name} and {@code messageFactory} parameters
+     *   and the values of {@link Logger#getName()} and {@link Logger#getMessageFactory()}.
+     * </p>
      *
      * @param name a logger name
      * @param messageFactory a message factory
@@ -263,9 +267,16 @@ public void putIfAbsent(final String name, @Nullable final MessageFactory messag
         try {
             final MessageFactory effectiveMessageFactory =
                     messageFactory != null ? messageFactory : ParameterizedMessageFactory.INSTANCE;
+            // Register using the keys provided by the caller
             loggerByMessageFactoryByName
                     .computeIfAbsent(name, this::createLoggerRefByMessageFactoryMap)
                     .putIfAbsent(effectiveMessageFactory, logger);
+            // Also register using the values extracted from `logger`
+            if (!name.equals(logger.getName()) || !effectiveMessageFactory.equals(logger.getMessageFactory())) {
+                loggerByMessageFactoryByName
+                        .computeIfAbsent(logger.getName(), this::createLoggerRefByMessageFactoryMap)
+                        .putIfAbsent(logger.getMessageFactory(), logger);
+            }
         } finally {
             writeLock.unlock();
         }
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistry.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/internal/InternalLoggerRegistry.java
@@ -156,18 +156,24 @@ public Logger computeIfAbsent(
             // Create the logger
             logger = loggerSupplier.apply(name, messageFactory);
 
-            // Report message factory mismatches, if there is any
+            // Report name and message factory mismatch if there are any
+            final String loggerName = logger.getName();
             final MessageFactory loggerMessageFactory = logger.getMessageFactory();
             if (!loggerMessageFactory.equals(messageFactory)) {
                 StatusLogger.getLogger()
                         .error(
-                                "Newly registered logger with name `{}` and message factory `{}`, is requested to be associated with a different message factory: `{}`.\n"
+                                "Newly registered logger with name `{}` and message factory `{}`, is requested to be associated with a different name `{}` or message factory `{}`.\n"
                                         + "Effectively the message factory of the logger will be used and the other one will be ignored.\n"
                                         + "This generally hints a problem at the logger context implementation.\n"
                                         + "Please report this using the Log4j project issue tracker.",
-                                name,
+                                loggerName,
                                 loggerMessageFactory,
+                                name,
                                 messageFactory);
+                // Register logger under alternative keys
+                loggerRefByNameByMessageFactory
+                        .computeIfAbsent(loggerMessageFactory, ignored -> new HashMap<>())
+                        .putIfAbsent(loggerName, new WeakReference<>(logger));
             }
 
             // Insert the logger
diff --git a/pom.xml b/pom.xml
@@ -308,9 +308,9 @@
     <!-- project version -->
     <revision>2.25.0-SNAPSHOT</revision>
     <!-- Versions used on the site: no snapshots! -->
-    <site-log4j-api.version>2.24.1</site-log4j-api.version>
-    <site-log4j-core.version>2.24.1</site-log4j-core.version>
-    <site-log4j-layout-template-json.version>2.24.1</site-log4j-layout-template-json.version>
+    <site-log4j-api.version>2.24.2</site-log4j-api.version>
+    <site-log4j-core.version>2.24.2</site-log4j-core.version>
+    <site-log4j-layout-template-json.version>2.24.2</site-log4j-layout-template-json.version>
 
     <!-- =================
          Common properties
@@ -324,7 +324,7 @@
          2. This value is employed in various places while creating the distribution
          To mitigate these, we define a *dummy* value here and let the CI replace it during a release.
          Hence, *DO NOT MANUALLY EDIT THIS VALUE*! -->
-    <project.build.outputTimestamp>2024-09-24T13:33:09Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2024-11-18T20:27:38Z</project.build.outputTimestamp>
 
     <!-- ========================
          Site-specific properties
diff --git a/src/changelog/2.24.1/.release-notes.adoc.ftl b/src/changelog/2.24.1/.release-notes.adoc.ftl
@@ -14,12 +14,21 @@
     See the License for the specific language governing permissions and
     limitations under the License.
 ////
-
+<#-- @ftlvariable name="release.date" type="java.lang.String" -->
+<#-- @ftlvariable name="release.version" type="java.lang.String" -->
 [#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}]
 == ${release.version}
 
 <#if release.date?has_content>Release date:: ${release.date}</#if>
 
+[WARNING]
+====
+Due to a critical bug affecting this release (see
+https://github.com/apache/logging-log4j2/issues/3143[#3143])
+users are encouraged to upgrade to
+${'<<release-notes-2-24-2, version `2.24.2`>>'}.
+====
+
 This release contains mainly bug fixes of problems encountered with the thread context map, logger registry and configuration reloading.
 
 It also enhances integration tests to use Docker images of the most recent releases of MongoDB and Elastic Search.
diff --git a/src/changelog/2.24.2/.release-notes.adoc.ftl b/src/changelog/2.24.2/.release-notes.adoc.ftl
@@ -0,0 +1,29 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+////
+<#-- @ftlvariable name="release.date" type="java.lang.String" -->
+<#-- @ftlvariable name="release.version" type="java.lang.String" -->
+[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}]
+== ${release.version}
+
+<#if release.date?has_content>Release date:: ${release.date}</#if>
+
+This release fixes a critical bug in Log4j API initialization code, which can cause `LogManager.getLogger()` to return `null` under certain conditions.
+See
+https://github.com/apache/logging-log4j2/issues/3143[#3143]
+for details.
+
+<#include "../.changelog.adoc.ftl">
diff --git a/src/changelog/2.24.2/.release.xml b/src/changelog/2.24.2/.release.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one or more
+  ~ contributor license agreements.  See the NOTICE file distributed with
+  ~ this work for additional information regarding copyright ownership.
+  ~ The ASF licenses this file to you under the Apache License, Version 2.0
+  ~ (the "License"); you may not use this file except in compliance with
+  ~ the License.  You may obtain a copy of the License at
+  ~
+  ~      http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<release xmlns="https://logging.apache.org/xml/ns"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+         date="2024-11-18" version="2.24.2"/>
diff --git a/src/changelog/2.24.2/3048_fix_ThreadContext_remove.xml b/src/changelog/2.24.2/3048_fix_ThreadContext_remove.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns="https://logging.apache.org/xml/ns"
+       xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+       type="fixed">
+  <issue id="3048" link="https://github.com/apache/logging-log4j2/pull/3048"/>
+  <description format="asciidoc">Fix key removal issues in Thread Context</description>
+</entry>
diff --git a/src/changelog/2.24.2/3143_logger_registry.xml b/src/changelog/2.24.2/3143_logger_registry.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns="https://logging.apache.org/xml/ns"
+       xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+       type="fixed">
+  <issue id="3143" link="https://github.com/apache/logging-log4j2/issues/3143"/>
+  <description format="asciidoc">
+    Use hard references to ``Logger``s in `LoggerRegistry`.
+  </description>
+</entry>
diff --git a/src/changelog/2.24.2/3216_fix_JTL_StackTraceStringResolver.xml b/src/changelog/2.24.2/3216_fix_JTL_StackTraceStringResolver.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns="https://logging.apache.org/xml/ns"
+       xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+       type="fixed">
+  <issue id="3216" link="https://github.com/apache/logging-log4j2/pull/3216"/>
+  <description format="asciidoc">Fix `ArrayIndexOutOfBoundsException` in JSON Template Layout truncated exception resolver</description>
+</entry>
