Merge tag 'rel/2.24.1' into 2.x

Author: ppkarwasz

log4j-cassandra/pom.xml

@@ -45,8 +45,29 @@
     <!-- cassandra-all breaks with a newer version -->
     <!-- at least this version has one CVE less than the one suggested by Cassandra -->
     <guava.version>25.1-jre</guava.version>
+    <!-- Pinned transitive dependencies for reproducibility between Linux and MacOS -->
+    <jnr-ffi.version>2.2.16</jnr-ffi.version>
+    <snappy.version>1.1.10.7</snappy.version>
   </properties>
 
+  <dependencyManagement>
+    <dependencies>
+
+      <dependency>
+        <groupId>com.github.jnr</groupId>
+        <artifactId>jnr-ffi</artifactId>
+        <version>${jnr-ffi.version}</version>
+      </dependency>
+
+      <dependency>
+        <groupId>org.xerial.snappy</groupId>
+        <artifactId>snappy-java</artifactId>
+        <version>${snappy.version}</version>
+      </dependency>
+
+    </dependencies>
+  </dependencyManagement>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>

log4j-core-test/src/test/java/org/apache/logging/log4j/core/util/WatchManagerTest.java

@@ -36,6 +36,7 @@
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.TimeUnit;
 import org.apache.logging.log4j.core.config.ConfigurationScheduler;
+import org.apache.logging.log4j.core.config.ConfigurationSource;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -143,10 +144,9 @@ void testWatchManagerResetFile() throws Exception {
      */
     @Test
     void testWatchManagerCallsWatcher() {
-        Source source = mock(Source.class);
         Watcher watcher = mock(Watcher.class);
         when(watcher.isModified()).thenReturn(false);
-        watchManager.watch(source, watcher);
+        watchManager.watch(new Source(ConfigurationSource.NULL_SOURCE), watcher);
         verify(watcher, timeout(2000)).isModified();
         verify(watcher, never()).modified();
         when(watcher.isModified()).thenReturn(true);

log4j-core/src/main/java/org/apache/logging/log4j/core/config/ConfigurationSource.java

@@ -16,8 +16,6 @@
  */
 package org.apache.logging.log4j.core.config;
 
-import static java.util.Objects.requireNonNull;
-
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
@@ -34,6 +32,7 @@
 import java.net.URLConnection;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.Objects;
 import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.core.net.UrlConnectionFactory;
 import org.apache.logging.log4j.core.util.FileUtils;
@@ -78,7 +77,16 @@ public class ConfigurationSource {
      * @param file the file where the input stream originated
      */
     public ConfigurationSource(final InputStream stream, final File file) {
-        this(null, new Source(file), stream, getLastModified(file.toPath()));
+        this.stream = Objects.requireNonNull(stream, "stream is null");
+        this.data = null;
+        this.source = new Source(file);
+        long modified = 0;
+        try {
+            modified = file.lastModified();
+        } catch (Exception ex) {
+            // There is a problem with the file. It will be handled somewhere else.
+        }
+        this.currentLastModified = this.initialLastModified = modified;
     }
 
     /**
@@ -89,16 +97,16 @@ public ConfigurationSource(final InputStream stream, final File file) {
      * @param path the path where the input stream originated.
      */
     public ConfigurationSource(final InputStream stream, final Path path) {
-        this(null, new Source(path), stream, getLastModified(path));
-    }
-
-    private static long getLastModified(Path path) {
+        this.stream = Objects.requireNonNull(stream, "stream is null");
+        this.data = null;
+        this.source = new Source(path);
+        long modified = 0;
         try {
-            return Files.getLastModifiedTime(path).toMillis();
-        } catch (Exception ignored) {
+            modified = Files.getLastModifiedTime(path).toMillis();
+        } catch (Exception ex) {
             // There is a problem with the file. It will be handled somewhere else.
         }
-        return 0L;
+        this.currentLastModified = this.initialLastModified = modified;
     }
 
     /**
@@ -120,8 +128,11 @@ public ConfigurationSource(final InputStream stream, final URL url) {
      * @param url the URL where the input stream originated
      * @param lastModified when the source was last modified.
      */
-    public ConfigurationSource(InputStream stream, final URL url, final long lastModified) {
-        this(null, new Source(url), stream, lastModified);
+    public ConfigurationSource(final InputStream stream, final URL url, final long lastModified) {
+        this.stream = Objects.requireNonNull(stream, "stream is null");
+        this.data = null;
+        this.currentLastModified = this.initialLastModified = lastModified;
+        this.source = new Source(url);
     }
 
     /**
@@ -142,26 +153,19 @@ public ConfigurationSource(InputStream stream) throws IOException {
      * @param data data from the source
      * @param lastModified when the source was last modified.
      */
-    public ConfigurationSource(Source source, byte[] data, long lastModified) {
-        this(data, requireNonNull(source, "source is null"), lastModified);
-    }
-
-    private ConfigurationSource(byte[] data, /*@Nullable*/ Source source, long lastModified) {
-        this(requireNonNull(data, "data is null"), source, new ByteArrayInputStream(data), lastModified);
+    public ConfigurationSource(final Source source, final byte[] data, final long lastModified) {
+        Objects.requireNonNull(source, "source is null");
+        this.data = Objects.requireNonNull(data, "data is null");
+        this.stream = new ByteArrayInputStream(data);
+        this.currentLastModified = this.initialLastModified = lastModified;
+        this.source = source;
     }
 
-    /**
-     * @throws NullPointerException if both {@code stream} and {@code data} are {@code null}.
-     */
-    private ConfigurationSource(
-            byte /*@Nullable*/[] data, /*@Nullable*/ Source source, InputStream stream, long lastModified) {
-        if (data == null && source == null) {
-            throw new NullPointerException("both `data` and `source` are null");
-        }
-        this.stream = stream;
-        this.data = data;
-        this.source = source;
+    private ConfigurationSource(final byte[] data, final URL url, final long lastModified) {
+        this.data = Objects.requireNonNull(data, "data is null");
+        this.stream = new ByteArrayInputStream(data);
         this.currentLastModified = this.initialLastModified = lastModified;
+        this.source = url == null ? null : new Source(url);
     }
 
     /**
@@ -194,6 +198,10 @@ private static byte[] toByteArray(final InputStream inputStream) throws IOExcept
         return source == null ? null : source.getFile();
     }
 
+    private boolean isLocation() {
+        return source != null && source.getLocation() != null;
+    }
+
     /**
      * Returns the configuration source URL, or {@code null} if this configuration source is based on a file or has
      * neither a file nor an URL.
@@ -279,13 +287,13 @@ public InputStream getInputStream() {
         URL url = getURL();
         if (url != null && data != null) {
             // Creates a ConfigurationSource without accessing the URL since the data was provided.
-            return new ConfigurationSource(data, new Source(url), currentLastModified);
+            return new ConfigurationSource(data, url, currentLastModified);
         }
         URI uri = getURI();
         if (uri != null) {
             return fromUri(uri);
         }
-        return data == null ? null : new ConfigurationSource(data, null, currentLastModified);
+        return data != null ? new ConfigurationSource(data, null, currentLastModified) : null;
     }
 
     @Override

log4j-mongodb/pom.xml

@@ -30,7 +30,7 @@
     <!-- OSGi and JPMS options -->
     <Fragment-Host>org.apache.logging.log4j.core</Fragment-Host>
     <!-- Dependency versions -->
-    <mongodb.version>5.1.3</mongodb.version>
+    <mongodb.version>5.1.4</mongodb.version>
     <slf4j2.version>2.0.16</slf4j2.version>
   </properties>
   <dependencyManagement>

pom.xml

@@ -307,6 +307,10 @@
 
     <!-- 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>
 
     <!-- =================
          Common properties
@@ -320,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-03T16:00:23Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2024-09-24T13:33:09Z</project.build.outputTimestamp>
 
     <!-- ========================
          Site-specific properties
@@ -347,10 +351,7 @@
     <site-je.version>18.3.12</site-je.version>
     <site-jeromq.version>0.6.0</site-jeromq.version>
     <site-kafka.version>3.8.0</site-kafka.version>
-    <site-log4j-api.version>2.24.0</site-log4j-api.version>
-    <site-log4j-core.version>2.24.0</site-log4j-core.version>
-    <site-log4j-layout-template-json.version>2.24.0</site-log4j-layout-template-json.version>
-    <site-logback.version>1.4.0</site-logback.version>
+    <site-logback.version>1.5.5</site-logback.version>
     <site-slf4j.version>2.0.16</site-slf4j.version>
 
     <!-- =====================================================

src/changelog/2.24.1/.release-notes.adoc.ftl

@@ -0,0 +1,27 @@
+////
+    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.
+////
+
+[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}]
+== ${release.version}
+
+<#if release.date?has_content>Release date:: ${release.date}</#if>
+
+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.
+
+<#include "../.changelog.adoc.ftl">

src/changelog/2.24.1/.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-09-24" version="2.24.1"/>

src/changelog/2.24.1/2229_mongodb_docker.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="2229" link="https://github.com/apache/logging-log4j2/issues/2229"/>
+  <description format="asciidoc">Switch MongoDB tests to use Docker.</description>
+</entry>

src/changelog/2.24.1/2936_make_LoggerRegistry_MessageFactory_namespaced.xml

@@ -0,0 +1,9 @@
+<?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="changed">
+  <issue id="2936" link="https://github.com/apache/logging-log4j2/pull/2936"/>
+  <description format="asciidoc">Rework `LoggerRegistry` to make it `MessageFactory`-namespaced.
+This effectively allows loggers of same name, but different message factory.</description>
+</entry>

src/changelog/2.24.1/2937-http-watcher.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="2937" link="https://github.com/apache/logging-log4j2/issues/2937"/>
+  <description format="asciidoc">Fix reloading of the configuration from an HTTP(S) source</description>
+</entry>